Difference between revisions of "Background Plugin"
Jump to navigation
Jump to search
(→Code) |
(→Syntax) |
||
| Line 10: | Line 10: | ||
== Syntax == | == Syntax == | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| − | |+ Parameter syntax of | + | |+ Parameter syntax of background plugin |
|- | |- | ||
! Parameter !! Type !! Default Value !! Mandatory !! class="unsortable" | Description | ! Parameter !! Type !! Default Value !! Mandatory !! class="unsortable" | Description | ||
Revision as of 21:42, 12 November 2021
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 |
|---|---|---|---|---|
url |
string |
null |
Yes |
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 in this example some properties are used that are only available in version 0.1.142 or higher.
Screenshot[edit]
Code[edit]
{
"headline": "Background Plugin Test",
"style": "flat",
"transparent": 2,
"ready": {
"action": "video:auto:plugin:http://msx.benzac.de/plugins/background.html?url=http://msx.benzac.de/media/atmos1.mp4",
"data": {
"playerLabel": "Atmospheric Background 1",
"properties": {
"control:type": "extended",
"control:reuse": "continue",
"control:transparent": true
}
}
},
"menu": [{
"label": "Menu Item 1",
"data": {
"pages": [{
"items": [{
"layout": "0,0,12,6",
"text": "Press {txt:msx-white:OK} to switch to {txt:msx-white:Atmospheric Background 1}.",
"action": "video:auto:plugin:http://msx.benzac.de/plugins/background.html?url=http://msx.benzac.de/media/atmos1.mp4",
"playerLabel": "Atmospheric Background 1",
"properties": {
"control:type": "extended",
"control:reuse": "restart",
"control:transparent": true
}
}]
}]
}
}, {
"label": "Menu Item 2",
"data": {
"pages": [{
"items": [{
"layout": "0,0,12,6",
"text": "Press {txt:msx-white:OK} to switch to {txt:msx-white:Atmospheric Background 2}.",
"action": "video:auto:plugin:http://msx.benzac.de/plugins/background.html?url=http://msx.benzac.de/media/atmos2.mp4",
"playerLabel": "Atmospheric Background 2",
"properties": {
"control:type": "extended",
"control:reuse": "restart",
"control:transparent": true
}
}]
}]
}
}, {
"label": "Menu Item 3",
"data": {
"pages": [{
"items": [{
"layout": "0,0,12,6",
"text": "Press {txt:msx-white:OK} to switch to {txt:msx-white:Atmospheric Background 3}.",
"action": "video:auto:plugin:http://msx.benzac.de/plugins/background.html?url=http://msx.benzac.de/media/atmos3.mp4",
"playerLabel": "Atmospheric Background 3",
"properties": {
"control:type": "extended",
"control:reuse": "restart",
"control:transparent": false
}
}]
}]
}
}, {
"label": "Menu Item 4",
"data": {
"pages": [{
"items": [{
"layout": "0,0,12,6",
"text": "Press {txt:msx-white:OK} to switch to {txt:msx-white:Atmospheric Background 4}.",
"action": "video:auto:plugin:http://msx.benzac.de/plugins/background.html?url=http://msx.benzac.de/media/atmos4.mp4",
"playerLabel": "Atmospheric Background 4",
"properties": {
"control:type": "extended",
"control:reuse": "restart",
"control:transparent": true
}
}]
}]
}
}, {
"label": "Menu Item 5",
"data": {
"pages": [{
"items": [{
"layout": "0,0,12,6",
"text": "Press {txt:msx-white:OK} to switch to {txt:msx-white:Atmospheric Background 5}.",
"action": "video:auto:plugin:http://msx.benzac.de/plugins/background.html?url=http://msx.benzac.de/media/atmos5.mp4",
"playerLabel": "Atmospheric Background 5",
"properties": {
"control:type": "extended",
"control:reuse": "restart",
"control:transparent": false
}
}]
}]
}
}]
}
Demo[edit]
- Launch via App: https://msx.benzac.de/?start=menu:https://msx.benzac.de/info/xp/data/plugin_test_6.json
- Launch via Demo Page: https://msx.benzac.de/info/?start=menu:https://msx.benzac.de/info/xp/data/plugin_test_6.json