Difference between revisions of "Background Plugin"

Revision as of 20:03, 17 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.

video:plugin:http://msx.benzac.de/plugins/background.html?url={URL}

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 syntax of background plugin
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. `"http://msx.benzac.de/media/atmos1.mp4"` → `"http%3A%2F%2Fmsx.benzac.de%2Fmedia%2Fatmos1.mp4"`).

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]

Example Screenshot (Background Plugin)

Code[edit]

{
    "headline": "Background Plugin Test",
    "pages": [{
            "items": [{
                    "layout": "0,0,12,6",
                    "color": "msx-glass",
                    "title": "Load Test",
                    "image": "http://msx.benzac.de/info/xp/img/background_plugin.png",
                    "imageFiller": "width",
                    "action": "menu:http://msx.benzac.de/info/xp/data/plugin_test_6_menu.json"
                }]
        }]
}

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

@@ Line 27: / Line 27: @@
 {
      "headline": "Background Plugin Test",
-     "style": "flat",
+     "pages": [{
-    "transparent": 2,
+             "items": [{
-    "ready": {
+                    "layout": "0,0,12,6",
-        "action": "execute:service:video:data:http://msx.benzac.de/services/background.php",
+                    "color": "msx-glass",
-        "data": {
+                    "title": "Load Test",
-            "url": "http://msx.benzac.de/media/atmos1.mp4",
+                     "image": "http://msx.benzac.de/info/xp/img/background_plugin.png",
-            "label": "Atmospheric Background 1",
+                    "imageFiller": "width",
-            "transparent": true
+                     "action": "menu:http://msx.benzac.de/info/xp/data/plugin_test_6_menu.json"
-        }
+                 }]
-    },
-    "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:duration": "{VALUE} {ico:repeat}"
-                                }
-                            }]
-                     }]
-            }
-        }, {
-            "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:duration": "{VALUE} {ico:repeat}"
-                                }
-                            }]
-                     }]
-            }
-        }, {
-            "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:duration": "{VALUE} {ico:repeat}"
-                                }
-                            }]
-                    }]
-            }
-        }, {
-            "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:duration": "{VALUE} {ico:repeat}"
-                                }
-                            }]
-                    }]
-            }
-        }, {
-            "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,
-                                    "label:duration": "{VALUE} {ico:repeat}"
-                                }
-                            }]
-                    }]
-            }
          }]
 }

Difference between revisions of "Background Plugin"

Revision as of 20:03, 17 November 2021

Contents

Usage[edit]

Syntax[edit]

Example[edit]

Screenshot[edit]

Code[edit]

Demo[edit]

See also[edit]

Navigation menu

Search