Difference between revisions of "Internal Actions"

From MSX - Wiki
Jump to navigation Jump to search
Line 2,452: Line 2,452:
 
|| No
 
|| 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.
+
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.
 
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.
 
|-
 
|-

Revision as of 10:07, 17 June 2022

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.145+. Please ensure that you are using the correct version, 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 internal action, please have a look at this link: https://msx.benzac.de/info/xp/actions.html.

Action syntax of internal actions in all possible variations
Syntax & Example Data Main Action Description

audio:{URL}
audio:http://msx.benzac.de/media/audio1.mp3

 Optional Yes Plays an audio file.

audio:auto:{URL}
audio:auto:http://msx.benzac.de/media/audio1.mp3

 Optional No Plays an audio file in auto mode.

audio:auto:broadcast:{BC_ACTION}
audio:auto:broadcast:current
audio:auto:broadcast:next
audio:auto:broadcast:prev
audio:auto:broadcast:release
audio:auto:broadcast:name:{CHANNEL_NAME}
audio:auto:broadcast:triplet:{ONID}.{TSID}.{SID}

 Optional No Executes a platform-specific audio broadcast action in auto mode.

audio:auto:plugin:{URL}
audio:auto:plugin:http://msx.benzac.de/plugins/template.html

 Optional No Plays a plugin audio file in auto mode.

audio:auto:resolve:{REQUEST_ACTION}
audio:auto:resolve:http://msx.benzac.de/services/resolve.php?type=audio
audio:auto:resolve:user:{URL}
audio:auto:resolve:request:interaction:{DATA_ID}
audio:auto:resolve:request:interaction:{DATA_ID}@{URL}

 Optional No Plays an audio file by resolving it with a URL in auto mode (the response data must contain a url property).

audio:broadcast:{BC_ACTION}
audio:broadcast:current
audio:broadcast:next
audio:broadcast:prev
audio:broadcast:release
audio:broadcast:name:{CHANNEL_NAME}
audio:broadcast:triplet:{ONID}.{TSID}.{SID}

 Optional No Executes a platform-specific audio broadcast action.

audio:plugin:{URL}
audio:plugin:http://msx.benzac.de/plugins/template.html

 Optional Yes Plays a plugin audio file.

audio:resolve:{REQUEST_ACTION}
audio:resolve:http://msx.benzac.de/services/resolve.php?type=audio
audio:resolve:user:{URL}
audio:resolve:request:interaction:{DATA_ID}
audio:resolve:request:interaction:{DATA_ID}@{URL}

 Optional No Plays an audio file by resolving it with a URL (the response data must contain a url property).

back

None Yes Goes back in history.

background

None No Shows the background scene (if a video is active, the video scene becomes visible).

background:{URL}
background:http://msx.benzac.de/img/bg1.jpg
background:none
background:default

 None No Loads a background (temporarily). The background is reset as soon as a new selection is performed.

background:resolve:{REQUEST_ACTION}
background:resolve:http://msx.benzac.de/services/resolve.php?type=image
background:resolve:user:{URL}
background:resolve:request:interaction:{DATA_ID}
background:resolve:request:interaction:{DATA_ID}@{URL}

 None No

Loads a background (temporarily) by resolving it with a URL (the response data must contain a url property). The background is reset as soon as a new selection is performed.

busy:start:{BUSY_ID}
busy:start:loading

 None No

Starts a busy action. A busy action can be pending for maximum 30 seconds (after this time, it is automatically stopped).

busy:stop:{BUSY_ID}
busy:stop:loading

 None No Stops a busy action.

cleanup

None No Closes all overlays.

close
close

 None No Closes visible content and/or panel.

close:{CONTENT_FLAG}
close:content_flag

 None No Closes visible content and/or panel that has the specific flag.

content:{URL}
content:http://msx.benzac.de/info/data/guide/videos.json

 None Yes Loads a content page.

content:data

Required Yes Shows a content page.

content:request:interaction:{DATA_ID}
content:request:interaction:custom_data_id

 None No Loads a content page from the interaction plugin.

content:request:interaction:{DATA_ID}@{URL}
content:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 None No Loads a content page from the interaction plugin (with ensuring that the interaction plugin is loaded).

content:request:player:{DATA_ID}
content:request:player:custom_data_id

 None No Loads a content page from the player (handled by the video/audio plugin).

content:user:{URL}
content:user:http://msx.benzac.de/info/data/guide/videos.json

 None Yes Loads a content page in user mode.

data

Required Yes Executes multiple actions in a row.

delay:{ACTION_ID}:{DELAY}:{ACTION}
delay:custom_action_id:1:info:Delayed action executed (after 1 second).
delay:custom_action_id:2:info:Delayed action executed (after 2 seconds).
delay:custom_action_id:30:info:Delayed action executed (after 30 seconds).

 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.

delay:{ACTION_ID}:cancel
delay:custom_action_id:cancel

 None No Cancels a pending delay action.

delay:{ACTION_ID}:execute
delay:custom_action_id:execute

 None No Executes (and stops) a pending delay action.

delay:{ACTION_ID}:restart
delay:custom_action_id:restart

 None No Restarts a pending delay action.

dialog:{DIALOG_ID}
dialog:reload
dialog:restart
dialog:leave
dialog:exit
dialog:application
dialog:action_not_available
dialog:action_not_available_for_platform
dialog:video_not_available
dialog:audio_not_available
dialog:content_not_available
dialog:feature_not_available
dialog:none

 None No Shows a dialog. The dialog none is a special dialog and will close an active notification.

enter:{CODE}
enter:1234

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

error:{MESSAGE}
error:This is an error message.

 None Yes Shows an error message.

event:{EVENT_ID}
event:custom_event_id

 Optional No Triggers a custom event (that can be handled by the interaction and/or video/audio plugin).

execute:{URL}
execute:http://msx.benzac.de/services/echo.php

 Optional Yes Executes an action on server side.

execute:accurate:{URL}
execute:accurate:http://msx.benzac.de/services/echo.php

 Optional Yes Executes an action on server side with accurate headers.

execute:code:{URL}
execute:code:http://msx.benzac.de/services/echo.php

 Optional Yes Executes an action on server side with an entered code.

execute:code:accurate:{URL}
execute:code:accurate:http://msx.benzac.de/services/echo.php

 Optional Yes Executes an action on server side with an entered code with accurate headers.

execute:code:request:interaction:{DATA_ID}
execute:code:request:interaction:custom_data_id

 Optional No Executes an action on the interaction plugin with an entered code.

execute:code:request:interaction:{DATA_ID}@{URL}
execute:code:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 Optional No Executes an action on the interaction plugin with an entered code (with ensuring that the interaction plugin is loaded).

execute:code:request:player:{DATA_ID}
execute:code:request:player:custom_data_id

 Optional No Executes an action on the player with an entered code (handled by the video/audio plugin).

execute:code:user:{URL}
execute:code:user:http://msx.benzac.de/services/echo.php

 Optional Yes Executes an action on server side with an entered code in user mode.

execute:code:user:accurate:{URL}
execute:code:user:accurate:http://msx.benzac.de/services/echo.php

 Optional Yes Executes an action on server side with an entered code in user mode with accurate headers.

execute:fetch:{URL}
execute:fetch:http://msx.benzac.de/services/echo.php

 None No Executes an action by simply fetching it from the server.

execute:fetch:accurate:{URL}
execute:fetch:accurate:http://msx.benzac.de/services/echo.php

 None No Executes an action by simply fetching it from the server with accurate headers.

