Difference between revisions of "Attached Data Examples"

From MSX - Wiki
Jump to navigation Jump to search
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
These are examples of the attached data that is sent/committed to the server/plugin for specific execute/commit actions. They are only valid for version '''0.1.125+'''. Please ensure that you are using the correct version, because the syntax in previous versions can be different. For more information about the execute/commit actions, please see [[Internal Actions]].
+
These are examples of the attached data that is sent/committed to the server/plugin for specific execute/commit actions. They are only valid for version '''0.1.145+'''. Please ensure that you are using the correct version, because the syntax in previous versions can be different. For more information about the execute/commit actions, please see [[Internal Actions]].
  
 
'''Note: Please note that no action-related <code>data</code> property is used for all examples. Therefore, the sent/committed <code>data</code> property is always <code>null</code>.'''
 
'''Note: Please note that no action-related <code>data</code> property is used for all examples. Therefore, the sent/committed <code>data</code> property is always <code>null</code>.'''
 
+
{| class="wikitable"
{| class="wikitable sortable"
 
 
|+ Examples of attached data
 
|+ Examples of attached data
 
|-
 
|-
! Action Example !! class="unsortable" | Data Example
+
! Action Example !! Data Example
 
|-
 
|-
 
|
 
|
Line 75: Line 74:
 
         "scene": "foreground"
 
         "scene": "foreground"
 
     },
 
     },
 +
    "data": null
 +
}
 +
</syntaxhighlight>
 +
|-
 +
|
 +
<code>execute:slider:{URL}</code><br/>
 +
<code>player:commit:slider</code><br/>
 +
<code>interaction:commit:slider</code><br/>
 +
|
 +
<syntaxhighlight lang="json">
 +
{
 +
    "slider": {
 +
        "state": 3,
 +
        "id": null,
 +
        "index": 0,
 +
        "number": 1,
 +
        "count": 4,
 +
        "listIndex": 0,
 +
        "listSize": 4,
 +
        "url": "http://msx.benzac.de/img/bg1.jpg",
 +
        "label": "Image 1",
 +
        "color": null,
 +
        "filler": null,
 +
        "rotation": 0,
 +
        "customLabel": null,
 +
        "customColor": null,
 +
        "properties": null
 +
    },
 +
    "data": null
 +
}
 +
</syntaxhighlight>
 +
|-
 +
|
 +
<code>execute:info:extended:{URL}</code><br/>
 +
<code>player:commit:info:extended</code><br/>
 +
<code>interaction:commit:info:extended</code><br/>
 +
|
 +
<syntaxhighlight lang="json">
 +
{
 +
    "info": {
 +
        "host": "local",
 +
        "secure": false,
 +
        "client": null,
 +
        "platform": "android",
 +
        "id": "Vv58jUgVvufU8pVrq7XCQ5DnrEBwmhfy",
 +
        "player": "html5/plugin",
 +
        "userAgent": "Mozilla/5.0 ...",
 +
        "application": {
 +
            "name": "Media Station X",
 +
            "version": "0.1.107",
 +
            "suffix": null,
 +
            "settings": {
 +
                "validateLinks": 1,
 +
                "randomPlayback": 0,
 +
                "slideshowInterval": 10000,
 +
                "hoverEffect": 1,
 +
                "menuButton": {
 +
                    "action": -1,
 +
                    "keyCode": -1
 +
                }
 +
            }
 +
        },
 +
        "framework": {
 +
            "name": "TVX Framework",
 +
            "version": "0.1.14",
 +
            "suffix": null,
 +
            "settings": {
 +
                "animate": 2,
 +
                "transform": 1,
 +
                "input": 3,
 +
                "remote": 1,
 +
                "layout": "1",
 +
                "scale": "auto",
 +
                "zoom": null,
 +
                "center": 1,
 +
                "background": 1,
 +
                "leave": 0,
 +
                "exit": 1,
 +
                "back": 1,
 +
                "volume": 1,
 +
                "busy": 1,
 +
                "speed": 3,
 +
                "playback": 1,
 +
                "fullscreen": 1,
 +
                "suspend": 2,
 +
                "secure": 0
 +
            }
 +
        },
 +
        "content": {
 +
            "name": "Google Drive MSX",
 +
            "version": "1.0.14",
 +
            "flag": null,
 +
            "server": "gd.msx.benzac.de",
 +
            "secure": false,
 +
            "parameter": "menu:request:interaction:init@http://gd.msx.benzac.de/interaction",
 +
            "state": {
 +
                "start": true,
 +
                "restored": false,               
 +
                "menuId": null,
 +
                "menuFlag": null,
 +
                "menuFocus": "index:0",
 +
                "menuIndex": 0,
 +
                "menuSize": 3,
 +
                "contentId": "request:interaction:gd:welcome",
 +
                "contentFlag": null,
 +
                "contentFocus": null,
 +
                "contentIndex": -1,
 +
                "contentSize": -1,
 +
                "contentVisible": true,
 +
                "panelId": null,
 +
                "panelFlag": null,
 +
                "panelFocus": null,
 +
                "panelIndex": -1,
 +
                "panelSize": -1,
 +
                "panelVisible": false,
 +
                "videoVisible": false,
 +
                "videoActive": false,
 +
                "playerVisible": false,
 +
                "slideshowVisible": false,
 +
                "volumeVisible": false,
 +
                "logVisible": false
 +
            },
 +
            "interaction": "http://gd.msx.benzac.de/interaction"           
 +
        },
 +
        "dictionary": {
 +
            "url": "http://msx.benzac.de/dic/en.json",
 +
            "name": "English",
 +
            "version": "1.0.0",
 +
            "size": 277
 +
        },
 +
        "screen": {
 +
            "width": 1280,
 +
            "height": 720,
 +
            "factor": 1,
 +
            "zoomFactor": 1
 +
        },
 +
        "time": {
 +
            "timestamp": 1580465719024,
 +
            "now": 1580465718178,
 +
            "zone": 3600000,
 +
            "offset": 0,
 +
            "zoneOffset": 0
 +
        },
 +
        "urlParams": {},
 +
        "system": {
 +
            "name": "Device - Android 8.0.0",
 +
            "ipAddress": "192.168.0.10",
 +
            "manufacturer": null,
 +
            "deviceId": "0000000000000000"
 +
        }
 +
    },
 +
    "data": null
 +
}
 +
