共享事件订阅
共享事件订阅,主要涉及共享相关的事件通知,通过订阅事件,您可以实现接收投屏码更新通知/共享状态更新通知 等功能。
1. 投屏码更新通知 (CastCodeUpdate)
事件说明
1)事件解释:当用户收到该事件时,代表投屏码有更新
2)引入版本: 3.8.10
3)所属模块(method):Event/Share
4)事件名(sub_event):CastCodeUpdate
5)触发条件: Rooms更新投屏码时,会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
cast_code | string | 投屏码 |
示例
{
"jsonrpc":"2.0",
"method":"Event/Share",
"result":{
"error_code":0,
"message":"",
"data":{
"cast_code":"AAA BBB"
}
},
"sub_event": "CastCodeUpdate"
}
2. 共享状态更新通知 (ShareStateUpdate)
事件说明
1)事件解释:当用户收到该事件时,代表当前有用户处于共享状态
2)引入版本: 3.9.150
3)所属模块(method):Event/Share
4)事件名(sub_event):ShareStateUpdate
5)触发条件: 用户通过Rooms或CSAPI共享屏幕时,都会收到这个事件通知
事件参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
screen | bool | 屏幕是否开启: |
up_web_share_on | bool | 是否通过web共享: |
is_hid_device_wireless | bool | 是否插入hdmi线: |
up_audio_share_on | bool | 是否共享音频: |
is_hdmi_sharing | bool | 是否通过hdmi投屏: |
screis_desktop_shareen | bool | 是否桌面共享: |
is_support_desktop_share | bool | 是否支持桌面共享: |
is_airplay_sharing | bool | 是否airplay共享: |
nickname | string | 用户昵称 |
quick_casting_state | int | 会前投屏状态: |
from_controller_init | bool | 是否是控制器端: |
示例
{
"jsonrpc": "2.0",
"method": "Event/Share",
"result": {
"error_code": 0,
"message": "成功",
"data": {
"screen": true,
"up_web_share_on": false,
"is_hid_device_wireless": false,
"up_audio_share_on": false,
"is_hdmi_sharing": false,
"is_screen_pause": false,
"is_desktop_share": true,
"is_support_desktop_share": true,
"is_airplay_sharing": false,
"nickname": "xxx",
"quick_casting_state": 0,
"from_controller_init": false
}
},
"sub_event": "ShareStateUpdate"
}