execute:fetch:user:{URL}
execute:fetch:user:http://msx.benzac.de/services/echo.php

 None No Executes an action by simply fetching it from the server in user mode.

execute:fetch:user:accurate:{URL}
execute:fetch:user:accurate:http://msx.benzac.de/services/echo.php

 None No Executes an action by simply fetching it from the server in user mode with accurate headers.

execute:info:{URL}
execute:info:http://msx.benzac.de/services/echo.php
execute:info:extended:http://msx.benzac.de/services/echo.php
execute:info:base:http://msx.benzac.de/services/echo.php
execute:info:application:http://msx.benzac.de/services/echo.php
execute:info:framework:http://msx.benzac.de/services/echo.php
execute:info:content:http://msx.benzac.de/services/echo.php
execute:info:dictionary:http://msx.benzac.de/services/echo.php
execute:info:screen:http://msx.benzac.de/services/echo.php
execute:info:time:http://msx.benzac.de/services/echo.php

 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.

execute:info:accurate:{URL}
execute:info:accurate:http://msx.benzac.de/services/echo.php

 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 execute:info:{URL} for possible examples.

execute:info:request:interaction:{DATA_ID}
execute:info:request:interaction:custom_data_id

 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 execute:info:{URL} for possible examples.

execute:info:request:interaction:{DATA_ID}@{URL}
execute:info:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 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 execute:info:{URL} for possible examples.

execute:info:request:player:{DATA_ID}
execute:info:request:player:custom_data_id

 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 execute:info:{URL} for possible examples.

execute:info:user:{URL}
execute:info:user:http://msx.benzac.de/services/echo.php

 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 execute:info:{URL} for possible examples.

execute:info:user:accurate:{URL}
execute:info:user:accurate:http://msx.benzac.de/services/echo.php

 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 execute:info:{URL} for possible examples.

execute:request:interaction:{DATA_ID}
execute:request:interaction:custom_data_id

 Optional No Executes an action on the interaction plugin.

execute:request:interaction:{DATA_ID}@{URL}
execute:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 Optional No Executes an action on the interaction plugin (with ensuring that the interaction plugin is loaded).

execute:request:player:{DATA_ID}
execute:request:player:custom_data_id

 Optional No Executes an action on the player (handled by the video/audio plugin).

execute:response:{REQUEST_ACTION}
execute:response:http://msx.benzac.de/services/echo.php
execute:response:user:{URL}
execute:response:accurate:{URL}
execute:response:user:accurate:{URL}
execute:response:request:player:{DATA_ID}
execute:response:request:interaction:{DATA_ID}
execute:response:request:interaction:{DATA_ID}@{URL}

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

execute:service:{URL}
execute:service:http://msx.benzac.de/services/echo.php

 Optional No Executes a service action on server side.

execute:service:accurate:{URL}
execute:service:accurate:http://msx.benzac.de/services/echo.php

 Optional No Executes a service action on server side with accurate headers.

execute:service:fetch:{URL}
execute:service:fetch:http://msx.benzac.de/services/echo.php

 None No Executes a service action by simply fetching it from the server.

execute:service:fetch:accurate:{URL}
execute:service:fetch:accurate:http://msx.benzac.de/services/echo.php

 None No Executes a service action by simply fetching it from the server with accurate headers.

execute:service:fetch:user:{URL}
execute:service:fetch:user:http://msx.benzac.de/services/echo.php

 None No Executes a service action by simply fetching it from the server in user mode.

execute:service:fetch:user:accurate:{URL}
execute:service:fetch:user:accurate:http://msx.benzac.de/services/echo.php

 None No Executes a service action by simply fetching it from the server in user mode with accurate headers.

execute:service:info:{URL}
execute:service:info:http://msx.benzac.de/services/echo.php

 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 execute:info:{URL} for possible examples.

execute:service:info:accurate:{URL}
execute:service:info:accurate:http://msx.benzac.de/services/echo.php

 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 execute:info:{URL} for possible examples.

execute:service:info:request:interaction:{DATA_ID}
execute:service:info:request:interaction:custom_data_id

 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 execute:info:{URL} for possible examples.

execute:service:info:request:interaction:{DATA_ID}@{URL}
execute:service:info:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 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 execute:info:{URL} for possible examples.

execute:service:info:request:player:{DATA_ID}
execute:service:info:request:player:custom_data_id

 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 execute:info:{URL} for possible examples.

execute:service:info:user:{URL}
execute:service:info:user:http://msx.benzac.de/services/echo.php

 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 execute:info:{URL} for possible examples.

execute:service:info:user:accurate:{URL}
execute:service:info:user:accurate:http://msx.benzac.de/services/echo.php

 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 execute:info:{URL} for possible examples.

execute:service:request:interaction:{DATA_ID}
execute:service:request:interaction:custom_data_id

 Optional No Executes a service action on the interaction plugin.

execute:service:request:interaction:{DATA_ID}@{URL}
execute:service:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 Optional No Executes a service action on the interaction plugin (with ensuring that the interaction plugin is loaded).

execute:service:request:player:{DATA_ID}
execute:service:request:player:custom_data_id

 Optional No Executes a service action on the player (handled by the video/audio plugin).

execute:service:response:{REQUEST_ACTION}
execute:service:response:http://msx.benzac.de/services/echo.php
execute:service:response:user:{URL}
execute:service:response:accurate:{URL}
execute:service:response:user:accurate:{URL}
execute:service:response:request:player:{DATA_ID}
execute:service:response:request:interaction:{DATA_ID}
execute:service:response:request:interaction:{DATA_ID}@{URL}

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

execute:service:slider:{URL}
execute:service:slider:http://msx.benzac.de/services/echo.php

 Optional No Executes a service action on server side with attached slider info.

execute:service:slider:accurate:{URL}
execute:service:slider:accurate:http://msx.benzac.de/services/echo.php

 Optional No Executes a service action on server side with attached slider info with accurate headers.

execute:service:slider:request:interaction:{DATA_ID}
execute:service:slider:request:interaction:custom_data_id

 Optional No Executes a service action on the interaction plugin with attached slider info.

execute:service:slider:request:interaction:{DATA_ID}@{URL}
execute:service:slider:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 Optional No Executes a service action on the interaction plugin with attached slider info (with ensuring that the interaction plugin is loaded).

execute:service:slider:request:player:{DATA_ID}
execute:service:slider:request:player:custom_data_id

 Optional No Executes a service action on the player with attached slider info (handled by the video/audio plugin).

execute:service:slider:user:{URL}
execute:service:slider:user:http://msx.benzac.de/services/echo.php

 Optional No Executes a service action on server side with attached slider info in user mode.

execute:service:slider:user:accurate:{URL}
execute:service:slider:user:accurate:http://msx.benzac.de/services/echo.php

 Optional No Executes a service action on server side with attached slider info in user mode with accurate headers.

execute:service:user:{URL}
execute:service:user:http://msx.benzac.de/services/echo.php

 Optional No Executes a service action on server side in user mode.

execute:service:user:accurate:{URL}
execute:service:user:accurate:http://msx.benzac.de/services/echo.php

 Optional No Executes a service action on server side in user mode with accurate headers.

execute:service:video:{URL}
execute:service:video:http://msx.benzac.de/services/echo.php

 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 execute:video:{URL} for possible examples.

execute:service:video:accurate:{URL}
execute:service:video:accurate:http://msx.benzac.de/services/echo.php

 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 execute:video:{URL} for possible examples.

