Difference between revisions of "Internal Actions"
(104 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | These actions are used internally, but can also be used to create more complex and interactive media pages. Unlike the main actions, they have no version control and are only valid for version '''0.1. | + | These actions are used internally, but can also be used to create more complex and interactive media pages. Unlike the main actions, they have no version control and are only valid for version '''0.1.160+'''. Therefore, please check your version if you encounter any errors/warnings, because the syntax in previous versions can be different. |
− | '''Note: The main actions are also described here (in less detail) to provide a better overview of all available actions.''' | + | '''Note: The main actions ([[Actions]]) are also described here (in less detail) to provide a better overview of all available actions.''' |
− | + | If you would like to search for an action, please have a look at this link: https://msx.benzac.de/info/xp/actions.html. | |
− | |||
− | If you would like to search for an | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
Line 17: | Line 15: | ||
|| Optional | || Optional | ||
|| '''Yes''' | || '''Yes''' | ||
− | || Plays an audio | + | || Plays an audio. |
|- | |- | ||
| | | | ||
Line 24: | Line 22: | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || Plays an audio | + | || Plays an audio in auto mode. |
|- | |- | ||
| | | | ||
Line 43: | Line 41: | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || Plays a plugin audio | + | || Plays a plugin audio in auto mode. |
|- | |- | ||
| | | | ||
Line 53: | Line 51: | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || Plays an audio | + | || Plays an audio by resolving it with a URL in auto mode (the response data must contain a <code>url</code> property). |
|- | |- | ||
| | | | ||
Line 72: | Line 70: | ||
|| Optional | || Optional | ||
|| '''Yes''' | || '''Yes''' | ||
− | || Plays a plugin audio | + | || Plays a plugin audio. |
|- | |- | ||
| | | | ||
Line 82: | Line 80: | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || Plays an audio | + | || Plays an audio by resolving it with a URL (the response data must contain a <code>url</code> property). |
+ | |- | ||
+ | | | ||
+ | <code>awake</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Awakes the screen when the screen saver is active and starts a new sleep or eject timeout. | ||
|- | |- | ||
| | | | ||
Line 114: | Line 118: | ||
|| No | || No | ||
|| | || | ||
− | Loads a background (temporarily) by resolving it with | + | Loads a background (temporarily) by resolving it with a URL (the response data must contain a <code>url</code> property). |
The background is reset as soon as a new selection is performed. | The background is reset as soon as a new selection is performed. | ||
|- | |- | ||
Line 132: | Line 136: | ||
|| No | || No | ||
|| Stops a busy action. | || Stops a busy action. | ||
+ | |- | ||
+ | | | ||
+ | <code>cleaning</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Clears the cache (if the platform supports it) and reloads the application. | ||
|- | |- | ||
| | | | ||
Line 138: | Line 148: | ||
|| No | || No | ||
|| Closes all overlays. | || Closes all overlays. | ||
+ | |- | ||
+ | | | ||
+ | <code>close</code><br/> | ||
+ | <code>close</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Closes visible content and/or panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>close:{CONTENT_FLAG}</code><br/> | ||
+ | <code>close:content_flag</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Closes a visible content and/or panel that has the specific flag. | ||
|- | |- | ||
| | | | ||
Line 151: | Line 175: | ||
|| '''Yes''' | || '''Yes''' | ||
|| Shows a content page. | || Shows a content page. | ||
+ | |- | ||
+ | | | ||
+ | <code>content:json:{BASE64_ENCODED_JSON}</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows a content page by indicating the data inline as base64-encoded JSON. | ||
|- | |- | ||
| | | | ||
Line 223: | Line 253: | ||
<code>dialog:reload</code><br/> | <code>dialog:reload</code><br/> | ||
<code>dialog:restart</code><br/> | <code>dialog:restart</code><br/> | ||
+ | <code>dialog:cleaning</code><br/> | ||
<code>dialog:leave</code><br/> | <code>dialog:leave</code><br/> | ||
<code>dialog:exit</code><br/> | <code>dialog:exit</code><br/> | ||
Line 236: | Line 267: | ||
|| No | || No | ||
|| Shows a dialog. The dialog <code>none</code> is a special dialog and will close an active notification. | || Shows a dialog. The dialog <code>none</code> is a special dialog and will close an active notification. | ||
+ | |- | ||
+ | | | ||
+ | <code>dictionary:{URL}</code><br/> | ||
+ | <code>dictionary:http://msx.benzac.de/dic/en.json</code><br/> | ||
+ | <code>dictionary:none</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets up a custom dictionary. | ||
+ | If the URL is set to <code>none</code>, a custom dictionary is reset. | ||
+ | If a custom dictionary is set, a possible dictionary from the startup data is ignored (unless it is set via the <code>start</code> URL parameter). | ||
+ | |- | ||
+ | | | ||
+ | <code>eject</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the auto eject panel if a video/audio/slideshow is active. | ||
|- | |- | ||
| | | | ||
Line 403: | Line 451: | ||
|| | || | ||
Executes an action on the player with attached system info (handled by the video/audio plugin). | Executes an action on the player with attached system info (handled by the video/audio plugin). | ||
+ | It is also possible to attach the extended or only a specific system info. | ||
+ | Please see action <code>execute:info:{URL}</code> for possible examples. | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:info:silent:{REQUEST_ACTION}</code><br/> | ||
+ | <code>execute:info:silent:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | <code>execute:info:silent:user:{URL}</code><br/> | ||
+ | <code>execute:info:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:info:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:info:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:info:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:info:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || | ||
+ | Executes an action with attached system info in silent mode (by not showing a busy indicator and error messages). | ||
It is also possible to attach the extended or only a specific system info. | It is also possible to attach the extended or only a specific system info. | ||
Please see action <code>execute:info:{URL}</code> for possible examples. | Please see action <code>execute:info:{URL}</code> for possible examples. | ||
Line 456: | Line 520: | ||
<code>execute:response:request:interaction:{DATA_ID}</code><br/> | <code>execute:response:request:interaction:{DATA_ID}</code><br/> | ||
<code>execute:response:request:interaction:{DATA_ID}@{URL}</code><br/> | <code>execute:response:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | <code>execute:response:silent:{URL}</code><br/> | ||
+ | <code>execute:response:silent:user:{URL}</code><br/> | ||
+ | <code>execute:response:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:response:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:response:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:response:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:response:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| '''Required''' | || '''Required''' | ||
|| No | || No | ||
|| Executes an action with attached response from a request action (the data must contain a <code>requestAction</code> property and can optionally contain a request-related <code>requestData</code> property). | || Executes an action with attached response from a request action (the data must contain a <code>requestAction</code> property and can optionally contain a request-related <code>requestData</code> property). | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:resume:{URL}</code><br/> | ||
+ | <code>execute:resume:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Executes an action on server side with attached resume keys. | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:resume:accurate:{URL}</code><br/> | ||
+ | <code>execute:resume:accurate:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Executes an action on server side with attached resume keys with accurate headers. | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:resume:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:resume:request:interaction:custom_data_id</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Executes an action on the interaction plugin with attached resume keys. | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:resume:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | <code>execute:resume:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Executes an action on the interaction plugin with attached resume keys (with ensuring that the interaction plugin is loaded). | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:resume:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:resume:request:player:custom_data_id</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Executes an action on the player with attached resume keys (handled by the video/audio plugin). | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:resume:silent:{REQUEST_ACTION}</code><br/> | ||
+ | <code>execute:resume:silent:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | <code>execute:resume:silent:user:{URL}</code><br/> | ||
+ | <code>execute:resume:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:resume:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:resume:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:resume:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:resume:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Executes an action with attached resume keys in silent mode (by not showing a busy indicator and error messages). | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:resume:user:{URL}</code><br/> | ||
+ | <code>execute:resume:user:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Executes an action on server side with attached resume keys in user mode. | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:resume:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:resume:user:accurate:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Executes an action on server side with attached resume keys in user mode with accurate headers. | ||
|- | |- | ||
| | | | ||
Line 553: | Line 686: | ||
|- | |- | ||
| | | | ||
− | <code>execute:service:info: | + | <code>execute:service:info:silent:{REQUEST_ACTION}</code><br/> |
− | <code>execute:service:info: | + | <code>execute:service:info:silent:http://msx.benzac.de/services/echo.php</code><br/> |
+ | <code>execute:service:info:silent:user:{URL}</code><br/> | ||
+ | <code>execute:service:info:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:info:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:info:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:info:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:info:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| Optional | || Optional | ||
|| No | || No | ||
|| | || | ||
− | Executes a service action on server side with attached system info in user mode. | + | Executes a service action with attached system info in silent mode (by not showing a busy indicator and error messages). |
− | It is also possible to attach the extended or only a specific system info. | + | It is also possible to attach the extended or only a specific system info. |
+ | Please see action <code>execute:info:{URL}</code> for possible examples. | ||
+ | |- | ||
+ | | | ||
+ | <code>execute:service:info:user:{URL}</code><br/> | ||
+ | <code>execute:service:info:user:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || | ||
+ | Executes a service action on server side with attached system info in user mode. | ||
+ | It is also possible to attach the extended or only a specific system info. | ||
Please see action <code>execute:info:{URL}</code> for possible examples. | Please see action <code>execute:info:{URL}</code> for possible examples. | ||
|- | |- | ||
Line 602: | Line 751: | ||
<code>execute:service:response:request:interaction:{DATA_ID}</code><br/> | <code>execute:service:response:request:interaction:{DATA_ID}</code><br/> | ||
<code>execute:service:response:request:interaction:{DATA_ID}@{URL}</code><br/> | <code>execute:service:response:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | <code>execute:service:response:silent:{URL}</code><br/> | ||
+ | <code>execute:service:response:silent:user:{URL}</code><br/> | ||
+ | <code>execute:service:response:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:response:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:response:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:response:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:response:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| '''Required''' | || '''Required''' | ||
|| No | || No | ||
Line 607: | Line 763: | ||
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:resume:{URL}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:resume:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes a service action on server side with attached | + | || Executes a service action on server side with attached resume keys. |
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:resume:accurate:{URL}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:resume:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes a service action on server side with attached | + | || Executes a service action on server side with attached resume keys with accurate headers. |
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:resume:request:interaction:{DATA_ID}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:resume:request:interaction:custom_data_id</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes a service action on the interaction plugin with attached | + | || Executes a service action on the interaction plugin with attached resume keys. |
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:resume:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:resume:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes a service action on the interaction plugin with attached | + | || Executes a service action on the interaction plugin with attached resume keys (with ensuring that the interaction plugin is loaded). |
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:resume:request:player:{DATA_ID}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:resume:request:player:custom_data_id</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes a service action on the player with attached | + | || Executes a service action on the player with attached resume keys (handled by the video/audio plugin). |
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:resume:silent:{REQUEST_ACTION}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:resume:silent:http://msx.benzac.de/services/echo.php</code><br/> |
+ | <code>execute:service:resume:silent:user:{URL}</code><br/> | ||
+ | <code>execute:service:resume:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:resume:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:resume:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:resume:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:resume:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes a service action | + | || Executes a service action with attached resume keys in silent mode (by not showing a busy indicator and error messages). |
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:resume:user:{URL}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:resume:user:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes a service action on server side with attached | + | || Executes a service action on server side with attached resume keys in user mode. |
|- | |- | ||
| | | | ||
− | <code>execute:service:user:{URL}</code><br/> | + | <code>execute:service:resume:user:accurate:{URL}</code><br/> |
− | <code>execute:service:user:http://msx.benzac.de/services/echo.php</code><br/> | + | <code>execute:service:resume:user:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes a service action on server side in user mode. | + | || Executes a service action on server side with attached resume keys in user mode with accurate headers. |
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:silent:{REQUEST_ACTION}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:silent:http://msx.benzac.de/services/echo.php</code><br/> |
+ | <code>execute:service:silent:user:{URL}</code><br/> | ||
+ | <code>execute:service:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:silent:fetch:{URL}</code><br/> | ||
+ | <code>execute:service:silent:fetch:user:{URL}</code><br/> | ||
+ | <code>execute:service:silent:fetch:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:silent:fetch:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes a service action | + | || Executes a service action in silent mode (by not showing a busy indicator and error messages). |
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:slider:{URL}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:slider:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes a service action on server side with attached slider info. |
− | Executes a service action on server side with attached | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:slider:accurate:{URL}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:slider:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes a service action on server side with attached slider info with accurate headers. |
− | Executes a service action on server side with attached | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:slider:request:interaction:{DATA_ID}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:slider:request:interaction:custom_data_id</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes a service action on the interaction plugin with attached slider info. |
− | Executes a service action on the interaction plugin with attached | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:slider:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:slider:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes a service action on the interaction plugin with attached slider info (with ensuring that the interaction plugin is loaded). |
− | Executes a service action on the interaction plugin with attached | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:slider:request:player:{DATA_ID}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:slider:request:player:custom_data_id</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes a service action on the player with attached slider info (handled by the video/audio plugin). |
− | Executes a service action on the player with attached | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:slider:silent:{REQUEST_ACTION}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:slider:silent:http://msx.benzac.de/services/echo.php</code><br/> |
+ | <code>execute:service:slider:silent:user:{URL}</code><br/> | ||
+ | <code>execute:service:slider:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:slider:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:slider:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:slider:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:slider:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes a service action with attached slider info in silent mode (by not showing a busy indicator and error messages). |
− | Executes a service action | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>execute:service: | + | <code>execute:service:slider:user:{URL}</code><br/> |
− | <code>execute:service: | + | <code>execute:service:slider:user:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes a service action on server side with attached slider info in user mode. |
− | Executes a service action on server side with attached | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>execute:slider:{URL}</code><br/> | + | <code>execute:service:slider:user:accurate:{URL}</code><br/> |
− | <code>execute:slider:http://msx.benzac.de/services/echo.php</code><br/> | + | <code>execute:service:slider:user:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes | + | || Executes a service action on server side with attached slider info in user mode with accurate headers. |
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:service:user:{URL}</code><br/> |
− | <code>execute: | + | <code>execute:service:user:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes | + | || Executes a service action on server side in user mode. |
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:service:user:accurate:{URL}</code><br/> |
− | <code>execute: | + | <code>execute:service:user:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes | + | || Executes a service action on server side in user mode with accurate headers. |
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:service:video:{URL}</code><br/> |
− | <code>execute: | + | <code>execute:service:video:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes | + | || |
+ | Executes a service action on server side with attached video info. | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:service:video:accurate:{URL}</code><br/> |
− | <code>execute: | + | <code>execute:service:video:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes | + | || |
+ | Executes a service action on server side with attached video info with accurate headers. | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:service:video:request:interaction:{DATA_ID}</code><br/> |
− | <code>execute: | + | <code>execute:service:video:request:interaction:custom_data_id</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes | + | || |
+ | Executes a service action on the interaction plugin with attached video info. | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:service:video:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | <code>execute: | + | <code>execute:service:video:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || Executes | + | || |
+ | Executes a service action on the interaction plugin with attached video info (with ensuring that the interaction plugin is loaded). | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:service:video:request:player:{DATA_ID}</code><br/> |
− | + | <code>execute:service:video:request:player:custom_data_id</code><br/> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <code>execute: | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|| Optional | || Optional | ||
|| No | || No | ||
|| | || | ||
− | Executes | + | Executes a service action on the player with attached video info (handled by the video/audio plugin). |
It is also possible to attach only a specific video info. | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code>execute:video: | + | <code>execute:service:video:silent:{REQUEST_ACTION}</code><br/> |
− | <code>execute:video: | + | <code>execute:service:video:silent:http://msx.benzac.de/services/echo.php</code><br/> |
+ | <code>execute:service:video:silent:user:{URL}</code><br/> | ||
+ | <code>execute:service:video:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:video:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:service:video:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:video:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:service:video:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| Optional | || Optional | ||
|| No | || No | ||
|| | || | ||
− | Executes | + | Executes a service action with attached video info in silent mode (by not showing a busy indicator and error messages). |
It is also possible to attach only a specific video info. | It is also possible to attach only a specific video info. | ||
Please see action <code>execute:video:{URL}</code> for possible examples. | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code>execute:video: | + | <code>execute:service:video:user:{URL}</code><br/> |
− | <code>execute:video: | + | <code>execute:service:video:user:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
|| | || | ||
− | Executes | + | Executes a service action on server side with attached video info in user mode. |
It is also possible to attach only a specific video info. | It is also possible to attach only a specific video info. | ||
Please see action <code>execute:video:{URL}</code> for possible examples. | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code>execute:video: | + | <code>execute:service:video:user:accurate:{URL}</code><br/> |
− | <code>execute:video: | + | <code>execute:service:video:user:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
|| | || | ||
− | Executes | + | Executes a service action on server side with attached video info in user mode with accurate headers. |
It is also possible to attach only a specific video info. | It is also possible to attach only a specific video info. | ||
Please see action <code>execute:video:{URL}</code> for possible examples. | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:silent:{REQUEST_ACTION}</code><br/> |
− | <code>execute: | + | <code>execute:silent:http://msx.benzac.de/services/echo.php</code><br/> |
+ | <code>execute:silent:user:{URL}</code><br/> | ||
+ | <code>execute:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:silent:fetch:{URL}</code><br/> | ||
+ | <code>execute:silent:fetch:user:{URL}</code><br/> | ||
+ | <code>execute:silent:fetch:accurate:{URL}</code><br/> | ||
+ | <code>execute:silent:fetch:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes an action in silent mode (by not showing a busy indicator and error messages). |
− | Executes an action | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:slider:{URL}</code><br/> |
− | <code>execute: | + | <code>execute:slider:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes an action on server side with attached slider info. |
− | Executes an action on server side with attached | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>execute: | + | <code>execute:slider:accurate:{URL}</code><br/> |
− | <code>execute: | + | <code>execute:slider:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Executes an action on server side with attached slider info with accurate headers. |
− | Executes an action on server side with attached | ||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:slider:request:interaction:{DATA_ID}</code><br/> |
− | || | + | <code>execute:slider:request:interaction:custom_data_id</code><br/> |
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Executes an action on the interaction plugin with attached slider info. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:slider:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | <code> | + | <code>execute:slider:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> |
− | || | + | || Optional |
− | || | + | || No |
− | || | + | || Executes an action on the interaction plugin with attached slider info (with ensuring that the interaction plugin is loaded). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:slider:request:player:{DATA_ID}</code><br/> |
− | <code> | + | <code>execute:slider:request:player:custom_data_id</code><br/> |
− | + | || Optional | |
− | || | ||
|| No | || No | ||
− | || | + | || Executes an action on the player with attached slider info (handled by the video/audio plugin). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:slider:silent:{REQUEST_ACTION}</code><br/> |
− | <code> | + | <code>execute:slider:silent:http://msx.benzac.de/services/echo.php</code><br/> |
− | + | <code>execute:slider:silent:user:{URL}</code><br/> | |
− | + | <code>execute:slider:silent:accurate:{URL}</code><br/> | |
− | + | <code>execute:slider:silent:user:accurate:{URL}</code><br/> | |
− | + | <code>execute:slider:silent:request:player:{DATA_ID}</code><br/> | |
− | + | <code>execute:slider:silent:request:interaction:{DATA_ID}</code><br/> | |
− | <code> | + | <code>execute:slider:silent:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | || | + | || Optional |
|| No | || No | ||
− | || | + | || Executes an action with attached slider info in silent mode (by not showing a busy indicator and error messages). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:slider:user:{URL}</code><br/> |
− | || | + | <code>execute:slider:user:http://msx.benzac.de/services/echo.php</code><br/> |
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Executes an action on server side with attached slider info in user mode. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:slider:user:accurate:{URL}</code><br/> |
− | || | + | <code>execute:slider:user:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Executes an action on server side with attached slider info in user mode with accurate headers. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:user:{URL}</code><br/> |
− | || | + | <code>execute:user:http://msx.benzac.de/services/echo.php</code><br/> |
− | || | + | || Optional |
− | || | + | || '''Yes''' |
+ | || Executes an action on server side in user mode. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:user:accurate:{URL}</code><br/> |
− | + | <code>execute:user:accurate:http://msx.benzac.de/services/echo.php</code><br/> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <code> | ||
|| Optional | || Optional | ||
|| '''Yes''' | || '''Yes''' | ||
− | || | + | || Executes an action on server side in user mode with accurate headers. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:video:{URL}</code><br/> |
− | || | + | <code>execute:video:http://msx.benzac.de/services/echo.php</code><br/> |
− | || | + | <code>execute:video:info:http://msx.benzac.de/services/echo.php</code><br/> |
− | || | + | <code>execute:video:data:http://msx.benzac.de/services/echo.php</code><br/> |
+ | <code>execute:video:resume:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | <code>execute:video:volume:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | <code>execute:video:scene:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || | ||
+ | Executes an action on server side with attached video info. | ||
+ | It is also possible to attach only a specific video info. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:video:accurate:{URL}</code><br/> |
− | <code> | + | <code>execute:video:accurate:http://msx.benzac.de/services/echo.php</code><br/> |
− | |||
− | |||
− | |||
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || |
+ | Executes an action on server side with attached video info with accurate headers. | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:video:request:interaction:{DATA_ID}</code><br/> |
− | + | <code>execute:video:request:interaction:custom_data_id</code><br/> | |
− | + | || Optional | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | <code> | ||
− | || | ||
|| No | || No | ||
|| | || | ||
− | + | Executes an action on the interaction plugin with attached video info. | |
− | + | It is also possible to attach only a specific video info. | |
− | + | Please see action <code>execute:video:{URL}</code> for possible examples. | |
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:video:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | <code>interaction: | + | <code>execute:video:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> |
− | || | + | || Optional |
|| No | || No | ||
− | || | + | || |
+ | Executes an action on the interaction plugin with attached video info (with ensuring that the interaction plugin is loaded). | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:video:request:player:{DATA_ID}</code><br/> |
− | || | + | <code>execute:video:request:player:custom_data_id</code><br/> |
+ | || Optional | ||
|| No | || No | ||
− | || | + | || |
+ | Executes an action on the player with attached video info (handled by the video/audio plugin). | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code>interaction: | + | <code>execute:video:silent:{REQUEST_ACTION}</code><br/> |
+ | <code>execute:video:silent:http://msx.benzac.de/services/echo.php</code><br/> | ||
+ | <code>execute:video:silent:accurate:{URL}</code><br/> | ||
+ | <code>execute:video:silent:user:{URL}</code><br/> | ||
+ | <code>execute:video:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>execute:video:silent:request:player:{DATA_ID}</code><br/> | ||
+ | <code>execute:video:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>execute:video:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || |
+ | Executes an action with attached video info in silent mode (by not showing a busy indicator and error messages). | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:video:user:{URL}</code><br/> |
+ | <code>execute:video:user:http://msx.benzac.de/services/echo.php</code><br/> | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || |
+ | Executes an action on server side with attached video info in user mode. | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>execute:video:user:accurate:{URL}</code><br/> |
+ | <code>execute:video:user:accurate:http://msx.benzac.de/services/echo.php</code><br/> | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || |
+ | Executes an action on server side with attached video info in user mode with accurate headers. | ||
+ | It is also possible to attach only a specific video info. | ||
+ | Please see action <code>execute:video:{URL}</code> for possible examples. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>exit</code> |
− | + | || None | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Exits the application by using the platform-specific function. |
+ | |- | ||
+ | | | ||
+ | <code>focus:{ITEM_ID}</code><br/> | ||
+ | <code>focus:content_item_id</code><br/> | ||
+ | || None | ||
+ | || '''Yes''' | ||
+ | || Focuses an item with the indicated ID in the current context. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>focus:clear:{CONTENT_FLAG}</code><br/> |
− | <code> | + | <code>focus:clear:content_flag</code><br/> |
− | || | + | || None |
|| No | || No | ||
− | || | + | || Clears the focus cache for a menu, content, and/or panel that has the specific flag. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>focus:control:{CONTROL}</code><br/> |
− | <code> | + | <code>focus:control:menu</code><br/> |
− | + | <code>focus:control:content</code><br/> | |
− | <code> | + | || None |
− | |||
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Focuses a control in the current context. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>focus:execute:{ITEM_ID}</code><br/> |
− | || | + | <code>focus:execute:content_item_id</code><br/> |
+ | || None | ||
|| No | || No | ||
− | || | + | || Focuses and executes an item with the indicated ID in the current context. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>focus:execute:index:{ITEM_INDEX}</code><br/> |
− | + | <code>focus:execute:index:0</code><br/> | |
− | <code> | + | || None |
− | || | ||
|| No | || No | ||
− | || | + | || Focuses and executes an item with the indicated index in the current context. |
+ | |- | ||
+ | | | ||
+ | <code>focus:index:{ITEM_INDEX}</code><br/> | ||
+ | <code>focus:index:0</code><br/> | ||
+ | || None | ||
+ | || '''Yes''' | ||
+ | || Focuses an item with the indicated index in the current context. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>fullscreen</code> |
− | || | + | || None |
|| No | || No | ||
− | || | + | || Toggles the fullscreen. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>history:back</code> |
− | + | || None | |
− | |||
− | |||
− | |||
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Goes back in the web history. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>history:clear</code> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Clears the web history. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>history:start</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Goes to the web history start. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>history:validate</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Validates the web history. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>home</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows the main scene (or the context menu if the main scene is already active). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>image:{URL}</code><br/> |
− | <code> | + | <code>image:http://msx.benzac.de/img/bg1.jpg</code><br/> |
− | || | + | || Optional |
− | || | + | || '''Yes''' |
− | || | + | || Shows an image. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>image:context</code> |
− | + | || '''Required''' | |
− | || | + | || '''Yes''' |
− | || | + | || Shows an image by using the current context. |
− | || | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>image:resolve:{REQUEST_ACTION}</code><br/> |
− | || | + | <code>image:resolve:http://msx.benzac.de/services/resolve.php?type=image</code><br/> |
+ | <code>image:resolve:user:{URL}</code><br/> | ||
+ | <code>image:resolve:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>image:resolve:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Shows an image by resolving it with a URL (the response data must contain a <code>url</code> property). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>info:{MESSAGE}</code><br/> |
− | <code> | + | <code>info:This is an info message.</code><br/> |
|| None | || None | ||
− | || | + | || '''Yes''' |
− | || | + | || Shows an info message. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:busy:start:{BUSY_ID}</code><br/> |
+ | <code>interaction:busy:start:loading</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Starts an interaction-related busy action. | ||
+ | This busy action is automatically stopped if the interaction plugin is unloaded. | ||
+ | A busy action can be pending for maximum 30 seconds (after this time, it is automatically stopped). | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:busy:stop:{BUSY_ID}</code><br/> |
− | <code> | + | <code>interaction:busy:stop:loading</code><br/> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Stops an interaction-related busy action. |
+ | |- | ||
+ | | | ||
+ | <code>interaction:commit</code> | ||
+ | || '''Required''' | ||
+ | || No | ||
+ | || Commits data to the interaction plugin. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:code</code> |
− | + | || Optional | |
− | || | ||
|| No | || No | ||
− | || | + | || Commits a code to the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:dictionary</code> |
− | + | || Optional | |
− | || | ||
|| No | || No | ||
− | || | + | || Commits the dictionary to the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:info</code> |
− | + | || Optional | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Commits the system info to the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:info:{DATA_TYPE}</code><br/> |
− | <code> | + | <code>interaction:commit:info:extended</code><br/> |
− | <code> | + | <code>interaction:commit:info:base</code><br/> |
− | <code> | + | <code>interaction:commit:info:application</code><br/> |
− | <code> | + | <code>interaction:commit:info:framework</code><br/> |
− | <code> | + | <code>interaction:commit:info:content</code><br/> |
− | <code> | + | <code>interaction:commit:info:dictionary</code><br/> |
− | || | + | <code>interaction:commit:info:screen</code><br/> |
+ | <code>interaction:commit:info:time</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Commits the extended system info (including URL parameters and system data) or a specific system info to the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:message:{MESSAGE}</code><br/> |
− | || | + | <code>interaction:commit:message:This is an interaction message.</code><br/> |
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Commits a message to the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:response:{REQUEST_ACTION}</code><br/> |
− | <code> | + | <code>interaction:commit:response:http://msx.benzac.de/services/echo.php</code><br/> |
− | || | + | <code>interaction:commit:response:user:{URL}</code><br/> |
− | || | + | <code>interaction:commit:response:accurate:{URL}</code><br/> |
− | || | + | <code>interaction:commit:response:user:accurate:{URL}</code><br/> |
+ | <code>interaction:commit:response:request:player:{DATA_ID}</code><br/> | ||
+ | <code>interaction:commit:response:silent:{URL}</code><br/> | ||
+ | <code>interaction:commit:response:silent:user:{URL}</code><br/> | ||
+ | <code>interaction:commit:response:silent:accurate:{URL}</code><br/> | ||
+ | <code>interaction:commit:response:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>interaction:commit:response:silent:request:player:{DATA_ID}</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Commits a response to the interaction plugin. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:slider</code> |
− | + | || Optional | |
− | || | ||
|| No | || No | ||
− | || | + | || Commits the slider info to the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:string:{TRANSFORM_TYPE}:{STRING}</code><br/> |
− | <code> | + | <code>interaction:commit:string:transform:Media Station X</code><br/> |
− | || | + | <code>interaction:commit:string:normalize:EW6l] 801JCU; )</code><br/> |
− | || | + | || Optional |
− | || | + | || No |
+ | || Commits a transformed/normalized string to the interaction plugin. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:video</code> |
− | || | + | || Optional |
|| No | || No | ||
− | || | + | || Commits the video info to the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:commit:video:{DATA_TYPE}</code><br/> |
− | || | + | <code>interaction:commit:video:info</code><br/> |
+ | <code>interaction:commit:video:data</code><br/> | ||
+ | <code>interaction:commit:video:resume</code><br/> | ||
+ | <code>interaction:commit:video:volume</code><br/> | ||
+ | <code>interaction:commit:video:scene</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Commits a specific video info to the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:load:{URL}</code><br/> |
− | || | + | <code>interaction:load:http://msx.benzac.de/interaction/template.html</code><br/> |
+ | <code>interaction:load:none</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || |
+ | Loads the interaction plugin (and optionally commits data to it). | ||
+ | If the interaction plugin is already loaded and action-related data is provided, this action behaves like <code>interaction:commit</code>. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:reload</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Reloads the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>interaction:unload</code> |
− | + | || None | |
− | || | ||
|| No | || No | ||
− | || | + | || Unloads the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:content</code> |
− | + | || None | |
− | || | ||
|| No | || No | ||
− | || | + | || Invalidates the current content (only if the content data is reloadable). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:content:flag:{CONTENT_FLAG}</code><br/> |
− | <code> | + | <code>invalidate:content:flag:content_flag</code><br/> |
− | || | + | || None |
|| No | || No | ||
− | || | + | || Invalidates the current content if it has the specific flag. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:content:{ITEM_ID}</code><br/> |
− | <code> | + | <code>invalidate:content:content_item_id</code><br/> |
− | || | + | || None |
|| No | || No | ||
− | || | + | || Invalidates a content item. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:content:overlay:{ITEM_ID}</code><br/> |
+ | <code>invalidate:content:overlay:content_item_id</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Invalidates a content overlay item. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:content:underlay:{ITEM_ID}</code><br/> |
+ | <code>invalidate:content:underlay:content_item_id</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Invalidates a content underlay item. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:menu</code> |
− | |||
|| None | || None | ||
− | || | + | || No |
− | || | + | || Invalidates the current menu (only if the menu data is reloadable). |
|- | |- | ||
| | | | ||
− | <code>menu: | + | <code>invalidate:menu:flag:{CONTENT_FLAG}</code><br/> |
− | || | + | <code>invalidate:menu:flag:content_flag</code><br/> |
− | || | + | || None |
− | || | + | || No |
+ | || Invalidates the current menu if it has the specific flag. | ||
|- | |- | ||
| | | | ||
− | <code>menu | + | <code>invalidate:menu:{ITEM_ID}</code><br/> |
− | <code>menu: | + | <code>invalidate:menu:menu_item_id</code><br/> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Invalidates a menu item. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:panel</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Invalidates the current panel (only if the panel data is reloadable). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:panel:flag:{CONTENT_FLAG}</code><br/> |
− | <code> | + | <code>invalidate:panel:flag:content_flag</code><br/> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Invalidates the current panel if it has the specific flag. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:panel:{ITEM_ID}</code><br/> |
− | <code> | + | <code>invalidate:panel:content_item_id</code><br/> |
|| None | || None | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|| No | || No | ||
− | || | + | || Invalidates a panel item. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>invalidate:panel:overlay:{ITEM_ID}</code><br/> |
+ | <code>invalidate:panel:overlay:content_item_id</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Invalidates a panel overlay item. |
|- | |- | ||
| | | | ||
− | <code>panel:{ | + | <code>invalidate:panel:underlay:{ITEM_ID}</code><br/> |
− | <code>panel: | + | <code>invalidate:panel:underlay:content_item_id</code><br/> |
|| None | || None | ||
− | || | + | || No |
− | || | + | || Invalidates a panel underlay item. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>key:{REMOTE_KEY}</code><br/> |
− | + | <code>key:left</code><br/> | |
− | + | <code>key:right</code><br/> | |
− | + | <code>key:up</code><br/> | |
− | + | <code>key:down</code><br/> | |
− | + | <code>key:execute</code><br/> | |
− | <code> | + | <code>key:back</code><br/> |
− | <code> | + | <code>key:red</code><br/> |
+ | <code>key:green</code><br/> | ||
+ | <code>key:yellow</code><br/> | ||
+ | <code>key:blue</code><br/> | ||
+ | <code>key:channel_up</code><br/> | ||
+ | <code>key:channel_down</code><br/> | ||
+ | <code>key:play</code><br/> | ||
+ | <code>key:pause</code><br/> | ||
+ | <code>key:stop</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Triggers a remote key. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>key:code:{REMOTE_KEY_CODE}</code><br/> |
− | <code> | + | <code>key:code:37</code><br/> |
+ | <code>key:code:39</code><br/> | ||
+ | <code>key:code:38</code><br/> | ||
+ | <code>key:code:40</code><br/> | ||
+ | <code>key:code:13</code><br/> | ||
+ | <code>key:code:8</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Triggers a remote key by using the remote key code. |
+ | |- | ||
+ | | | ||
+ | <code>lazy:{ACTION}</code><br/> | ||
+ | <code>lazy:info:Lazy action executed.</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || | ||
+ | Executes an action when all running animations are completed. | ||
+ | If no animations are currently running, the action is executed directly. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>leave</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Leaves the application by using the web history back function. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>link:{URL}</code><br/> |
− | <code> | + | <code>link:http://msx.benzac.de/info/</code><br/> |
|| None | || None | ||
− | || | + | || No |
− | || | + | || Opens a link. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>link:replace:{URL}</code><br/> |
+ | <code>link:replace:http://msx.benzac.de/info/</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Opens a link by replacing the current URL. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>link:validate:{URL}</code><br/> |
+ | <code>link:validate:http://msx.benzac.de/info/</code><br/> | ||
+ | <code>link:validate:window:http://msx.benzac.de/info/</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Opens a link by enforcing validation. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>link:window:{URL}</code><br/> |
− | <code> | + | <code>link:window:http://msx.benzac.de/info/</code><br/> |
− | + | || None | |
− | + | || '''Yes''' | |
− | + | || Opens a link in a window. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | || | ||
− | || | ||
− | || | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>live</code> |
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Executes the live action. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>log</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Toggles the log scene. |
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>log:clear</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Clears the log. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>logger:debug:{MESSAGE}</code><br/> |
− | + | <code>logger:debug:This is a debug message.</code><br/> | |
− | |||
− | <code> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Logs a debug message. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>logger:error:{MESSAGE}</code><br/> |
− | + | <code>logger:error:This is an error message.</code><br/> | |
− | + | || Optional | |
− | <code> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Logs (and shows) an error message. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>logger:info:{MESSAGE}</code><br/> |
− | <code> | + | <code>logger:info:This is an info message.</code><br/> |
− | + | || Optional | |
− | + | || No | |
− | + | || Logs (and shows) an info message. | |
− | + | |- | |
− | + | | | |
− | <code> | + | <code>logger:success:{MESSAGE}</code><br/> |
− | + | <code>logger:success:This is a success message.</code><br/> | |
− | <code> | + | || Optional |
− | || | ||
|| No | || No | ||
− | || | + | || Logs (and shows) a success message. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>logger:warn:{MESSAGE}</code><br/> |
− | + | <code>logger:warn:This is a warning message.</code><br/> | |
− | |||
− | <code> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
|| Optional | || Optional | ||
|| No | || No | ||
− | || | + | || Logs (and shows) a warning message. |
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>main</code> |
− | || | + | || None |
|| No | || No | ||
− | || | + | || Shows the main scene (if the main scene is not already active). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>menu</code> |
− | || | + | || None |
|| No | || No | ||
− | || | + | || Toggles the context menu. |
+ | |- | ||
+ | | | ||
+ | <code>menu:{URL}</code><br/> | ||
+ | <code>menu:http://msx.benzac.de/info/data/guide/actions.json</code><br/> | ||
+ | || None | ||
+ | || '''Yes''' | ||
+ | || Loads a menu. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>menu:data</code> |
− | || | + | || '''Required''' |
− | || | + | || '''Yes''' |
− | || | + | || Shows a menu. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>menu:json:{BASE64_ENCODED_JSON}</code> |
− | || | + | || None |
|| No | || No | ||
− | || | + | || Shows a menu by indicating the data inline as base64-encoded JSON. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>menu:request:interaction:{DATA_ID}</code><br/> |
− | <code> | + | <code>menu:request:interaction:custom_data_id</code><br/> |
− | + | || None | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Loads a menu from the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>menu:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | <code> | + | <code>menu:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> |
− | || | + | || None |
|| No | || No | ||
− | || | + | || Loads a menu from the interaction plugin (with ensuring that the interaction plugin is loaded). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>menu:request:player:{DATA_ID}</code><br/> |
− | + | <code>menu:request:player:custom_data_id</code><br/> | |
− | + | || None | |
− | |||
− | |||
− | <code> | ||
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Loads a menu from the player (handled by the video/audio plugin). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>menu:user:{URL}</code><br/> |
− | || | + | <code>menu:user:http://msx.benzac.de/info/data/guide/actions.json</code> |
− | || | + | || None |
− | || | + | || '''Yes''' |
+ | || Loads a menu in user mode. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>notification:{MESSAGE}</code><br/> |
− | + | <code>notification:This is a notification message.</code> | |
− | <code> | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || Commits a | + | || Commits a notification message to the video/audio and interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>options</code> |
− | || | + | || None |
|| No | || No | ||
− | || | + | || Toggles the content options. |
+ | |- | ||
+ | | | ||
+ | <code>panel:{URL}</code><br/> | ||
+ | <code>panel:http://msx.benzac.de/info/data/guide/panel.json</code><br/> | ||
+ | || None | ||
+ | || '''Yes''' | ||
+ | || Loads a panel. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>panel:data</code> |
− | + | || '''Required''' | |
− | + | || '''Yes''' | |
− | + | || Shows a panel. | |
− | |||
− | |||
− | || | ||
− | || | ||
− | || | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>panel:json:{BASE64_ENCODED_JSON}</code> |
|| None | || None | ||
|| No | || No | ||
− | || Shows the | + | || Shows a panel by indicating the data inline as base64-encoded JSON. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>panel:request:interaction:{DATA_ID}</code><br/> |
− | + | <code>panel:request:interaction:custom_data_id</code><br/> | |
− | |||
− | |||
− | <code> | ||
|| None | || None | ||
|| No | || No | ||
− | || Loads a | + | || Loads a panel from the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>panel:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | + | <code>panel:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> | |
− | |||
− | |||
− | |||
− | |||
− | <code> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a panel from the interaction plugin (with ensuring that the interaction plugin is loaded). |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>panel:request:player:{DATA_ID}</code><br/> |
+ | <code>panel:request:player:custom_data_id</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a panel from the player (handled by the video/audio plugin). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>panel:user:{URL}</code><br/> |
− | <code> | + | <code>panel:user:http://msx.benzac.de/info/data/guide/panel.json</code><br/> |
|| None | || None | ||
− | || | + | || '''Yes''' |
− | || | + | || Loads a panel in user mode. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playback</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows video/audio playback (closes overlaying content if a video/audio is active). |
|- | |- | ||
| | | | ||
− | <code>player | + | <code>player</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Toggles the player scene. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:action</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows the player action. |
|- | |- | ||
| | | | ||
− | <code>player:goto:last</code> | + | <code>player:auto:{PLAYER_ACTION}</code><br/> |
− | || | + | <code>player:auto:next</code><br/> |
+ | <code>player:auto:prev</code><br/> | ||
+ | <code>player:auto:play</code><br/> | ||
+ | <code>player:auto:pause</code><br/> | ||
+ | <code>player:auto:play_pause</code><br/> | ||
+ | <code>player:auto:forward</code><br/> | ||
+ | <code>player:auto:rewind</code><br/> | ||
+ | <code>player:auto:restart</code><br/> | ||
+ | <code>player:auto:goto:first</code><br/> | ||
+ | <code>player:auto:goto:last</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Executes a player action in auto mode. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:background:{URL}</code><br/> |
+ | <code>player:background:http://msx.benzac.de/img/bg1.jpg</code><br/> | ||
+ | <code>player:background:none</code><br/> | ||
+ | <code>player:background:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Sets up an audio background (overrides the <code>background</code> property of the corresponding content item with a custom value). |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:busy:start:{BUSY_ID}</code><br/> |
− | <code>player: | + | <code>player:busy:start:loading</code><br/> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Starts a player-related busy action. | ||
+ | This busy action is automatically stopped if the player is stopped. | ||
+ | A busy action can be pending for maximum 30 seconds (after this time, it is automatically stopped). | ||
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:busy:stop:{BUSY_ID}</code><br/> |
+ | <code>player:busy:stop:loading</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Stops a player-related busy action. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:button:{BUTTON_ID}:disable</code><br/> |
+ | <code>player:button:content:disable</code><br/> | ||
+ | <code>player:button:restart:disable</code><br/> | ||
+ | <code>player:button:prev:disable</code><br/> | ||
+ | <code>player:button:rewind:disable</code><br/> | ||
+ | <code>player:button:play_pause:disable</code><br/> | ||
+ | <code>player:button:forward:disable</code><br/> | ||
+ | <code>player:button:next:disable</code><br/> | ||
+ | <code>player:button:speed:disable</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Disables a player button (all buttons except the eject button are supported). |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:button:{BUTTON_ID}:enable</code><br/> |
+ | <code>player:button:content:enable</code><br/> | ||
+ | <code>player:button:restart:enable</code><br/> | ||
+ | <code>player:button:prev:enable</code><br/> | ||
+ | <code>player:button:rewind:enable</code><br/> | ||
+ | <code>player:button:play_pause:enable</code><br/> | ||
+ | <code>player:button:forward:enable</code><br/> | ||
+ | <code>player:button:next:enable</code><br/> | ||
+ | <code>player:button:speed:enable</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Enables a player button (all buttons except the eject button are supported). |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:button:{BUTTON_ID}:execute</code><br/> |
+ | <code>player:button:content:execute</code><br/> | ||
+ | <code>player:button:restart:execute</code><br/> | ||
+ | <code>player:button:prev:execute</code><br/> | ||
+ | <code>player:button:rewind:execute</code><br/> | ||
+ | <code>player:button:play_pause:execute</code><br/> | ||
+ | <code>player:button:forward:execute</code><br/> | ||
+ | <code>player:button:next:execute</code><br/> | ||
+ | <code>player:button:speed:execute</code><br/> | ||
+ | <code>player:button:eject:execute</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Executes a player button. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:button:{BUTTON_ID}:focus</code><br/> |
− | <code>player: | + | <code>player:button:content:focus</code><br/> |
− | <code>player: | + | <code>player:button:restart:focus</code><br/> |
+ | <code>player:button:prev:focus</code><br/> | ||
+ | <code>player:button:rewind:focus</code><br/> | ||
+ | <code>player:button:play_pause:focus</code><br/> | ||
+ | <code>player:button:forward:focus</code><br/> | ||
+ | <code>player:button:next:focus</code><br/> | ||
+ | <code>player:button:speed:focus</code><br/> | ||
+ | <code>player:button:eject:focus</code><br/> | ||
+ | <code>player:button:none:focus</code><br/> | ||
+ | <code>player:button:default:focus</code><br/> | ||
+ | <code>player:button:invalid:focus</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Focuses a player button. Additionally, the focus button for player execution events will be set. | ||
+ | If the button <code>none</code> is used, no button is focused and the focus button for player execution events will be set <code>none</code>. | ||
+ | If the button <code>default</code> is used, the default button is focused and the focus button for player execution events will also be set to default. | ||
+ | If the button <code>invalid</code> (or any other invalid ID) is used, no button is focused, but the focus button for player execution events will be set to default. | ||
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:button:{BUTTON_ID}:reset</code><br/> |
− | <code>player: | + | <code>player:button:content:reset</code><br/> |
− | <code>player: | + | <code>player:button:restart:reset</code><br/> |
+ | <code>player:button:prev:reset</code><br/> | ||
+ | <code>player:button:rewind:reset</code><br/> | ||
+ | <code>player:button:play_pause:reset</code><br/> | ||
+ | <code>player:button:forward::reset</code><br/> | ||
+ | <code>player:button:next:reset</code><br/> | ||
+ | <code>player:button:speed:reset</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Resets a player button (all buttons except the eject button are supported). |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:button:{BUTTON_ID}:setup</code><br/> |
− | || | + | <code>player:button:content:setup</code><br/> |
+ | <code>player:button:restart:setup</code><br/> | ||
+ | <code>player:button:prev:setup</code><br/> | ||
+ | <code>player:button:rewind:setup</code><br/> | ||
+ | <code>player:button:play_pause:setup</code><br/> | ||
+ | <code>player:button:forward:setup</code><br/> | ||
+ | <code>player:button:next:setup</code><br/> | ||
+ | <code>player:button:speed:setup</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || |
+ | Sets up a player button (all buttons except the eject button are supported). | ||
+ | The data can contain a <code>key</code> property (of type <code>string</code>), an <code>icon</code> property (of type <code>string</code>), an <code>action</code> property (of type <code>string</code>), and an <code>enable</code> property (of type <code>boolean</code>). | ||
+ | If some properties are not set, the default values are used. | ||
+ | |||
+ | '''Note: If the <code>icon</code> property is set, the <code>action</code> property must also be set (and vice versa), otherwise the default values are used for both properties.''' | ||
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit</code> |
− | + | || '''Required''' | |
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Commits data to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:code</code> |
− | + | || Optional | |
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Commits a code to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:dictionary</code> |
− | + | || Optional | |
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Commits the dictionary to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:info</code> |
− | + | || Optional | |
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Commits the system info to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:info:{DATA_TYPE}</code><br/> |
− | <code>player: | + | <code>player:commit:info:extended</code><br/> |
− | <code>player: | + | <code>player:commit:info:base</code><br/> |
− | || | + | <code>player:commit:info:application</code><br/> |
+ | <code>player:commit:info:framework</code><br/> | ||
+ | <code>player:commit:info:content</code><br/> | ||
+ | <code>player:commit:info:dictionary</code><br/> | ||
+ | <code>player:commit:info:screen</code><br/> | ||
+ | <code>player:commit:info:time</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Commits the extended system info (including URL parameters and system data) or a specific system info to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:message:{MESSAGE}</code><br/> |
− | + | <code>player:commit:message:This is a player message.</code><br/> | |
− | + | || Optional | |
− | <code>player: | ||
− | |||
− | || | ||
|| No | || No | ||
− | || | + | || Commits a message to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:response:{REQUEST_ACTION}</code><br/> |
− | || | + | <code>player:commit:response:http://msx.benzac.de/services/echo.php</code><br/> |
+ | <code>player:commit:response:user:{URL}</code><br/> | ||
+ | <code>player:commit:response:accurate:{URL}</code><br/> | ||
+ | <code>player:commit:response:user:accurate:{URL}</code><br/> | ||
+ | <code>player:commit:response:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>player:commit:response:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | <code>player:commit:response:silent:{URL}</code><br/> | ||
+ | <code>player:commit:response:silent:user:{URL}</code><br/> | ||
+ | <code>player:commit:response:silent:accurate:{URL}</code><br/> | ||
+ | <code>player:commit:response:silent:user:accurate:{URL}</code><br/> | ||
+ | <code>player:commit:response:silent:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>player:commit:response:silent:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Commits a response to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:slider</code> |
− | || | + | || Optional |
|| No | || No | ||
− | || | + | || Commits the slider info to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:string:{TRANSFORM_TYPE}:{STRING}</code><br/> |
− | || | + | <code>player:commit:string:transform:Media Station X</code><br/> |
+ | <code>player:commit:string:normalize:EW6l] 801JCU; )</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Commits a transformed/normalized string to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:video</code> |
− | || | + | || Optional |
|| No | || No | ||
− | || | + | || Commits the video info to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:commit:video:{DATA_TYPE}</code><br/> |
− | || | + | <code>player:commit:video:info</code><br/> |
+ | <code>player:commit:video:data</code><br/> | ||
+ | <code>player:commit:video:resume</code><br/> | ||
+ | <code>player:commit:video:volume</code><br/> | ||
+ | <code>player:commit:video:scene</code><br/> | ||
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Commits a specific video info to the video/audio plugin. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:content</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows the related content page (default action for the player button in the lower left corner). |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:content:{REQUEST_ACTION}</code><br/> |
− | <code>player: | + | <code>player:content:http://msx.benzac.de/info/data/guide/videos.json</code><br/> |
− | <code>player: | + | <code>player:content:user:{URL}</code><br/> |
+ | <code>player:content:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>player:content:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a content page with the player back function. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:content:data</code> |
− | || | + | || '''Required''' |
|| No | || No | ||
− | || | + | || Shows a content page with the player back function. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:content:json:{BASE64_ENCODED_JSON}</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows a content page with the player back function by indicating the data inline as base64-encoded JSON. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:control:action:{ACTION}</code><br/> |
+ | <code>player:control:action:info:Custom player control action executed.</code><br/> | ||
+ | <code>player:control:action:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Sets up a custom player control action (replacement for the action that is executed if the OK key is pressed while the video/audio is in foreground). | ||
+ | |||
+ | '''Note: For control actions, it is not possible to provide an action-related <code>data</code> property. If you want to execute a control data action, please use the <code>execute:fetch:{URL}</code> action, alternatively.''' | ||
|- | |- | ||
| | | | ||
− | <code>player | + | <code>player:default</code> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Executes the following default player action. Shows the player with applied remote key <code>execute</code>. |
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:eject</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Stops/Ejects the video/audio. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:execute_pause:{ACTION}</code><br/> |
− | || | + | <code>player:execute_pause:info:Video is paused.</code><br/> |
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Executes an action if the player is paused. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:execute_play:{ACTION}</code><br/> |
− | || | + | <code>player:execute_play:info:Video is playing.</code><br/> |
+ | || Optional | ||
|| No | || No | ||
− | || | + | || Executes an action if the player is playing. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:forward</code> |
|| None | || None | ||
|| No | || No | ||
− | || Jumps | + | || Jumps forward in the playback. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:{ITEM_ID}</code><br/> |
− | <code>player: | + | <code>player:goto:content_item_id</code><br/> |
− | |||
− | |||
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays the item with the indicated ID. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:current</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Replays the current item (by retuning it). |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:first</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays the first item. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:index:{ITEM_INDEX}</code><br/> |
+ | <code>player:goto:index:0</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays the item with the indicated index. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:last</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays the last item. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:next</code> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays the next item. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:number:{ITEM_NUMBER}</code><br/> |
+ | <code>player:goto:number:1</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays the item with the indicated number. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:prev</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays the previous item. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:random</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays a random item. |
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:goto:swap</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays the swap item. |
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:hide</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Hides the player. |
− | + | |- | |
− | |||
− | |||
− | |||
− | |||
− | |- | ||
| | | | ||
− | <code>player: | + | <code>player:hide_pause</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Hides the player if it is paused. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code>player: | + | <code>player:hide_play</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Hides the player if it is playing. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:info:headline:{HEADLINE}</code><br/> |
− | <code> | + | <code>player:info:headline:Additional video/audio information headline</code><br/> |
+ | <code>player:info:headline:default</code><br/> | ||
|| None | || None | ||
− | || | + | || No |
− | || | + | || Sets up a player info headline (only available for extended players). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:info:image:{URL}</code><br/> |
− | <code> | + | <code>player:info:image:http://msx.benzac.de/img/icon.png</code><br/> |
+ | <code>player:info:image:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Sets up a player info image (only available for extended players). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:info:overlay:{OVERLAY}</code><br/> |
− | || | + | <code>player:info:overlay:full</code><br/> |
+ | <code>player:info:overlay:default</code><br/> | ||
+ | || None | ||
|| No | || No | ||
− | || | + | || Sets up the player info overlay (only available for extended players). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:info:round:disable</code><br/> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Disables rounded corners of the info image if the rounded style is used (only available for extended players). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:info:round:enable</code><br/> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Enables rounded corners of the info image if the rounded style is used (only available for extended players). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:info:size:{SIZE}</code><br/> |
− | <code> | + | <code>player:info:size:small</code><br/> |
+ | <code>player:info:size:medium</code><br/> | ||
+ | <code>player:info:size:large</code><br/> | ||
+ | <code>player:info:size:extra-large</code><br/> | ||
+ | <code>player:info:size:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Sets up the size of the player info image area (only available for extended players). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:info:text:{TEXT}</code><br/> |
− | <code> | + | <code>player:info:text:Additional video/audio information text.</code><br/> |
+ | <code>player:info:text:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Sets up a player info text (only available for extended players). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:invalidate</code> |
− | || | + | || None |
− | || | + | || No |
− | || | + | || Invalidates the player (hides the player if it is not extended). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:label:content:{LABEL}</code><br/> |
− | <code> | + | <code>player:label:content:Custom player content label</code><br/> |
+ | <code>player:label:content:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Sets up the player content label (overrides the <code>playerLabel</code> property of the corresponding content item with a custom value). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:label:duration:{LABEL}</code><br/> |
− | <code> | + | <code>player:label:duration:Custom player duration label</code><br/> |
+ | <code>player:label:duration:Custom player duration label ({VALUE})</code><br/> | ||
+ | <code>player:label:duration:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Sets up the player duration label (overrides the default duration value of the video/audio player with a custom value). If the custom value contains the <code>{VALUE}</code> keyword, it is replaced with the default value. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:label:extension:{LABEL}</code><br/> |
− | <code> | + | <code>player:label:extension:{ico:live-tv}</code><br/> |
+ | <code>player:label:extension:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Sets up an additional player extension label. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:label:position:{LABEL}</code><br/> |
− | <code> | + | <code>player:label:position:Custom player position label</code><br/> |
+ | <code>player:label:position:Custom player position label ({VALUE})</code><br/> | ||
+ | <code>player:label:position:default</code><br/> | ||
|| None | || None | ||
− | || | + | || No |
− | || | + | || Sets up the player position label (overrides the default position value of the video/audio player with a custom value). If the custom value contains the <code>{VALUE}</code> keyword, it is replaced with the default value. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:label:speed:{LABEL}</code><br/> |
+ | <code>player:label:speed:Custom player speed label</code><br/> | ||
+ | <code>player:label:speed:Custom player speed label ({VALUE})</code><br/> | ||
+ | <code>player:label:speed:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Sets up the player speed label (overrides the default speed value of the video/audio player with a custom value). If the custom value contains the <code>{VALUE}</code> keyword, it is replaced with the default value. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:menu:{REQUEST_ACTION}</code><br/> |
+ | <code>player:menu:http://msx.benzac.de/info/data/guide/actions.json</code><br/> | ||
+ | <code>player:menu:user:{URL}</code><br/> | ||
+ | <code>player:menu:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>player:menu:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a menu with the player back function. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:menu:data</code> |
− | || | + | || '''Required''' |
|| No | || No | ||
− | || | + | || Shows a menu with the player back function. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:menu:json:{BASE64_ENCODED_JSON}</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows a menu with the player back function by indicating the data inline as base64-encoded JSON. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:next</code> |
|| None | || None | ||
− | || | + | || No |
− | || | + | || Plays the next related item. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:pause</code> |
|| None | || None | ||
− | || | + | || No |
− | || | + | || Pauses the video/audio. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:play</code> |
|| None | || None | ||
− | || | + | || No |
− | || | + | || Plays the video/audio. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:play_pause</code> |
|| None | || None | ||
− | || | + | || No |
− | || | + | || Toggles the video/audio playback. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:prev</code> |
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays the previous related item. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:progress:color:{COLOR}</code><br/> |
− | <code> | + | <code>player:progress:color:msx-red</code><br/> |
− | || | + | <code>player:progress:color:default</code><br/> |
+ | || None | ||
|| No | || No | ||
− | || | + | || Sets up the player progress color. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:progress:duration:{PROGRESS_DURATION}</code><br/> |
+ | <code>player:progress:duration:60</code><br/> | ||
+ | <code>player:progress:duration:-1</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Sets up the player progress duration in seconds (overrides the default duration value of the video/audio player with a custom value). The duration <code>-1</code> is default and uses the value of the video/audio player. | ||
+ | |||
+ | '''Note: Please note that this duration is only used in the player controls (it is not used for trigger and resume functions, nor for live playback objects).''' | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:progress:marker:disable</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Disables the player progress marker. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:progress:marker:enable</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Enables the player progress marker. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:progress:marker:invalidate</code> |
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Invalidates the player progress marker (marker will be unfocused). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:progress:position:{PROGRESS_POSITION}</code><br/> |
+ | <code>player:progress:position:0</code><br/> | ||
+ | <code>player:progress:position:-1</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Sets up the player progress position (overrides the default position value of the video/audio player with a custom value). The position <code>-1</code> is default and uses the value of the video/audio player. | ||
+ | |||
+ | '''Note: Please note that this position is only used in the player controls (it is not used for trigger and resume functions, nor for live playback objects).''' | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:progress:type:{PROGRESS_TYPE}</code><br/> |
− | <code> | + | <code>player:progress:type:position</code><br/> |
− | + | <code>player:progress:type:position:{POSITION} {ico:image}</code><br/> | |
− | + | <code>player:progress:type:number</code><br/> | |
− | + | <code>player:progress:type:number:{NUMBER} {ico:image}</code><br/> | |
− | + | <code>player:progress:type:percentage</code><br/> | |
− | + | <code>player:progress:type:time:{LIVE_DURATION_FORMAT}</code><br/> | |
− | <code> | + | <code>player:progress:type:text:{LIVE_DURATION_TEXT}</code><br/> |
− | <code> | + | <code>player:progress:type:reverse:position</code><br/> |
− | <code> | + | <code>player:progress:type:reverse:position:{POSITION} {ico:image}</code><br/> |
+ | <code>player:progress:type:reverse:number</code><br/> | ||
+ | <code>player:progress:type:reverse:number:{NUMBER} {ico:image}</code><br/> | ||
+ | <code>player:progress:type:reverse:percentage</code><br/> | ||
+ | <code>player:progress:type:reverse:time:{LIVE_DURATION_FORMAT}</code><br/> | ||
+ | <code>player:progress:type:reverse:text:{LIVE_DURATION_TEXT}</code><br/> | ||
+ | <code>player:progress:type:difference:position</code><br/> | ||
+ | <code>player:progress:type:difference:position:{POSITION} {ico:image}</code><br/> | ||
+ | <code>player:progress:type:difference:number</code><br/> | ||
+ | <code>player:progress:type:difference:number:{NUMBER} {ico:image}</code><br/> | ||
+ | <code>player:progress:type:difference:percentage</code><br/> | ||
+ | <code>player:progress:type:difference:time:{LIVE_DURATION_FORMAT}</code><br/> | ||
+ | <code>player:progress:type:difference:text:{LIVE_DURATION_TEXT}</code><br/> | ||
+ | <code>player:progress:type:fix:Fix progress label</code><br/> | ||
+ | <code>player:progress:type:default</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
|| | || | ||
− | Sets up | + | Sets up the player progress type (<code>default</code> is like <code>time:hh:mm:ss</code>). |
− | + | For the type that starts with (or contains) <code>position:</code>, the <code>{POSITION}</code> part is automatically replaced with the corresponding position value. | |
+ | For the type that starts with (or contains) <code>number:</code>, the <code>{NUMBER}</code> part is automatically replaced with the corresponding number value (which is the incremented position value). | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:refresh</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Refreshes all player values. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:reset</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Resets custom player values that have been set at runtime. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:restart</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Restarts the video/audio. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:rewind</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Jumps rewind in the playback. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:seek:{VALUE}</code><br/> |
− | <code> | + | <code>player:seek:10</code><br/> |
− | <code> | + | <code>player:seek:+10</code><br/> |
− | <code> | + | <code>player:seek:-10</code><br/> |
+ | <code>player:seek:10%</code><br/> | ||
+ | <code>player:seek:+10%</code><br/> | ||
+ | <code>player:seek:-10%</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Executes a seek action. |
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:show</code> |
|| None | || None | ||
|| No | || No | ||
− | || Shows the | + | || Shows the player. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:show:{REMOTE_KEY}</code><br/> |
− | <code> | + | <code>player:show:left</code><br/> |
− | <code> | + | <code>player:show:right</code><br/> |
+ | <code>player:show:up</code><br/> | ||
+ | <code>player:show:down</code><br/> | ||
+ | <code>player:show:execute</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows the player with applied remote key. |
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:show:code:{REMOTE_KEY_CODE}</code><br/> |
+ | <code>player:show:code:37</code><br/> | ||
+ | <code>player:show:code:39</code><br/> | ||
+ | <code>player:show:code:38</code><br/> | ||
+ | <code>player:show:code:40</code><br/> | ||
+ | <code>player:show:code:13</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || Shows the | + | || Shows the player with applied remote key code. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:show_pause</code> |
− | <code> | + | || None |
− | <code> | + | || No |
− | <code> | + | || Shows the player if it is paused. |
− | <code> | + | |- |
+ | | | ||
+ | <code>player:show_pause:{REMOTE_KEY}</code><br/> | ||
+ | <code>player:show_pause:left</code><br/> | ||
+ | <code>player:show_pause:right</code><br/> | ||
+ | <code>player:show_pause:up</code><br/> | ||
+ | <code>player:show_pause:down</code><br/> | ||
+ | <code>player:show_pause:execute</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows the player if it is paused with applied remote key. |
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:show_pause:code:{REMOTE_KEY_CODE}</code><br/> |
+ | <code>player:show_pause:code:37</code><br/> | ||
+ | <code>player:show_pause:code:39</code><br/> | ||
+ | <code>player:show_pause:code:38</code><br/> | ||
+ | <code>player:show_pause:code:40</code><br/> | ||
+ | <code>player:show_pause:code:13</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || Shows the | + | || Shows the player if it is paused with applied remote key code. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:show_play</code> |
− | |||
− | |||
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows the player if it is playing. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:show_play:{REMOTE_KEY}</code><br/> |
+ | <code>player:show_play:left</code><br/> | ||
+ | <code>player:show_play:right</code><br/> | ||
+ | <code>player:show_play:up</code><br/> | ||
+ | <code>player:show_play:down</code><br/> | ||
+ | <code>player:show_play:execute</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || Shows the | + | || Shows the player if it is playing with applied remote key. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:show_play:code:{REMOTE_KEY_CODE}</code><br/> |
+ | <code>player:show_play:code:37</code><br/> | ||
+ | <code>player:show_play:code:39</code><br/> | ||
+ | <code>player:show_play:code:38</code><br/> | ||
+ | <code>player:show_play:code:40</code><br/> | ||
+ | <code>player:show_play:code:13</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || Shows the | + | || Shows the player if it is playing with applied remote key code. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:speed</code> |
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Shows the playback speed panel. |
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:speed:dec</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Decreases the playback speed. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:speed:inc</code> |
− | |||
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Increases the playback speed. |
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:speed:set:{VALUE}</code><br/> |
+ | <code>player:speed:set:0.125</code><br/> | ||
+ | <code>player:speed:set:0.25</code><br/> | ||
+ | <code>player:speed:set:0.5</code><br/> | ||
+ | <code>player:speed:set:1</code><br/> | ||
+ | <code>player:speed:set:2</code><br/> | ||
+ | <code>player:speed:set:4</code><br/> | ||
+ | <code>player:speed:set:8</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Sets the playback speed. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:stop</code> |
− | |||
− | |||
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Stops/Ejects the video/audio. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:sync</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Synchronizes the video/audio with the corresponding content item (i.e. the corresponding content item is selected). This action is automatically executed when a new video/audio is played. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:ticking:restart</code> |
− | |||
− | |||
− | |||
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Restarts the player ticking (the next tick will be <code>0t</code>). |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:video:clear</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Clears all custom video values. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:video:duration:{VIDEO_DURATION}</code><br/> |
+ | <code>player:video:duration:60</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Sets up a custom video duration in seconds. | ||
+ | If a custom duration is set, only that duration is displayed (and used for trigger and resume functions, as well as live playback objects) during playback. | ||
+ | It can be used for live data or ads to disable/override the progress feature. | ||
+ | The duration <code>-1</code> re-enables the display feature. | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:video:position:{VIDEO_POSITION}</code><br/> |
− | <code> | + | <code>player:video:position:0</code><br/> |
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
|| | || | ||
− | Sets | + | Sets up a custom video position in seconds. |
− | + | If a custom position is set, only that position is displayed (and used for trigger and resume functions, as well as live playback objects) during playback and it is not possible to seek to another position (instead a <code>custom:video:seek</code> event is triggered). | |
− | + | It can be used for live data or ads to disable/override the progress feature. | |
− | + | The position <code>-1</code> re-enables the display and seek feature. | |
+ | The position <code>-2</code> only re-enables the display feature (it is still not possible to seek to another position). | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:video:speed:{VIDEO_SPEED}</code><br/> |
+ | <code>player:video:speed:1</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Sets up a custom video speed. | ||
+ | If a custom speed is set, only that speed is displayed during playback and it is not possible to change it (instead a <code>custom:video:speed</code> event is triggered). | ||
+ | It can be used for live data or ads to disable/override the speed feature. | ||
+ | The speed <code>-1</code> re-enables the display and change feature. | ||
+ | The speed <code>-2</code> only re-enables the display feature (it is still not possible to change it). | ||
+ | |||
+ | '''Note: The actual video speed is not changed. For example, if the custom video speed is set to x0.5, the actual video may still be playing at normal speed.''' | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>player:video:state:{VIDEO_STATE}</code><br/> |
− | <code> | + | <code>player:video:state:2</code><br/> |
− | |||
|| None | || None | ||
|| No | || No | ||
|| | || | ||
− | Sets the | + | Sets up a custom video state. |
− | * <code> | + | If a custom state is set, only that state is displayed during playback and it is not possible to change it (instead a <code>custom:video:play</code> or <code>custom:video:pause</code> event is triggered). |
− | * <code>1</code>: | + | It can be used for live data or ads to disable/override the play/pause feature. |
+ | * <code>-2</code>: Read-only (only re-enables the display feature) | ||
+ | * <code>-1</code>: Clear (re-enables the display and change feature) | ||
+ | * <code>1</code>: Stopped (not supported) | ||
+ | * <code>2</code>: Playing | ||
+ | * <code>3</code>: Paused | ||
+ | |||
+ | '''Note: The actual video state is not changed. For example, if the custom video state is paused, the actual video may still be in the playing state.''' | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:{URL}</code><br/> |
+ | <code>playlist:http://msx.benzac.de/info/data/guide/videos.json</code><br/> | ||
|| None | || None | ||
− | || | + | || '''Yes''' |
− | || | + | || Loads a playlist. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:auto:{URL}</code><br/> |
− | <code> | + | <code>playlist:auto:http://msx.benzac.de/info/data/guide/videos.json</code><br/> |
− | |||
− | |||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a playlist in auto mode. |
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:auto:data</code> |
− | || | + | || '''Required''' |
|| No | || No | ||
− | || | + | || Plays a playlist in auto mode. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:auto:json:{BASE64_ENCODED_JSON}</code> |
|| None | || None | ||
|| No | || No | ||
− | || Plays the | + | || Plays a playlist in auto mode by indicating the data inline as base64-encoded JSON. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:auto:request:interaction:{DATA_ID}</code><br/> |
+ | <code>playlist:auto:request:interaction:custom_data_id</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a playlist from the interaction plugin in auto mode. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:auto:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | <code> | + | <code>playlist:auto:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a playlist from the interaction plugin in auto mode (with ensuring that the interaction plugin is loaded). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:auto:request:player:{DATA_ID}</code><br/> |
+ | <code>playlist:auto:request:player:custom_data_id</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a playlist from the player in auto mode (handled by the video/audio plugin). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:auto:user:{URL}</code><br/> |
− | <code> | + | <code>playlist:auto:user:http://msx.benzac.de/info/data/guide/videos.json</code><br/> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a playlist in auto and user mode. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:data</code> |
− | || | + | || '''Required''' |
− | || | + | || '''Yes''' |
− | || | + | || Plays a playlist. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:json:{BASE64_ENCODED_JSON}</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Plays a playlist by indicating the data inline as base64-encoded JSON. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:request:interaction:{DATA_ID}</code><br/> |
− | <code> | + | <code>playlist:request:interaction:custom_data_id</code><br/> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a playlist from the interaction plugin. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:request:interaction:{DATA_ID}@{URL}</code><br/> |
+ | <code>playlist:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a playlist from the interaction plugin (with ensuring that the interaction plugin is loaded). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:request:player:{DATA_ID}</code><br/> |
+ | <code>playlist:request:player:custom_data_id</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || | + | || Loads a playlist from the player (handled by the video/audio plugin). |
|- | |- | ||
| | | | ||
− | <code> | + | <code>playlist:user:{URL}</code><br/> |
+ | <code>playlist:user:http://msx.benzac.de/info/data/guide/videos.json</code><br/> | ||
|| None | || None | ||
− | || | + | || '''Yes''' |
− | || | + | || Loads a playlist in user mode. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>quiet</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || Stops a running video/audio. |
|- | |- | ||
| | | | ||
− | <code> | + | <code>release:content</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Releases the current content data (clears caches and removes references). | ||
+ | |||
+ | '''Note: Please note that once the data has been released, it cannot be reloaded using the <code>reload</code> action. However, the <code>replace</code> action can still be used.''' | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>release:menu</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Releases the current menu data (clears caches and removes references). | ||
+ | |||
+ | '''Note: Please note that once the data has been released, it cannot be reloaded using the <code>reload</code> action. However, the <code>replace</code> action can still be used.''' | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>release:panel</code> |
|| None | || None | ||
|| No | || No | ||
− | || | + | || |
+ | Releases the current panel data (clears caches and removes references). | ||
+ | |||
+ | '''Note: Please note that once the data has been released, it cannot be reloaded using the <code>reload</code> action. However, the <code>replace</code> action can still be used.''' | ||
|- | |- | ||
| | | | ||
− | <code> | + | <code>reload</code> |
|| None | || None | ||
− | || No | + | || '''Yes''' |
− | || Plays the slideshow. | + | || Reloads the application. |
− | |- | + | |- |
− | | | + | | |
− | <code>slider:play_pause</code> | + | <code>reload:content</code> |
− | || None | + | || None |
− | || No | + | || '''Yes''' |
− | || Toggles the slideshow playback. | + | || Reloads the current content data. |
− | |- | + | |- |
− | | | + | | |
− | <code>slider:prev</code> | + | <code>reload:menu</code> |
− | || None | + | || None |
− | || No | + | || '''Yes''' |
− | || Goes to the previous item without showing the labels. | + | || Reloads the current menu data. |
− | |- | + | |- |
− | | | + | | |
− | <code>slider:restart</code> | + | <code>reload:panel</code> |
− | || None | + | || None |
− | || No | + | || '''Yes''' |
− | || Restarts the slideshow. | + | || Reloads the current panel data. |
− | |- | + | |- |
− | | | + | | |
− | <code>slider:stop</code> | + | <code>reopen:{PARAMS}</code><br/> |
− | || None | + | <code>reopen:key1=value1&key2=value2</code><br/> |
− | || No | + | || None |
− | || Stops/Ejects the slideshow. | + | || No |
− | |- | + | || Reopens the application link with new URL parameters. |
− | | | + | |- |
− | <code>slideshow:{URL}</code><br/> | + | | |
− | <code>slideshow:http://msx.benzac.de/info/data/guide/images.json</code><br/> | + | <code>replace:content:{CONTENT_FLAG}:{REQUEST_ACTION}</code><br/> |
− | || None | + | <code>replace:content:content_flag:http://msx.benzac.de/info/data/guide/videos.json</code><br/> |
− | || '''Yes''' | + | <code>replace:content:content_flag:user:{URL}</code><br/> |
− | || Loads a slideshow. | + | <code>replace:content:content_flag:request:interaction:{DATA_ID}</code><br/> |
− | |- | + | <code>replace:content:content_flag:request:interaction:{DATA_ID}@{URL}</code><br/> |
− | | | + | <code>replace:content:content_flag:json:{BASE64_ENCODED_JSON}</code><br/> |
− | <code>slideshow:data</code> | + | || None |
− | || '''Required''' | + | || No |
− | || '''Yes''' | + | || |
− | || Shows a slideshow. | + | Replaces (and reloads) the current content data. |
− | |- | + | |
− | | | + | '''Note: The current content data <code>flag</code> property must match the indicated flag, otherwise the content data will not be replaced.''' |
− | <code>slideshow:request:interaction:{DATA_ID}</code><br/> | + | |- |
+ | | | ||
+ | <code>replace:menu:{CONTENT_FLAG}:{REQUEST_ACTION}</code><br/> | ||
+ | <code>replace:menu:content_flag:http://msx.benzac.de/info/data/guide/menu.json</code><br/> | ||
+ | <code>replace:menu:content_flag:user:{URL}</code><br/> | ||
+ | <code>replace:menu:content_flag:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>replace:menu:content_flag:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | <code>replace:menu:content_flag:json:{BASE64_ENCODED_JSON}</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Replaces (and reloads) the current menu data. | ||
+ | |||
+ | '''Note: The current menu data <code>flag</code> property must match the indicated flag, otherwise the menu data will not be replaced.''' | ||
+ | |- | ||
+ | | | ||
+ | <code>replace:panel:{CONTENT_FLAG}:{REQUEST_ACTION}</code><br/> | ||
+ | <code>replace:panel:content_flag:http://msx.benzac.de/info/data/guide/panel.json</code><br/> | ||
+ | <code>replace:panel:content_flag:user:{URL}</code><br/> | ||
+ | <code>replace:panel:content_flag:request:interaction:{DATA_ID}</code><br/> | ||
+ | <code>replace:panel:content_flag:request:interaction:{DATA_ID}@{URL}</code><br/> | ||
+ | <code>replace:panel:content_flag:json:{BASE64_ENCODED_JSON}</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Replaces (and reloads) the current panel data. | ||
+ | |||
+ | '''Note: The current panel data <code>flag</code> property must match the indicated flag, otherwise the panel data will not be replaced.''' | ||
+ | |- | ||
+ | | | ||
+ | <code>response:{REQUEST_ID}</code><br/> | ||
+ | <code>response:rq10_1541593729708</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Handles a response for a pending request. | ||
+ | |- | ||
+ | | | ||
+ | <code>restart</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Restarts the application. | ||
+ | |- | ||
+ | | | ||
+ | <code>resume:cancel</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Cancels an ongoing resume process. | ||
+ | |- | ||
+ | | | ||
+ | <code>resume:clear</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Clears all resume keys. | ||
+ | |- | ||
+ | | | ||
+ | <code>resume:clear:{RESUME_KEY}</code><br/> | ||
+ | <code>resume:clear:content_item_id</code><br/> | ||
+ | <code>resume:clear:http://msx.benzac.de/media/video1.mp4</code><br/> | ||
+ | <code>resume:clear:custom_resume_key</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Clears a specific resume key. | ||
+ | |- | ||
+ | | | ||
+ | <code>resume:clear:context:{RESUME_CONTEXT}</code><br/> | ||
+ | <code>resume:clear:context:custom_resume_context</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Clears all resume keys for a specific context. | ||
+ | |- | ||
+ | | | ||
+ | <code>resume:clear:context:hash:{RESUME_CONTEXT_HASH_CODE}</code><br/> | ||
+ | <code>resume:clear:context:hash:105224747</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Clears all resume keys for a specific context by using the context hash code. | ||
+ | |- | ||
+ | | | ||
+ | <code>resume:clear:current</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Clears the current resume key. | ||
+ | |- | ||
+ | | | ||
+ | <code>resume:clear:hash:{RESUME_KEY_HASH_CODE}</code><br/> | ||
+ | <code>resume:clear:hash:511673863</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Clears a specific resume key by using the resume key hash code. | ||
+ | |- | ||
+ | | | ||
+ | <code>resume:import</code> | ||
+ | || '''Required''' | ||
+ | || No | ||
+ | || Imports resume keys (the data must contain a <code>properties</code> property that should contain the resume keys as key-value pairs of type <code>string</code> in the format <code>"{RESUME_KEY_HASH_CODE}": "{RESUME_VALUE}"</code>). | ||
+ | |- | ||
+ | | | ||
+ | <code>resume:position:{RESUME_POSITION}</code><br/> | ||
+ | <code>resume:position:10</code><br/> | ||
+ | <code>resume:position:10%</code><br/> | ||
+ | <code>resume:position:none</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets up a fix resume position in seconds or percentage to start the current content from there. If the resume position is set to <code>none</code>, no resuming is performed. | ||
+ | This action must be called after a <code>video:{URL}</code>, <code>audio:{URL}</code>, or <code>playlist:{URL}</code> action in order to take effect. | ||
+ | |- | ||
+ | | | ||
+ | <code>selection</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Executes the selection action. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Toggles the settings scene. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:about</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the about panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:animate</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the animation settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:animate:{VALUE}</code><br/> | ||
+ | <code>settings:animate:0</code><br/> | ||
+ | <code>settings:animate:1</code><br/> | ||
+ | <code>settings:animate:2</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the animation settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: JS | ||
+ | * <code>2</code>: CSS | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:eject_timeout</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the eject timeout settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:eject_timeout:{VALUE}</code><br/> | ||
+ | <code>settings:eject_timeout:0</code><br/> | ||
+ | <code>settings:eject_timeout:7200000</code><br/> | ||
+ | <code>settings:eject_timeout:14400000</code><br/> | ||
+ | <code>settings:eject_timeout:28800000</code><br/> | ||
+ | <code>settings:eject_timeout:43200000</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Sets the eject timeout settings (in milliseconds). Value must be greater than or equal to <code>3600000</code> (1 hr), otherwise it is interpreted as <code>0</code> (off). | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:hover_effect</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the hover effect settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:hover_effect:{VALUE}</code><br/> | ||
+ | <code>settings:hover_effect:0</code><br/> | ||
+ | <code>settings:hover_effect:1</code><br/> | ||
+ | <code>settings:hover_effect:2</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the hover effect settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: Plain | ||
+ | * <code>2</code>: Preselect | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:immersive_mode</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the immersive mode settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:immersive_mode:{VALUE}</code><br/> | ||
+ | <code>settings:immersive_mode:0</code><br/> | ||
+ | <code>settings:immersive_mode:1</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the immersive mode settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: On | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:input</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the input settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:input:{VALUE}</code><br/> | ||
+ | <code>settings:input:0</code><br/> | ||
+ | <code>settings:input:1</code><br/> | ||
+ | <code>settings:input:2</code><br/> | ||
+ | <code>settings:input:3</code><br/> | ||
+ | <code>settings:input:4</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the input settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: Remote Only | ||
+ | * <code>2</code>: Click & Swipe | ||
+ | * <code>3</code>: Drag & Drop | ||
+ | * <code>4</code>: Move & Execute | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:layout</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the layout settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:layout:{VALUE}</code><br/> | ||
+ | <code>settings:layout:0.5</code><br/> | ||
+ | <code>settings:layout:0.75</code><br/> | ||
+ | <code>settings:layout:1</code><br/> | ||
+ | <code>settings:layout:1.5</code><br/> | ||
+ | <code>settings:layout:3</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the layout settings. | ||
+ | * <code>0.5</code>: 360p | ||
+ | * <code>0.75</code>: 540p | ||
+ | * <code>1</code>: 720p | ||
+ | * <code>1.5</code>: 1080p | ||
+ | * <code>3</code>: 2160p | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:menu_button</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the menu button settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:random_playback</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the random playback settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:random_playback:{VALUE}</code><br/> | ||
+ | <code>settings:random_playback:0</code><br/> | ||
+ | <code>settings:random_playback:1</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the random playback settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: On | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:remote</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the remote settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:remote:{VALUE}</code><br/> | ||
+ | <code>settings:remote:0</code><br/> | ||
+ | <code>settings:remote:1</code><br/> | ||
+ | <code>settings:remote:2</code><br/> | ||
+ | <code>settings:remote:3</code><br/> | ||
+ | <code>settings:remote:4</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the remote settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: Minimalistic | ||
+ | * <code>2</code>: Navigation Frame | ||
+ | * <code>3</code>: Corner Controls | ||
+ | * <code>4</code>: Complex | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:reset</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the reset settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:resolution</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the resolution settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:rounded_style</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the rounded style settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:rounded_style:{VALUE}</code><br/> | ||
+ | <code>settings:rounded_style:0</code><br/> | ||
+ | <code>settings:rounded_style:1</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the rounded style settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: On | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:scale</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the scale settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:scale:{VALUE}</code><br/> | ||
+ | <code>settings:scale:default</code><br/> | ||
+ | <code>settings:scale:auto</code><br/> | ||
+ | <code>settings:scale:device</code><br/> | ||
+ | <code>settings:scale:0.75</code><br/> | ||
+ | <code>settings:scale:fix:0.75</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the scale settings (viewport settings). | ||
+ | * <code>default</code>: No scaling | ||
+ | * <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>settings:sleep_timeout</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the sleep timeout settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:sleep_timeout:{VALUE}</code><br/> | ||
+ | <code>settings:sleep_timeout:0</code><br/> | ||
+ | <code>settings:sleep_timeout:60000</code><br/> | ||
+ | <code>settings:sleep_timeout:300000</code><br/> | ||
+ | <code>settings:sleep_timeout:600000</code><br/> | ||
+ | <code>settings:sleep_timeout:900000</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Sets the sleep timeout settings (in milliseconds). Value must be greater than or equal to <code>60000</code> (1 min), otherwise it is interpreted as <code>0</code> (off). | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:slideshow_interval</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the slideshow interval settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:slideshow_interval:{VALUE}</code><br/> | ||
+ | <code>settings:slideshow_interval:1000</code><br/> | ||
+ | <code>settings:slideshow_interval:5000</code><br/> | ||
+ | <code>settings:slideshow_interval:10000</code><br/> | ||
+ | <code>settings:slideshow_interval:20000</code><br/> | ||
+ | <code>settings:slideshow_interval:40000</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the slideshow interval settings (in milliseconds). | ||
+ | * <code>1000</code>: Very Fast | ||
+ | * <code>5000</code>: Fast | ||
+ | * <code>10000</code>: Normal | ||
+ | * <code>20000</code>: Slow | ||
+ | * <code>40000</code>: Very Slow | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:start</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the start parameter panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:transform</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the transformation settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:transform:{VALUE}</code><br/> | ||
+ | <code>settings:transform:0</code><br/> | ||
+ | <code>settings:transform:1</code><br/> | ||
+ | <code>settings:transform:2</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the transformation settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: 2D | ||
+ | * <code>2</code>: 3D | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:validate</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the validate settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:validate_links</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the validate links settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:validate_links:{VALUE}</code><br/> | ||
+ | <code>settings:validate_links:0</code><br/> | ||
+ | <code>settings:validate_links:1</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the validate links settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: On | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:visual_execution</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the visual execution settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:visual_execution:{VALUE}</code><br/> | ||
+ | <code>settings:visual_execution:0</code><br/> | ||
+ | <code>settings:visual_execution:1</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the visual execution settings. | ||
+ | * <code>0</code>: Off | ||
+ | * <code>1</code>: On | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:zoom</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the zoom settings panel. | ||
+ | |- | ||
+ | | | ||
+ | <code>settings:zoom:{VALUE}</code><br/> | ||
+ | <code>settings:zoom:default</code><br/> | ||
+ | <code>settings:zoom:auto</code><br/> | ||
+ | <code>settings:zoom:0.75</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets the zoom settings. | ||
+ | * <code>default</code>: No zooming | ||
+ | * <code>auto</code>: Auto detect (with resize adjustment) | ||
+ | * <code>{NUMBER}</code>: Set zoom factor to specific number | ||
+ | |- | ||
+ | | | ||
+ | <code>sleep</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Forces the screen saver to be active (even if a video/audio/slideshow is active). | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:action:{ACTION}</code><br/> | ||
+ | <code>slider:action:info:Custom image action executed.</code><br/> | ||
+ | <code>slider:action:default</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets up a custom slideshow image action of the current image (replacement for the default slideshow image action). | ||
+ | |||
+ | '''Note: For image actions, it is not possible to provide an action-related <code>data</code> property. If you want to execute an image data action, please use the <code>execute:fetch:{URL}</code> action, alternatively.''' | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:break</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Pauses the slideshow if it is playing. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:color:{COLOR}</code><br/> | ||
+ | <code>slider:color:msx-blue</code><br/> | ||
+ | <code>slider:color:default</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Sets up the slideshow image color of the current image (overrides the <code>imageColor</code> property of the corresponding content item with a custom value). | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:continue</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Plays the slideshow if it is not playing. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:default</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Executes the following default slideshow action. Shows the slideshow labels or toggles the slideshow playback (or shows a warning if no action is available). | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:eject</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Stops/Ejects the slideshow. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:execute:{ACTION}</code><br/> | ||
+ | <code>slider:execute:info:Slideshow action executed.</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Shows the slideshow labels or executes the indicated slideshow action (if labels are already visible or not present). | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:extension:{LABEL}</code><br/> | ||
+ | <code>slider:extension:Custom image extension label</code><br/> | ||
+ | <code>slider:extension:default</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Sets up the slideshow image extension label of the current image. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:goto:{ITEM_ID}</code><br/> | ||
+ | <code>slider:goto:content_item_id</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Goes to the item with the indicated ID. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:goto:first</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Goes to the first item. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:goto:index:{ITEM_INDEX}</code><br/> | ||
+ | <code>slider:goto:index:0</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Goes to the item with the indicated index. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:goto:last</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Goes to the last item. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:goto:next</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Goes to the next item. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:goto:number:{ITEM_NUMBER}</code><br/> | ||
+ | <code>slider:goto:number:1</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Goes to the item with the indicated number. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:goto:prev</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Goes to the previous item. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:icon:{ICON}</code><br/> | ||
+ | <code>slider:icon:info</code><br/> | ||
+ | <code>slider:icon:default</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Sets up a custom slideshow image icon of the current image. | ||
+ | |||
+ | '''Note: A custom slideshow image action must be available for the icon to be visible.''' | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:label:{LABEL}</code><br/> | ||
+ | <code>slider:label:Custom image label</code><br/> | ||
+ | <code>slider:label:default</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || Sets up the slideshow image label of the current image (overrides the <code>imageLabel</code> property of the corresponding content item with a custom value). | ||
+ | |||
+ | '''Note: Only if the <code>imageLabel</code> property has been set (to a non <code>null</code> value) in the corresponding content item, it can be updated.''' | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:labels:hide</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Hides the slideshow labels. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:labels:play_pause</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the slideshow labels or toggles the slideshow playback. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:labels:show</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows the slideshow labels. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:labels:toggle</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Toggles the slideshow labels. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:next</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Goes to the next item without showing the labels. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:options</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Toggles the slideshow image options. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:options:execute</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Executes the selected slideshow image option item. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:options:select:{ITEM_ID}</code><br/> | ||
+ | <code>slider:options:select:slideshow</code><br/> | ||
+ | <code>slider:options:select:right_rotation</code><br/> | ||
+ | <code>slider:options:select:left_rotation</code><br/> | ||
+ | <code>slider:options:select:full_rotation</code><br/> | ||
+ | <code>slider:options:select:reset_rotation</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Selects a slideshow image option item. | ||
+ | |||
+ | '''Note: This action does not focus the item, it just notifies the slideshow which item is selected.''' | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:pause</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Pauses the slideshow. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:play</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Plays the slideshow. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:play_pause</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Toggles the slideshow playback. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:prev</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Goes to the previous item without showing the labels. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:reset</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Resets custom slideshow image values of the current image that have been set at runtime. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:restart</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Restarts the slideshow. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:rotate:{ROTATION_VALUE}</code><br/> | ||
+ | <code>slider:rotate:right</code><br/> | ||
+ | <code>slider:rotate:left</code><br/> | ||
+ | <code>slider:rotate:full</code><br/> | ||
+ | <code>slider:rotate:full-right</code><br/> | ||
+ | <code>slider:rotate:full-left</code><br/> | ||
+ | <code>slider:rotate:reset</code><br/> | ||
+ | <code>slider:rotate:-270</code><br/> | ||
+ | <code>slider:rotate:-180</code><br/> | ||
+ | <code>slider:rotate:-90</code><br/> | ||
+ | <code>slider:rotate:0</code><br/> | ||
+ | <code>slider:rotate:90</code><br/> | ||
+ | <code>slider:rotate:180</code><br/> | ||
+ | <code>slider:rotate:270</code><br/> | ||
+ | || None | ||
+ | || No | ||
+ | || | ||
+ | Rotates the current slideshow image. | ||
+ | |||
+ | '''Note: If the rotation value is a number (which must be divisible by 90), it is applied as an absolute rotation in degrees.''' | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:stop</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Stops/Ejects the slideshow. | ||
+ | |- | ||
+ | | | ||
+ | <code>slider:sync</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Synchronizes the current slideshow image with the corresponding content item (i.e. the corresponding content item is selected in the background). This action is automatically executed when the slideshow is stopped/ejected. | ||
+ | |- | ||
+ | | | ||
+ | <code>slideshow:{URL}</code><br/> | ||
+ | <code>slideshow:http://msx.benzac.de/info/data/guide/images.json</code><br/> | ||
+ | || None | ||
+ | || '''Yes''' | ||
+ | || Loads a slideshow. | ||
+ | |- | ||
+ | | | ||
+ | <code>slideshow:data</code> | ||
+ | || '''Required''' | ||
+ | || '''Yes''' | ||
+ | || Shows a slideshow. | ||
+ | |- | ||
+ | | | ||
+ | <code>slideshow:json:{BASE64_ENCODED_JSON}</code> | ||
+ | || None | ||
+ | || No | ||
+ | || Shows a slideshow by indicating the data inline as base64-encoded JSON. | ||
+ | |- | ||
+ | | | ||
+ | <code>slideshow:request:interaction:{DATA_ID}</code><br/> | ||
<code>slideshow:request:interaction:custom_data_id</code><br/> | <code>slideshow:request:interaction:custom_data_id</code><br/> | ||
|| None | || None | ||
Line 2,635: | Line 3,600: | ||
<code>system:hbbtv:show</code><br/> | <code>system:hbbtv:show</code><br/> | ||
<code>system:hbbtv:hide</code><br/> | <code>system:hbbtv:hide</code><br/> | ||
− | <code>system:hbbtv:launch: | + | <code>system:hbbtv:launch:{APP_ID}</code><br/> |
<code>system:hbbtv:foreground</code><br/> | <code>system:hbbtv:foreground</code><br/> | ||
<code>system:hbbtv:background</code><br/> | <code>system:hbbtv:background</code><br/> | ||
Line 2,647: | Line 3,612: | ||
<code>system:lg:{SYSTEM_ACTION}</code><br/> | <code>system:lg:{SYSTEM_ACTION}</code><br/> | ||
<code>system:lg:launch:{APP_ID}</code><br/> | <code>system:lg:launch:{APP_ID}</code><br/> | ||
+ | || Optional | ||
+ | || No | ||
+ | || Executes an LG-related action. | ||
+ | |- | ||
+ | | | ||
+ | <code>system:netcast:{SYSTEM_ACTION}</code><br/> | ||
+ | <code>system:netcast:menu</code><br/> | ||
+ | <code>system:netcast:ratio</code><br/> | ||
|| None | || None | ||
|| No | || No | ||
− | || Executes | + | || Executes a Netcast-related action. |
|- | |- | ||
| | | | ||
Line 2,666: | Line 3,639: | ||
| | | | ||
<code>system:tizen:{SYSTEM_ACTION}</code><br/> | <code>system:tizen:{SYSTEM_ACTION}</code><br/> | ||
+ | <code>system:tizen:launch</code><br/> | ||
<code>system:tizen:launch:{APP_ID}</code><br/> | <code>system:tizen:launch:{APP_ID}</code><br/> | ||
<code>system:tizen:keys:mapped</code><br/> | <code>system:tizen:keys:mapped</code><br/> | ||
<code>system:tizen:keys:unmapped</code><br/> | <code>system:tizen:keys:unmapped</code><br/> | ||
− | || | + | || Optional |
|| No | || No | ||
|| Executes a Tizen-related action. | || Executes a Tizen-related action. | ||
Line 2,684: | Line 3,658: | ||
<code>system:tvx:system_log:clear</code><br/> | <code>system:tvx:system_log:clear</code><br/> | ||
<code>system:tvx:options</code><br/> | <code>system:tvx:options</code><br/> | ||
+ | <code>system:tvx:launch</code><br/> | ||
<code>system:tvx:launch:{APP_ID}</code><br/> | <code>system:tvx:launch:{APP_ID}</code><br/> | ||
− | || | + | || Optional |
|| No | || No | ||
|| Executes a TVX-related action (Android-/iOS-related action). | || Executes a TVX-related action (Android-/iOS-related action). | ||
Line 2,694: | Line 3,669: | ||
|| None | || None | ||
|| No | || No | ||
− | || Executes | + | || Executes a UWP-related action (Universal Windows Platform action). |
|- | |- | ||
| | | | ||
Line 2,725: | Line 3,700: | ||
<code>trigger:ready:info:Video ready.</code><br/> | <code>trigger:ready:info:Video ready.</code><br/> | ||
<code>trigger:start:info:Video started.</code><br/> | <code>trigger:start:info:Video started.</code><br/> | ||
+ | <code>trigger:ending:info:Video is ending (video is playing and 10 seconds or less are remaining).</code><br/> | ||
<code>trigger:end:info:Video ended.</code><br/> | <code>trigger:end:info:Video ended.</code><br/> | ||
<code>trigger:complete:info:Video completed.</code><br/> | <code>trigger:complete:info:Video completed.</code><br/> | ||
Line 2,730: | Line 3,706: | ||
<code>trigger:10%:info:10% of video passed.</code><br/> | <code>trigger:10%:info:10% of video passed.</code><br/> | ||
<code>trigger:10t:info:10 ticks of video passed.</code><br/> | <code>trigger:10t:info:10 ticks of video passed.</code><br/> | ||
+ | <code>trigger:-10:info:Last 10 seconds of video passed.</code><br/> | ||
<code>trigger:20:shot:info:20 seconds of video passed (shot).</code><br/> | <code>trigger:20:shot:info:20 seconds of video passed (shot).</code><br/> | ||
<code>trigger:20%:shot:info:20% of video passed (shot).</code><br/> | <code>trigger:20%:shot:info:20% of video passed (shot).</code><br/> | ||
<code>trigger:20t:shot:info:20 ticks of video passed (shot).</code><br/> | <code>trigger:20t:shot:info:20 ticks of video passed (shot).</code><br/> | ||
+ | <code>trigger:-20:shot:info:Last 20 seconds of video passed (shot).</code><br/> | ||
<code>trigger:quartile1:info:First quartile of video entered.</code><br/> | <code>trigger:quartile1:info:First quartile of video entered.</code><br/> | ||
<code>trigger:quartile2:info:Second quartile of video entered.</code><br/> | <code>trigger:quartile2:info:Second quartile of video entered.</code><br/> | ||
Line 2,743: | Line 3,721: | ||
<code>trigger:pause:info:Video paused.</code><br/> | <code>trigger:pause:info:Video paused.</code><br/> | ||
<code>trigger:stop:info:Video stopped.</code><br/> | <code>trigger:stop:info:Video stopped.</code><br/> | ||
+ | <code>trigger:active:info:Video player is visible or video moved to foreground.</code><br/> | ||
+ | <code>trigger:inactive:info:Video moved to background.</code><br/> | ||
+ | <code>trigger:player:info:Video player is visible.</code><br/> | ||
<code>trigger:foreground:info:Video moved to foreground.</code><br/> | <code>trigger:foreground:info:Video moved to foreground.</code><br/> | ||
<code>trigger:background:info:Video moved to background.</code><br/> | <code>trigger:background:info:Video moved to background.</code><br/> | ||
Line 2,750: | Line 3,731: | ||
|| No | || No | ||
|| | || | ||
− | Sets up a video/audio trigger for the current content. | + | Sets up a video/audio trigger for the current content. If the action <code>none</code> is indicated, the trigger is removed again. |
− | This action must be called after a <code>video:{URL}</code> or <code> | + | This action must be called after a <code>video:{URL}</code>, <code>audio:{URL}</code>, or <code>playlist:{URL}</code> action in order to take effect. |
'''Note: Triggers that are set at runtime are executed after the default triggers and do not overwrite them. For trigger actions, it is not possible to provide an action-related <code>data</code> property. If you want to execute a trigger data action, please use the <code>execute:fetch:{URL}</code> action, alternatively.''' | '''Note: Triggers that are set at runtime are executed after the default triggers and do not overwrite them. For trigger actions, it is not possible to provide an action-related <code>data</code> property. If you want to execute a trigger data action, please use the <code>execute:fetch:{URL}</code> action, alternatively.''' | ||
Line 2,845: | Line 3,826: | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || Plays a video by resolving it with | + | || Plays a video by resolving it with a URL in auto mode (the response data must contain a <code>url</code> property). |
|- | |- | ||
| | | | ||
Line 2,874: | Line 3,855: | ||
|| Optional | || Optional | ||
|| No | || No | ||
− | || Plays a video by resolving it with | + | || Plays a video by resolving it with a URL (the response data must contain a <code>url</code> property). |
|- | |- | ||
| | | |
Latest revision as of 10:02, 29 October 2024
These actions are used internally, but can also be used to create more complex and interactive media pages. Unlike the main actions, they have no version control and are only valid for version 0.1.160+. Therefore, please check your version if you encounter any errors/warnings, because the syntax in previous versions can be different.
Note: The main actions (Actions) are also described here (in less detail) to provide a better overview of all available actions.
If you would like to search for an action, please have a look at this link: https://msx.benzac.de/info/xp/actions.html.
Syntax & Example | Data | Main Action | Description |
---|---|---|---|
|
Optional | Yes | Plays an audio. |
|
Optional | No | Plays an audio in auto mode. |
|
Optional | No | Executes a platform-specific audio broadcast action in auto mode. |
|
Optional | No | Plays a plugin audio in auto mode. |
|
Optional | No | Plays an audio by resolving it with a URL in auto mode (the response data must contain a url property).
|
|
Optional | No | Executes a platform-specific audio broadcast action. |
|
Optional | Yes | Plays a plugin audio. |
|
Optional | No | Plays an audio by resolving it with a URL (the response data must contain a url property).
|
|
None | No | Awakes the screen when the screen saver is active and starts a new sleep or eject timeout. |
|
None | Yes | Goes back in history. |
|
None | No | Shows the background scene (if a video is active, the video scene becomes visible). |
|
None | No | Loads a background (temporarily). The background is reset as soon as a new selection is performed. |
|
None | No |
Loads a background (temporarily) by resolving it with a URL (the response data must contain a |
|
None | No |
Starts a busy action. A busy action can be pending for maximum 30 seconds (after this time, it is automatically stopped). |
|
None | No | Stops a busy action. |
|
None | No | Clears the cache (if the platform supports it) and reloads the application. |
|
None | No | Closes all overlays. |
|
None | No | Closes visible content and/or panel. |
|
None | No | Closes a visible content and/or panel that has the specific flag. |
|
None | Yes | Loads a content page. |
|
Required | Yes | Shows a content page. |
|
None | No | Shows a content page by indicating the data inline as base64-encoded JSON. |
|
None | No | Loads a content page from the interaction plugin. |
|
None | No | Loads a content page from the interaction plugin (with ensuring that the interaction plugin is loaded). |
|
None | No | Loads a content page from the player (handled by the video/audio plugin). |
|
None | Yes | Loads a content page in user mode. |
|
Required | Yes | Executes multiple actions in a row. |
|
Optional | No |
Executes an action after a specific delay (indicated in seconds). The maximum delay is 30 seconds. Note: There can only be one pending delay action per ID. If a new delay action is started for an existing ID, the previous action is automatically canceled. |
|
None | No | Cancels a pending delay action. |
|
None | No | Executes (and stops) a pending delay action. |
|
None | No | Restarts a pending delay action. |
|
None | No | Shows a dialog. The dialog none is a special dialog and will close an active notification.
|
|
None | No |
Sets up a custom dictionary.
If the URL is set to |
|
None | No | Shows the auto eject panel if a video/audio/slideshow is active. |
|
Required | No | If the entered code is correct, the indicated action is executed (the data must contain an action property and can optionally contain an action-related data property).
|
|
None | Yes | Shows an error message. |
|
Optional | No | Triggers a custom event (that can be handled by the interaction and/or video/audio plugin). |
|
Optional | Yes | Executes an action on server side. |
|
Optional | Yes | Executes an action on server side with accurate headers. |
|
Optional | Yes | Executes an action on server side with an entered code. |
|
Optional | Yes | Executes an action on server side with an entered code with accurate headers. |
|
Optional | No | Executes an action on the interaction plugin with an entered code. |
|
Optional | No | Executes an action on the interaction plugin with an entered code (with ensuring that the interaction plugin is loaded). |
|
Optional | No | Executes an action on the player with an entered code (handled by the video/audio plugin). |
|
Optional | Yes | Executes an action on server side with an entered code in user mode. |
|
Optional | Yes | Executes an action on server side with an entered code in user mode with accurate headers. |
|
None | No | Executes an action by simply fetching it from the server. |
|
None | No | Executes an action by simply fetching it from the server with accurate headers. |
|
None | No | Executes an action by simply fetching it from the server in user mode. |
|
None | No | Executes an action by simply fetching it from the server in user mode with accurate headers. |
|
Optional | No |
Executes an action on server side with attached system info. It is also possible to attach the extended system info (including URL parameters and system data) or only a specific system info. |
|
Optional | No |
Executes an action on server side with attached system info with accurate headers.
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes an action on the interaction plugin with attached system info.
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes an action on the interaction plugin with attached system info (with ensuring that the interaction plugin is loaded).
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes an action on the player with attached system info (handled by the video/audio plugin).
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes an action with attached system info in silent mode (by not showing a busy indicator and error messages).
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes an action on server side with attached system info in user mode.
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes an action on server side with attached system info in user mode with accurate headers.
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No | Executes an action on the interaction plugin. |
|
Optional | No | Executes an action on the interaction plugin (with ensuring that the interaction plugin is loaded). |
|
Optional | No | Executes an action on the player (handled by the video/audio plugin). |
|
Required | No | Executes an action with attached response from a request action (the data must contain a requestAction property and can optionally contain a request-related requestData property).
|
|
Optional | No | Executes an action on server side with attached resume keys. |
|
Optional | No | Executes an action on server side with attached resume keys with accurate headers. |
|
Optional | No | Executes an action on the interaction plugin with attached resume keys. |
|
Optional | No | Executes an action on the interaction plugin with attached resume keys (with ensuring that the interaction plugin is loaded). |
|
Optional | No | Executes an action on the player with attached resume keys (handled by the video/audio plugin). |
|
Optional | No | Executes an action with attached resume keys in silent mode (by not showing a busy indicator and error messages). |
|
Optional | No | Executes an action on server side with attached resume keys in user mode. |
|
Optional | No | Executes an action on server side with attached resume keys in user mode with accurate headers. |
|
Optional | No | Executes a service action on server side. |
|
Optional | No | Executes a service action on server side with accurate headers. |
|
None | No | Executes a service action by simply fetching it from the server. |
|
None | No | Executes a service action by simply fetching it from the server with accurate headers. |
|
None | No | Executes a service action by simply fetching it from the server in user mode. |
|
None | No | Executes a service action by simply fetching it from the server in user mode with accurate headers. |
|
Optional | No |
Executes a service action on server side with attached system info.
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes a service action on server side with attached system info with accurate headers.
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes a service action on the interaction plugin with attached system info.
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes a service action on the interaction plugin with attached system info (with ensuring that the interaction plugin is loaded).
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes a service action on the player with attached system info (handled by the video/audio plugin).
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes a service action with attached system info in silent mode (by not showing a busy indicator and error messages).
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes a service action on server side with attached system info in user mode.
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No |
Executes a service action on server side with attached system info in user mode with accurate headers.
It is also possible to attach the extended or only a specific system info.
Please see action |
|
Optional | No | Executes a service action on the interaction plugin. |
|
Optional | No | Executes a service action on the interaction plugin (with ensuring that the interaction plugin is loaded). |
|
Optional | No | Executes a service action on the player (handled by the video/audio plugin). |
|
Required | No | Executes a service action with attached response from a request action (the data must contain a requestAction property and can optionally contain a request-related requestData property).
|
|
Optional | No | Executes a service action on server side with attached resume keys. |
|
Optional | No | Executes a service action on server side with attached resume keys with accurate headers. |
|
Optional | No | Executes a service action on the interaction plugin with attached resume keys. |
|
Optional | No | Executes a service action on the interaction plugin with attached resume keys (with ensuring that the interaction plugin is loaded). |
|
Optional | No | Executes a service action on the player with attached resume keys (handled by the video/audio plugin). |
|
Optional | No | Executes a service action with attached resume keys in silent mode (by not showing a busy indicator and error messages). |
|
Optional | No | Executes a service action on server side with attached resume keys in user mode. |
|
Optional | No | Executes a service action on server side with attached resume keys in user mode with accurate headers. |
|
Optional | No | Executes a service action in silent mode (by not showing a busy indicator and error messages). |
|
Optional | No | Executes a service action on server side with attached slider info. |
|
Optional | No | Executes a service action on server side with attached slider info with accurate headers. |
|
Optional | No | Executes a service action on the interaction plugin with attached slider info. |
|
Optional | No | Executes a service action on the interaction plugin with attached slider info (with ensuring that the interaction plugin is loaded). |
|
Optional | No | Executes a service action on the player with attached slider info (handled by the video/audio plugin). |
|
Optional | No | Executes a service action with attached slider info in silent mode (by not showing a busy indicator and error messages). |
|
Optional | No | Executes a service action on server side with attached slider info in user mode. |
|
Optional | No | Executes a service action on server side with attached slider info in user mode with accurate headers. |
|
Optional | No | Executes a service action on server side in user mode. |
|
Optional | No | Executes a service action on server side in user mode with accurate headers. |
|
Optional | No |
Executes a service action on server side with attached video info.
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes a service action on server side with attached video info with accurate headers.
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes a service action on the interaction plugin with attached video info.
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes a service action on the interaction plugin with attached video info (with ensuring that the interaction plugin is loaded).
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes a service action on the player with attached video info (handled by the video/audio plugin).
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes a service action with attached video info in silent mode (by not showing a busy indicator and error messages).
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes a service action on server side with attached video info in user mode.
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes a service action on server side with attached video info in user mode with accurate headers.
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No | Executes an action in silent mode (by not showing a busy indicator and error messages). |
|
Optional | No | Executes an action on server side with attached slider info. |
|
Optional | No | Executes an action on server side with attached slider info with accurate headers. |
|
Optional | No | Executes an action on the interaction plugin with attached slider info. |
|
Optional | No | Executes an action on the interaction plugin with attached slider info (with ensuring that the interaction plugin is loaded). |
|
Optional | No | Executes an action on the player with attached slider info (handled by the video/audio plugin). |
|
Optional | No | Executes an action with attached slider info in silent mode (by not showing a busy indicator and error messages). |
|
Optional | No | Executes an action on server side with attached slider info in user mode. |
|
Optional | No | Executes an action on server side with attached slider info in user mode with accurate headers. |
|
Optional | Yes | Executes an action on server side in user mode. |
|
Optional | Yes | Executes an action on server side in user mode with accurate headers. |
|
Optional | No |
Executes an action on server side with attached video info. It is also possible to attach only a specific video info. |
|
Optional | No |
Executes an action on server side with attached video info with accurate headers.
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes an action on the interaction plugin with attached video info.
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes an action on the interaction plugin with attached video info (with ensuring that the interaction plugin is loaded).
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes an action on the player with attached video info (handled by the video/audio plugin).
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes an action with attached video info in silent mode (by not showing a busy indicator and error messages).
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes an action on server side with attached video info in user mode.
It is also possible to attach only a specific video info.
Please see action |
|
Optional | No |
Executes an action on server side with attached video info in user mode with accurate headers.
It is also possible to attach only a specific video info.
Please see action |
|
None | No | Exits the application by using the platform-specific function. |
|
None | Yes | Focuses an item with the indicated ID in the current context. |
|
None | No | Clears the focus cache for a menu, content, and/or panel that has the specific flag. |
|
None | No | Focuses a control in the current context. |
|
None | No | Focuses and executes an item with the indicated ID in the current context. |
|
None | No | Focuses and executes an item with the indicated index in the current context. |
|
None | Yes | Focuses an item with the indicated index in the current context. |
|
None | No | Toggles the fullscreen. |
|
None | No | Goes back in the web history. |
|
None | No | Clears the web history. |
|
None | No | Goes to the web history start. |
|
None | No | Validates the web history. |
|
None | No | Shows the main scene (or the context menu if the main scene is already active). |
|
Optional | Yes | Shows an image. |
|
Required | Yes | Shows an image by using the current context. |
|
Optional | No | Shows an image by resolving it with a URL (the response data must contain a url property).
|
|
None | Yes | Shows an info message. |
|
None | No |
Starts an interaction-related busy action. This busy action is automatically stopped if the interaction plugin is unloaded. A busy action can be pending for maximum 30 seconds (after this time, it is automatically stopped). |
|
None | No | Stops an interaction-related busy action. |
|
Required | No | Commits data to the interaction plugin. |
|
Optional | No | Commits a code to the interaction plugin. |
|
Optional | No | Commits the dictionary to the interaction plugin. |
|
Optional | No | Commits the system info to the interaction plugin. |
|
Optional | No | Commits the extended system info (including URL parameters and system data) or a specific system info to the interaction plugin. |
|
Optional | No | Commits a message to the interaction plugin. |
|
Optional | No | Commits a response to the interaction plugin. |
|
Optional | No | Commits the slider info to the interaction plugin. |
|
Optional | No | Commits a transformed/normalized string to the interaction plugin. |
|
Optional | No | Commits the video info to the interaction plugin. |
|
Optional | No | Commits a specific video info to the interaction plugin. |
|
Optional | No |
Loads the interaction plugin (and optionally commits data to it).
If the interaction plugin is already loaded and action-related data is provided, this action behaves like |
|
None | No | Reloads the interaction plugin. |
|
None | No | Unloads the interaction plugin. |
|
None | No | Invalidates the current content (only if the content data is reloadable). |
|
None | No | Invalidates the current content if it has the specific flag. |
|
None | No | Invalidates a content item. |
|
None | No | Invalidates a content overlay item. |
|
None | No | Invalidates a content underlay item. |
|
None | No | Invalidates the current menu (only if the menu data is reloadable). |
|
None | No | Invalidates the current menu if it has the specific flag. |
|
None | No | Invalidates a menu item. |
|
None | No | Invalidates the current panel (only if the panel data is reloadable). |
|
None | No | Invalidates the current panel if it has the specific flag. |
|
None | No | Invalidates a panel item. |
|
None | No | Invalidates a panel overlay item. |
|
None | No | Invalidates a panel underlay item. |
|
None | No | Triggers a remote key. |
|
None | No | Triggers a remote key by using the remote key code. |
|
Optional | No |
Executes an action when all running animations are completed. If no animations are currently running, the action is executed directly. |
|
None | No | Leaves the application by using the web history back function. |
|
None | No | Opens a link. |
|
None | No | Opens a link by replacing the current URL. |
|
None | No | Opens a link by enforcing validation. |
|
None | Yes | Opens a link in a window. |
|
None | No | Executes the live action. |
|
None | No | Toggles the log scene. |
|
None | No | Clears the log. |
|
None | No | Logs a debug message. |
|
Optional | No | Logs (and shows) an error message. |
|
Optional | No | Logs (and shows) an info message. |
|
Optional | No | Logs (and shows) a success message. |
|
Optional | No | Logs (and shows) a warning message. |
|
None | No | Shows the main scene (if the main scene is not already active). |
|
None | No | Toggles the context menu. |
|
None | Yes | Loads a menu. |
|
Required | Yes | Shows a menu. |
|
None | No | Shows a menu by indicating the data inline as base64-encoded JSON. |
|
None | No | Loads a menu from the interaction plugin. |
|
None | No | Loads a menu from the interaction plugin (with ensuring that the interaction plugin is loaded). |
|
None | No | Loads a menu from the player (handled by the video/audio plugin). |
|
None | Yes | Loads a menu in user mode. |
|
Optional | No | Commits a notification message to the video/audio and interaction plugin. |
|
None | No | Toggles the content options. |
|
None | Yes | Loads a panel. |
|
Required | Yes | Shows a panel. |
|
None | No | Shows a panel by indicating the data inline as base64-encoded JSON. |
|
None | No | Loads a panel from the interaction plugin. |
|
None | No | Loads a panel from the interaction plugin (with ensuring that the interaction plugin is loaded). |
|
None | No | Loads a panel from the player (handled by the video/audio plugin). |
|
None | Yes | Loads a panel in user mode. |
|
None | No | Shows video/audio playback (closes overlaying content if a video/audio is active). |
|
None | No | Toggles the player scene. |
|
None | No | Shows the player action. |
|
Optional | No | Executes a player action in auto mode. |
|
None | No | Sets up an audio background (overrides the background property of the corresponding content item with a custom value).
|
|
None | No |
Starts a player-related busy action. This busy action is automatically stopped if the player is stopped. A busy action can be pending for maximum 30 seconds (after this time, it is automatically stopped). |
|
None | No | Stops a player-related busy action. |
|
None | No | Disables a player button (all buttons except the eject button are supported). |
|
None | No | Enables a player button (all buttons except the eject button are supported). |
|
None | No | Executes a player button. |
|
None | No |
Focuses a player button. Additionally, the focus button for player execution events will be set.
If the button |
|
None | No | Resets a player button (all buttons except the eject button are supported). |
|
Optional | No |
Sets up a player button (all buttons except the eject button are supported).
The data can contain a Note: If the |
|
Required | No | Commits data to the video/audio plugin. |
|
Optional | No | Commits a code to the video/audio plugin. |
|
Optional | No | Commits the dictionary to the video/audio plugin. |
|
Optional | No | Commits the system info to the video/audio plugin. |
|
Optional | No | Commits the extended system info (including URL parameters and system data) or a specific system info to the video/audio plugin. |
|
Optional | No | Commits a message to the video/audio plugin. |
|
Optional | No | Commits a response to the video/audio plugin. |
|
Optional | No | Commits the slider info to the video/audio plugin. |
|
Optional | No | Commits a transformed/normalized string to the video/audio plugin. |
|
Optional | No | Commits the video info to the video/audio plugin. |
|
Optional | No | Commits a specific video info to the video/audio plugin. |
|
None | No | Shows the related content page (default action for the player button in the lower left corner). |
|
None | No | Loads a content page with the player back function. |
|
Required | No | Shows a content page with the player back function. |
|
None | No | Shows a content page with the player back function by indicating the data inline as base64-encoded JSON. |
|
None | No |
Sets up a custom player control action (replacement for the action that is executed if the OK key is pressed while the video/audio is in foreground). Note: For control actions, it is not possible to provide an action-related |
|
None | No | Executes the following default player action. Shows the player with applied remote key execute .
|
|
None | No | Stops/Ejects the video/audio. |
|
Optional | No | Executes an action if the player is paused. |
|
Optional | No | Executes an action if the player is playing. |
|
None | No | Jumps forward in the playback. |
|
None | No | Plays the item with the indicated ID. |
|
None | No | Replays the current item (by retuning it). |
|
None | No | Plays the first item. |
|
None | No | Plays the item with the indicated index. |
|
None | No | Plays the last item. |
|
None | No | Plays the next item. |
|
None | No | Plays the item with the indicated number. |
|
None | No | Plays the previous item. |
|
None | No | Plays a random item. |
|
None | No | Plays the swap item. |
|
None | No | Hides the player. |
|
None | No | Hides the player if it is paused. |
|
None | No | Hides the player if it is playing. |
|
None | No | Sets up a player info headline (only available for extended players). |
|
None | No | Sets up a player info image (only available for extended players). |
|
None | No | Sets up the player info overlay (only available for extended players). |
|
None | No | Disables rounded corners of the info image if the rounded style is used (only available for extended players). |
|
None | No | Enables rounded corners of the info image if the rounded style is used (only available for extended players). |
|
None | No | Sets up the size of the player info image area (only available for extended players). |
|
None | No | Sets up a player info text (only available for extended players). |
|
None | No | Invalidates the player (hides the player if it is not extended). |
|
None | No | Sets up the player content label (overrides the playerLabel property of the corresponding content item with a custom value).
|
|
None | No | Sets up the player duration label (overrides the default duration value of the video/audio player with a custom value). If the custom value contains the {VALUE} keyword, it is replaced with the default value.
|
|
None | No | Sets up an additional player extension label. |
|
None | No | Sets up the player position label (overrides the default position value of the video/audio player with a custom value). If the custom value contains the {VALUE} keyword, it is replaced with the default value.
|
|
None | No | Sets up the player speed label (overrides the default speed value of the video/audio player with a custom value). If the custom value contains the {VALUE} keyword, it is replaced with the default value.
|
|
None | No | Loads a menu with the player back function. |
|
Required | No | Shows a menu with the player back function. |
|
None | No | Shows a menu with the player back function by indicating the data inline as base64-encoded JSON. |
|
None | No | Plays the next related item. |
|
None | No | Pauses the video/audio. |
|
None | No | Plays the video/audio. |
|
None | No | Toggles the video/audio playback. |
|
None | No | Plays the previous related item. |
|
None | No | Sets up the player progress color. |
|
None | No |
Sets up the player progress duration in seconds (overrides the default duration value of the video/audio player with a custom value). The duration Note: Please note that this duration is only used in the player controls (it is not used for trigger and resume functions, nor for live playback objects). |
|
None | No | Disables the player progress marker. |
|
None | No | Enables the player progress marker. |
|
None | No | Invalidates the player progress marker (marker will be unfocused). |
|
None | No |
Sets up the player progress position (overrides the default position value of the video/audio player with a custom value). The position Note: Please note that this position is only used in the player controls (it is not used for trigger and resume functions, nor for live playback objects). |
|
None | No |
Sets up the player progress type ( |
|
None | No | Refreshes all player values. |
|
None | No | Resets custom player values that have been set at runtime. |
|
None | No | Restarts the video/audio. |
|
None | No | Jumps rewind in the playback. |
|
None | No | Executes a seek action. |
|
None | No | Shows the player. |
|
None | No | Shows the player with applied remote key. |
|
None | No | Shows the player with applied remote key code. |
|
None | No | Shows the player if it is paused. |
|
None | No | Shows the player if it is paused with applied remote key. |
|
None | No | Shows the player if it is paused with applied remote key code. |
|
None | No | Shows the player if it is playing. |
|
None | No | Shows the player if it is playing with applied remote key. |
|
None | No | Shows the player if it is playing with applied remote key code. |
|
None | No | Shows the playback speed panel. |
|
None | No | Decreases the playback speed. |
|
None | No | Increases the playback speed. |
|
None | No | Sets the playback speed. |
|
None | No | Stops/Ejects the video/audio. |
|
None | No | Synchronizes the video/audio with the corresponding content item (i.e. the corresponding content item is selected). This action is automatically executed when a new video/audio is played. |
|
None | No | Restarts the player ticking (the next tick will be 0t ).
|
|
None | No | Clears all custom video values. |
|
None | No |
Sets up a custom video duration in seconds.
If a custom duration is set, only that duration is displayed (and used for trigger and resume functions, as well as live playback objects) during playback.
It can be used for live data or ads to disable/override the progress feature.
The duration |
|
None | No |
Sets up a custom video position in seconds.
If a custom position is set, only that position is displayed (and used for trigger and resume functions, as well as live playback objects) during playback and it is not possible to seek to another position (instead a |
|
None | No |
Sets up a custom video speed.
If a custom speed is set, only that speed is displayed during playback and it is not possible to change it (instead a Note: The actual video speed is not changed. For example, if the custom video speed is set to x0.5, the actual video may still be playing at normal speed. |
|
None | No |
Sets up a custom video state.
If a custom state is set, only that state is displayed during playback and it is not possible to change it (instead a
Note: The actual video state is not changed. For example, if the custom video state is paused, the actual video may still be in the playing state. |
|
None | Yes | Loads a playlist. |
|
None | No | Loads a playlist in auto mode. |
|
Required | No | Plays a playlist in auto mode. |
|
None | No | Plays a playlist in auto mode by indicating the data inline as base64-encoded JSON. |
|
None | No | Loads a playlist from the interaction plugin in auto mode. |
|
None | No | Loads a playlist from the interaction plugin in auto mode (with ensuring that the interaction plugin is loaded). |
|
None | No | Loads a playlist from the player in auto mode (handled by the video/audio plugin). |
|
None | No | Loads a playlist in auto and user mode. |
|
Required | Yes | Plays a playlist. |
|
None | No | Plays a playlist by indicating the data inline as base64-encoded JSON. |
|
None | No | Loads a playlist from the interaction plugin. |
|
None | No | Loads a playlist from the interaction plugin (with ensuring that the interaction plugin is loaded). |
|
None | No | Loads a playlist from the player (handled by the video/audio plugin). |
|
None | Yes | Loads a playlist in user mode. |
|
None | No | Stops a running video/audio. |
|
None | No |
Releases the current content data (clears caches and removes references). Note: Please note that once the data has been released, it cannot be reloaded using the |
|
None | No |
Releases the current menu data (clears caches and removes references). Note: Please note that once the data has been released, it cannot be reloaded using the |
|
None | No |
Releases the current panel data (clears caches and removes references). Note: Please note that once the data has been released, it cannot be reloaded using the |
|
None | Yes | Reloads the application. |
|
None | Yes | Reloads the current content data. |
|
None | Yes | Reloads the current menu data. |
|
None | Yes | Reloads the current panel data. |
|
None | No | Reopens the application link with new URL parameters. |
|
None | No |
Replaces (and reloads) the current content data. Note: The current content data |
|
None | No |
Replaces (and reloads) the current menu data. Note: The current menu data |
|
None | No |
Replaces (and reloads) the current panel data. Note: The current panel data |
|
Optional | No | Handles a response for a pending request. |
|
None | No | Restarts the application. |
|
None | No | Cancels an ongoing resume process. |
|
None | No | Clears all resume keys. |
|
None | No | Clears a specific resume key. |
|
None | No | Clears all resume keys for a specific context. |
|
None | No | Clears all resume keys for a specific context by using the context hash code. |
|
None | No | Clears the current resume key. |
|
None | No | Clears a specific resume key by using the resume key hash code. |
|
Required | No | Imports resume keys (the data must contain a properties property that should contain the resume keys as key-value pairs of type string in the format "{RESUME_KEY_HASH_CODE}": "{RESUME_VALUE}" ).
|
|
None | No |
Sets up a fix resume position in seconds or percentage to start the current content from there. If the resume position is set to |
|
None | No | Executes the selection action. |
|
None | No | Toggles the settings scene. |
|
None | No | Shows the about panel. |
|
None | No | Shows the animation settings panel. |
|
None | No |
Sets the animation settings.
|
|
None | No | Shows the eject timeout settings panel. |
|
None | No | Sets the eject timeout settings (in milliseconds). Value must be greater than or equal to 3600000 (1 hr), otherwise it is interpreted as 0 (off).
|
|
None | No | Shows the hover effect settings panel. |
|
None | No |
Sets the hover effect settings.
|
|
None | No | Shows the immersive mode settings panel. |
|
None | No |
Sets the immersive mode settings.
|
|
None | No | Shows the input settings panel. |
|
None | No |
Sets the input settings.
|
|
None | No | Shows the layout settings panel. |
|
None | No |
Sets the layout settings.
|
|
None | No | Shows the menu button settings panel. |
|
None | No | Shows the random playback settings panel. |
|
None | No |
Sets the random playback settings.
|
|
None | No | Shows the remote settings panel. |
|
None | No |
Sets the remote settings.
|
|
None | No | Shows the reset settings panel. |
|
None | No | Shows the resolution settings panel. |
|
None | No | Shows the rounded style settings panel. |
|
None | No |
Sets the rounded style settings.
|
|
None | No | Shows the scale settings panel. |
|
None | No |
Sets the scale settings (viewport settings).
|
|
None | No | Shows the sleep timeout settings panel. |
|
None | No | Sets the sleep timeout settings (in milliseconds). Value must be greater than or equal to 60000 (1 min), otherwise it is interpreted as 0 (off).
|
|
None | No | Shows the slideshow interval settings panel. |
|
None | No |
Sets the slideshow interval settings (in milliseconds).
|
|
None | No | Shows the start parameter panel. |
|
None | No | Shows the transformation settings panel. |
|
None | No |
Sets the transformation settings.
|
|
None | No | Shows the validate settings panel. |
|
None | No | Shows the validate links settings panel. |
|
None | No |
Sets the validate links settings.
|
|
None | No | Shows the visual execution settings panel. |
|
None | No |
Sets the visual execution settings.
|
|
None | No | Shows the zoom settings panel. |
|
None | No |
Sets the zoom settings.
|
|
None | No | Forces the screen saver to be active (even if a video/audio/slideshow is active). |
|
None | No |
Sets up a custom slideshow image action of the current image (replacement for the default slideshow image action). Note: For image actions, it is not possible to provide an action-related |
|
None | No | Pauses the slideshow if it is playing. |
|
None | No | Sets up the slideshow image color of the current image (overrides the imageColor property of the corresponding content item with a custom value).
|
|
None | No | Plays the slideshow if it is not playing. |
|
None | No | Executes the following default slideshow action. Shows the slideshow labels or toggles the slideshow playback (or shows a warning if no action is available). |
|
None | No | Stops/Ejects the slideshow. |
|
Optional | No | Shows the slideshow labels or executes the indicated slideshow action (if labels are already visible or not present). |
|
None | No | Sets up the slideshow image extension label of the current image. |
|
None | No | Goes to the item with the indicated ID. |
|
None | No | Goes to the first item. |
|
None | No | Goes to the item with the indicated index. |
|
None | No | Goes to the last item. |
|
None | No | Goes to the next item. |
|
None | No | Goes to the item with the indicated number. |
|
None | No | Goes to the previous item. |
|
None | No |
Sets up a custom slideshow image icon of the current image. Note: A custom slideshow image action must be available for the icon to be visible. |
|
None | No | Sets up the slideshow image label of the current image (overrides the imageLabel property of the corresponding content item with a custom value).
Note: Only if the |
|
None | No | Hides the slideshow labels. |
|
None | No | Shows the slideshow labels or toggles the slideshow playback. |
|
None | No | Shows the slideshow labels. |
|
None | No | Toggles the slideshow labels. |
|
None | No | Goes to the next item without showing the labels. |
|
None | No | Toggles the slideshow image options. |
|
None | No | Executes the selected slideshow image option item. |
|
None | No |
Selects a slideshow image option item. Note: This action does not focus the item, it just notifies the slideshow which item is selected. |
|
None | No | Pauses the slideshow. |
|
None | No | Plays the slideshow. |
|
None | No | Toggles the slideshow playback. |
|
None | No | Goes to the previous item without showing the labels. |
|
None | No | Resets custom slideshow image values of the current image that have been set at runtime. |
|
None | No | Restarts the slideshow. |
|
None | No |
Rotates the current slideshow image. Note: If the rotation value is a number (which must be divisible by 90), it is applied as an absolute rotation in degrees. |
|
None | No | Stops/Ejects the slideshow. |
|
None | No | Synchronizes the current slideshow image with the corresponding content item (i.e. the corresponding content item is selected in the background). This action is automatically executed when the slideshow is stopped/ejected. |
|
None | Yes | Loads a slideshow. |
|
Required | Yes | Shows a slideshow. |
|
None | No | Shows a slideshow by indicating the data inline as base64-encoded JSON. |
|
None | No | Loads a slideshow from the interaction plugin. |
|
None | No | Loads a slideshow from the interaction plugin (with ensuring that the interaction plugin is loaded). |
|
None | No | Loads a slideshow from the player (handled by the video/audio plugin). |
|
None | Yes | Loads a slideshow in user mode. |
|
Required | Yes | Sets up a start parameter. |
|
None | No | Stops a running slideshow. |
|
None | Yes | Shows a success message. |
|
None | No | Executes an HbbTV-related action. |
|
Optional | No | Executes an LG-related action. |
|
None | No | Executes a Netcast-related action. |
|
None | No | Shows the system options. |
|
None | No | Executes a Samsung-related action. |
|
Optional | No | Executes a Tizen-related action. |
|
Optional | No | Executes a TVX-related action (Android-/iOS-related action). |
|
None | No | Executes a UWP-related action (Universal Windows Platform action). |
|
None | No | Toggles the test scene. |
|
None | No | Clears the time and zone offset. |
|
Required | No | Initializes the time and/or zone offset (the data must contain a time and/or timeZone property).
|
|
Required | No | Sets a fix time and/or zone offset (the data must contain an offset and/or zoneOffset property).
|
|
None | No |
Sets up a video/audio trigger for the current content. If the action Note: Triggers that are set at runtime are executed after the default triggers and do not overwrite them. For trigger actions, it is not possible to provide an action-related |
|
Required | Yes | Updates a content item. |
|
Required | Yes | Updates a content overlay item. |
|
Required | Yes | Updates a content underlay item. |
|
Required | Yes | Updates a menu item. |
|
Required | Yes | Updates a panel item. |
|
Required | Yes | Updates a panel overlay item. |
|
Required | Yes | Updates a panel underlay item. |
|
Optional | Yes | Plays a video. |
|
Optional | No | Plays a video in auto mode. |
|
Optional | No | Executes a platform-specific video broadcast action in auto mode. |
|
Optional | No | Plays a plugin video in auto mode. |
|
Optional | No | Plays a video by resolving it with a URL in auto mode (the response data must contain a url property).
|
|
Optional | No | Executes a platform-specific video broadcast action. |
|
Optional | Yes | Plays a plugin video. |
|
Optional | No | Plays a video by resolving it with a URL (the response data must contain a url property).
|
|
None | No | Toggles the volume scene. |
|
None | No | Shows the volume action. |
|
None | No | Decreases the volume. |
|
None | No | Hides the volume scene. |
|
None | No | Increases the volume. |
|
None | No | Mutes the volume. |
|
None | No | Sets the volume. |
|
None | No | Shows the volume scene. |
|
None | No | Toggles the volume or shows the volume scene. |
|
None | No | Unmutes the volume. |
|
None | No | Toggles the volume. |
|
None | Yes | Shows a warning message. |
|
Optional | Yes | Executes multiple actions in a row. |