设备事件订阅
设备事件订阅,主要涉及设备相关的事件通知,通过订阅事件,您可以实现接收开启摄像头通知/开启麦克风通知/设置扬声器音量通知/选择扬声器通知/选择麦克风通知 等功能。
1. 开启摄像头通知 (EnableCamera)
事件说明
1)事件解释:当用户收到该事件时,代表完成了开启或关闭摄像头的操作
2)引入版本: 3.8.10
3)所属模块(method):Event/Device
4)事件名(sub_event):EnableCamera
5)触发条件: 用户通过Rooms或CSAPI开启或关闭摄像头,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
in_meeting | object | 会中信息,详见会中信息表 |
会中信息表(in_meeting)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
camera_open | bool | 是否开启摄像头: |
示例
{
"jsonrpc": "2.0",
"method":"Event/Device",
"result":{
"error_code":0,
"message":"",
"data":{
"in_meeting":{
"camera_open":false
}
}
},
"sub_event": "EnableCamera"
}
2. 开启麦克风通知 (EnableMic)
事件说明
1)事件解释:当用户收到该事件时,代表完成了开启或关闭麦克风的操作
2)引入版本: 3.8.10
3)所属模块(method):Event/Device
4)事件名(sub_event):EnableMic
5)触发条件: 用户通过Rooms或CSAPI开启或关闭麦克风,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
in_meeting | object | 会中信息,详见会中信息表 |
会中信息表(in_meeting)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
mic_open | bool | 是否开启麦克风: |
示例
{
"jsonrpc": "2.0",
"method":"Event/Device",
"result":{
"error_code":0,
"message":"",
"data":{
"in_meeting":{
"mic_open":false
}
}
},
"sub_event": "EnableMic"
}
3. 设置扬声器音量通知 (SetSpeakerVolume)
事件说明
1)事件解释:当用户收到该事件时,代表完成了设置扬声器音量的操作
2)引入版本: 3.8.10
3)所属模块(method):Event/Device
4)事件名(sub_event):SetSpeakerVolume
5)触发条件: 用户通过Rooms或CSAPI设置扬声器音量,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
in_meeting | object | 会中信息,详见会中信息表 |
会中信息表(in_meeting)
参数名称 | 参数类型 | 参数描述 |
---|---|---|
camera_open | int | 音量值,0-100 |
mute | bool | 扬声器是否静音: |
示例
{
"jsonrpc": "2.0",
"method":"Event/Device",
"result":{
"error_code":0,
"message":"",
"data":{
"in_meeting":{
"volume":50,
"mute": true
}
}
},
"sub_event": "SetSpeakerVolume"
}
4. 选择扬声器通知 (SelectSpeaker)
事件说明
1)事件解释:当用户收到该事件时,代表完成了选择扬声器的操作
2)引入版本: 3.9.150
3)所属模块(method):Event/Device
4)事件名(sub_event):SelectSpeaker
5)触发条件: 用户通过Rooms或CSAPI选择扬声器,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
device_id | string | 扬声器名称,可通过查询设备信息接口获取扬声器名称 |
is_system_device | bool | 是否是系统默认音频: |
示例
{
"jsonrpc": "2.0",
"method":"Event/Device",
"result":{
"error_code":0,
"message":"",
"data":{
"device_id": "xxx",
"is_system_device": false
}
},
"sub_event": "SelectSpeaker"
}
5. 选择麦克风通知 (SelectMic)
事件说明
1)事件解释:当用户收到该事件时,代表完成了选择麦克风的操作
2)引入版本: 3.9.150
3)所属模块(method):Event/Device
4)事件名(sub_event):SelectMic
5)触发条件: 用户通过Rooms或CSAPI选择麦克风,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
device_id | string | 麦克风名称,可通过查询设备信息接口获取摄像头名称 |
is_system_device | bool | 是否是系统默认音频: |
示例
{
"jsonrpc": "2.0",
"method": "Event/Device",
"result": {
"error_code": 0,
"message": "",
"data": {
"device_id": "xxx",
"is_system_device": false
}
},
"sub_event": "SelectMic"
}
6. 扬声器测试状态变化通知 (SpeakerTestStateChange)
事件说明
1)事件解释:当用户收到该事件时,代表正在测试扬声器且扬声器的状态有更新,停止或启动
2)引入版本: 3.9.150
3)所属模块(method):Event/Device
4)事件名(sub_event):SpeakerTestStateChange
5)触发条件: 用户通过Rooms或CSAPI测试扬声器时,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
state | int | 扬声器状态: |
示例
{
"jsonrpc": "2.0",
"method":"Event/Device",
"result":{
"error_code":0,
"message":"",
"data":{
"state": 0
}
},
"sub_event": "SpeakerTestStateChange"
}
7. 扬声器测试音量变化通知 (SpeakerTestVolumeChange)
事件说明
1)事件解释:当用户收到该事件时,代表正在测试扬声器且扬声器的音量有更新
2)引入版本: 3.9.150
3)所属模块(method):Event/Device
4)事件名(sub_event):SpeakerTestVolumeChange
5)触发条件: 用户通过Rooms或CSAPI测试扬声器时,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
volume | int | 音量值 0 - 100 |
示例
{
"jsonrpc": "2.0",
"method":"Event/Device",
"result":{
"error_code":0,
"message":"",
"data":{
"volume": 50
}
},
"sub_event": "SpeakerTestVolumeChange"
}
8. 麦克风测试状态变化通知 (MicTestStateChange)
事件说明
1)事件解释:当用户收到该事件时,代表正在测试麦克风且麦克风的状态有更新,停止或启动
2)引入版本: 3.9.150
3)所属模块(method):Event/Device
4)事件名(sub_event):MicTestStateChange
5)触发条件: 用户通过Rooms或CSAPI测试麦克风时,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
state | int | 麦克风状态: |
示例
{
"jsonrpc": "2.0",
"method":"Event/Device",
"result":{
"error_code":0,
"message":"",
"data":{
"state": 0
}
},
"sub_event": "MicTestStateChange"
}
9. 麦克风测试音量变化通知 (MicTestVolumeChange)
事件说明
1)事件解释:当用户收到该事件时,代表正在测试麦克风且麦克风的音量有更新
2)引入版本: 3.9.150
3)所属模块(method):Event/Device
4)事件名(sub_event):MicTestVolumeChange
5)触发条件: 用户通过Rooms或CSAPI测试麦克风时,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
volume | int | 音量值 0 - 100 |
示例
{
"jsonrpc": "2.0",
"method":"Event/Device",
"result":{
"error_code":0,
"message":"",
"data":{
"volume": 50
}
},
"sub_event": "MicTestVolumeChange"
}
10. 网络状态变化通知 (NetworkInfo)
事件说明
1)事件解释:Rooms网络状态通知的事件
2)引入版本: 3.13.190
3)所属模块(method):Event/Device
4)事件名(sub_event):NetworkInfo
5)触发条件: Rooms当前网络状态发生变化时,会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
network_level | int | 网络状态: |
示例
{
"jsonrpc": "2.0",
"method":"Event/Device",
"result":{
"error_code":0,
"message":"",
"data":{
"network_level": 1
}
},
"sub_event": "NetworkStateChange"
}