execute:service:video:request:interaction:{DATA_ID}
execute:service:video:request:interaction:custom_data_id

 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 execute:video:{URL} for possible examples.

execute:service:video:request:interaction:{DATA_ID}@{URL}
execute:service:video:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 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 execute:video:{URL} for possible examples.

execute:service:video:request:player:{DATA_ID}
execute:service:video:request:player:custom_data_id

 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 execute:video:{URL} for possible examples.

execute:service:video:user:{URL}
execute:service:video:user:http://msx.benzac.de/services/echo.php

 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 execute:video:{URL} for possible examples.

execute:service:video:user:accurate:{URL}
execute:service:video:user:accurate:http://msx.benzac.de/services/echo.php

 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 execute:video:{URL} for possible examples.

execute:slider:{URL}
execute:slider:http://msx.benzac.de/services/echo.php

 Optional No Executes an action on server side with attached slider info.

execute:slider:accurate:{URL}
execute:slider:accurate:http://msx.benzac.de/services/echo.php

 Optional No Executes an action on server side with attached slider info with accurate headers.

execute:slider:request:interaction:{DATA_ID}
execute:slider:request:interaction:custom_data_id

 Optional No Executes an action on the interaction plugin with attached slider info.

execute:slider:request:interaction:{DATA_ID}@{URL}
execute:slider:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 Optional No Executes an action on the interaction plugin with attached slider info (with ensuring that the interaction plugin is loaded).

execute:slider:request:player:{DATA_ID}
execute:slider:request:player:custom_data_id

 Optional No Executes an action on the player with attached slider info (handled by the video/audio plugin).

execute:slider:user:{URL}
execute:slider:user:http://msx.benzac.de/services/echo.php

 Optional No Executes an action on server side with attached slider info in user mode.

execute:slider:user:accurate:{URL}
execute:slider:user:accurate:http://msx.benzac.de/services/echo.php

 Optional No Executes an action on server side with attached slider info in user mode with accurate headers.

execute:user:{URL}
execute:user:http://msx.benzac.de/services/echo.php

 Optional Yes Executes an action on server side in user mode.

execute:user:accurate:{URL}
execute:user:accurate:http://msx.benzac.de/services/echo.php

 Optional Yes Executes an action on server side in user mode with accurate headers.

execute:video:{URL}
execute:video:http://msx.benzac.de/services/echo.php
execute:video:info:http://msx.benzac.de/services/echo.php
execute:video:data:http://msx.benzac.de/services/echo.php
execute:video:resume:http://msx.benzac.de/services/echo.php
execute:video:volume:http://msx.benzac.de/services/echo.php
execute:video:scene:http://msx.benzac.de/services/echo.php

 Optional No

Executes an action on server side with attached video info. It is also possible to attach only a specific video info.

execute:video:accurate:{URL}
execute:video:accurate:http://msx.benzac.de/services/echo.php

 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 execute:video:{URL} for possible examples.

execute:video:request:interaction:{DATA_ID}
execute:video:request:interaction:custom_data_id

 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 execute:video:{URL} for possible examples.

execute:video:request:interaction:{DATA_ID}@{URL}
execute:video:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 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 execute:video:{URL} for possible examples.

execute:video:request:player:{DATA_ID}
execute:video:request:player:custom_data_id

 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 execute:video:{URL} for possible examples.

execute:video:user:{URL}
execute:video:user:http://msx.benzac.de/services/echo.php

 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 execute:video:{URL} for possible examples.

execute:video:user:accurate:{URL}
execute:video:user:accurate:http://msx.benzac.de/services/echo.php

 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 execute:video:{URL} for possible examples.

exit

None No Exits the application by using the platform-specific function.

focus:{ITEM_ID}
focus:content_item_id

 None Yes Focuses an item with the indicated ID in the current context.

focus:control:{CONTROL}
focus:control:menu
focus:control:content

 None No Focuses a control in the current context.

focus:index:{ITEM_INDEX}
focus:index:0

 None Yes Focuses an item with the indicated index in the current context.

fullscreen

None No Toggles the fullscreen.

history:back

None No Goes back in the web history.

history:clear

None No Clears the web history.

history:start

None No Goes to the web history start.

history:validate

None No Validates the web history.

home

None No Shows the main scene (or the context menu if the main scene is already active).

image:{URL}
image:http://msx.benzac.de/img/bg1.jpg

 Optional Yes Shows an image.

image:context

Required Yes Shows an image by using the current context.

image:resolve:{REQUEST_ACTION}
image:resolve:http://msx.benzac.de/services/resolve.php?type=image
image:resolve:user:{URL}
image:resolve:request:interaction:{DATA_ID}
image:resolve:request:interaction:{DATA_ID}@{URL}

 Optional No Shows an image by resolving it with a URL (the response data must contain a url property).

info:{MESSAGE}
info:This is an info message.

 None Yes Shows an info message.

interaction:busy:start:{BUSY_ID}
interaction:busy:start:loading

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

interaction:busy:stop:{BUSY_ID}
interaction:busy:stop:loading

 None No Stops an interaction-related busy action.

interaction:commit

Required No Commits data to the interaction plugin.

interaction:commit:code

Optional No Commits a code to the interaction plugin.

interaction:commit:dictionary

Optional No Commits the dictionary to the interaction plugin.

interaction:commit:info

Optional No Commits the system info to the interaction plugin.

interaction:commit:info:{DATA_TYPE}
interaction:commit:info:extended
interaction:commit:info:base
interaction:commit:info:application
interaction:commit:info:framework
interaction:commit:info:content
interaction:commit:info:dictionary
interaction:commit:info:screen
interaction:commit:info:time

 Optional No Commits the extended system info (including URL parameters and system data) or a specific system info to the interaction plugin.

interaction:commit:message:{MESSAGE}
interaction:commit:message:This is an interaction message.

 Optional No Commits a message to the interaction plugin.

interaction:commit:response:{REQUEST_ACTION}
interaction:commit:response:http://msx.benzac.de/services/echo.php
interaction:commit:response:user:{URL}
interaction:commit:response:accurate:{URL}
interaction:commit:response:user:accurate:{URL}
interaction:commit:response:request:player:{DATA_ID}

 Optional No Commits a response to the interaction plugin.

interaction:commit:slider

Optional No Commits the slider info to the interaction plugin.

interaction:commit:string:{TRANSFORM_TYPE}:{STRING}
interaction:commit:string:transform:Media Station X
interaction:commit:string:normalize:EW6l] 801JCU; )

 Optional No Commits a transformed/normalized string to the interaction plugin.

interaction:commit:video

Optional No Commits the video info to the interaction plugin.

interaction:commit:video:{DATA_TYPE}
interaction:commit:video:info
interaction:commit:video:data
interaction:commit:video:resume
interaction:commit:video:volume
interaction:commit:video:scene

 Optional No Commits a specific video info to the interaction plugin.

interaction:load:{URL}
interaction:load:http://msx.benzac.de/interaction/template.html
interaction:load:none

 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 interaction:commit.

interaction:reload

None No Reloads the interaction plugin.

interaction:unload

None No Unloads the interaction plugin.

invalidate:content

None No Invalidates the current content (only if the content data is reloadable).

invalidate:content:flag:{CONTENT_FLAG}
invalidate:content:flag:content_flag

 None No Invalidates the current content if it has the specific flag.

invalidate:content:{ITEM_ID}
invalidate:content:content_item_id

 None No Invalidates a content item.

