事件列表

最近更新时间:2024-11-26 16:04:13

我的收藏

侧边栏应用位置发生变化

事件名:sidebar-position-changed
描述:侧边栏应用位置发生变化时,触发此事件。
支持的客户端:Windows、Mac。
支持的版本: 2.17.0及以上版本。

WebAppPositionInfo 参数

参数名称
参数类型
参数描述
WebAppPosition
Number
应用位置:
1:弹窗
2:侧边栏
4:主视图内嵌
8:自定义布局
16:覆盖布局

会中自身信息发生变化

事件名:inmeeting-user-info
描述:会中自身信息发生变化时,触发此事件。
支持的客户端:iOS、Android、Windows、Mac。
支持的版本: 3.8.6及以上版本。

InmeetingUserInfo 参数

参数名称
参数类型
参数描述
isCohost
Boolean
是否是联席主持人。
isHost
Boolean
是否是主持人。
nickname
String
昵称。

语音激励成员发生变化

事件名:speaking-members-changed
描述:语音激励成员发生变化时,触发此事件。
支持的客户端:iOS、Android、Windows、Mac。
支持的版本: 3.9.2及以上版本。

MeetingUser 参数

参数名称
参数类型
参数描述
index
String
分页锚点,下一页数据不会包含此锚点用户。
msOpenId
String
用户在当前会议中临时 openId。
nickname
String
昵称。
openId
String
用户的 openId,未授权用户无此数据。
roleType
-
角色信息:
0:无类型
1:主持人
2:联席主持人
3:参会用户
4:内部嘉宾(定会的时候指定)
5:外部嘉宾(观众升级上来的)
6:嘉宾(降级再升级的是嘉宾)
7:观众
8:翻译员

用户音频状态变化

事件名:user-audio-status
描述:语音激励成员发生变化时,触发此事件。
支持的客户端:iOS、Android、Windows、Mac。
支持的版本:3.9.0及以上版本。

参数

参数名称
参数类型
参数描述
msOpenId
String
用户在当前会议中的临时 openId。
isAudioOn
Boolean
用户是否打开了音频。

用户入会

事件名:user-join
描述:用户加入会议时,触发此事件。
支持的客户端:iOS、Android、Windows、Mac。
支持的版本:3.9.0及以上版本。

MeetingOpenUserInfo 参数

参数名称
参数类型
参数描述
avatar
String
头像:特殊场景不返回(例如面试、pstn 等场景)。
msOpenId
String
用户在当前会议中的临时 openId。
nickname
String
昵称。
openCorpId
String
用户的企业 ID。
openId
String
用户的 OpenId,没有授权或授权失效则无此数据。
roleType

-
角色信息:
0:无类型
1:主持人
2:联席主持人
3:参会用户
4:内部嘉宾(定会的时候指定)
5:外部嘉宾(观众升级上来的)
6:嘉宾(降级再升级的是嘉宾)
7:观众
8:翻译员
userId
String
调用方用于标识用户的唯一 ID。