设置观察员
1.接口描述
接口说明:设置观察员的数量和权限。
请求方式:
- 固件版本 V2.6.0 及以上:POST [ip]/mwapi/V2.0/app/set-observer-settings
- 固件版本 V2.5.0 及以下:POST [ip]/mwapi/set-observer-settings
管理员权限 | 登录认证 |
---|---|
否 | 是 |
2.输入参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
observerCount | 是 | Int | 观察员数量。 0:无;1:1人;2:2人 |
observerLocked | 是 | Boolean | 锁定观察员可见画面。 true:锁定; false:不锁定 |
observerAnnotateEnable | 是 | Boolean | 允许观察员注解画面。 true:允许; false:不允许 |
3.输出参数
参数名称 | 类型 | 描述 |
---|---|---|
status | Int | 状态码 |
message | String | 状态描述 |
4.示例
设置 1 名观察员,不锁定画面,允许注解。
输入示例
{
"observerCount": 1,
"observerLocked": false,
"observerAnnotateEnable": true
}
输出示例
{
"message": "success",
"status": 0
}
5.错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 定义 | 说明 |
---|---|---|
49 | MW_STATUS_INVALID_DATA | 参数缺失或错误 |