invalidate:content:overlay:{ITEM_ID}
invalidate:content:overlay:content_item_id

 None No Invalidates a content overlay item.

invalidate:content:underlay:{ITEM_ID}
invalidate:content:underlay:content_item_id

 None No Invalidates a content underlay item.

invalidate:menu

None No Invalidates the current menu (only if the menu data is reloadable).

invalidate:menu:flag:{CONTENT_FLAG}
invalidate:menu:flag:content_flag

 None No Invalidates the current menu if it has the specific flag.

invalidate:menu:{ITEM_ID}
invalidate:menu:menu_item_id

 None No Invalidates a menu item.

invalidate:panel

None No Invalidates the current panel (only if the panel data is reloadable).

invalidate:panel:flag:{CONTENT_FLAG}
invalidate:panel:flag:content_flag

 None No Invalidates the current panel if it has the specific flag.

invalidate:panel:{ITEM_ID}
invalidate:panel:content_item_id

 None No Invalidates a panel item.

invalidate:panel:overlay:{ITEM_ID}
invalidate:panel:overlay:content_item_id

 None No Invalidates a panel overlay item.

invalidate:panel:underlay:{ITEM_ID}
invalidate:panel:underlay:content_item_id

 None No Invalidates a panel underlay item.

key:{REMOTE_KEY}
key:left
key:right
key:up
key:down
key:execute
key:back
key:red
key:green
key:yellow
key:blue
key:channel_up
key:channel_down
key:play
key:pause
key:stop

 None No Triggers a remote key.

key:code:{REMOTE_KEY_CODE}
key:code:37
key:code:39
key:code:38
key:code:40
key:code:13
key:code:8

 None No Triggers a remote key by using the remote key code.

leave

None No Leaves the application by using the web history back function.

link:{URL}
link:http://msx.benzac.de/info/

 None Yes Opens a link.

link:replace:{URL}
link:replace:http://msx.benzac.de/info/

 None No Opens a link by replacing the current URL.

link:window:{URL}
link:window:http://msx.benzac.de/info/

 None Yes Opens a link in a window.

live

None No Executes the live action.

log

None No Toggles the log scene.

log:clear

None No Clears the log.

logger:debug:{MESSAGE}
logger:debug:This is a debug message.

 None No Logs a debug message.

logger:error:{MESSAGE}
logger:error:This is an error message.

 Optional No Logs (and shows) an error message.

logger:info:{MESSAGE}
logger:info:This is an info message.

 Optional No Logs (and shows) an info message.

logger:success:{MESSAGE}
logger:success:This is a success message.

 Optional No Logs (and shows) a success message.

logger:warn:{MESSAGE}
logger:warn:This is a warning message.

 Optional No Logs (and shows) a warning message.

main

None No Shows the main scene (if the main scene is not already active).

menu

None No Toggles the context menu.

menu:{URL}
menu:http://msx.benzac.de/info/data/guide/actions.json

 None Yes Loads a menu.

menu:data

Required Yes Shows a menu.

menu:request:interaction:{DATA_ID}
menu:request:interaction:custom_data_id

 None No Loads a menu from the interaction plugin.

menu:request:interaction:{DATA_ID}@{URL}
menu:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 None No Loads a menu from the interaction plugin (with ensuring that the interaction plugin is loaded).

menu:request:player:{DATA_ID}
menu:request:player:custom_data_id

 None No Loads a menu from the player (handled by the video/audio plugin).

menu:user:{URL}
menu:user:http://msx.benzac.de/info/data/guide/actions.json

None Yes Loads a menu in user mode.

notification:{MESSAGE}
notification:This is a notification message.

Optional No Commits a notification message to the video/audio and interaction plugin.

options

None No Toggles the content options.

panel:{URL}
panel:http://msx.benzac.de/info/data/guide/panel.json

 None Yes Loads a panel.

panel:data

Required Yes Shows a panel.

panel:request:interaction:{DATA_ID}
panel:request:interaction:custom_data_id

 None No Loads a panel from the interaction plugin.

panel:request:interaction:{DATA_ID}@{URL}
panel:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 None No Loads a panel from the interaction plugin (with ensuring that the interaction plugin is loaded).

panel:request:player:{DATA_ID}
panel:request:player:custom_data_id

 None No Loads a panel from the player (handled by the video/audio plugin).

panel:user:{URL}
panel:user:http://msx.benzac.de/info/data/guide/panel.json

 None Yes Loads a panel in user mode.

playback

None No Shows video/audio playback (closes overlaying content if a video/audio is active).

player

None No Toggles the player scene.

player:action

None No Shows the player action.

player:auto:{PLAYER_ACTION}
player:auto:next
player:auto:prev
player:auto:play
player:auto:pause
player:auto:play_pause
player:auto:forward
player:auto:rewind
player:auto:restart
player:auto:goto:first
player:auto:goto:last

 Optional No Executes a player action in auto mode.

player:background:{URL}
player:background:http://msx.benzac.de/img/bg1.jpg
player:background:none
player:background:default

 None No Sets up an audio background (overrides the background property of the corresponding content item with a custom value).

player:busy:start:{BUSY_ID}
player:busy:start:loading

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

player:busy:stop:{BUSY_ID}
player:busy:stop:loading

 None No Stops a player-related busy action.

player:button:{BUTTON_ID}:disable
player:button:content:disable
player:button:restart:disable
player:button:prev:disable
player:button:rewind:disable
player:button:play_pause:disable
player:button:forward:disable
player:button:next:disable
player:button:speed:disable

 None No Disables a player button (all buttons except the eject button are supported).

player:button:{BUTTON_ID}:enable
player:button:content:enable
player:button:restart:enable
player:button:prev:enable
player:button:rewind:enable
player:button:play_pause:enable
player:button:forward:enable
player:button:next:enable
player:button:speed:enable

 None No Enables a player button (all buttons except the eject button are supported).

player:button:{BUTTON_ID}:execute
player:button:content:execute
player:button:restart:execute
player:button:prev:execute
player:button:rewind:execute
player:button:play_pause:execute
player:button:forward:execute
player:button:next:execute
player:button:speed:execute
player:button:eject:execute

 None No Executes a player button.

player:button:{BUTTON_ID}:focus
player:button:content:focus
player:button:restart:focus
player:button:prev:focus
player:button:rewind:focus
player:button:play_pause:focus
player:button:forward:focus
player:button:next:focus
player:button:speed:focus
player:button:eject:focus

 None No Focuses a player button.

player:button:{BUTTON_ID}:setup
player:button:content:setup
player:button:restart:setup
player:button:prev:setup
player:button:rewind:setup
player:button:play_pause:setup
player:button:forward:setup
player:button:next:setup
player:button:speed:setup

 Optional No

Sets up a player button (all buttons except the eject button are supported). The data can contain an icon property (of type string), an action property (of type string), and an enable property (of type boolean). If some properties are not set, the default values are used.

Note: If the icon property is set, the action property must also be set (and vice versa), otherwise the default values are used for both properties.

player:commit

Required No Commits data to the video/audio plugin.

player:commit:code

Optional No Commits a code to the video/audio plugin.

player:commit:dictionary

Optional No Commits the dictionary to the video/audio plugin.

player:commit:info

Optional No Commits the system info to the video/audio plugin.

