Socket对象
appKey
会议成员对象的集合
集合的key为成员的uri, key为 self 表示自己(即: participantMap['self'] === selfParticipant)
获取录制控制对象
代表自己的会议成员对象
获取client状态
设置client状态
获取视频布局对象
添加事件监听器
要监听的事件类型
事件监听回调
若添加成功则返回一个函数, 用于移除事件监听
对多个事件添加同一个事件监听器
要监听的事件类型
事件监听回调
设置监听器参数
若添加成功则返回一个函数, 用于移除事件监听
清空所有绑定的事件
分发事件
分发的事件对象
事件是否发送成功
简化分发事件接口, 如需要分发的是错误事件, error参数传入具体错误类型
事件类型
消息
错误类型
指定类型的事件是否被监听
移除事件监听器, 要提供与调用addEventListener或addEventListeners时相同的参数
要移除的事件监听器类型
要移除的事件监听器
返回true表示有该fun监听器并且移除成功
发送在线消息, 与sendMessage的区别是sendOnlineMessage在client登录后即可调用.
在线消息发送的结果会通过两种途径体现:
resolve / reject 状态.true / false.通过监听ConferenceEventType.ONLINE_MESSAGE_RECEIVE事件可以接收其他人发送的在线消息, 接收的对象解构如下:
| 属性名 | 类型 | 描述 |
|---|---|---|
| fromUserId | string | 发送者的uri |
| content | string | 发送的消息内容 |
使用示例如下:
// 获取发送结果方式1
this.client.sendOnlineMessage('toUserId', 'content')
.then(() => {
wx.showModal({content: `在线消息发送成功`}).then();
})
.catch((reason) => {
wx.showModal({title: '在线消息发送失败', content: reason.message}).then();
});
// 获取发送结果方式2
this.client.addEventListener(ConferenceEventType.ONLINE_MESSAGE_SENT, (ev) => {
wx.showModal({content: `在线消息发送成功${ev.message.result ? '成功' : '失败'}`}).then();
});
// 接收在线消息
this.client.addEventListener(ConferenceEventType.ONLINE_MESSAGE_RECEIVE, (ev) => {
wx.showModal({title: '接收到在线消息', content: `发送者: ${ev.message.fromUserId}\n内容: ${ev.message.content}`}).then();
});
消息发送对象的 userId, 也可传入{@link _participantMap}的value.
消息内容, 如传入json对象会通过{@link JSON}字符串化
发送信令消息, 可指定发送的目的地
信令消息
设置小程序当前页面的 this
Generated using TypeDoc
微信小程序视频访客模块