DOCSEARCHbyAlgolia
Submit Docs

LX Music Documentation

website·Indexed 32 days ago

https://lxmusic.toside.cn/

User guides and FAQ for LX Music, an open-source music player available for desktop and mobile. Includes documentation on custom source scripting using JavaScript (ES6+), Scheme URL parameter passing, data storage paths, and troubleshooting for playback, lyrics, and synchronization.

Tokens
19.1K
Snippets
51
Records
151
Agent score
62%

What's inside LX Music

  1. Overview of LX Music Scheme URL system

    LX Music (v1.17.0+) supports Scheme URLs starting with lxmusic:// to allow external triggers (e.g., from a browser) to control the application.

    Common Value Constants:

    • Sources (source): kw, kg, tx, wy, mg
    • Audio Quality: 128k, 320k, flac, flac24bit

  2. Troubleshoot LX Music failing to start after Windows installation

    If the installation directory contains only the uninstaller and no other program files after installation, it is likely caused by:

    • Using the wrong architecture installer (e.g., using the Windows Arm64 installer on an x64 system).
    • Changing the installation directory during an overwrite installation. To change the directory, you must uninstall the software first.

    Solution: Uninstall the software via 'Control Panel → Programs and Features/Uninstall' and reinstall using the correct installation package.

  3. Sync songs across LX Music devices

    LX Music provides an experimental feature to synchronize favorite songs across different platforms. To use this feature, you must meet the minimum version requirements: Desktop v2.4.0, Mobile v1.1.0, and Sync Service v2.0.0.

    Security Warning: Data is transmitted in plain text. Only use this feature on trusted networks.

  4. LX Music Project Overview and Platform Support

    LX Music is a free, ad-free, open-source project developed for technical learning and research. It is designed to remain pure and without advertisements throughout its maintenance lifecycle. The project is hosted on GitHub for global technical exchange.

    Supported Platforms:

    • Linux
    • macOS
    • Windows
    • Android

    Unsupported Platforms:

    • iOS
    • HarmonyOS NEXT

  5. Access script and environment info via globalThis.lx

    The globalThis.lx object provides metadata about the current environment and the script itself:
    // API Version
const version = globalThis.lx.version;

// Environment (fixed to 'mobile' on mobile devices)
const env = globalThis.lx.env;

// Current script metadata (parsed from the header comments)
const info = globalThis.lx.currentScriptInfo;
console.log(info.name);
console.log(info.description);
console.log(info.version);
console.log(info.author);
console.log(info.homepage);
console.log(info.rawScript);

  6. Understand how songs are added to the playback list

    By default, when playing songs from 'Search', 'Playlists', or 'Charts', the application automatically adds the song to the 'Audition List' (试听列表) under 'My List' (我的列表) before playback. This is functionally equivalent to manually adding a song to the Audition List and playing it from there.

  7. Understand LX Music (Desktop) licensing and data sourcing

    LX Music (洛雪音乐助手) Desktop is released under the Apache License 2.0. The project acts as a client that pulls data from public servers of official music platforms (such as Kuwo, Kugou, and Migu) and displays it after simple filtering and merging. It does not own the audio data; it merely requests links from the selected 'Music Source' in the software settings and plays the returned stream. Non-official data, such as collection lists, are sourced from the user's local system or connected synchronization services.

  8. Select the correct LX Music Desktop installation package

    Choose the package based on your operating system and architecture:

    • macOS: Files ending in .dmg.
    • Linux: Files ending in .deb, .rpm, .AppImage, or .pacman.
    • Windows:
      • Installer (Setup.exe): Recommended. Supports automatic updates. If GitHub access is slow, updates may fail and require manual installation.
      • Portable (green.7z): Compressed 7z archive. Requires extraction (e.g., using 7-Zip, NanaZip, or Bandizip). Run lx-music-desktop.exe after extraction. Does not support automatic updates.
      • Windows 7/8/8.1: Since v2.5.0, these systems are not supported by default. Use the portable version with win7 in the filename (note: lacks security updates).
    • Architecture: x64 for 64-bit, x86 for 32-bit, and arm64 for Arm machines.

  9. Select the correct LX Music Mobile installation package

    Android installation packages end in .apk.

    • Architecture: Prioritize arm64-v8a. If installation fails, use the universal package. Other options include armeabi-v7a and x86_64.
    • Special Editions: Packages containing sl in the version number are the "Ink Status Bar" special edition.
    • Caveat: The universal package often has a lower internal version number than single-architecture packages. If you encounter a "version too low" error during update, try a single-architecture package.

  10. Understand how songs are added to the playback list

    By default, when playing songs from 'Search', 'Playlists', or 'Charts', the app automatically adds the song to the 'Audition List' (试听列表) under 'My List' (我的列表) before playback. This is functionally equivalent to manually adding a song to the Audition List and playing it from there.

  11. Handle copyrighted data in LX Music Mobile

    The project does not own the copyright to images, audio, or names (copyrighted data) encountered during use. To avoid infringement, users are required to clear any copyrighted data generated while using the project within 24 hours.

  12. Control application view and volume

    General application shortcuts for view and audio management:

    • Full Screen: Press F11 to toggle full screen, or Esc to exit full screen.
    • Volume Control: Hover the mouse over the volume button in the playback bar and use the mouse scroll wheel to adjust volume quickly.
    • Navigation: Press Backspace in a playlist detail page to return to the playlist list.
    • Editing: Press Esc to cancel editing a list name.
    • Details Page: Double right-click within the playback details page to close it.