player:commit:info:{DATA_TYPE}
player:commit:info:extended
player:commit:info:base
player:commit:info:application
player:commit:info:framework
player:commit:info:content
player:commit:info:dictionary
player:commit:info:screen
player:commit:info:time

 Optional No Commits the extended system info (including URL parameters and system data) or a specific system info to the video/audio plugin.

player:commit:message:{MESSAGE}
player:commit:message:This is a player message.

 Optional No Commits a message to the video/audio plugin.

player:commit:response:{REQUEST_ACTION}
player:commit:response:http://msx.benzac.de/services/echo.php
player:commit:response:user:{URL}
player:commit:response:accurate:{URL}
player:commit:response:user:accurate:{URL}
player:commit:response:request:interaction:{DATA_ID}
player:commit:response:request:interaction:{DATA_ID}@{URL}

 Optional No Commits a response to the video/audio plugin.

player:commit:slider

Optional No Commits the slider info to the video/audio plugin.

player:commit:string:{TRANSFORM_TYPE}:{STRING}
player:commit:string:transform:Media Station X
player:commit:string:normalize:EW6l] 801JCU; )

 Optional No Commits a transformed/normalized string to the video/audio plugin.

player:commit:video

Optional No Commits the video info to the video/audio plugin.

player:commit:video:{DATA_TYPE}
player:commit:video:info
player:commit:video:data
player:commit:video:resume
player:commit:video:volume
player:commit:video:scene

 Optional No Commits a specific video info to the video/audio plugin.

player:content

None No Shows the related content page (default action for the player button in the lower left corner).

player:content:{REQUEST_ACTION}
player:content:http://msx.benzac.de/info/data/guide/videos.json
player:content:user:{URL}
player:content:request:interaction:{DATA_ID}
player:content:request:interaction:{DATA_ID}@{URL}

 None No Loads a content page with the player back function.

player:content:data

Required No Shows a content page with the player back function.

player:control:action:{ACTION}
player:control:action:info:Custom player control action executed.
player:control:action:default

 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 data property. If you want to execute a control data action, please use the execute:fetch:{URL} action, alternatively.

player:default

None No Executes the following default player action. Shows the player with applied remote key execute.

player:eject

None No Stops/Ejects the video/audio.

player:forward

None No Jumps forward in the playback.

player:goto:{ITEM_ID}
player:goto:content_item_id

 None No Plays the item with the indicated ID.

player:goto:current

None No Replays the current item (by retuning it).

player:goto:first

None No Plays the first item.

player:goto:index:{ITEM_INDEX}
player:goto:index:0

 None No Plays the item with the indicated index.

player:goto:last

None No Plays the last item.

player:goto:next

None No Plays the next item.

player:goto:number:{ITEM_NUMBER}
player:goto:number:1

 None No Plays the item with the indicated number.

player:goto:prev

None No Plays the previous item.

player:goto:random

None No Plays a random item.

player:goto:swap

None No Plays the swap item.

player:hide

None No Hides the player.

player:hide_pause

None No Hides the player if it is paused.

player:hide_play

None No Hides the player if it is playing.

player:info:image:{URL}
player:info:image:http://msx.benzac.de/img/icon.png
player:info:image:default

 None No Sets up a player info image (only available for extended players).

player:info:overlay:{OVERLAY}
player:info:overlay:full
player:info:overlay:default

 None No Sets up the player info overlay (only available for extended players).

player:info:overlay:{OVERLAY}
player:info:overlay:full
player:info:overlay:default

 None No Sets up the player info overlay (only available for extended players).

player:info:size:{SIZE}
player:info:size:small
player:info:size:medium
player:info:size:large
player:info:size:extra-large
player:info:size:default

 None No Sets up the size of the player info image area (only available for extended players).

player:invalidate

None No Invalidates the player (hides the player if it is not extended).

player:label:content:{LABEL}
player:label:content:Custom player content label
player:label:content:default

 None No Sets up the player content label (overrides the playerLabel property of the corresponding content item with a custom value).

player:label:duration:{LABEL}
player:label:duration:Custom player duration label
player:label:duration:Custom player duration label ({VALUE})
player:label:duration:default

 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.

player:label:extension:{LABEL}
player:label:extension:{ico:live-tv}
player:label:extension:default

 None No Sets up an additional player extension label.

player:label:position:{LABEL}
player:label:position:Custom player position label
player:label:position:Custom player position label ({VALUE})
player:label:position:default

 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.

player:label:speed:{LABEL}
player:label:speed:Custom player speed label
player:label:speed:Custom player speed label ({VALUE})
player:label:speed:default

 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.

player:menu:{REQUEST_ACTION}
player:menu:http://msx.benzac.de/info/data/guide/actions.json
player:menu:user:{URL}
player:menu:request:interaction:{DATA_ID}
player:menu:request:interaction:{DATA_ID}@{URL}

 None No Loads a menu with the player back function.

player:menu:data

Required No Shows a menu with the player back function.

player:next

None No Plays the next related item.

player:pause

None No Pauses the video/audio.

player:play

None No Plays the video/audio.

player:play_pause

None No Toggles the video/audio playback.

player:prev

None No Plays the previous related item.

player:progress:color:{COLOR}
player:progress:color:msx-red
player:progress:color:default

 None No Sets up the player progress color.

player:progress:duration:{PROGRESS_DURATION}
player:progress:duration:60
player:progress:duration:-1

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

player:progress:marker:disable

None No Disables the player progress marker.

player:progress:marker:enable

None No Enables the player progress marker.

player:progress:marker:invalidate

None No Invalidates the player progress marker (marker will be unfocused).

player:progress:position:{PROGRESS_POSITION}
player:progress:position:0
player:progress:position:-1

 None No

Sets up the player progress position (overrides the default position value of the video/audio player with a custom value). The position -1 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).

player:progress:type:{PROGRESS_TYPE}
player:progress:type:position
player:progress:type:position:{POSITION} {ico:image}
player:progress:type:number
player:progress:type:number:{NUMBER} {ico:image}
player:progress:type:percentage
player:progress:type:time:{LIVE_DURATION_FORMAT}
player:progress:type:text:{LIVE_DURATION_TEXT}
player:progress:type:reverse:position
player:progress:type:reverse:position:{POSITION} {ico:image}
player:progress:type:reverse:number
player:progress:type:reverse:number:{NUMBER} {ico:image}
player:progress:type:reverse:percentage
player:progress:type:reverse:time:{LIVE_DURATION_FORMAT}
player:progress:type:reverse:text:{LIVE_DURATION_TEXT}
player:progress:type:difference:position
player:progress:type:difference:position:{POSITION} {ico:image}
player:progress:type:difference:number
player:progress:type:difference:number:{NUMBER} {ico:image}
player:progress:type:difference:percentage
player:progress:type:difference:time:{LIVE_DURATION_FORMAT}
player:progress:type:difference:text:{LIVE_DURATION_TEXT}
player:progress:type:fix:Fix progress label
player:progress:type:default

 None No

Sets up the player progress type (default is like time:hh:mm:ss). For the type that starts with (or contains) position:, the {POSITION} part is automatically replaced with the corresponding position value. For the type that starts with (or contains) number:, the {NUMBER} part is automatically replaced with the corresponding number value (which is the incremented position value).

player:refresh

None No Refreshes all player values.

player:reset

None No Resets custom player values that have been set at runtime.

player:restart

None No Restarts the video/audio.

player:rewind

None No Jumps rewind in the playback.

player:seek:{VALUE}
player:seek:10
player:seek:+10
player:seek:-10
player:seek:10%
player:seek:+10%
player:seek:-10%

 None No Executes a seek action.

