Difference between revisions of "URL Parameters"

From MSX - Wiki
Jump to navigation Jump to search
(31 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.'''
  
−
== Parameter Syntax ==
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|+ Parameter syntax of URL parameters
 
|+ Parameter syntax of URL parameters
Line 19: Line 18:
 
* <code>1</code>: JS
 
* <code>1</code>: JS
 
* <code>2</code>: CSS (default for most platforms)
 
* <code>2</code>: CSS (default for most platforms)
 +
|-
 +
| <code>back</code> || <code>number</code> ||
 +
<code>back=0</code><br/>
 +
<code>back=1</code><br/>
 +
||
 +
Sets the back function.
 +
 +
* <code>0</code>: Off (use back key only; default for most platforms)
 +
* <code>1</code>: On (use web history)
 +
|-
 +
| <code>background</code> || <code>number</code> ||
 +
<code>background=0</code><br/>
 +
<code>background=1</code><br/>
 +
||
 +
Sets the background function.
 +
 +
* <code>0</code>: Off (transparant)
 +
* <code>1</code>: On (opaque; default for most platforms)
 +
|-
 +
| <code>busy</code> || <code>number</code> ||
 +
<code>busy=0</code><br/>
 +
<code>busy=1</code><br/>
 +
<code>busy=2</code><br/>
 +
||
 +
Sets the busy function (for data and video requests).
 +
 +
* <code>0</code>: Off (no busy indicator)
 +
* <code>1</code>: Delayed busy indicator (default for most platforms)
 +
* <code>2</code>: Instant busy indicator
 +
|-
 +
| <code>center</code> || <code>number</code> ||
 +
<code>center=0</code><br/>
 +
<code>center=1</code><br/>
 +
||
 +
Sets the center function.
 +
 +
* <code>0</code>: Off (UI is aligned at the top left)
 +
* <code>1</code>: On (UI is aligned in the center; default for most platforms)
 +
|-
 +
| <code>dictionary</code> || <code>string</code> ||
 +
<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 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=0</code><br/>
 +
<code>exit=1</code><br/>
 +
<code>exit=2</code><br/>
 +
<code>exit=3</code><br/>
 +
<code>exit=4</code><br/>
 +
||
 +
Sets the exit function.
 +
 +
* <code>0</code>: Off (exit function is hidden)
 +
* <code>1</code>: Platform-specific (default for most platforms)
 +
* <code>2</code>: Perform web history back
 +
* <code>3</code>: Perform web history start
 +
* <code>4</code>: Perform window close
 +
|-
 +
| <code>fullscreen</code> || <code>number</code> ||
 +
<code>fullscreen=0</code><br/>
 +
<code>fullscreen=1</code><br/>
 +
<code>fullscreen=2</code><br/>
 +
||
 +
Sets the fullscreen function.
 +
 +
* <code>0</code>: Off (fullscreen is not available)
 +
* <code>1</code>: On (fullscreen is always active and cannot be changed; default for most platforms)
 +
* <code>2</code>: Toggle (fullscreen can be toggled)
 +
|-
 +
| <code>init</code> || <code>number</code> ||
 +
<code>init=0</code><br/>
 +
<code>init=1</code><br/>
 +
||
 +
Sets the init value.
 +
 +
* <code>0</code>: Default (default for most platforms)
 +
* <code>1</code>: Ignore stored content state
 +
|-
 +
| <code>input</code> || <code>number</code> ||
 +
<code>input=0</code><br/>
 +
<code>input=1</code><br/>
 +
<code>input=2</code><br/>
 +
<code>input=3</code><br/>
 +
||
 +
Sets the input settings.
 +
 +
* <code>0</code>: Off
 +
* <code>1</code>: Remote Only
 +
* <code>2</code>: Click & Swipe
 +
* <code>3</code>: Drag & Drop (default for most platforms)
 +
|-
 +
| <code>layout</code> || <code>number</code>{{pipe}}<code>string</code> ||
 +
<code>layout=0.5</code><br/>
 +
<code>layout=0.75</code><br/>
 +
<code>layout=1</code><br/>
 +
<code>layout=1.5</code><br/>
 +
<code>layout=3</code><br/>
 +
<code>layout=6</code><br/>
 +
<code>layout=360p</code><br/>
 +
<code>layout=540p</code><br/>
 +
<code>layout=720p</code><br/>
 +
<code>layout=1080p</code><br/>
 +
<code>layout=2160p</code><br/>
 +
<code>layout=4320p</code><br/>
 +
<code>layout=auto</code><br/>
 +
<code>layout=detect</code><br/>
 +
||
 +
Sets the layout settings.
 +
 +
* <code>0.5</code>{{pipe}}<code>360p</code>: 360p
 +
* <code>0.75</code>{{pipe}}<code>540p</code>{{pipe}}<code>sd</code>: 540p
 +
* <code>1</code>{{pipe}}<code>720p</code>{{pipe}}<code>hd</code>: 720p
 +
* <code>1.5</code>{{pipe}}<code>1080p</code>{{pipe}}<code>shd</code>: 1080p
 +
* <code>3</code>{{pipe}}<code>2160p</code>{{pipe}}<code>uhd</code>{{pipe}}<code>4k</code>: 2160p
 +
* <code>6</code>{{pipe}}<code>4320p</code>{{pipe}}<code>8k</code>: 4320p
 +
* <code>auto</code>: Auto detect (with 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=default</code><br/>
 +
<code>platform=tizen</code><br/>
 +
<code>platform=samsung</code><br/>
 +
<code>platform=lg</code><br/>
 +
<code>platform=netcast</code><br/>
 +
<code>platform=panasonic</code><br/>
 +
<code>platform=chromecast</code><br/>
 +
<code>platform=ios</code><br/>
 +
<code>platform=android</code><br/>
 +
<code>platform=firetv</code><br/>
 +
<code>platform=hbbtv</code><br/>
 +
<code>platform=hbbtvop</code><br/>
 +
<code>platform=uwp</code><br/>
 +
<code>platform=mac</code><br/>
 +
||
 +
Sets the platform identifier (usually this is not set by parameter, because each platform has its own index file).
 +
|-
 +
| <code>remote</code> || <code>number</code> ||
 +
<code>remote=0</code><br/>
 +
<code>remote=1</code><br/>
 +
<code>remote=2</code><br/>
 +
<code>remote=3</code><br/>
 +
||
 +
Sets the remote settings.
 +
 +
* <code>0</code>: Off
 +
* <code>1</code>: Minimalistic (default for most platforms)
 +
* <code>2</code>: Navigation Frame
 +
* <code>3</code>: Complex
 +
|-
 +
| <code>playback</code> || <code>number</code> ||
 +
<code>playback=0</code><br/>
 +
<code>playback=1</code><br/>
 +
<code>playback=2</code><br/>
 +
<code>playback=3</code><br/>
 +
||
 +
Sets the playback mode.
 +
 +
* <code>0</code>: Stop (video/audio stops when the application goes to sleep)
 +
* <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=default</code><br/>
 +
<code>scale=auto</code><br/>
 +
<code>scale=device</code><br/>
 +
<code>scale=0.75</code><br/>
 +
<code>scale=fix:0.75</code><br/>
 +
||
 +
Sets the scale settings (viewport settings).
 +
 +
* <code>default</code>: No scaling (default for most platforms)
 +
* <code>auto</code>: Auto detect (with resize adjustment)
 +
* <code>device</code>: Set scale factor to device width (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>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=0</code><br/>
 +
<code>speed=1</code><br/>
 +
<code>speed=2</code><br/>
 +
<code>speed=3</code><br/>
 +
||
 +
Sets the playback speed function.
 +
 +
* <code>0</code>: Off (speed button is always disabled)
 +
* <code>1</code>: Video only (speed button is only enabled for videos)
 +
* <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>start</code> || <code>string</code> ||
 +
<code>start=menu:user:http://sc.msx.benzac.de/msx/service.php</code><br/>
 +
<code>start=menu:user:http://sc.msx.benzac.de/msx/service.php&gt;index:2</code><br/>
 +
<code>start=menu:user:http://sc.msx.benzac.de/msx/service.php&gt;index:2&gt;index:4</code><br/>
 +
<code>start=menu:user:http://sc.msx.benzac.de/msx/service.php&gt;index:2&gt;index:4&gt;execute</code><br/>
 +
||
 +
Sets the start parameter. The focus separator <code>&gt;</code> can be used to focus (and execute) an item on load.
 +
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=1542793102320</code><br/>
 +
||
 +
Sets the current timestamp (difference to the start timestamp must be less than 1 second to skip the splash screen).
 +
|-
 +
| <code>transform</code> || <code>number</code> ||
 +
<code>transform=0</code><br/>
 +
<code>transform=1</code><br/>
 +
<code>transform=2</code><br/>
 +
||
 +
Sets the transformation settings.
 +
 +
* <code>0</code>: Off
 +
* <code>1</code>: 2D (default for most platforms)
 +
* <code>2</code>: 3D
 +
|-
 +
| <code>volume</code> || <code>number</code> ||
 +
<code>volume=0</code><br/>
 +
<code>volume=1</code><br/>
 +
<code>volume=2</code><br/>
 +
||
 +
Sets the volume function.
 +
 +
* <code>0</code>: Off (volume function is hidden)
 +
* <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>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&gt;index:2</code><br/>
 +
<code>welcome=menu:user:http://sc.msx.benzac.de/msx/service.php&gt;index:2&gt;index:4</code><br/>
 +
<code>welcome=menu:user:http://sc.msx.benzac.de/msx/service.php&gt;index:2&gt;index:4&gt;execute</code><br/>
 +
||
 +
Sets the welcome pages that are used if no start parameter is set. The focus separator <code>&gt;</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=default</code><br/>
 +
<code>zoom=auto</code><br/>
 +
<code>zoom=0.75</code><br/>
 +
||
 +
Sets the zoom settings.
 +
 +
* <code>default</code>: No zooming (default for most platforms)
 +
* <code>auto</code>: Auto detect (with resize adjustment)
 +
* <code>{NUMBER}</code>: Set zoom factor to specific number
 
|}
 
|}

Revision as of 13: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 syntax of URL parameters
Parameter Type Example Description
animate number

animate=0
animate=1
animate=2

Sets the animation settings.

  • 0: Off
  • 1: JS
  • 2: CSS (default for most platforms)
back number

back=0
back=1

Sets the back function.

  • 0: Off (use back key only; default for most platforms)
  • 1: On (use web history)
background number

background=0
background=1

Sets the background function.

  • 0: Off (transparant)
  • 1: On (opaque; default for most platforms)
busy number

busy=0
busy=1
busy=2

Sets the busy function (for data and video requests).

  • 0: Off (no busy indicator)
  • 1: Delayed busy indicator (default for most platforms)
  • 2: Instant busy indicator
center number

center=0
center=1

Sets the center function.

  • 0: Off (UI is aligned at the top left)
  • 1: On (UI is aligned in the center; default for most platforms)
dictionary string

dictionary=http://msx.benzac.de/dic/en.json

Sets the dictionary. This parameter is designed for testing purposes. For final usage, please set the URL as dictionary property in the menu or content data. For more information, please see Dictionary Structure.

exit number

exit=0
exit=1
exit=2
exit=3
exit=4

Sets the exit function.

  • 0: Off (exit function is hidden)
  • 1: Platform-specific (default for most platforms)
  • 2: Perform web history back
  • 3: Perform web history start
  • 4: Perform window close
fullscreen number

fullscreen=0
fullscreen=1
fullscreen=2

Sets the fullscreen function.

  • 0: Off (fullscreen is not available)
  • 1: On (fullscreen is always active and cannot be changed; default for most platforms)
  • 2: Toggle (fullscreen can be toggled)
init number

init=0
init=1

Sets the init value.

  • 0: Default (default for most platforms)
  • 1: Ignore stored content state
input number

input=0
input=1
input=2
input=3

Sets the input settings.

  • 0: Off
  • 1: Remote Only
  • 2: Click & Swipe
  • 3: Drag & Drop (default for most platforms)
layout number|string

layout=0.5
layout=0.75
layout=1
layout=1.5
layout=3
layout=6
layout=360p
layout=540p
layout=720p
layout=1080p
layout=2160p
layout=4320p
layout=auto
layout=detect

Sets the layout settings.

  • 0.5|360p: 360p
  • 0.75|540p|sd: 540p
  • 1|720p|hd: 720p
  • 1.5|1080p|shd: 1080p
  • 3|2160p|uhd|4k: 2160p
  • 6|4320p|8k: 4320p
  • auto: Auto detect (with resize adjustment)
  • detect: Auto detect (without resize adjustment)
leave number

leave=0
leave=1

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).

  • 0: Off (leave function is hidden)
  • 1: On (leave function is visible)
platform string

platform=default
platform=tizen
platform=samsung
platform=lg
platform=netcast
platform=panasonic
platform=chromecast
platform=ios
platform=android
platform=firetv
platform=hbbtv
platform=hbbtvop
platform=uwp
platform=mac

Sets the platform identifier (usually this is not set by parameter, because each platform has its own index file).

remote number

remote=0
remote=1
remote=2
remote=3

Sets the remote settings.

  • 0: Off
  • 1: Minimalistic (default for most platforms)
  • 2: Navigation Frame
  • 3: Complex
playback number

playback=0
playback=1
playback=2
playback=3

Sets the playback mode.

  • 0: Stop (video/audio stops when the application goes to sleep)
  • 1: Pause only (video/audio pauses when the application goes to sleep and stays in that state when the application wakes up)
  • 2: Pause/Play (video/audio pauses when the application goes to sleep and continues to play when the application wakes up)
  • 3: Keep playing (video/audio continues to play when the application goes to sleep or the system controls the behavior; default for most platforms)
scale string

scale=default
scale=auto
scale=device
scale=0.75
scale=fix:0.75

Sets the scale settings (viewport settings).

  • default: No scaling (default for most platforms)
  • auto: Auto detect (with resize adjustment)
  • device: Set scale factor to device width (not fixed)
  • {NUMBER}: Set scale factor to specific number (not fixed)
  • fix:{NUMBER}: Set scale factor to specific number (fixed)
secure number

secure=0
secure=1
secure=2
secure=3
secure=4

Sets the secure settings (protocol updates from http:// to https://).

  • 0: Update JSON files and plugins in a secure context and never update media files (default for most platforms)
  • 1: Update JSON files, plugins, and media files in a secure context
  • 2: Force update of JSON files and plugins and never update media files
  • 3: Force update of media files and update JSON files and plugins in a secure context
  • 4: Force update of JSON files, plugins, and media files
speed number

speed=0
speed=1
speed=2
speed=3

Sets the playback speed function.

  • 0: Off (speed button is always disabled)
  • 1: Video only (speed button is only enabled for videos)
  • 2: Audio only (speed button is only enabled for audios)
  • 3: Video & Audio (speed button is always enabled; default for most platforms)
start string

start=menu:user:http://sc.msx.benzac.de/msx/service.php
start=menu:user:http://sc.msx.benzac.de/msx/service.php>index:2
start=menu:user:http://sc.msx.benzac.de/msx/service.php>index:2>index:4
start=menu:user:http://sc.msx.benzac.de/msx/service.php>index:2>index:4>execute

Sets the start parameter. The focus separator > can be used to focus (and execute) an item on load. For more information, please see Focus Separator.

suspend number

suspend=0
suspend=1
suspend=2

Sets the suspend mode.

  • 0: Off (application will never suspend/resume)
  • 1: Visibility handler (document visibility is checked to suspend/resume the application)
  • 2: System handler (system events are checked to suspend/resume the application; default for most platforms)
t number

t=1542793102320

Sets the current timestamp (difference to the start timestamp must be less than 1 second to skip the splash screen).

transform number

transform=0
transform=1
transform=2

Sets the transformation settings.

  • 0: Off
  • 1: 2D (default for most platforms)
  • 2: 3D
volume number

volume=0
volume=1
volume=2

Sets the volume function.

  • 0: Off (volume function is hidden)
  • 1: On (default for most platforms)
  • 2: Mute only (volume function is visible, but can only be used to toggle the muted state)
welcome string

welcome=menu:user:http://sc.msx.benzac.de/msx/service.php
welcome=menu:user:http://sc.msx.benzac.de/msx/service.php>index:2
welcome=menu:user:http://sc.msx.benzac.de/msx/service.php>index:2>index:4
welcome=menu:user:http://sc.msx.benzac.de/msx/service.php>index:2>index:4>execute

Sets the welcome pages that are used if no start parameter is set. The focus separator > 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 welcome property).

zoom string

zoom=default
zoom=auto
zoom=0.75

Sets the zoom settings.

  • default: No zooming (default for most platforms)
  • auto: Auto detect (with resize adjustment)
  • {NUMBER}: Set zoom factor to specific number
Retrieved from "https://msx.benzac.de/wiki/index.php?title=URL_Parameters&oldid=2584"