Difference between revisions of "Background Plugin"

From MSX - Wiki
Jump to navigation Jump to search
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
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. However, the example uses some properties that are only available in version '''0.1.142''' or higher.
+
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 ==
 
== Usage ==
Line 10: Line 10:
 
== Syntax ==
 
== Syntax ==
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
−
|+ Parameter syntax of panorama plugin
+
|+ Parameter syntax of background plugin
 
|-
 
|-
 
! Parameter !! Type !! Default Value !! Mandatory !! class="unsortable" | Description  
 
! Parameter !! Type !! Default Value !! Mandatory !! class="unsortable" | Description  
Line 19: Line 19:
  
 
== Example ==
 
== Example ==
 +
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 26: Line 27:
 
{
 
{
 
     "headline": "Background Plugin Test",
 
     "headline": "Background Plugin Test",
−
     "style": "flat",
+
     "style": "overlay",
 
     "transparent": 2,
 
     "transparent": 2,
 
     "ready": {
 
     "ready": {
−
         "action": "video:auto:plugin:http://msx.benzac.de/plugins/background.html?url=http://msx.benzac.de/media/atmos1.mp4",
+
         "action": "execute:service:video:data:http://msx.benzac.de/services/background.php",
 
         "data": {
 
         "data": {
−
             "playerLabel": "Atmospheric Background 1",
+
             "url": "http://msx.benzac.de/media/atmos1.mp4",
−
             "properties": {
+
             "label": "Atmospheric Background 1",
−
                "control:type": "extended",
+
            "transparent": true
−
                "control: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"
−
                "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:transparent": true
 
−
                                }
 
−
                            }]
 
−
                    }]
 
−
            }
 
 
         }, {
 
         }, {
 
             "label": "Menu Item 2",
 
             "label": "Menu Item 2",
−
             "data": {
+
             "data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
−
                "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:transparent": true
 
−
                                }
 
−
                            }]
 
−
                    }]
 
−
            }
 
 
         }, {
 
         }, {
 
             "label": "Menu Item 3",
 
             "label": "Menu Item 3",
−
             "data": {
+
             "data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
−
                "pages": [{
+
        }, {
−
                        "items": [{
+
            "label": "Menu Item 4",
−
                                "layout": "0,0,12,6",
+
            "data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
−
                                "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",
+
            "label": "Menu Item 5",
−
                                "playerLabel": "Atmospheric Background 3",
+
            "data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
−
                                "properties": {
+
        }, {
−
                                    "control:type": "extended",
+
            "label": "Menu Item 6",
−
                                    "control:transparent": false
+
            "data": "http://msx.benzac.de/info/xp/data/plugin_test_6_content.json"
−
                                }
 
−
                            }]
 
−
                    }]
 
−
            }
 
 
         }]
 
         }]
 
}
 
}
Line 91: Line 60:
  
 
=== Demo ===
 
=== Demo ===
−
* Launch via App: https://msx.benzac.de/?start=menu:https://msx.benzac.de/info/xp/data/plugin_test_6.json
+
* 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.json
+
* 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 99: Line 68:
 
* [[Image Plugin]]
 
* [[Image Plugin]]
 
* [[HTML5X Plugin]]
 
* [[HTML5X 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 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",
    "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]

See also[edit]

Retrieved from "https://msx.benzac.de/wiki/index.php?title=Background_Plugin&oldid=2562"