player:show

None No Shows the player.

player:show:{REMOTE_KEY}
player:show:left
player:show:right
player:show:up
player:show:down
player:show:execute

 None No Shows the player with applied remote key.

player:show:code:{REMOTE_KEY_CODE}
player:show:code:37
player:show:code:39
player:show:code:38
player:show:code:40
player:show:code:13

 None No Shows the player with applied remote key code.

player:show_pause

None No Shows the player if it is paused.

player:show_pause:{REMOTE_KEY}
player:show_pause:left
player:show_pause:right
player:show_pause:up
player:show_pause:down
player:show_pause:execute

 None No Shows the player if it is paused with applied remote key.

player:show_pause:code:{REMOTE_KEY_CODE}
player:show_pause:code:37
player:show_pause:code:39
player:show_pause:code:38
player:show_pause:code:40
player:show_pause:code:13

 None No Shows the player if it is paused with applied remote key code.

player:show_play

None No Shows the player if it is playing.

player:show_play:{REMOTE_KEY}
player:show_play:left
player:show_play:right
player:show_play:up
player:show_play:down
player:show_play:execute

 None No Shows the player if it is playing with applied remote key.

player:show_play:code:{REMOTE_KEY_CODE}
player:show_play:code:37
player:show_play:code:39
player:show_play:code:38
player:show_play:code:40
player:show_play:code:13

 None No Shows the player if it is playing with applied remote key code.

player:speed

None No Shows the playback speed panel.

player:speed:dec

None No Decreases the playback speed.

player:speed:inc

None No Increases the playback speed.

player:speed:set:{VALUE}
player:speed:set:0.125
player:speed:set:0.25
player:speed:set:0.5
player:speed:set:1
player:speed:set:2
player:speed:set:4
player:speed:set:8

 None No Sets the playback speed.

player:stop

None No Stops/Ejects the video/audio.

player:sync

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.

player:ticking:restart

None No Restarts the player ticking (the next tick will be 0t).

player:video:clear

None No Clears all custom video values.

player:video:duration:{VIDEO_DURATION}
player:video:duration:60

 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 -1 re-enables the display feature.

player:video:position:{VIDEO_POSITION}
player:video:position:0

 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 custom:video:seek event is triggered). It can be used for live data or ads to disable/override the progress feature. The position -1 re-enables the display and seek feature. The position -2 only re-enables the display feature (it is still not possible to seek to another position).

player:video:speed:{VIDEO_SPEED}
player:video:speed:1

 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 custom:video:speed event is triggered). It can be used for live data or ads to disable/override the speed feature. The speed -1 re-enables the display and change feature. The speed -2 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.

player:video:state:{VIDEO_STATE}
player:video:state:2

 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 custom:video:play or custom:video:pause event is triggered). It can be used for live data or ads to disable/override the play/pause feature.

  • -2: Read-only (only re-enables the display feature)
  • -1: Clear (re-enables the display and change feature)
  • 1: Stopped (not supported)
  • 2: Playing
  • 3: 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.

playlist:{URL}
playlist:http://msx.benzac.de/info/data/guide/videos.json

 None Yes Loads a playlist.

playlist:auto:{URL}
playlist:auto:http://msx.benzac.de/info/data/guide/videos.json

 None No Loads a playlist in auto mode.

playlist:auto:data

Required No Plays a playlist in auto mode.

playlist:auto:request:interaction:{DATA_ID}
playlist:auto:request:interaction:custom_data_id

 None No Loads a playlist from the interaction plugin in auto mode.

playlist:auto:request:interaction:{DATA_ID}@{URL}
playlist:auto:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 None No Loads a playlist from the interaction plugin in auto mode (with ensuring that the interaction plugin is loaded).

playlist:auto:request:player:{DATA_ID}
playlist:auto:request:player:custom_data_id

 None No Loads a playlist from the player in auto mode (handled by the video/audio plugin).

playlist:auto:user:{URL}
playlist:auto:user:http://msx.benzac.de/info/data/guide/videos.json

 None No Loads a playlist in auto and user mode.

playlist:data

Required Yes Plays a playlist.

playlist:request:interaction:{DATA_ID}
playlist:request:interaction:custom_data_id

 None No Loads a playlist from the interaction plugin.

playlist:request:interaction:{DATA_ID}@{URL}
playlist:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 None No Loads a playlist from the interaction plugin (with ensuring that the interaction plugin is loaded).

playlist:request:player:{DATA_ID}
playlist:request:player:custom_data_id

 None No Loads a playlist from the player (handled by the video/audio plugin).

playlist:user:{URL}
playlist:user:http://msx.benzac.de/info/data/guide/videos.json

 None Yes Loads a playlist in user mode.

quiet

None No Stops a running video/audio.

release:content

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 reload action. However, the replace action can still be used.

release:menu

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 reload action. However, the replace action can still be used.

release:panel

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 reload action. However, the replace action can still be used.

reload

None Yes Reloads the application.

reload:content

None Yes Reloads the current content data.

reload:menu

None Yes Reloads the current menu data.

reload:panel

None Yes Reloads the current panel data.

reopen:{PARAMS}
reopen:key1=value1&key2=value2

 None No Reopens the application link with new URL parameters.

replace:content:{CONTENT_FLAG}:{REQUEST_ACTION}
replace:content:content_flag:http://msx.benzac.de/info/data/guide/videos.json
replace:content:content_flag:user:{URL}
replace:content:content_flag:request:interaction:{DATA_ID}
replace:content:content_flag:request:interaction:{DATA_ID}@{URL}

 None No

Replaces (and reloads) the current content data.

Note: The current content data flag property must match the indicated flag, otherwise the content data will not be replaced.

replace:menu:{CONTENT_FLAG}:{REQUEST_ACTION}
replace:menu:content_flag:http://msx.benzac.de/info/data/guide/menu.json
replace:menu:content_flag:user:{URL}
replace:menu:content_flag:request:interaction:{DATA_ID}
replace:menu:content_flag:request:interaction:{DATA_ID}@{URL}

 None No

Replaces (and reloads) the current menu data.

Note: The current menu data flag property must match the indicated flag, otherwise the menu data will not be replaced.

replace:panel:{CONTENT_FLAG}:{REQUEST_ACTION}
replace:panel:content_flag:http://msx.benzac.de/info/data/guide/panel.json
replace:panel:content_flag:user:{URL}
replace:panel:content_flag:request:interaction:{DATA_ID}
replace:panel:content_flag:request:interaction:{DATA_ID}@{URL}

 None No

Replaces (and reloads) the current panel data.

Note: The current panel data flag property must match the indicated flag, otherwise the panel data will not be replaced.

response:{REQUEST_ID}
response:rq10_1541593729708

 Optional No Handles a response for a pending request.

restart

None No Restarts the application.

resume:cancel

None No Cancels an ongoing resume process.

resume:clear

None No Clears all resume keys.

resume:clear:{RESUME_KEY}
resume:clear:content_item_id
resume:clear:http://msx.benzac.de/media/video1.mp4
resume:clear:custom_resume_key

 None No Clears a specific resume key.

resume:clear:current

None No Clears the current resume key.

resume:clear:hash:{RESUME_KEY_HASH_CODE}
resume:clear:hash:511673863

 None No Clears a specific resume key by using the resume key hash code.

resume:position:{RESUME_POSITION}
resume:position:10
resume:position:10%
resume:position:none

 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 resuming is performed. This action must be called after a video:{URL}, audio:{URL}, or playlist:{URL} action in order to take effect.

