2.3.1 • Published 13 days ago
@tencentcloud/tuiroom-engine-wx v2.3.1
TUIRoomEngine WX SDK
简介
TUIRoomEngine WX SDK 依托腾讯云 实时音视频 TRTC 和 即时通信 IM 服务,为用户提供房间管理,多人实时音视频互动,屏幕分享,成员管理,即时聊天等功能。
安装
// with npm
npm i @tencentcloud/tuiroom-engine-wx --save
// with yarn
yarn add @tencentcloud/tuiroom-engine-wx
// with pnpm
pnpm i @tencentcloud/tuiroom-engine-wx --save
示例代码
import TUIRoomEngine from '@tencentcloud/tuiroom-engine-wx';
let roomEngine = null;
// 错误
function onError(error) {
console.error(error);
}
// 音量变化
function onUserVoiceVolumeChanged(eventInfo) {
console.log(eventInfo.userVolumeList);
}
// 网络质量变化
function onUserNetworkQualityChanged(eventInfo) {
console.log(eventInfo.userNetworkList);
}
// 被踢出房间
function onKickedOutOfRoom(eventInfo) {
console.log(`roomId: ${eventInfo.roomId}, ${eventInfo.message}`);
}
// 用户是否被禁止发消息
function onUserMuteStateChanged(eventInfo) {
console.log(`user ${eventInfo.userId} isMute:${eventInfo.muted}`);
}
// 用户签名 userSig 过期
function onUserSigExpired() {
console.log('userSig expire');
}
// 被踢下线
function onKickedOffLine(eventInfo) {
console.log(`user offline, reason: ${eventInfo.message}`);
}
// 房间信息变更
function onRoomInfoChanged(eventInfo) {
console.log(`roomInfo ${JSON.stringify(eventInfo)}`);
}
async function init() {
TUIRoomEngine.once('ready', () => {
roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onError, onError);
roomEngine.on(TUIRoomEvents.onUserVoiceVolumeChanged, onUserVoiceVolumeChanged);
roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, onUserNetworkQualityChanged);
roomEngine.on(TUIRoomEvents.onKickedOutOfRoom, onKickedOutOfRoom);
roomEngine.on(TUIRoomEvents.onUserMuteStateChanged, onUserMuteStateChanged);
roomEngine.on(TUIRoomEvents.onUserSigExpired, onUserSigExpired);
roomEngine.on(TUIRoomEvents.onKickedOffLine, onKickedOffLine);
roomEngine.on(TUIRoomEvents.onRoomInfoChanged, onRoomInfoChanged);
roomEngine.on(TUIRoomEvents.onDeviceChange, onDeviceChange);
});
// sdkAppId 获取和 userSig 生成详见官网文档
// https://cloud.tencent.com/document/product/647/81962#step1
await TUIRoomEngine.login({ sdkAppId: 0, userId: '', userSig: '' });
await TUIRoomEngine.setSelfInfo({ userName: 'zhangsan', avatarUrl: 'https://testurl' });
}
init();
API 列表
参考文档
2.3.1
13 days ago
2.2.2
1 month ago
2.2.1
1 month ago
2.2.0
2 months ago
2.1.0
2 months ago
2.0.3
3 months ago
2.0.2
3 months ago
2.0.1
4 months ago
2.0.0
4 months ago
1.7.1
4 months ago
1.7.0
5 months ago
1.6.1
6 months ago
1.6.0
7 months ago
1.5.1
8 months ago
1.5.0
8 months ago
1.5.0-beta.1
9 months ago
1.5.0-beta.0
9 months ago
0.0.4
9 months ago
0.0.4-beta.1
9 months ago
0.0.4-beta.0
9 months ago
0.0.3
9 months ago
0.0.3-beta.0
9 months ago
0.0.2
9 months ago
0.0.1
9 months ago