要监听的事件类型
事件监听回调
若添加成功则返回一个函数, 用于移除事件监听
添加事件监听器
若添加成功则返回一个函数, 用于移除事件监听
对多个事件添加同一个事件监听器
要监听的事件类型
事件监听回调
设置监听器参数
若添加成功则返回一个函数, 用于移除事件监听
对多个事件添加同一个事件监听器
若添加成功则返回一个函数, 用于移除事件监听
清空所有绑定的事件
取消订阅会议音频流
关闭上传音频
关闭的可选选项 | name | default value | description | | ---- | ------------- | ----------- | | signal | true | 发送关闭音频发送的信令 | | render | true | 停止在界面上渲染音频流 | | source | true | 停止发送音视流 |
关闭视频流上传
关闭的可选选项 | name | default value | description | | ---- | ------------- | ----------- | | signal | true | 发送关闭视频发送的信令 | | render | true | 停止在界面上渲染视频流 | | source | true | 停止发送视频流 |
分发事件
分发的事件对象
事件是否发送成功
简化的dispatchEvent接口
具体错误类型, 此时 dispatchEventLite的 type 应是一个 xxxEventType.Error 类型
订阅会议音频流，关闭订阅将无法听到会议中其他成员的声音
开启音频流上传
开启的可选选项 | name | default value | description | | ---- | ------------- | ----------- | | signal | true | 发送开启音频发送的信令 | | render | true | 开始在界面上渲音频流 | | source | true | 开始发送音频流 |
开启视频流上传
开启的可选选项 | name | default value | description | | ---- | ------------- | ----------- | | signal | true | 发送开启视频发送的信令 | | render | true | 开始在界面上渲视频流 | | source | true | 开始发送视频流 |
指定类型的事件是否被监听
client.inviteSipUser({
calleeNumber: 'xxx',
coreNetwork: 'xxx'
})
.then(() => {
// todo 邀请sip用户成功
})
.catch(() => {
// todo 邀请sip用户失败
});
加入一个会议，结果回调由ConferenceEventType.CONFERENCE_JOIN上报
离开会议，结果回调由ConferenceEventType.CONFERENCE_LEAVE上报
创建CD并登录
登出
根据 channelId(房间号) 查询会议是否存在
移除事件监听器, 要提供与调用addEventListener或addEventListeners时相同的参数
要移除的事件监听器类型
要移除的事件监听器
返回 true 表示移除成功
请求用户的视频流 当 pictureSize 为 PictureSizeNone 标识关闭请求
频道中发送消息，当 toUserId 不为 null 时，content 不能大于 4k 此接口调用成功后，消息接收方会收到 ConferenceEventType.MESSAGE_RECEIVE 事件，通过此事件可以获取消息的文本类型和文本内容
发送在线消息
发送文本消息，消息内容不能大于4K 通话中的其他成员会收到ConferenceEventType.TEXT_MESSAGE_RECEIVE_NOTIFY事件
设置音频路由, 听筒或扬声器等
设置CD合流的画布参数
设置对端接收到的访客画面的宽高比
微信小程序本地画面无需设置{@link RenderType}
开启服务端录制.
使用服务端录制, 需要在加入会议时设置ConferenceJoinParam.enableRecord设置为 true. 在收到录制CD加入会议的事件后再调用startRemoteRecord.
await client.join('roomId', true, {enableRecord: true});
// 字面量方式
client.addEventListener('conferenceParticipantJoin', ({message}) => {
const {participant} = message.data;
if (participant.type === 3) {
client.startRemoteRecord({...});
}
});
// TS方式
client.addEventListener(ConferenceEventType.CONFERENCE_PARTICIPANT_JOIN, ({message}) => {
const {participant} = message.data;
if (participant.type === ParticipantType.IRC) {
client.startRemoteRecord({...});
}
});
获得视频对象，通过此对象能获得远端画面用于UI显示
结束会议，由返回的Promise或ConferenceEventType.CONFERENCE_LEAVE事件表示结果.
client.stop()
.then(() => {
// todo
})
.catch((reason) => {
// todo
})
// or
client.stop();
client.addEventListener(ConferenceEventType.CONFERENCE_LEAVE, (ev) => {
const result = ev.message.result;
// todo
});
关闭服务端录制.
切换摄像头
Generated using TypeDoc
添加事件监听器