Difference between revisions of "URL Parameters"
(26 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
'''Note: If you set some application settings via these parameters, the corresponding settings in the application are disabled. For example, if you set the start parameter, the start parameter in the application settings is disabled.''' | '''Note: If you set some application settings via these parameters, the corresponding settings in the application are disabled. For example, if you set the start parameter, the start parameter in the application settings is disabled.''' | ||
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|+ Parameter syntax of URL parameters | |+ Parameter syntax of URL parameters | ||
Line 61: | Line 60: | ||
<code>dictionary=http://msx.benzac.de/dic/en.json</code><br/> | <code>dictionary=http://msx.benzac.de/dic/en.json</code><br/> | ||
|| | || | ||
− | Sets the dictionary. This parameter is designed for testing purposes. For final usage, please set the dictionary | + | Sets the dictionary. This parameter is designed for testing purposes. For final usage, please set the URL as <code>dictionary</code> property in the menu or content data. |
− | + | For more information, please see [[Dictionary Structure]]. | |
|- | |- | ||
| <code>exit</code> || <code>number</code> || | | <code>exit</code> || <code>number</code> || | ||
Line 138: | Line 137: | ||
* <code>auto</code>: Auto detect (with resize adjustment) | * <code>auto</code>: Auto detect (with resize adjustment) | ||
* <code>detect</code>: Auto detect (without resize adjustment) | * <code>detect</code>: Auto detect (without resize adjustment) | ||
+ | |- | ||
+ | | <code>leave</code> || <code>number</code> || | ||
+ | <code>leave=0</code><br/> | ||
+ | <code>leave=1</code><br/> | ||
+ | || | ||
+ | Sets the leave function. | ||
+ | The leave function performs a web history back on execution and can be used if the Media Station X application is opened from another application (or from the local Media Station X application). | ||
+ | |||
+ | * <code>0</code>: Off (leave function is hidden) | ||
+ | * <code>1</code>: On (leave function is visible) | ||
|- | |- | ||
| <code>platform</code> || <code>string</code> || | | <code>platform</code> || <code>string</code> || | ||
Line 144: | Line 153: | ||
<code>platform=samsung</code><br/> | <code>platform=samsung</code><br/> | ||
<code>platform=lg</code><br/> | <code>platform=lg</code><br/> | ||
+ | <code>platform=netcast</code><br/> | ||
<code>platform=panasonic</code><br/> | <code>platform=panasonic</code><br/> | ||
<code>platform=chromecast</code><br/> | <code>platform=chromecast</code><br/> | ||
Line 172: | Line 182: | ||
<code>playback=0</code><br/> | <code>playback=0</code><br/> | ||
<code>playback=1</code><br/> | <code>playback=1</code><br/> | ||
+ | <code>playback=2</code><br/> | ||
+ | <code>playback=3</code><br/> | ||
|| | || | ||
Sets the playback mode. | Sets the playback mode. | ||
− | * <code>0</code>: | + | * <code>0</code>: Stop (video/audio stops when the application goes to sleep) |
− | * <code> | + | * <code>1</code>: Pause only (video/audio pauses when the application goes to sleep and stays in that state when the application wakes up) |
+ | * <code>2</code>: Pause/Play (video/audio pauses when the application goes to sleep and continues to play when the application wakes up) | ||
+ | * <code>3</code>: Keep playing (video/audio continues to play when the application goes to sleep or the system controls the behavior; default for most platforms) | ||
|- | |- | ||
| <code>scale</code> || <code>string</code> || | | <code>scale</code> || <code>string</code> || | ||
Line 192: | Line 206: | ||
* <code>{NUMBER}</code>: Set scale factor to specific number (not fixed) | * <code>{NUMBER}</code>: Set scale factor to specific number (not fixed) | ||
* <code>fix:{NUMBER}</code>: Set scale factor to specific number (fixed) | * <code>fix:{NUMBER}</code>: Set scale factor to specific number (fixed) | ||
+ | |- | ||
+ | | <code>secure</code> || <code>number</code> || | ||
+ | <code>secure=0</code><br/> | ||
+ | <code>secure=1</code><br/> | ||
+ | <code>secure=2</code><br/> | ||
+ | <code>secure=3</code><br/> | ||
+ | <code>secure=4</code><br/> | ||
+ | || | ||
+ | Sets the secure settings (protocol updates from <code>http://</code> to <code>https://</code>). | ||
+ | |||
+ | * <code>0</code>: Update JSON files and plugins in a secure context and never update media files (default for most platforms) | ||
+ | * <code>1</code>: Update JSON files, plugins, and media files in a secure context | ||
+ | * <code>2</code>: Force update of JSON files and plugins and never update media files | ||
+ | * <code>3</code>: Force update of media files and update JSON files and plugins in a secure context | ||
+ | * <code>4</code>: Force update of JSON files, plugins, and media files | ||
|- | |- | ||
| <code>speed</code> || <code>number</code> || | | <code>speed</code> || <code>number</code> || | ||
Line 203: | Line 232: | ||
* <code>0</code>: Off (speed button is always disabled) | * <code>0</code>: Off (speed button is always disabled) | ||
* <code>1</code>: Video only (speed button is only enabled for videos) | * <code>1</code>: Video only (speed button is only enabled for videos) | ||
− | * <code>2</code>: Audio only (speed button is only enabled for | + | * <code>2</code>: Audio only (speed button is only enabled for audios) |
* <code>3</code>: Video & Audio (speed button is always enabled; default for most platforms) | * <code>3</code>: Video & Audio (speed button is always enabled; default for most platforms) | ||
|- | |- | ||
Line 213: | Line 242: | ||
|| | || | ||
Sets the start parameter. The focus separator <code>></code> can be used to focus (and execute) an item on load. | Sets the start parameter. The focus separator <code>></code> can be used to focus (and execute) an item on load. | ||
− | For more information | + | For more information, please see [[Focus Separator]]. |
+ | |- | ||
+ | | <code>suspend</code> || <code>number</code> || | ||
+ | <code>suspend=0</code><br/> | ||
+ | <code>suspend=1</code><br/> | ||
+ | <code>suspend=2</code><br/> | ||
+ | || | ||
+ | Sets the suspend mode. | ||
+ | |||
+ | * <code>0</code>: Off (application will never suspend/resume) | ||
+ | * <code>1</code>: Visibility handler (document visibility is checked to suspend/resume the application) | ||
+ | * <code>2</code>: System handler (system events are checked to suspend/resume the application; default for most platforms) | ||
|- | |- | ||
| <code>t</code> || <code>number</code> || | | <code>t</code> || <code>number</code> || | ||
Line 241: | Line 281: | ||
* <code>1</code>: On (default for most platforms) | * <code>1</code>: On (default for most platforms) | ||
* <code>2</code>: Mute only (volume function is visible, but can only be used to toggle the muted state) | * <code>2</code>: Mute only (volume function is visible, but can only be used to toggle the muted state) | ||
+ | |- | ||
+ | | <code>welcome</code> || <code>string</code> || | ||
+ | <code>welcome=menu:user:http://sc.msx.benzac.de/msx/service.php</code><br/> | ||
+ | <code>welcome=menu:user:http://sc.msx.benzac.de/msx/service.php>index:2</code><br/> | ||
+ | <code>welcome=menu:user:http://sc.msx.benzac.de/msx/service.php>index:2>index:4</code><br/> | ||
+ | <code>welcome=menu:user:http://sc.msx.benzac.de/msx/service.php>index:2>index:4>execute</code><br/> | ||
+ | || | ||
+ | Sets the welcome pages that are used if no start parameter is set. The focus separator <code>></code> can be used to focus (and execute) an item on load. | ||
+ | For more information, please see [[Focus Separator]]. | ||
+ | |||
+ | '''Note: This parameter will override the welcome pages in the application settings, however, it will not disable the function to setup the sart parameter (and to setup welcome pages via the <code>welcome</code> property).''' | ||
|- | |- | ||
| <code>zoom</code> || <code>string</code> || | | <code>zoom</code> || <code>string</code> || |
Revision as of 12:02, 12 July 2022
These parameters are only relevant for the web version of Media Station X (i.e. when using the URL http://msx.benzac.de
or https://msx.benzac.de
) and can be used to override some application settings with fixed values and to set some platform-specific functions.
Note: If you set some application settings via these parameters, the corresponding settings in the application are disabled. For example, if you set the start parameter, the start parameter in the application settings is disabled.
Parameter | Type | Example | Description |
---|---|---|---|
animate |
number |
|
Sets the animation settings.
|
back |
number |
|
Sets the back function.
|
background |
number |
|
Sets the background function.
|
busy |
number |
|
Sets the busy function (for data and video requests).
|
center |
number |
|
Sets the center function.
|
dictionary |
string |
|
Sets the dictionary. This parameter is designed for testing purposes. For final usage, please set the URL as |
exit |
number |
|
Sets the exit function.
|
fullscreen |
number |
|
Sets the fullscreen function.
|
init |
number |
|
Sets the init value.
|
input |
number |
|
Sets the input settings.
|
layout |
number |string |
|
Sets the layout settings.
|
leave |
number |
|
Sets the leave function. The leave function performs a web history back on execution and can be used if the Media Station X application is opened from another application (or from the local Media Station X application).
|
platform |
string |
|
Sets the platform identifier (usually this is not set by parameter, because each platform has its own index file). |
remote |
number |
|
Sets the remote settings.
|
playback |
number |
|
Sets the playback mode.
|
scale |
string |
|
Sets the scale settings (viewport settings).
|
secure |
number |
|
Sets the secure settings (protocol updates from
|
speed |
number |
|
Sets the playback speed function.
|
start |
string |
|
Sets the start parameter. The focus separator |
suspend |
number |
|
Sets the suspend mode.
|
t |
number |
|
Sets the current timestamp (difference to the start timestamp must be less than 1 second to skip the splash screen). |
transform |
number |
|
Sets the transformation settings.
|
volume |
number |
|
Sets the volume function.
|
welcome |
string |
|
Sets the welcome pages that are used if no start parameter is set. The focus separator Note: This parameter will override the welcome pages in the application settings, however, it will not disable the function to setup the sart parameter (and to setup welcome pages via the |
zoom |
string |
|
Sets the zoom settings.
|