Difference between revisions of "URL Parameters"
(8 intermediate revisions by the same user not shown) | |||
Line 47: | Line 47: | ||
* <code>1</code>: Delayed busy indicator (default for most platforms) | * <code>1</code>: Delayed busy indicator (default for most platforms) | ||
* <code>2</code>: Instant busy indicator | * <code>2</code>: Instant busy indicator | ||
+ | |- | ||
+ | | <code>caption</code> || <code>number</code> || | ||
+ | <code>caption=0</code><br/> | ||
+ | <code>caption=1</code><br/> | ||
+ | <code>caption=2</code><br/> | ||
+ | || | ||
+ | Sets the caption settings (visibility of the options/menu caption that is indicated in the lower right corner of the content screen). | ||
+ | |||
+ | * <code>0</code>: Off (options/menu caption is hidden) | ||
+ | * <code>1</code>: Visible if available (options/menu caption is visible if the menu button is available) | ||
+ | * <code>2</code>: Always visible (default for most platforms) | ||
+ | * <code>3</code>: Always visible (will be set automatically if the value was <code>1</code> and the menu button was pressed) | ||
|- | |- | ||
| <code>center</code> || <code>number</code> || | | <code>center</code> || <code>number</code> || | ||
Line 59: | Line 71: | ||
| <code>dictionary</code> || <code>string</code> || | | <code>dictionary</code> || <code>string</code> || | ||
<code>dictionary=http://msx.benzac.de/dic/en.json</code><br/> | <code>dictionary=http://msx.benzac.de/dic/en.json</code><br/> | ||
+ | <code>dictionary=none</code><br/> | ||
+ | <code>dictionary=custom</code><br/> | ||
|| | || | ||
− | 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. | + | Sets the dictionary. This parameter is designed for testing purposes or special use cases. |
+ | If this parameter is to <code>none</code>, no dictionary will be used (even if the startup data contains one or a custom dictionary is set). | ||
+ | If this parameter is to <code>custom</code>, the custom dictionary will be used in preference (even if a <code>start</code> parameter is set). | ||
+ | For final usage, please set the URL as <code>dictionary</code> property in the menu or content data or use the <code>dictionary:{URL}</code> action. | ||
For more information, please see [[Dictionary Structure]]. | For more information, please see [[Dictionary Structure]]. | ||
|- | |- | ||
Line 92: | Line 109: | ||
<code>init=0</code><br/> | <code>init=0</code><br/> | ||
<code>init=1</code><br/> | <code>init=1</code><br/> | ||
+ | <code>init=2</code><br/> | ||
|| | || | ||
Sets the init value. | Sets the init value. | ||
Line 97: | Line 115: | ||
* <code>0</code>: Default (default for most platforms) | * <code>0</code>: Default (default for most platforms) | ||
* <code>1</code>: Ignore stored content state | * <code>1</code>: Ignore stored content state | ||
+ | * <code>2</code>: Enforce use of stored content state (by default, the stored content state is not used if a start parameter is set) | ||
|- | |- | ||
| <code>input</code> || <code>number</code> || | | <code>input</code> || <code>number</code> || | ||
Line 103: | Line 122: | ||
<code>input=2</code><br/> | <code>input=2</code><br/> | ||
<code>input=3</code><br/> | <code>input=3</code><br/> | ||
+ | <code>input=4</code><br/> | ||
|| | || | ||
Sets the input settings. | Sets the input settings. | ||
Line 110: | Line 130: | ||
* <code>2</code>: Click & Swipe | * <code>2</code>: Click & Swipe | ||
* <code>3</code>: Drag & Drop (default for most platforms) | * <code>3</code>: Drag & Drop (default for most platforms) | ||
+ | * <code>4</code>: Move & Execute | ||
|- | |- | ||
| <code>layout</code> || <code>number</code>{{pipe}}<code>string</code> || | | <code>layout</code> || <code>number</code>{{pipe}}<code>string</code> || | ||
Line 163: | Line 184: | ||
<code>platform=uwp</code><br/> | <code>platform=uwp</code><br/> | ||
<code>platform=mac</code><br/> | <code>platform=mac</code><br/> | ||
+ | <code>platform=win</code><br/> | ||
|| | || | ||
Sets the platform identifier (usually this is not set by parameter, because each platform has its own index file). | Sets the platform identifier (usually this is not set by parameter, because each platform has its own index file). | ||
Line 193: | Line 215: | ||
* <code>2</code>: Pause/Play (video/audio pauses when the application goes to sleep and continues to play 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>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>pointer</code> || <code>number</code> || | ||
+ | <code>pointer=0</code><br/> | ||
+ | <code>pointer=1</code><br/> | ||
+ | <code>pointer=2</code><br/> | ||
+ | <code>pointer=3</code><br/> | ||
+ | <code>pointer=4</code><br/> | ||
+ | <code>pointer=5</code><br/> | ||
+ | || | ||
+ | Sets the pointer mode. | ||
+ | |||
+ | * <code>0</code>: Off (no mouse and touch events are handled) | ||
+ | * <code>1</code>: Mouse (only mouse events are handled) | ||
+ | * <code>2</code>: Touch (only touch events are handled) | ||
+ | * <code>3</code>: Merge (mouse and touch events are handled together) | ||
+ | * <code>4</code>: Switch (either mouse or touch events are handled, whichever is detected first; default for most platforms) | ||
+ | * <code>5</code>: Combi (only passive mouse, but all touch events are handled) | ||
|- | |- | ||
| <code>scale</code> || <code>string</code> || | | <code>scale</code> || <code>string</code> || |
Latest revision as of 19:19, 8 October 2024
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).
|
caption |
number |
|
Sets the caption settings (visibility of the options/menu caption that is indicated in the lower right corner of the content screen).
|
center |
number |
|
Sets the center function.
|
dictionary |
string |
|
Sets the dictionary. This parameter is designed for testing purposes or special use cases.
If this parameter is to |
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.
|
pointer |
number |
|
Sets the pointer 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.
|