13 URL query parameters - CDrummond/lms-material GitHub Wiki
As detailed in the earlier pages, Material supports customisation via various URL query parameters. The full list of these is detailed below:
| Name | Parameter type | Description |
|---|---|---|
| player | String (player name or ID) | Set the player to use. |
| page | String (browse, now-playing, queue) | Set initial view to use, for mobile layout. |
| debug | Comma separated string (json, cometd, libcometd) | Enable debug logging. |
| clearcache | none | Clear cache (such as artist and album lists). Section 06 Cache. |
| action | String | Specify initial actions. Section 03 Actions. |
| css | String | Specify path to CSS file on server. Section 07 Customisation. |
| js | String | Specify path to Javascript file on server. Section 07 Customisation. |
| nativeStatus | String (c, none) | Update native wrapper when status changes. Pass 'c' to use console messages. Section 08 Native applications. |
| nativeColors | String (c, none) | Update native wrapper when color changes. Pass 'c' to use console messages. Section 08 Native applications. |
| nativePlayer | String (c, none) | Update native wrapper when player changes. Pass 'c' to use console messages. Section 08 Native applications. |
| nativeUiChanges | String (c, none). | Update native wrapper when UI changes. Pass 'c' to use console messages. Section 08 Native applications |
| nativeTheme | String (c, none) | Update native wrapper when theme changes. Pass 'c' to use console messages. Section 08 Native applications. |
| nativeCover | String (c, none) | Update native wrapper when cover changes. Pass 'c' to use console messages. Section 08 Native applications. |
| nativePlayerPower | String (c, none) | Update native wrapper when player-power changes. Pass 'c' to use console messages. Section 08 Native applications. |
| nativeAccent | String (c, none) | Update native wrapper when accent colour changes, if using colour-from-cover. Section 08 Native applications. |
| nativeTitlebar | String (c, none) | Update native wrapper when titlebar interacted with. Section 08 Native applications. |
| nativeTextColor | String (c, none) | Update native wrapper when top text colour changes. Section 08 Native applications. |
| nativeConnectionStatus | String (c, none) | Update native wrapper when server connection state changes. Section 08 Native applications. |
| hide | Comma separated string (defplayer, mediaControls) | Hide certain UI elements (defplayer - default player controls, mediaControls - media/notification controls). |
| layout | String (desktop, mobile) | Force layout. |
| appSettings | URL | Add 'Application' entry to 'Settings' section of main menu, and specify URL to call when invoked. |
| appQuit | URL | Add 'Quit' entry to main menu, and specify URL to call when invoked. |
| appLaunchPlayer | URL | Add 'Start player' entry to main menu, and specify URL to call when invoked. |
| theme | String | Set theme - e.g. ?theme=linux/light/Adwaita |
| defaultTheme | String | Set default (i.e. initial) theme - e.g. ?defaultTheme=linux/light/Adwaita |
| themeColor | String | Set HTML theme-color, 6 digits without # - e.g. ?themColor=ff0000 |
| single | none | Only control 1 player. |
| addpad | none | Add padding to bottom navigation bar in mobile layout. |
| topPad | Integer | Padding to add to top of view. |
| botPad | Integer | Padding to add to bottom of view. |
| dlgPad | Integer | Padding to add to bottom of fullscreen dialogs. |
| party | none | Start in 'party' mode. |
| download | String (browser, native) | Configure how downloads are handled. If this value is neither browser nor native then downloads are disabled. |
| dontEmbed | Comma separated string | List of of file-types that are not to be embedded, and should invoke external handler. |
| altBtnLayout | Boolean | If true (or no value) is passed then force Windows OK/Cancel layout (e.g. Cancel button is on right). |
| expand | / separated path string |
Path to item to auto-expand in browse view. |
| npRatio | Float | Set width/height ratio when now-playing toggles between landscape and portrait. Default is 1.33333. (As of version 3.2.3) |
| npAutoClose | boolean | If true is passed then don't automatically close now-playing when no track. |
| dontTrapBack | boolean | If true is passed then don't intercept browser's back button, this will also enable updating window/tab title on track change (as per setTitle, below). |
| setTitle | boolean | If true window/tab title is updated on track change. This is disabled by default as trapping browser's back button messes up navigation history, leading to odd entries if window/tab title is also changed. |
| tbarBtns | String | Titlebar buttons to show (min, max, close) - default is to show all buttons. |
| tbarBtnsPos | String | Position of titlebar buttons - l for left, r for right (default) |
| tbarBtnsStyle | String | Style used for titlebar buttons - win for Windows, mac for macOS, gnome (default) for Linux/Adwaita. |
| hidePlayers | Comma separated string | List of player IDs to hide. |
| ipAddresses | Comma separated string | List of IP addresses of current machine, used to hide Start player menu entry if local player already started. |