获取设备通用设置
1.接口描述
接口说明:获取设备通用设置。
请求方式:
- 固件版本 V2.6.0 及以上:POST [ip]/mwapi/V2.0/general/get-server-settings
- 固件版本 V2.5.0 及以下:POST [ip]/mwapi/get-server-settings
| 管理员权限 | 登录认证 |
|---|---|
| 否 | 是 |
2.输入参数
无
3.输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | Int | 状态码 |
| launchScene | Int | 开机画面 ID |
| autoSwitch | Int | 自动切换是否启用 0:不启用; 1:启用 |
| autoSwitchType | Int | 自动切换策略, 0:禁止自动切换 2:自动切换到优先级更高的信号 3: 自动切换到新信号 |
| autoSwitchSequence | Int | 信号优先级顺序,仅在“autoSwitchType”为 2 时有效。 1:HDMI 1;2:HDMI 2;3:WEBCAM;31:无线投屏画面 |
| usbMirror | Int | 是否启用对 USB-C 输出进行镜像 0:不启用; 1:启用 |
| mirroringVerificationMode | Int | 无线投屏验证方式 0:无验证;1:密码验证; 2:动态投屏码验证 |
| mirroringPasscode | String | 无线投屏验证密码,4位数字,仅在mirroringVerificationMode设置为1时生效 |
| participantsLayout | Int | 无线投屏布局模式。 0:单画面;1:多画面 |
| screencastBGColor | Int | 无线投屏画面背景色。rgba, uint32 |
| screencastNameEnable | Int | 在屏幕上叠加投屏设备名称。 1:叠加;0:不叠加 |
| screencastFormatEnable | Int | 在屏幕上叠加投屏图像尺寸和帧率。 1:叠加;0:不叠加 |
| screencastOverlayFadeOut | Int | 投屏叠加信息淡出方式 0:不淡出 1:5秒后淡出 2:10秒后淡出 3:20秒后淡出 4:30秒后淡出 5:1分钟后淡出 |
| utilityEnable | Int | 预留参数 |
| airPlayEnable | Int | 允许支持 AirPlay 的苹果设备或其他设备投屏。 1:允许; 0:不允许 |
| miracastEnable | Int | 允许支持 Miracast 的 Windows 设备或安卓设备等投屏。 1:允许; 0:不允许 |
| googleCastEnable | Int | 允许支持 Google Cast 的软件或设备投屏,如 Chrome Book 或 Chrome 浏览器。 1:允许; 0:不允许 |
| cropBlackArea | Int | 是否去除黑边,仅对 Miracast 生效。 1:是; 0:否 |
| gotoSleep | Int | 设备休眠策略 0:从不休眠; 1:30 分钟后休眠; 2:1 小时后休眠; 3:2 小时后休眠; 4:4 小时后休眠 5:8 小时后休眠 6:12 小时后休眠 |
| wakeOnClient | Int | 预留参数 |
| rebootWhenWakeUp | Int | 设备唤醒后立即重新启动设备, 1:重启; 0:不重启 |
| autoBackup | Int | 是否启用自动备份 0:否; 1:是 |
| backupSchedule | Int | 备份计划 0:全天; 1:每天限定时间段 |
| backupStartTime | Int | 每天限定时间段自动备份开始时间戳,毫秒 |
| backupEndTime | Int | 每天限定时间段自动备份结束时间戳,毫秒 |
4.示例
获取设备通用设置。
输入示例
None
输出示例
{
"status": 0,
"launchScene": 28,
"autoSwitch": 0,
"autoSwitchType": 0,
"autoSwitchSequence": [1,2,3,31],
"usbMirror": 0,
"mirroringVerificationMode": 0,
"mirroringPasscode": "",
"participantsLayout": 1,
"screencastBGColor": 255,
"screencastNameEnable": 1,
"screencastFormatEnable": 1,
"screencastOverlayFadeOut": 0,
"utilityEnable": 1,
"airPlayEnable": 1,
"miracastEnable": 1,
"googleCastEnable": 1,
"cropBlackArea": 1,
"gotoSleep": 0,
"wakeOnClient": 1,
"rebootWhenWakeUp": 0,
"autoBackup": 0,
"backupSchedule": 1,
"backupStartTime": 0,
"backupEndTime": 0
}
5.错误码
无接口业务逻辑相关的错误码,其他错误码详见 公共错误码。