会议控制事件订阅
会议控制事件订阅,主要涉及会议控制相关的事件通知,通过订阅事件,您可以实现接收焦点视频状态变更通知/静音所有成员通知/录制开始通知/请求录制通知/移除会中成员通知 等功能。
1. 焦点视频状态变更通知 (SpotLight)
事件说明
1)事件解释:当用户收到该事件时,代表完成了开启或关闭焦点视频的操作
2)引入版本: 3.9.150
3)所属模块(method):Event/MeetingControl
4)事件名(sub_event):SpotLight
5)触发条件: 用户通过Rooms或CSAPI开启或关闭焦点视频,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
type | int | 类型: |
user_id | string | 用户user_id,可通过 4. 参会者id列表 (ListMemberIds) 获取 |
示例
{
"jsonrpc":"2.0",
"method":"Event/MeetingControl",
"result":{
"error_code":0,
"message":"成功",
"data":{
"type":1,
"user_id": "xxx"
}
},
"sub_event": "SpotLight"
}
2. 静音所有成员通知 (MuteAll)
事件说明
1)事件解释:当用户收到该事件时,代表完成了静音所有成员
2)引入版本: 3.9.150
3)所属模块(method):Event/MeetingControl
4)事件名(sub_event):MuteAll
5)触发条件: 用户通过Rooms或CSAPI静音所有成员,都会收到这个事件通知
事件参数
无事件参数,失败返回错误消息
示例
{
"jsonrpc":"2.0",
"method":"Event/MeetingControl",
"result":{
"error_code":0,
"message":"成功",
"data":{
}
},
"sub_event": "MuteAll"
}
3. 录制开始通知 (RecordResult)
事件说明
1)事件解释:当用户收到该事件时,代表录制已经开始
2)引入版本: 3.9.150
3)所属模块(method):Event/MeetingControl
4)事件名(sub_event):RecordResult
5)触发条件: 用户通过Rooms或CSAPI开始录制,都会收到这个事件通知
事件参数
无事件参数,失败返回错误消息
示例
{
"jsonrpc":"2.0",
"method":"Event/MeetingControl",
"result":{
"error_code":0,
"message":"成功",
"data":{
}
},
"sub_event": "RecordResult"
}
4. 请求录制通知 (RequestRecord)
事件说明
1)事件解释:当用户收到该事件时,代表已经完成请求录制
2)引入版本: 3.9.150
3)所属模块(method):Event/MeetingControl
4)事件名(sub_event):RequestRecord
5)触发条件: 用户通过Rooms或CSAPI请求录制,都会收到这个事件通知
事件参数
无事件参数,失败返回错误消息
示例
{
"jsonrpc":"2.0",
"method":"Event/MeetingControl",
"result":{
"error_code":0,
"message":"成功",
"data":{
}
},
"sub_event": "RequestRecord"
}
5. 移除会中成员通知 (UserRemove)
事件说明
1)事件解释:当用户收到该事件时,代表已经完成移除指定会中成员
2)引入版本: 3.9.150
3)所属模块(method):Event/MeetingControl
4)事件名(sub_event):UserRemove
5)触发条件: 用户通过Rooms或CSAPI移除指定会中成员,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
data | array | user_id数组,user_id可通过 4. 参会者id列表 (ListMemberIds) 获取 |
示例
{
"jsonrpc": "2.0",
"method": "Event/MeetingControl",
"result": {
"error_code": 0,
"message": "成功",
"data": ["xxx"]
},
"sub_event": "UserRemove"
}