获取设备状态信息

1.接口描述

接口说明:获取设备状态信息。

请求方式:

  • 固件版本 V2.6.0 及以上:POST [ip]/mwapi/V2.0/scene/get-device-status
  • 固件版本 V2.5.0 及以下:POST [ip]/mwapi/get-device-status
管理员权限 登录认证

2.输入参数

3.输出参数

参数名称 类型 描述
result Int 状态码
message String 状态描述
info InfoData 设备状态信息
InfoData
参数名称 类型 描述
annotationStatus 注解配置
autoBackup Int 是否启用自动备份
0:否;1:是
deviceName String 设备名称
serialNumber String 设备序列号
hardwareVersion String 当前硬件版本号
firmwareVersion String 当前固件版本号
deviceWorkingStatus Int 设备工作状态
0:空闲
1:录制中
2:文件备份中
3:文件下载中
4:演示稿导出中
5:演示稿导入中
encodeMode Int APP 预览画面编码方式
0:标清,720p; 1:高清,1080p; 2:自动; 3:自定义
ftbEnable Int 是否启用 FTB
0:否;1:是
ftbSceneId Int 演示稿启用的FTB画面ID
musicStatus MusicStatus BGM 播放状态
observerStatus ObserverStatus 观察员状态
osdId Int 当前启用的 GFX ID
pdfConfig PdfConfig 当前画面中 PDF 图层相关配置
recordStatus RecordStatus 录制状态
sceneStatus SceneStatus 当前画面状态
srtStatus SrtStatus 采集画面 SRT 流服务状态信息
videoPlayerStatus VideoPlayerStatus 当前画面中视频播放状态
webBrowser WebBrowser 当前画面中网页图层相关配置
MusicStatus
参数名称 类型 描述
currentMusicId Int 当前播放音乐 ID
duration Int 音频文件时长,单位:毫秒
policy Int 播放策略
1:顺序播放;2:随机播放; 3:单曲循环;4:整体循环
progress Int 播放进度,范围为0~1000000
status Int 播放暂停状态
0:暂停;1:播放
ObserverStatus
参数名称 类型 描述
observerAnnotateEnable Bool 允许观察员注解画面。
true:允许; false:不允许
observerCount Int 观察员数量
0:无;1:1人;2:2人
observerLocked Bool 锁定观察员可见画面。
true:锁定; false:不锁定
onlineClientCount Int 在线的移动设备数量
operatorClientId String 操作员使用的移动设备的唯一标识
PdfConfig
参数名称 类型 描述
sceneId Int 画面 ID
layerId Int 含有 PDF 的图层 ID,图层在图层数组中的位置
sourceTotalPageNumber Int PDF 文件总页数
pdfPosition Int 当前预览位置,(页码-1) * 100
pdfScale Int 缩放属性,1~5 * 10000
pdfScaleMode Int 缩放模式,
0:自由
1:维持页面原比例
2:适合页面大小
3:适合窗口宽度
RecordStatus
参数名称 类型 描述
endCountDown Int 结束计时器,秒
endstartTimestamp Int 自动录制结束时间戳,毫秒
lastRecordError Int 最后一次录制异常信息
recordState Int 录制状态
0:停止
1:普通录制中
2:计划录制中
3:等待计划录制
4:计划录制已结束
recording Int 自动录制任务状态
0:未启用;1:录制中
scheduleRecordEndTime String 自动录制结束时间,设备所在时区
scheduleRecordStartTime String 自动录制开始时间,设备所在时区
startCountDown Int 启动倒计时,秒
startTimestamp Int 自动录制开始时间戳,毫秒
timeRecording Int 录制持续时间,秒
timeRemaining Int 可用录制时间,秒
SceneStatus
参数名称 类型 描述
cropping Int 是否处于图层裁剪编辑状态
0:否;1:是
croppingLayerId Int 裁剪编辑的图层 ID
currentShowId Int 当前演示稿 ID
currentID Int 当前预览画面 ID
defaultNoteBgId Int 默认笔记背景资源 ID
editSceneId Int 编辑的画面 ID
editing Int 是否处于画面编辑状态
0:否;1:是
isFrozen Int 预览画面是否被冻结
0:否;1:是
lastNoteId Int 最后一次预览的笔记 ID
lastSceneId Int 最后一次预览的画面 ID
location Int 画面位置
画中画 -- 1:左上、2:右上、3:左下、4:右下
分屏画面 -- 1:最左、2:中间偏左 3:中间、4:中间偏右、5:最右
modeOfButton Int 设备按键绑定模式
0:默认,按键指向预置场景
1:自定义,按键指向用户设置的功能
2:自动,按键指向演示稿前5个画面
noteEditing Int 是否在编辑笔记
0:否;1:是
sceneOfButton1 Int 设备按键一指向的画面ID(可通过获取画面列表获得)或事件ID
sceneOfButton2 Int 设备按键二指向的画面ID(可通过获取画面列表获得)或事件ID
sceneOfButton3 Int 设备按键三指向的画面ID(可通过获取画面列表获得)或事件ID
sceneOfButton4 Int 设备按键四指向的画面ID(可通过获取画面列表获得)或事件ID
sceneOfButton5 Int 设备按键五指向的画面ID(可通过获取画面列表获得)或事件ID
sourceCollection Int 资源组合
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
videoRangeSetting Int 正在截取视频
videoRangeSettingLayerId Int 正在被截取的视频的图层ID
SrtStatus
参数名称 类型 描述
srtId Int SRT推流ID
0:预览画面; 1:HDMI 1; 2:HDMI 2; 3:Web Camera
port Int 端口号
stoped Int SRT推流启停状态
1:停止;0:启动
VideoPlayerStatus
参数名称 类型 描述
layerId Int 图层ID,图层在图层数组中的位置
playStatus Int 播放状态
0:暂停;1:播放
progress Int 播放进度,0~1000000
sceneId Int 画面ID
sourceDuration Int 视频文件持续时长,毫秒
sourceId Int 视频文件资源ID
videoRangeEnd Int 视频切割起点位置,ms
videoRangeStart Int 视频切割终点位置,ms
WebBrowser
参数名称 类型 描述
canGoBack Int 是否可后退
0:否;1:是
canGoForward Int 是否可前进
0:否;1:是
currentScale Int 缩放属性,1~5 * 10000

