Difference between revisions of "Background Plugin"

Revision as of 16:54, 13 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 in this example some properties are used that are only available in version 0.1.142 or higher.

Screenshot[edit]

Example Screenshot (Background Plugin)

Code[edit]

{
    "headline": "Background Plugin Test",
    "style": "flat",
    "transparent": 2,
    "ready": {
        "action": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos1.mp4&reuse=continue&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": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos1.mp4&reuse=restart&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": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos2.mp4&reuse=restart&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": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos3.mp4&reuse=restart&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": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos4.mp4&reuse=restart&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": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos5.mp4&reuse=restart&transparent=true"
                            }]
                    }]
            }
        }]
}

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 30: / Line 30: @@
      "transparent": 2,
      "ready": {
-         "action": "video:auto:plugin:http://msx.benzac.de/plugins/background.html?url=http://msx.benzac.de/media/atmos1.mp4",
+         "action": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos1.mp4&reuse=continue&transparent=true"
-        "data": {
-            "playerLabel": "Atmospheric Background 1",
-            "properties": {
-                "control:type": "extended",
-                "control:reuse": "continue",
-                "control:transparent": true
-            }
-        }
      },
      "menu": [{
@@ Line 47: / Line 39: @@
                                  "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]",
+                                 "action": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos1.mp4&reuse=restart&transparent=true"
-                                "data": {
-                                    "playerLabel": "Atmospheric Background 1",
-                                    "properties": {
-                                        "control:type": "extended",
-                                        "control:reuse": "restart",
-                                        "control:transparent": true
-                                    }
-                                }
                              }]
                      }]
@@ Line 66: / Line 50: @@
                                  "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]",
+                                 "action": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos2.mp4&reuse=restart&transparent=true"
-                                "data": {
-                                    "playerLabel": "Atmospheric Background 2",
-                                    "properties": {
-                                        "control:type": "extended",
-                                        "control:reuse": "restart",
-                                        "control:transparent": true
-                                    }
-                                }
                              }]
                      }]
@@ Line 85: / Line 61: @@
                                  "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]",
+                                 "action": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos3.mp4&reuse=restart&transparent=false"
-                                "data": {
-                                    "playerLabel": "Atmospheric Background 3",
-                                    "properties": {
-                                        "control:type": "extended",
-                                        "control:reuse": "restart",
-                                        "control:transparent": false
-                                    }
-                                }
                              }]
                      }]
@@ Line 104: / Line 72: @@
                                  "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]",
+                                 "action": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos4.mp4&reuse=restart&transparent=true"
-                                "data": {
-                                    "playerLabel": "Atmospheric Background 4",
-                                    "properties": {
-                                        "control:type": "extended",
-                                        "control:reuse": "restart",
-                                        "control:transparent": true
-                                    }
-                                }
                              }]
                      }]
@@ Line 123: / Line 83: @@
                                  "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]",
+                                 "action": "execute:fetch:http://msx.benzac.de/services/background.php?url=http://msx.benzac.de/media/atmos5.mp4&reuse=restart&transparent=true"
-                                "data": {
-                                    "playerLabel": "Atmospheric Background 5",
-                                    "properties": {
-                                        "control:type": "extended",
-                                        "control:reuse": "restart",
-                                        "control:transparent": false
-                                    }
-                                }
                              }]
                      }]

Difference between revisions of "Background Plugin"

Revision as of 16:54, 13 November 2021

Contents

Usage[edit]

Syntax[edit]

Example[edit]

Screenshot[edit]

Code[edit]

Demo[edit]

See also[edit]

Navigation menu

Search