Actions
All actions are indicated as strings and are used by content items to perform specific tasks (e.g. play a video, start a slideshow, etc.). Some actions use additional data, provided by the corresponding content item.
Base Actions[edit]
| Syntax | Example | Since Version | Description |
|---|---|---|---|
video:{URL}
|
video:http://msx.benzac.de/media/video1.mp4
|
0.1.0 | Plays a video. The {URL} part must be replaced with the video URL.
|
audio:{URL}
|
audio:http://msx.benzac.de/media/audio1.mp3
|
0.1.0 | Plays an audio file. The {URL} part must be replaced with the audio URL. This action works in the same way as video:{URL}, except that the video screen is not displayed. Instead, the background screen is displayed. If the corresponding content item provides a background property, it is used, otherwise the next available background property (at higher level) is used.
|
image:{URL}
|
image:http://msx.benzac.de/img/bg1.jpg
|
0.1.0 | Shows an image. The {URL} part must be replaced with the image URL.
|
image:context
|
image:context
|
0.1.0 | Shows an image by using the current context. The image URL must be provided as image property by the corresponding content item.
|
link:{URL}
|
link:http://msx.benzac.de/info/
|
0.1.0 | Opens a link. The {URL} part must be replaced with the link URL.
|
link:window:{URL}
|
link:window:http://msx.benzac.de/info/
|
0.1.0 | Opens a link in a separate window or in an external browser. The {URL} part must be replaced with the link URL. |
playlist:{URL}
|
playlist:http://msx.benzac.de/info/data/guide/videos.json
|
0.1.0 | Loads a playlist without a corresponding content page. The {URL} part must be replaced with the playlist URL.
The data structure is the same like the Templated Items from the Content API. Please see Content Root Object for more information. |
playlist:data
|
playlist:data
|
0.1.0 | Starts a playlist without a corresponding content page. The playlist data must be provided as data property by the corresponding content item.
The data structure is the same like the Templated Items from the Content API. Please see Content Root Object for more information. |
slideshow:{URL}
|
slideshow:http://msx.benzac.de/info/data/guide/images.json
|
0.1.0 | Loads a slideshow without a corresponding content page. The {URL} part must be replaced with the slideshow URL.
The data structure is the same like the Templated Items from the Content API. Please see Content Root Object for more information. |
slideshow:data
|
slideshow:data
|
0.1.0 | Starts a slideshow without a corresponding content page. The playlist data must be provided as data property by the corresponding content item.
The data structure is the same like the Templated Items from the Content API. Please see Content Root Object for more information. |
menu:{URL}
|
menu:http://msx.benzac.de/info/data/guide/actions.json
|
0.1.0 | Loads a menu. The {URL} part must be replaced with the menu URL.
Please see Menu Root Object for the data structure. |
menu:data
|
menu:data
|
0.1.0 | Shows a menu. The menu data must be provided as data property by the corresponding content item.
Please see Menu Root Object for the data structure. |
content:{URL}
|
content:http://msx.benzac.de/info/data/guide/videos.json
|
0.1.0 | Loads a content page. The {URL} part must be replaced with the content URL.
Please see Content Root Object for the data structure. |
content:data
|
content:data
|
0.1.0 | Shows a content page. The content data must be provided as data property by the corresponding content item.
Please see Content Root Object for the data structure. |
panel:{URL}
|
panel:http://msx.benzac.de/info/data/guide/panel.json
|
0.1.0 | Loads a content page in a panel. The {URL} part must be replaced with the content URL.
Please see Content Root Object for the data structure. |
panel:data
|
panel:data
|
0.1.0 | Shows a content page in a panel. The content data must be provided as data property by the corresponding content item.
Please see Content Root Object for the data structure. |
success:{TEXT}
|
success:This is a success message.
|
0.1.0 | Shows a success message. The {TEXT} part must be replaced with any text.
The text supports inline expressions. Please see Inline Expressions for more information. |
info:{TEXT}
|
info:This is an info message.
|
0.1.0 | Shows an info message. The {TEXT} part must be replaced with any text.
The text supports inline expressions. Please see Inline Expressions for more information. |
warn:{TEXT}
|
warn:This is a warning message.
|
0.1.0 | Shows a warning message. The {TEXT} part must be replaced with any text.
The text supports inline expressions. Please see Inline Expressions for more information. |
error:{TEXT}
|
error:This is an error message.
|
0.1.0 | Shows an error message. The {TEXT} part must be replaced with any text.
The text supports inline expressions. Please see Inline Expressions for more information. |
focus:{ID}
|
focus:content_item_id
|
0.1.0 | Sets the focus to a specific item in the current context. The {ID} part must be replaced with an item ID (e.g. the content item ID).
|
focus:index:{INDEX}
|
focus:index:0
|
0.1.0 | Sets the focus to a specific item in the current context. The {INDEX} part must be replaced with an item index (e.g. index 0 will set the focus to the first item).
|
start
|
start
|
0.1.30 | Sets up a new start parameter. The start parameter data must be provided as data property by the corresponding content item.
Please see Start Object for the data structure. |
video:plugin:{URL}
|
video:plugin:http://msx.benzac.de/plugins/template.html
|
0.1.40 | Plays a plugin video. The {URL} part must be replaced with the plugin URL.
Please see the YouTube, Vimeo & Co. for plugin examples. |
audio:plugin:{URL}
|
audio:plugin:http://msx.benzac.de/plugins/template.html
|
0.1.40 | Plays a plugin audio file. The {URL} part must be replaced with the plugin URL. This action works in the same way as video:plugin:{URL}, except that the video screen is not displayed. Instead, the background screen is displayed. If the corresponding content item provides a background property, it is used, otherwise the next available background property (at higher level) is used.
Please see the YouTube, Vimeo & Co. for plugin examples. |