Play Plugin - Revision history

Benzac: /* Usage */

2024-04-02T08:03:08Z

Usage

Benzac at 07:57, 2 April 2024

2024-04-02T07:57:36Z

Benzac at 07:54, 2 April 2024

2024-04-02T07:54:08Z

Benzac at 11:07, 12 June 2023

2023-06-12T11:07:56Z

Benzac at 11:00, 12 June 2023

2023-06-12T11:00:20Z

Benzac: /* Usage */

2023-01-24T14:26:10Z

Usage

Benzac: /* Demo */

2023-01-23T10:23:31Z

Demo

Benzac: /* See also */

2023-01-23T09:58:27Z

Benzac: Created page with "This is a special interaction plugin that allows you to select a platform-compatible player at runtime. Additionally, the settings of the selected player are made available. T..."

2023-01-23T09:40:20Z

Created page with "This is a special interaction plugin that allows you to select a platform-compatible player at runtime. Additionally, the settings of the selected player are made available. T..."

New page

This is a special interaction plugin that allows you to select a platform-compatible player at runtime. Additionally, the settings of the selected player are made available. The plugin can be used with version '''0.1.145''' or higher.

== Usage ==
The plugin must be loaded with a video URL. Optionally, the player button (to make the player selection available) can be indicated. Please see following action syntax examples.

* <code>video:resolve:request:interaction:{URL}@http://msx.benzac.de/interaction/play.html</code>
* <code>video:resolve:request:interaction:{URL}@http://msx.benzac.de/interaction/play.html?button=content</code>

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/interaction/js/play.js.

== Syntax ==
{| class="wikitable sortable"
|+ Parameter syntax of play plugin
|-
! Parameter !! Type !! Default Value !! Mandatory !! class="unsortable" | Description
|-
| <code>button</code> || <code>string</code> || <code>"content"</code> || No ||
The player button that should be used to make the player selection available.
|}

== Example ==
=== Screenshot ===
[[File:play_plugin.png|thumb|640px|none|Example Screenshot (Play Plugin)]]

=== Code ===
<syntaxhighlight lang="json">
{
"type": "list",
"headline": "Play Plugin Test",
"template": {
"type": "separate",
"layout": "0,0,2,4",
"icon": "msx-white-soft:extension",
"color": "msx-glass",
"titleFooter": "",
"progress": -1,
"live": {
"type": "playback",
"titleFooter": "{progress:time:hh:mm:ss}",
"action": "player:show"
},
"properties": {
"resume:key": "url"
}
},
"items": [{
"title": "Video 1",
"playerLabel": "Video 1",
"action": "video:resolve:request:interaction:http://msx.benzac.de/media/video1.mp4@http://msx.benzac.de/interaction/play.html"
}, {
"title": "Video 2",
"playerLabel": "Video 2",
"action": "video:resolve:request:interaction:http://msx.benzac.de/media/video2.mp4@http://msx.benzac.de/interaction/play.html"
}, {
"title": "Video 3",
"playerLabel": "Video 3",
"action": "video:resolve:request:interaction:http://msx.benzac.de/media/video3.mp4@http://msx.benzac.de/interaction/play.html"
}, {
"title": "Video 4",
"playerLabel": "Video 4",
"action": "video:resolve:request:interaction:http://msx.benzac.de/media/video4.mp4@http://msx.benzac.de/interaction/play.html"
}, {
"title": "Video 5",
"playerLabel": "Video 5",
"action": "video:resolve:request:interaction:http://msx.benzac.de/media/video5.mp4@http://msx.benzac.de/interaction/play.html"
}, {
"title": "Video 6",
"playerLabel": "Video 6",
"action": "video:resolve:request:interaction:http://msx.benzac.de/media/video6.mp4@http://msx.benzac.de/interaction/play.html"
}]
}
</syntaxhighlight>

=== Demo ===
* Launch via App: https://msx.benzac.de/?start=content:http://msx.benzac.de/info/xp/data/plugin_test_10.json
* Launch via Demo Page: https://msx.benzac.de/info/?start=content:http://msx.benzac.de/info/xp/data/plugin_test_10.json

== See also ==
* [[Video/Audio Plugin]]
* [[Interaction Plugin]]
* [[Image Plugin]]
* [[HTML5X Plugin]]
* [[Panorama Plugin]]
* [[Background Plugin]]
* [[Backdrop Plugin]]
* [[Ad Plugin]]
* [[Plugin API Reference]]

@@ Line 21: / Line 21: @@
 Indicates if the related content button should be displayed in the player selection panel.
-* <code>0</code>: Hide related content button
+* <code>0</code>: Hides the related content button.
-* <code>1</code>: Show related content button
+* <code>1</code>: Shows the related content button.
 |}

@@ Line 2: / Line 2: @@
 == Usage ==
-The plugin must be loaded with a video URL. Optionally, the player button (to make the player selection available) can be indicated. Please see following action syntax examples.
+The plugin must be loaded with a video URL. Optionally, the player button (to make the player selection available) can be indicated. Additionally, the related content button can be displayed in the player selection panel (e.g. if the player button is set to the content button). Please see following action syntax examples.
 * <code>video:resolve:request:interaction:{URL}@http://msx.benzac.de/interaction/play.html</code>
-* <code>video:resolve:request:interaction:{URL}@http://msx.benzac.de/interaction/play.html?button={BUTTON}</code>
+* <code>video:resolve:request:interaction:{URL}@http://msx.benzac.de/interaction/play.html?button={BUTTON}&related={RELATED}</code>
 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/interaction/js/play.js.

@@ Line 17: / Line 17: @@
 | <code>button</code> || <code>string</code> || <code>"content"</code> || No ||
 The player button that should be used to make the player selection available.
 |}

@@ Line 78: / Line 78: @@
 == See also ==
 * [[Interaction Plugin]]
 * [[Plugin API Reference]]

@@ Line 73: / Line 73: @@
 === Demo ===
-* Launch via App: https://msx.benzac.de/?start=content:http://msx.benzac.de/info/xp/data/plugin_test_10.json
+* Launch via App: https://msx.benzac.de/?start=content:https://msx.benzac.de/info/xp/data/plugin_test_10.json
-* Launch via Demo Page: https://msx.benzac.de/info/?start=content:http://msx.benzac.de/info/xp/data/plugin_test_10.json
+* Launch via Demo Page: https://msx.benzac.de/info/?start=content:https://msx.benzac.de/info/xp/data/plugin_test_10.json
 == See also ==

@@ Line 85: / Line 85: @@
 * [[Backdrop Plugin]]
 * [[Ad Plugin]]
 * [[Plugin API Reference]]