get-scenes-list

Use the interface to get the scene list of the current presentation.

Request Mode

 POST http://ip/mwapi/get-scenes-list

Response Body

JSON structure is as follows:

{
  "result": 0,
  "info":{
      "totalCount": 3,
      "pageIndex":0,
      "audioList":[{...}],
      "sceneList":[{...}]
      } 
}
1. Response Status
"result": 0
Name Description
result Response status. 0 indicates a successful data acquisition. Refer to API Status Codes to find specific description for other values.
totalCount The total number of scene items
2. Presentation Audio Configuration (audioList [{...}])
"audioList":[
            {
                "muted":0,
                "type":1,
                "volume":1000000
            },
            {
                "muted":1,
                "type":2,
                "volume":1000000
            },
            {
                "muted":0,
                "type":3,
                "volume":1000000
            },
            {
                "muted":0,
                "type":4,
                "volume":1000000
            },
            {
                "muted":0,
                "type":5,
                "volume":1000000
            },
            {
                "muted":0,
                "type":6,
                "volume":1000000
            }
        ],
Name Description
type Audio type
1: output
2: monitor
3: mic
4: bgm
5: uac in
6: line in
muted Muted
0: NO
1: YES
volume Volume (0 - 1000000)
3. Scene List of Current Page (sceneList [{...}])
"sceneList":[
            {
                "audioList": [
                    {
                        "layerId": 0,
                        "muted": 0,
                        "type": 256,
                        "volume": 1000000
                    }
                ],
                "dividerLine": {
                    "color": 0,
                    "width": 0,
                    "x1": 500000,
                    "x2": 500000,
                    "y1": 0,
                    "y2": 1000000
                },
                "id": 100,
                "layerList": [
                    {
                        "cropWindow": {
                            "height": 1000000,
                            "type": 0,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        },
                        "flip": 0,
                        "frame": {
                            "color": 0,
                            "width": 0
                        },
                        "givenBg": 0,
                        "mediaProgress": 0,
                        "rotation": 360,
                        "sourceDuration": 0,
                        "sourceHeight": 1080,
                        "sourceId": 1,
                        "sourceThumbHeight": 144,
                        "sourceThumbWidth": 256,
                        "sourceType": 3,
                        "sourceWidth": 1920,
                        "srcWindow": {
                            "height": 1000000,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        },
                        "window": {
                            "height": 1000000,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        }
                    },
                    {
                        "cropWindow": {
                            "height": 1000000,
                            "type": 0,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        },
                        "flip": 0,
                        "frame": {
                            "color": 0,
                            "width": 0
                        },
                        "givenBg": 0,
                        "rotation": 0,
                        "sourceHeight": 0,
                        "sourceId": 0,
                        "sourceThumbHeight": 0,
                        "sourceThumbWidth": 0,
                        "sourceType": 0,
                        "sourceWidth": 0,
                        "srcWindow": {
                            "height": 1000000,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        },
                        "window": {
                            "height": 0,
                            "width": 0,
                            "x": 0,
                            "y": 0
                        }
                    }
                ],
                "name": "",
                "template": 2,
                "type": 3
            },
            {
                "audioList": [],
                "dividerLine": {
                    "color": 0,
                    "width": 0,
                    "x1": 500000,
                    "x2": 500000,
                    "y1": 0,
                    "y2": 1000000
                },
                "id": 101,
                "layerList": [
                    {
                        "cropWindow": {
                            "height": 1000000,
                            "type": 0,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        },
                        "flip": 0,
                        "frame": {
                            "color": 0,
                            "width": 0
                        },
                        "givenBg": 0,
                        "rotation": 0,
                        "sourceHeight": 1080,
                        "sourceId": 1001,
                        "sourceThumbHeight": 0,
                        "sourceThumbWidth": 0,
                        "sourceType": 7,
                        "sourceWidth": 1920,
                        "srcWindow": {
                            "height": 1000000,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        },
                        "thumbHeight": 144,
                        "thumbWidth": 256,
                        "window": {
                            "height": 1000000,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        }
                    },
                    {
                        "cropWindow": {
                            "height": 1000000,
                            "type": 0,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        },
                        "flip": 0,
                        "frame": {
                            "color": 0,
                            "width": 0
                        },
                        "givenBg": 0,
                        "rotation": 0,
                        "sourceDuration": 0,
                        "sourceHeight": 1080,
                        "sourceId": 2039,
                        "sourceThumbHeight": 0,
                        "sourceThumbWidth": 0,
                        "sourceType": 1,
                        "sourceWidth": 1920,
                        "srcWindow": {
                            "height": 1000000,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        },
                        "window": {
                            "height": 1000000,
                            "width": 1000000,
                            "x": 0,
                            "y": 0
                        }
                    }
                ],
                "name": "note",
                "template": 0,
                "type": 4
            }
        ]
1. Scene
Name Description
id The scene ID
name The scene name
type The scene type
4: note
Others: scenes (no detailed types)
template The combination template
0: picture in picture
1: side by side
2: single-layer picture
dividerLine The attribute of the divider line
layerList The layer list
2. Audio Configuration of the Scene
Name Description
type Audio type
0x0100: HDMI 1
0x0200: video
0x0300: HDMI 2
0x0400: USB Camera
0x0500: picture
0x0700: web page
muted Muted
0: NO
1: YES
volume Volume: 0 - 1000000
3. Divider Line (dividerLine)
Name Description
color The color of divider line in uint32 (gbra)
x1 The x value of divider line top point
y1 The y value of divider line top point
x2 The x value of divider line end point
y2 The y value of divider line end point
4. Layer (layer)
Name Description
sourceId The source ID, accessing through http (http://[deviceIP]/source/(sourceId))
sourceType The source type
1: picture
2: video
3: HDMI 1 scene
4: HDMI 2 scene
5: USB-Camera
6: audio
7: background picture
8: automatic camera
sourceWidth The width of the source picture
sourceHeight The height of the source picture
sourceDuration The length of the source video
mediaProgress The play process of the source media, only for video
rotation The rotation angle which is in a counterclockwise direction
Range: [0 - 360]
flip The flip attribute
0: not flip
1: flip horizontally
2: flip vertically
3: flip horizontally and vertically
frame The frame attribute
window The window attribute
srcWindow The attribute of the content window
cropWindow The attribute of the cropping window
sourceTotalPageNumber The total number of PDF pages
pdfPosition The current position of PDF layer, (page - 1) * 100
pdfScaleMode The scaling property of PDF, 1~5 * 10000
pdfScaleValue The scaling mode of PDF
0: Free
1: Maintain the original ratio of the page
2: Fit the page size
3: Fit the width
webScaleValue The scaling property of web page, 1~5 * 10000
url The URL of web page
videoPolicy The video playback policy
0: Play once
1: Playback repeatedly
2: Switch to the next scene after the video is finished
Thumbnail Access Address
PDF layer http://[deviceIP]/pdf/[presentationID]/[sceneID]
Home web page http://[deviceIP]/source/[sourceId]/homepage
Current web page http://[deviceIP]/source/[sourceId]/currentpage or http://[deviceIP]/source/[sourceId]
5. Window (window)
Name Description
x x, relative value (0 -1000000), the same below
y y
width Width
height Height
type (Optional) Aspect ratio
0: free ratio
1: original ratio
2: 4:3
3: 16:9
4: 1:1

results matching ""

    No results matching ""

    results matching ""

      No results matching ""