selection

None No Executes the selection action.

settings

None No Toggles the settings scene.

settings:about

None No Shows the about panel.

settings:animate

None No Shows the animation settings panel.

settings:animate:{VALUE}
settings:animate:0
settings:animate:1
settings:animate:2

 None No

Sets the animation settings.

  • 0: Off
  • 1: JS
  • 2: CSS

settings:hover_effect

None No Shows the hover effect settings panel.

settings:hover_effect:{VALUE}
settings:hover_effect:0
settings:hover_effect:1
settings:hover_effect:2

 None No

Sets the hover effect settings.

  • 0: Off
  • 1: Plain
  • 2: Preselect

settings:input

None No Shows the input settings panel.

settings:input:{VALUE}
settings:input:0
settings:input:1
settings:input:2
settings:input:3

 None No

Sets the input settings.

  • 0: Off
  • 1: Remote Only
  • 2: Click & Swipe
  • 3: Drag & Drop

settings:layout

None No Shows the layout settings panel.

settings:layout:{VALUE}
settings:layout:0.5
settings:layout:0.75
settings:layout:1
settings:layout:1.5
settings:layout:3

 None No

Sets the layout settings.

  • 0.5: 360p
  • 0.75: 540p
  • 1: 720p
  • 1.5: 1080p
  • 3: 2160p

settings:menu_button

None No Shows the menu button settings panel.

settings:random_playback

None No Shows the random playback settings panel.

settings:random_playback:{VALUE}
settings:random_playback:0
settings:random_playback:1

 None No

Sets the random playback settings.

  • 0: Off
  • 1: On

settings:remote

None No Shows the remote settings panel.

settings:remote:{VALUE}
settings:remote:0
settings:remote:1
settings:remote:2
settings:remote:3

 None No

Sets the remote settings.

  • 0: Off
  • 1: Minimalistic
  • 2: Navigation Frame
  • 3: Complex

settings:scale

None No Shows the scale settings panel.

settings:scale:{VALUE}
settings:scale:default
settings:scale:auto
settings:scale:device
settings:scale:0.75
settings:scale:fix:0.75

 None No

Sets the scale settings (viewport settings).

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

settings:slideshow_interval

None No Shows the slideshow interval settings panel.

settings:slideshow_interval:{VALUE}
settings:slideshow_interval:1000
settings:slideshow_interval:5000
settings:slideshow_interval:10000
settings:slideshow_interval:20000
settings:slideshow_interval:40000

 None No

Sets the slideshow interval settings (in milliseconds).

  • 1000: Very Fast
  • 5000: Fast
  • 10000: Normal
  • 20000: Slow
  • 40000: Very Slow

settings:start

None No Shows the start parameter panel.

settings:transform

None No Shows the transformation settings panel.

settings:transform:{VALUE}
settings:transform:0
settings:transform:1
settings:transform:2

 None No

Sets the transformation settings.

  • 0: Off
  • 1: 2D
  • 2: 3D

settings:validate_links

None No Shows the validate links settings panel.

settings:validate_links:{VALUE}
settings:validate_links:0
settings:validate_links:1

 None No

Sets the validate links settings.

  • 0: Off
  • 1: On

settings:zoom

None No Shows the zoom settings panel.

settings:zoom:{VALUE}
settings:zoom:default
settings:zoom:auto
settings:zoom:0.75

 None No

Sets the zoom settings.

  • default: No zooming
  • auto: Auto detect (with resize adjustment)
  • {NUMBER}: Set zoom factor to specific number

slider:action:{ACTION}
slider:action:info:Custom image action executed.
slider:action:default

 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 data property. If you want to execute an image data action, please use the execute:fetch:{URL} action, alternatively.

slider:break

None No Pauses the slideshow if it is playing.

slider:color:{COLOR}
slider:color:msx-blue
slider:color:default

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

slider:continue

None No Plays the slideshow if it is not playing.

slider:default

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

slider:eject

None No Stops/Ejects the slideshow.

slider:execute:{ACTION}
slider:execute:info:Slideshow action executed.

 Optional No Shows the slideshow labels or executes the indicated slideshow action (if labels are already visible or not present).

slider:extension:{LABEL}
slider:extension:Custom image extension label
slider:extension:default

 None No Sets up the slideshow image extension label of the current image.

slider:goto:{ITEM_ID}
slider:goto:content_item_id

 None No Goes to the item with the indicated ID.

slider:goto:first

None No Goes to the first item.

slider:goto:index:{ITEM_INDEX}
slider:goto:index:0

 None No Goes to the item with the indicated index.

slider:goto:last

None No Goes to the last item.

slider:goto:next

None No Goes to the next item.

slider:goto:number:{ITEM_NUMBER}
slider:goto:number:1

 None No Goes to the item with the indicated number.

slider:goto:prev

None No Goes to the previous item.

slider:icon:{ICON}
slider:icon:info
slider:icon:default

 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.

slider:label:{LABEL}
slider:label:Custom image label
slider:label:default

 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 imageLabel property has been set (to a non null value) in the corresponding content item, it can be updated.

slider:labels:hide

None No Hides the slideshow labels.

slider:labels:play_pause

None No Shows the slideshow labels or toggles the slideshow playback.

slider:labels:show

None No Shows the slideshow labels.

slider:labels:toggle

None No Toggles the slideshow labels.

slider:next

None No Goes to the next item without showing the labels.

slider:options

None No Toggles the slideshow image options.

slider:options:execute

None No Executes the selected slideshow image option item.

slider:options:select:{ITEM_ID}
slider:options:select:slideshow
slider:options:select:right_rotation
slider:options:select:left_rotation
slider:options:select:full_rotation
slider:options:select:reset_rotation

 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.

slider:pause

None No Pauses the slideshow.

slider:play

None No Plays the slideshow.

slider:play_pause

None No Toggles the slideshow playback.

slider:prev

None No Goes to the previous item without showing the labels.

slider:reset

None No Resets custom slideshow image values of the current image that have been set at runtime.

slider:restart

None No Restarts the slideshow.

slider:rotate:{ROTATION_VALUE}
slider:rotate:right
slider:rotate:left
slider:rotate:full
slider:rotate:full-right
slider:rotate:full-left
slider:rotate:reset
slider:rotate:-270
slider:rotate:-180
slider:rotate:-90
slider:rotate:0
slider:rotate:90
slider:rotate:180
slider:rotate:270

 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.

slider:stop

None No Stops/Ejects the slideshow.

slider:sync

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.

slideshow:{URL}
slideshow:http://msx.benzac.de/info/data/guide/images.json

 None Yes Loads a slideshow.

slideshow:data

Required Yes Shows a slideshow.

slideshow:request:interaction:{DATA_ID}
slideshow:request:interaction:custom_data_id

 None No Loads a slideshow from the interaction plugin.

slideshow:request:interaction:{DATA_ID}@{URL}
slideshow:request:interaction:custom_data_id@http://msx.benzac.de/interaction/template.html

 None No Loads a slideshow from the interaction plugin (with ensuring that the interaction plugin is loaded).

slideshow:request:player:{DATA_ID}
slideshow:request:player:custom_data_id

 None No Loads a slideshow from the player (handled by the video/audio plugin).

slideshow:user:{URL}
slideshow:user:http://msx.benzac.de/info/data/guide/images.json

 None Yes Loads a slideshow in user mode.

start

