get-device-status

Use the interface to get the status information of the device.

Request Mode

 POST http://ip/mwapi/get-device-status

Response Body

JSON structure is as follows:

{
  "result": 0,
  "message": "success",
  "info": {...}
}
1. Response Status
"result": 0
Name Description
result 0 indicates a successful data acquisition. Refer to API Status Codes to find specific description for other values.
2. Basic Status Information (info {...})
"info":{
        "annotationStatus":{
            "arrowWidth":1,
            "boardMode":2,
            "eraserWidth":34,
            "fillColor":0,
            "highlighterWidth":20,
            "inkDuration":5000,
            "inkStyle":0,
            "laserpointerPosX":500000,
            "laserpointerPosY":500000,
            "lineWidth":16,
            "lowerFactor":0,
            "shapeType":6,
            "strokeColor":3977979135,
            "upperFactor":500000,
            "useStroke":false
        },
        "deviceName":"USB Fusion",
        "deviceWorkingStatus":0,
        "firmwareVersion":"2.0.5",
        "ftbEnable":0,
        "hardwareVersion":"A",
        "musicStatus":{
            "currentMusicId":0,
            "duration":0,
            "policy":1,
            "progress":0,
            "status":0
        },
        "osdId":0,
        "pdfConfig":{
            "layerId":0,
            "pdfPosition":0,
            "pdfScale":23468,
            "pdfScaleMode":3,
            "sceneId":0,
            "sourceTotalPageNumber":0
        },
        "recordStatus":{
            "lastRecordError":0,
            "recording":0,
            "timeRecording":0,
            "timeRemaining":13358
        },
        "sceneStatus":{
            "cropping":0,
            "croppingLayerId":0,
            "currentID":24,
            "currentShowId":7,
            "defaultNoteBgId":1001,
            "editSceneId":0,
            "editing":0,
            "isFrozen":0,
            "lastNoteId":0,
            "lastSceneId":100,
            "location":0,
            "noteEditing":0,
            "sourceCollection":0
        },
        "serialNumber":"A506211025003",
        "srtStatus":[
            {
                "port":9110,
                "srtId":0,
                "stoped":0
            },
            {
                "port":9111,
                "srtId":1,
                "stoped":0
            },
            {
                "port":9112,
                "srtId":2,
                "stoped":0
            },
            {
                "port":9113,
                "srtId":3,
                "stoped":0
            }
        ],
        "videoPlayerStatus":[

        ],
        "webBrowser":{
            "canGoBack":0,
            "canGoForward":0,
            "currentScale":10000
        }
    }
Name Description
annotationStatus The configuration of annotation
ftbEnable Whether to enable FTB
0: not enabled
1: enabled
musicStatus The status information of the BGM player
recordStatus The status information of the recording
sceneStatus The status information of the current scene
srtStatus The SRT server status information of the captured scene
videoPlayerStatus The video player status information of the current scene
hardwareVersion The current hardware version
firmwareVersion The current firmware version
osdId The current enabled watermark ID
pdfConfig The configuration of the PDF layer in the current scene
webBrowser The configuration of the web page layer in the current scene
Status Information of BGM Player (musicStatus)
Name Description
currentMusicId The ID of current music
duration The duration of audio file in ms
policy The play policy
1: play in order
2: shuffle the playlist
3: repeat a single song
4: repeat the playlist
progress The play progress (0 - 1000000)
status The play status
0: pause
1: playing
Status Information of Recording (recordStatus)
Name Description
lastRecordError The information of the last record error
recording Recording task status
0: not enabled
1: recording
timeRecording The duration of the recording in seconds
timeRemaining The remaining recording duration in seconds
Status Information of Current Scene (sceneStatus)
Name Description
currentShowId The ID of the current presentation
currentID The ID of the current preview scene
lastNoteId The ID of the last preview note
lastSceneId The ID of the last preview scene
editing Whether the scene is editing
0: false
1: true
editSceneId The ID of the editing scene
defaultNoteBgId The ID of the default note background source
cropping Whether the layer is cropping
0: false
1: true
croppingLayerId The ID of the cropping layer
isFrozen Whether the preview scene is frozen
0: false
1: true
location The scene location
PIP
1: top_left, 2: top_right, 3: bottom_left, 4: bottom_right
SBS
1: left_most, 2: left_center, 3: center, 4: center_right, 5: right_most
sourceCollection The source collection
1: HDMI 1 + HDMI 2
2: HDMI 2 + HDMI 1
3: HDMI 1 + WEBCAM
4: WEBCAM + HDMI 1
5: HDMI 2 + WEBCAM
6: WEBCAM + HDMI 2
Video Player Status Information of Current Scene (videoPlayerStatus)
Name Description
layerId The layer ID
playStatus The player status
0: pause
1: playing
progress The player progress (0 - 1000000)
sourceDuration The length of the source video in ms
sourceId The source ID
SRT Streaming Configuration
Name Description
srtId The srtId
0: preview scene
0: HDMI 1
2: HDMI 2
3: USB Camera
port The port number
stopped The start or stop status
1: stopped
0: started
The configuration of the PDF layer in the current scene
Name Description
sceneId The scene ID
layerId The PDF layer ID
sourceTotalPageNumber The total number of PDF pages
pdfPosition The current preview position, (page - 1) * 100
pdfScale The scaling properties, 1~5 * 10000
pdfScaleMode The scaling mode
0: free
1: Maintain the original ratio of the page
2: Fit the page size
3: Fit the width
The configuration of the web page layer in the current scene
Name Description
canGoBack Can it go backward. 0: No 1: Yes
canGoForward Can it go forward. 0: No 1: Yes
currentScale The scaling properties, 1~5 * 10000

results matching ""

    No results matching ""

    results matching ""

      No results matching ""