</syntaxhighlight>
 +
|-
 +
|
 +
<code>player:commit:message:test</code><br/>
 +
<code>interaction:commit:message:test</code><br/>
 +
|
 +
<syntaxhighlight lang="json">
 +
{
 +
    "message": "test",
 +
    "data": null
 +
}
 +
</syntaxhighlight>
 +
|-
 +
|
 +
<code>player:commit:string:transform:test</code><br/>
 +
<code>interaction:commit:string:transform:test</code><br/>
 +
|
 +
<syntaxhighlight lang="json">
 +
{
 +
    "string": "pzr.",
 +
    "data": null
 +
}
 +
</syntaxhighlight>
 +
|-
 +
|
 +
<code>player:commit:string:normalize:pzr.</code><br/>
 +
<code>interaction:commit:string:normalize:pzr.</code><br/>
 +
|
 +
<syntaxhighlight lang="json">
 +
{
 +
    "string": "test",
 +
    "data": null
 +
}
 +
</syntaxhighlight>
 +
|-
 +
|
 +
<code>player:commit:response:http://msx.benzac.de/services/echo.php</code><br/>
 +
<code>interaction:commit:response:http://msx.benzac.de/services/echo.php</code><br/>
 +
|
 +
<syntaxhighlight lang="json">
 +
{
 +
    "response": {
 +
        "action": "info:Hello, I am a simple echo service."
 +
    },
 +
    "error": null,
 +
    "data": null
 +
}
 +
</syntaxhighlight>
 +
|-
 +
|
 +
<code>player:commit:dictionary</code><br/>
 +
<code>interaction:commit:dictionary</code><br/>
 +
|
 +
<syntaxhighlight lang="json">
 +
{
 +
    "dictionary": {
 +
        "name": "English",
 +
        "version": "1.0.0",
 +
        "size": 277,
 +
        "properties": {
 +
            "format:date": "mm/dd/yy",
 +
            "format:day": "D mm/dd",
 +
            "format:full_day": "DD, MM d, yyyy",
 +
            "format:long_date": "MM d, yyyy",
 +
            "format:long_day": "D mm/dd/yyyy",
 +
            "format:long_time": "h:mm:ss/ampm",
 +
            "format:separator": ", ",
 +
            "format:time": "h:mm/ampm",
 +
            [...]
 +
        }
 +
    },
 +
    "data": null
 +
}
 +
</syntaxhighlight>
 +
|-
 +
|
 +
<code>notification:test</code><br/>
 +
|
 +
<syntaxhighlight lang="json">
 +
{
 +
    "notification": "test",
 
     "data": null
 
     "data": null
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 
|}
 
|}

Latest revision as of 14:09, 26 January 2022

These are examples of the attached data that is sent/committed to the server/plugin for specific execute/commit actions. They are only valid for version 0.1.145+. Please ensure that you are using the correct version, because the syntax in previous versions can be different. For more information about the execute/commit actions, please see Internal Actions.

Note: Please note that no action-related data property is used for all examples. Therefore, the sent/committed data property is always null.

Examples of attached data
Action Example Data Example

execute:{URL}
player:commit
interaction:commit

{
    "data": null
}

execute:code:{URL}
player:commit:code
interaction:commit:code

{
    "code": "1234",
    "data": null
}

execute:video:{URL}
player:commit:video
interaction:commit:video

{
    "video": {
        "info": {
            "id": null,
            "index": 0,
            "number": 1,
            "count": 3,
            "listIndex": 0,
            "listSize": 3,
            "type": "video",
            "url": "http://msx.benzac.de/media/video1.mp4",
            "label": "Video 1",
            "background": null,
            "customLabel": null,
            "customBackground": null,
            "properties": null
        },
        "data": {
            "state": 2,
            "position": 4,
            "duration": 118,
            "speed": 1,
            "ended": false
        },
        "resume": {
            "key": null,
            "count": 10,
            "resuming": false,
            "position": null,
            "progress": -1
        },
        "volume": {
            "type": "player",
            "level": 100,
            "muted": false
        },
        "scene": "foreground"
    },
    "data": null
}