4.示例

获取设备状态信息。

输入示例
None
输出示例
{
    "info": {
        "annotationStatus": {...},
        "autoBackup": 0,
        "deviceName": "USB Fusion A506220808456-1",
        "deviceWorkingStatus": 0,
        "encodeMode": 0,
        "firmwareVersion": "2.6.1",
        "ftbEnable": 0,
        "ftbSceneId": 0,
        "hardwareVersion": "A",
        "musicStatus": {
            "currentMusicId": 0,
            "duration": 0,
            "policy": 1,
            "progress": 0,
            "status": 0
        },
        "observerStatus": {
            "observerAnnotateEnable": true,
            "observerCount": 0,
            "observerLocked": true,
            "onlineClientCount": 0,
            "operatorClientId": ""
        },
        "osdId": 0,
        "pdfConfig": {
            "layerId": 0,
            "pdfPosition": 0,
            "pdfScale": 10000,
            "pdfScaleMode": 0,
            "sceneId": 0,
            "sourceTotalPageNumber": 0
        },
        "recordStatus": {
            "endCountDown": -1,
            "endstartTimestamp": 0,
            "lastRecordError": 0,
            "recordState": 0,
            "recording": 0,
            "scheduleRecordEndTime": "",
            "scheduleRecordStartTime": "",
            "startCountDown": -1,
            "startTimestamp": 0,
            "timeRecording": 0,
            "timeRemaining": 106571
        },
        "sceneStatus": {
            "cropping": 0,
            "croppingLayerId": 0,
            "currentID": 101,
            "currentShowId": 9,
            "defaultNoteBgId": 1001,
            "editSceneId": 0,
            "editing": 0,
            "isFrozen": 0,
            "lastNoteId": 0,
            "lastSceneId": 101,
            "location": 0,
            "modeOfButton": 0,
            "noteEditing": 0,
            "sceneOfButton1": 1,
            "sceneOfButton2": 2,
            "sceneOfButton3": 3,
            "sceneOfButton4": 4,
            "sceneOfButton5": 5,
            "sourceCollection": 0,
            "videoRangeSetting": 0,
            "videoRangeSettingLayerId": 0
        },
        "serialNumber": "A506220808456",
        "srtStatus": [
            {
                "port": 9110,
                "srtId": 0,
                "stoped": 1
            },
            {
                "port": 9111,
                "srtId": 1,
                "stoped": 1
            },
            {
                "port": 9112,
                "srtId": 2,
                "stoped": 1
            },
            {
                "port": 9113,
                "srtId": 3,
                "stoped": 1
            },
            {
                "port": 9114,
                "srtId": 4,
                "stoped": 0
            }
        ],
        "videoPlayerStatus": [
            {
                "layerId": 0,
                "playStatus": 1,
                "progress": 2436,
                "sceneId": 101,
                "sourceDuration": 27500,
                "sourceId": 2135,
                "videoRangeEnd": 27500,
                "videoRangeStart": 0
            }
        ],
        "webBrowser": {
            "canGoBack": 0,
            "canGoForward": 0,
            "currentScale": 10000
        }
    },
    "message": "success",
    "result": 0
}

5.错误码

无接口业务逻辑相关的错误码,其他错误码详见 公共错误码

与“”相关结果约

    找不到与“”相关的结果