Difference between revisions of "Background Plugin"
(→Syntax) |
|||
| Line 14: | Line 14: | ||
! Parameter !! Type !! Default Value !! Mandatory !! class="unsortable" | Description | ! Parameter !! Type !! Default Value !! Mandatory !! class="unsortable" | Description | ||
|- | |- | ||
| − | | <code>url</code> || <code>string</code> || <code>null</code> || ''' | + | | <code>id</code> || <code>string</code> || <code>null</code> || No || |
| + | The ID of the background video. This ID is used to request the corresponding URL from the interaction plugin. | ||
| + | |- | ||
| + | | <code>url</code> || <code>string</code> || <code>null</code> || '''Only if video ID is not set''' || | ||
The URL of the background video. It is recommended to encode the value to ensure that it is evaluated correctly (e.g. <code>"http://msx.benzac.de/media/atmos1.mp4"</code> → <code>"http%3A%2F%2Fmsx.benzac.de%2Fmedia%2Fatmos1.mp4"</code>). | The URL of the background video. It is recommended to encode the value to ensure that it is evaluated correctly (e.g. <code>"http://msx.benzac.de/media/atmos1.mp4"</code> → <code>"http%3A%2F%2Fmsx.benzac.de%2Fmedia%2Fatmos1.mp4"</code>). | ||
|} | |} | ||
Revision as of 15:34, 22 March 2023
This is a special video plugin that plays a video in an endless loop. The plugin can be used with version 0.1.74 or higher.
Usage[edit]
The plugin must be loaded with a video URL. Please see following action syntax example.
If you would like to use the plugin as reference to implement your own plugin, please have a look at this implementation script: http://msx.benzac.de/plugins/js/background.js.
Syntax[edit]
| Parameter | Type | Default Value | Mandatory | Description |
|---|---|---|---|---|
id |
string |
null |
No |
The ID of the background video. This ID is used to request the corresponding URL from the interaction plugin. |
url |
string |
null |
Only if video ID is not set |
The URL of the background video. It is recommended to encode the value to ensure that it is evaluated correctly (e.g. |
Example[edit]
Please note that this example uses some properties that are only available in version 0.1.142 or higher. Please also note that the service http://msx.benzac.de/services/background.php is not part of the plugin. It is just a helper service to return a background video plugin action if no other video/audio is running.
Screenshot[edit]
Code[edit]
{
"headline": "Background Plugin Test",
"style": "overlay",
"transparent": 2,
"ready": {
"action": "execute:service:video:data:http://msx.benzac.de/services/background.php",
"data": {
"url": "http://msx.benzac.de/media/atmos1.mp4",
"label": "Atmospheric Background 1",
"transparent": true
}
},
"menu": [{
"label": "Menu Item 1",
"data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
}, {
"label": "Menu Item 2",
"data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
}, {
"label": "Menu Item 3",
"data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
}, {
"label": "Menu Item 4",
"data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
}, {
"label": "Menu Item 5",
"data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
}, {
"label": "Menu Item 6",
"data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
}]
}
Demo[edit]
- Launch via App: https://msx.benzac.de/?start=menu:https://msx.benzac.de/info/xp/data/plugin_test_6_menu.json
- Launch via Demo Page: https://msx.benzac.de/info/?start=menu:https://msx.benzac.de/info/xp/data/plugin_test_6_menu.json