更新时间:2022-08-25 GMT+08:00
分享

开始暂隐图像

接口名称

WEB_StartSendBlueScreenAPI

功能描述

开始暂隐图像。对应的停止暂隐图像的接口为WEB_StopSendBlueScreenAPI。只有在会议中,才能调用该接口。终端是否入会,可以通过 请求邮箱数据 中的 conftype 字段查看。该字段非0时,表示当前在会议中。

应用场景

启用该功能时,会向对端发送蓝屏并关闭本端MIC。处理结果由消息MSG_VIDEO_HIDDEN上报。

URL

https://ip/action.cgi?ActionID=WEB_StartSendBlueScreenAPI

参数

返回值

表1 开始暂隐图像返回值

参数

类型

取值范围

参数说明

success

int

[0, 1]

响应结果

0:失败

1:成功

data

Object

可选, 空对象

成功返回数据。这里返回空。

例如:{"success":1,"data":""}

error

Object

可选

失败返回错误信息。详细参考表2

例如:{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}}

表2 error

参数

类型

取值范围

参数说明

id

int

32位整数

错误id,用于转换。

code

int

32位整数

错误码,跟错误id对应,具体含义参考错误码

param

Object

param 对象

失败响应的附带参数。

相关文档