Required Yes Sets up a start parameter.

still

None No Stops a running slideshow.

success:{MESSAGE}
success:This is a success message.

 None Yes Shows a success message.

system:hbbtv:{SYSTEM_ACTION}
system:hbbtv:show
system:hbbtv:hide
system:hbbtv:launch:{APP_ID}
system:hbbtv:foreground
system:hbbtv:background
system:hbbtv:transient
system:hbbtv:update

 None No Executes an HbbTV-related action.

system:lg:{SYSTEM_ACTION}
system:lg:launch:{APP_ID}

 Optional No Executes an LG-related action.

system:netcast:{SYSTEM_ACTION}
system:netcast:menu
system:netcast:ratio

 None No Executes a Netcast-related action.

system:options

None No Shows the system options.

system:samsung:{SYSTEM_ACTION}
system:samsung:launch:{APP_ID}

 None No Executes a Samsung-related action.

system:tizen:{SYSTEM_ACTION}
system:tizen:launch
system:tizen:launch:{APP_ID}
system:tizen:keys:mapped
system:tizen:keys:unmapped

 Optional No Executes a Tizen-related action.

system:tvx:{SYSTEM_ACTION}
system:tvx:about
system:tvx:settings
system:tvx:restart
system:tvx:exit
system:tvx:log
system:tvx:log:clear
system:tvx:system_log
system:tvx:system_log:clear
system:tvx:options
system:tvx:launch
system:tvx:launch:{APP_ID}

 Optional No Executes a TVX-related action (Android-/iOS-related action).

system:uwp:{SYSTEM_ACTION}
system:uwp:launch:{APP_ID}

 None No Executes a UWP-related action (Universal Windows Platform action).

test

None No Toggles the test scene.

time:clear

None No Clears the time and zone offset.

time:init

Required No Initializes the time and/or zone offset (the data must contain a time and/or timeZone property).

time:set

Required No Sets a fix time and/or zone offset (the data must contain an offset and/or zoneOffset property).

trigger:{TRIGGER_KEY}:{ACTION}
trigger:load:info:Video loaded.
trigger:ready:info:Video ready.
trigger:start:info:Video started.
trigger:ending:info:Video is ending (video is playing and 10 seconds or less are remaining).
trigger:end:info:Video ended.
trigger:complete:info:Video completed.
trigger:10:info:10 seconds of video passed.
trigger:10%:info:10% of video passed.
trigger:10t:info:10 ticks of video passed.
trigger:-10:info:Last 10 seconds of video passed.
trigger:20:shot:info:20 seconds of video passed (shot).
trigger:20%:shot:info:20% of video passed (shot).
trigger:20t:shot:info:20 ticks of video passed (shot).
trigger:-20:shot:info:Last 20 seconds of video passed (shot).
trigger:quartile1:info:First quartile of video entered.
trigger:quartile2:info:Second quartile of video entered.
trigger:quartile3:info:Third quartile of video entered.
trigger:quartile4:info:Fourth quartile of video entered.
trigger:first_quartile:info:First quartile of video reached.
trigger:midpoint:info:Midpoint of video reached.
trigger:third_quartile:info:Third quartile of video reached.
trigger:play:info:Video is playing.
trigger:pause:info:Video paused.
trigger:stop:info:Video stopped.
trigger:active:info:Video player is visible or video moved to foreground.
trigger:inactive:info:Video moved to background.
trigger:player:info:Video player is visible.
trigger:foreground:info:Video moved to foreground.
trigger:background:info:Video moved to background.
trigger:back:info:Video back executed.
trigger:back:none

 None No

Sets up a video/audio trigger for the current content. If the action none is indicated, the trigger is removed again. This action must be called after a video:{URL}, audio:{URL}, or playlist:{URL} 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 data property. If you want to execute a trigger data action, please use the execute:fetch:{URL} action, alternatively.

update:content:{ITEM_ID}
update:content:content_item_id

 Required Yes Updates a content item.

update:content:overlay:{ITEM_ID}
update:content:overlay:content_item_id

 Required Yes Updates a content overlay item.

update:content:underlay:{ITEM_ID}
update:content:underlay:content_item_id

 Required Yes Updates a content underlay item.

update:menu:{ITEM_ID}
update:menu:menu_item_id

 Required Yes Updates a menu item.

update:panel:{ITEM_ID}
update:panel:content_item_id

 Required Yes Updates a panel item.

update:panel:overlay:{ITEM_ID}
update:panel:overlay:content_item_id

 Required Yes Updates a panel overlay item.

update:panel:underlay:{ITEM_ID}
update:panel:underlay:content_item_id

 Required Yes Updates a panel underlay item.

video:{URL}
video:http://msx.benzac.de/media/video1.mp4

 Optional Yes Plays a video.

video:auto:{URL}
video:auto:http://msx.benzac.de/media/video1.mp4

 Optional No Plays a video in auto mode.

video:auto:broadcast:{BC_ACTION}
video:auto:broadcast:current
video:auto:broadcast:next
video:auto:broadcast:prev
video:auto:broadcast:release
video:auto:broadcast:name:{CHANNEL_NAME}
video:auto:broadcast:triplet:{ONID}.{TSID}.{SID}

 Optional No Executes a platform-specific video broadcast action in auto mode.

video:auto:plugin:{URL}
video:auto:plugin:http://msx.benzac.de/plugins/template.html

 Optional No Plays a plugin video in auto mode.

video:auto:resolve:{REQUEST_ACTION}
video:auto:resolve:http://msx.benzac.de/services/resolve.php?type=video
video:auto:resolve:user:{URL}
video:auto:resolve:request:interaction:{DATA_ID}
video:auto:resolve:request:interaction:{DATA_ID}@{URL}

 Optional No Plays a video by resolving it with a URL in auto mode (the response data must contain a url property).

video:broadcast:{BC_ACTION}
video:broadcast:current
video:broadcast:next
video:broadcast:prev
video:broadcast:release
video:broadcast:name:{CHANNEL_NAME}
video:broadcast:triplet:{ONID}.{TSID}.{SID}

 Optional No Executes a platform-specific video broadcast action.

video:plugin:{URL}
video:plugin:http://msx.benzac.de/plugins/template.html

 Optional Yes Plays a plugin video.

video:resolve:{REQUEST_ACTION}
video:resolve:http://msx.benzac.de/services/resolve.php?type=video
video:resolve:user:{URL}
video:resolve:request:interaction:{DATA_ID}
video:resolve:request:interaction:{DATA_ID}@{URL}

 Optional No Plays a video by resolving it with a URL (the response data must contain a url property).

volume

None No Toggles the volume scene.

volume:action

None No Shows the volume action.

volume:dec

None No Decreases the volume.

volume:hide

None No Hides the volume scene.

volume:inc

None No Increases the volume.

volume:mute

None No Mutes the volume.

volume:set:{VALUE}
volume:set:100
volume:set:50
volume:set:0

 None No Sets the volume.

volume:show

None No Shows the volume scene.

volume:toggle_show

None No Toggles the volume or shows the volume scene.

volume:unmute

None No Unmutes the volume.

volume:toggle

None No Toggles the volume.

warn:{MESSAGE}
warn:This is a warning message.

 None Yes Shows a warning message.

[{ACTION}|{ACTION}|...]
[reload:content|info:Action executed.]

 Optional Yes Executes multiple actions in a row.
Retrieved from "https://msx.benzac.de/wiki/index.php?title=Internal_Actions&oldid=2553"