Difference between revisions of "Background Plugin"
(→Code) |
|||
(13 intermediate revisions by the same user not shown) | |||
Line 19: | Line 19: | ||
== Example == | == Example == | ||
− | Please note that | + | 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 === | === Screenshot === | ||
[[File:background_plugin.png|thumb|640px|none|Example Screenshot (Background Plugin)]] | [[File:background_plugin.png|thumb|640px|none|Example Screenshot (Background Plugin)]] | ||
Line 27: | Line 27: | ||
{ | { | ||
"headline": "Background Plugin Test", | "headline": "Background Plugin Test", | ||
− | "style": " | + | "style": "overlay", |
"transparent": 2, | "transparent": 2, | ||
"ready": { | "ready": { | ||
− | "action": "execute: | + | "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": [{ | "menu": [{ | ||
"label": "Menu Item 1", | "label": "Menu Item 1", | ||
− | "data": | + | "data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json" |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}, { | }, { | ||
"label": "Menu Item 2", | "label": "Menu Item 2", | ||
− | "data": | + | "data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json" |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}, { | }, { | ||
"label": "Menu Item 3", | "label": "Menu Item 3", | ||
− | "data": | + | "data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json" |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}, { | }, { | ||
"label": "Menu Item 4", | "label": "Menu Item 4", | ||
− | "data": | + | "data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json" |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}, { | }, { | ||
"label": "Menu Item 5", | "label": "Menu Item 5", | ||
− | "data": | + | "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" | |
− | |||
− | |||
− | |||
− | |||
− | |||
}] | }] | ||
} | } | ||
Line 92: | Line 60: | ||
=== Demo === | === Demo === | ||
− | * Launch via App: https://msx.benzac.de/?start=menu:https://msx.benzac.de/info/xp/data/ | + | * 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/ | + | * Launch via Demo Page: https://msx.benzac.de/info/?start=menu:https://msx.benzac.de/info/xp/data/plugin_test_6_menu.json |
== See also == | == See also == | ||
Line 101: | Line 69: | ||
* [[HTML5X Plugin]] | * [[HTML5X Plugin]] | ||
* [[Panorama Plugin]] | * [[Panorama Plugin]] | ||
+ | * [[Ad Plugin]] | ||
* [[Plugin API Reference]] | * [[Plugin API Reference]] |
Revision as of 13:28, 17 June 2022
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 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