execute:slider:{URL}
player:commit:slider
interaction:commit:slider

{
    "slider": {
        "state": 3,
        "id": null,
        "index": 0,
        "number": 1,
        "count": 4,
        "listIndex": 0,
        "listSize": 4,
        "url": "http://msx.benzac.de/img/bg1.jpg",
        "label": "Image 1",
        "color": null,
        "filler": null,
        "rotation": 0,
        "customLabel": null,
        "customColor": null,
        "properties": null
    },
    "data": null
}

execute:info:extended:{URL}
player:commit:info:extended
interaction:commit:info:extended

{
    "info": {
        "host": "local",
        "secure": false,
        "client": null,
        "platform": "android",
        "id": "Vv58jUgVvufU8pVrq7XCQ5DnrEBwmhfy",
        "player": "html5/plugin",
        "userAgent": "Mozilla/5.0 ...",
        "application": {
            "name": "Media Station X",
            "version": "0.1.107",
            "suffix": null,
            "settings": {
                "validateLinks": 1,
                "randomPlayback": 0,
                "slideshowInterval": 10000,
                "hoverEffect": 1,
                "menuButton": {
                    "action": -1,
                    "keyCode": -1
                }
            }
        },
        "framework": {
            "name": "TVX Framework",
            "version": "0.1.14",
            "suffix": null,
            "settings": {
                "animate": 2,
                "transform": 1,
                "input": 3,
                "remote": 1,
                "layout": "1",
                "scale": "auto",
                "zoom": null,
                "center": 1,
                "background": 1,
                "leave": 0,
                "exit": 1,
                "back": 1,
                "volume": 1,
                "busy": 1,
                "speed": 3,
                "playback": 1,
                "fullscreen": 1,
                "suspend": 2,
                "secure": 0
            }
        },
        "content": {
            "name": "Google Drive MSX",
            "version": "1.0.14",
            "flag": null,
            "server": "gd.msx.benzac.de",
            "secure": false,
            "parameter": "menu:request:interaction:init@http://gd.msx.benzac.de/interaction",
            "state": {
                "start": true,
                "restored": false,                
                "menuId": null,
                "menuFlag": null,
                "menuFocus": "index:0",
                "menuIndex": 0,
                "menuSize": 3,
                "contentId": "request:interaction:gd:welcome",
                "contentFlag": null,
                "contentFocus": null,
                "contentIndex": -1,
                "contentSize": -1,
                "contentVisible": true,
                "panelId": null,
                "panelFlag": null,
                "panelFocus": null,
                "panelIndex": -1,
                "panelSize": -1,
                "panelVisible": false,
                "videoVisible": false,
                "videoActive": false,
                "playerVisible": false,
                "slideshowVisible": false,
                "volumeVisible": false,
                "logVisible": false
            },
            "interaction": "http://gd.msx.benzac.de/interaction"            
        },
        "dictionary": {
            "url": "http://msx.benzac.de/dic/en.json",
            "name": "English",
            "version": "1.0.0",
            "size": 277
        },
        "screen": {
            "width": 1280,
            "height": 720,
            "factor": 1,
            "zoomFactor": 1
        },
        "time": {
            "timestamp": 1580465719024,
            "now": 1580465718178,
            "zone": 3600000,
            "offset": 0,
            "zoneOffset": 0
        },
        "urlParams": {},
        "system": {
            "name": "Device - Android 8.0.0",
            "ipAddress": "192.168.0.10",
            "manufacturer": null,
            "deviceId": "0000000000000000"
        }
    },
    "data": null
}

player:commit:message:test
interaction:commit:message:test

{
    "message": "test",
    "data": null
}

player:commit:string:transform:test
interaction:commit:string:transform:test

{
    "string": "pzr.",
    "data": null
}

player:commit:string:normalize:pzr.
interaction:commit:string:normalize:pzr.

{
    "string": "test",
    "data": null
}

player:commit:response:http://msx.benzac.de/services/echo.php
interaction:commit:response:http://msx.benzac.de/services/echo.php

{
    "response": {
        "action": "info:Hello, I am a simple echo service."
    },
    "error": null,
    "data": null
}

player:commit:dictionary
interaction:commit:dictionary

{
    "dictionary": {
        "name": "English",
        "version": "1.0.0",
        "size": 277,
        "properties": {
            "format:date": "mm/dd/yy",
            "format:day": "D mm/dd",
            "format:full_day": "DD, MM d, yyyy",
            "format:long_date": "MM d, yyyy",
            "format:long_day": "D mm/dd/yyyy",
            "format:long_time": "h:mm:ss/ampm",
            "format:separator": ", ",
            "format:time": "h:mm/ampm",
            [...]
        }
    },
    "data": null
}

notification:test

{
    "notification": "test",
    "data": null
}