@tencentcloud/tuiroom-engine-js 1.0.2 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -27
- package/index.cjs.js +2 -2
- package/index.d.ts +512 -443
- package/index.esm.js +2 -2
- package/index.js +2 -2
- package/package.json +3 -3
- package/types.d.ts +143 -69
package/README.md
CHANGED
|
@@ -48,11 +48,6 @@ function onKickedOutOfRoom(eventInfo) {
|
|
|
48
48
|
console.log(`roomId: ${eventInfo.roomId}, ${eventInfo.message}`);
|
|
49
49
|
}
|
|
50
50
|
|
|
51
|
-
// 用户是否被禁止发消息
|
|
52
|
-
function onUserMuteStateChanged(eventInfo) {
|
|
53
|
-
console.log(`user ${eventInfo.userId} isMute:${eventInfo.muted}`);
|
|
54
|
-
}
|
|
55
|
-
|
|
56
51
|
// 用户签名 userSig 过期
|
|
57
52
|
function onUserSigExpired() {
|
|
58
53
|
console.log('userSig expire');
|
|
@@ -63,11 +58,6 @@ function onKickedOffLine(eventInfo) {
|
|
|
63
58
|
console.log(`user offline, reason: ${eventInfo.message}`);
|
|
64
59
|
}
|
|
65
60
|
|
|
66
|
-
// 房间信息变更
|
|
67
|
-
function onRoomInfoChanged(eventInfo) {
|
|
68
|
-
console.log(`roomInfo ${JSON.stringify(eventInfo)}`);
|
|
69
|
-
}
|
|
70
|
-
|
|
71
61
|
// 设备变化：设备切换、设备插拔事件
|
|
72
62
|
function onDeviceChange(eventInfo) {
|
|
73
63
|
console.log(`deviceChange ${JSON.stringify(eventInfo)}`);
|
|
@@ -80,10 +70,8 @@ async function init() {
|
|
|
80
70
|
roomEngine.on(TUIRoomEvents.onUserVoiceVolumeChanged, onUserVoiceVolumeChanged);
|
|
81
71
|
roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, onUserNetworkQualityChanged);
|
|
82
72
|
roomEngine.on(TUIRoomEvents.onKickedOutOfRoom, onKickedOutOfRoom);
|
|
83
|
-
roomEngine.on(TUIRoomEvents.onUserMuteStateChanged, onUserMuteStateChanged);
|
|
84
73
|
roomEngine.on(TUIRoomEvents.onUserSigExpired, onUserSigExpired);
|
|
85
74
|
roomEngine.on(TUIRoomEvents.onKickedOffLine, onKickedOffLine);
|
|
86
|
-
roomEngine.on(TUIRoomEvents.onRoomInfoChanged, onRoomInfoChanged);
|
|
87
75
|
roomEngine.on(TUIRoomEvents.onDeviceChange, onDeviceChange);
|
|
88
76
|
});
|
|
89
77
|
|
|
@@ -103,44 +91,49 @@ init();
|
|
|
103
91
|
| :-------------------------------- | :----------------- |
|
|
104
92
|
| [TUIRoomEngine.login](https://cloud.tencent.com/document/product/647/81970#login) | 登录 TUIRoomEngine |
|
|
105
93
|
| [TUIRoomEngine.setSelfInfo](https://cloud.tencent.com/document/product/647/81970#setSelfInfo) | 设置当前用户基本信息（用户名、用户头像） |
|
|
94
|
+
| [TUIRoomEngine.getSelfInfo](https://cloud.tencent.com/document/product/647/81970#getSelfInfo) | 获取当前用户信息 |
|
|
106
95
|
| [TUIRoomEngine.logout](https://cloud.tencent.com/document/product/647/81970#logout) | 登出 TUIRoomEngine |
|
|
107
96
|
| [roomEngine.createRoom](https://cloud.tencent.com/document/product/647/81970#createRoom) | 创建房间 |
|
|
108
97
|
| [roomEngine.enterRoom](https://cloud.tencent.com/document/product/647/81970#enterRoom) | 进入房间 |
|
|
109
98
|
| [roomEngine.destroyRoom](https://cloud.tencent.com/document/product/647/81970#destroyRoom) | 销毁房间 |
|
|
110
99
|
| [roomEngine.exitRoom](https://cloud.tencent.com/document/product/647/81970#exitRoom) | 离开房间 |
|
|
111
|
-
| [roomEngine.
|
|
112
|
-
| [roomEngine.
|
|
100
|
+
| [roomEngine.fetchRoomInfo](https://cloud.tencent.com/document/product/647/81970#fetchRoomInfo) | 获取房间信息 |
|
|
101
|
+
| [roomEngine.updateRoomNameByAdmin](https://cloud.tencent.com/document/product/647/81970#updateRoomNameByAdmin) | 更新房间的名字（仅群主或者管理员可以调用） |
|
|
102
|
+
| [roomEngine.updateRoomSpeechModeByAdmin](https://cloud.tencent.com/document/product/647/81970#updateRoomSpeechModeByAdmin) | 更新房间的发言模式 |
|
|
113
103
|
| [roomEngine.getUserList](https://cloud.tencent.com/document/product/647/81970#getUserList) | 获取当前房间用户列表 |
|
|
114
104
|
| [roomEngine.getUserInfo](https://cloud.tencent.com/document/product/647/81970#getUserInfo) | 获取用户的详细信息 |
|
|
115
105
|
| [roomEngine.takeSeat](https://cloud.tencent.com/document/product/647/81970#takeSeat) | 获取麦位 |
|
|
106
|
+
| [roomEngine.setMaxSeatCount](https://cloud.tencent.com/document/product/647/81970#setMaxSeatCount) | 设置房间麦位最大值 |
|
|
116
107
|
| [roomEngine.leaveSeat](https://cloud.tencent.com/document/product/647/81970#leaveSeat) | 释放麦位 |
|
|
108
|
+
| [roomEngine.lockSeatByAdmin](https://cloud.tencent.com/document/product/647/81970#lockSeatByAdmin) | 锁定某个麦位状态 |
|
|
117
109
|
| [roomEngine.getSeatList](https://cloud.tencent.com/document/product/647/81970#getSeatList) | 获取麦位信息 |
|
|
118
|
-
| [roomEngine.
|
|
119
|
-
| [roomEngine.
|
|
120
|
-
| [roomEngine.
|
|
121
|
-
| [roomEngine.
|
|
122
|
-
| [roomEngine.
|
|
123
|
-
| [roomEngine.kickRemoteUserOffSeat](https://cloud.tencent.com/document/product/647/81970#kickRemoteUserOffSeat) | 要求其他人下麦 |
|
|
110
|
+
| [roomEngine.openRemoteDeviceByAdmin](https://cloud.tencent.com/document/product/647/81970#openRemoteDeviceByAdmin) | 请求远端用户打开摄像头 |
|
|
111
|
+
| [roomEngine.applyToAdminToOpenLocalDevice](https://cloud.tencent.com/document/product/647/81970#applyToAdminToOpenLocalDevice) | 参会者向主持人申请打开设备 |
|
|
112
|
+
| [roomEngine.closeRemoteDeviceByAdmin](https://cloud.tencent.com/document/product/647/81970#closeRemoteDeviceByAdmin) | 关闭远端用户设备 |
|
|
113
|
+
| [roomEngine.takeUserOnSeatByAdmin](https://cloud.tencent.com/document/product/647/81970#takeUserOnSeatByAdmin) | 邀请其他人上麦 |
|
|
114
|
+
| [roomEngine.kickUserOffSeatByAdmin](https://cloud.tencent.com/document/product/647/81970#kickUserOffSeatByAdmin) | 要求其他人下麦 |
|
|
124
115
|
| [roomEngine.cancelRequest](https://cloud.tencent.com/document/product/647/81970#cancelRequest) | 取消已经发出的请求 |
|
|
125
116
|
| [roomEngine.responseRemoteRequest](https://cloud.tencent.com/document/product/647/81970#responseRemoteRequest) | 回复远端用户的请求 |
|
|
126
|
-
| [roomEngine.
|
|
117
|
+
| [roomEngine.setLocalVideoView](https://cloud.tencent.com/document/product/647/81970#setLocalVideoView) | 设置本地流的渲染位置 |
|
|
127
118
|
| [roomEngine.openLocalCamera](https://cloud.tencent.com/document/product/647/81970#openLocalCamera) | 本地摄像头视频流采集 |
|
|
128
119
|
| [roomEngine.closeLocalCamera](https://cloud.tencent.com/document/product/647/81970#closeLocalCamera) | 关闭本地摄像头 |
|
|
129
120
|
| [roomEngine.openLocalMicrophone](https://cloud.tencent.com/document/product/647/81970#openLocalMicrophone) | 打开本地麦克风 |
|
|
130
121
|
| [roomEngine.closeLocalMicrophone](https://cloud.tencent.com/document/product/647/81970#closeLocalMicrophone) | 关闭本地麦克风 |
|
|
131
|
-
| [roomEngine.
|
|
132
|
-
| [roomEngine.
|
|
122
|
+
| [roomEngine.updateVideoQuality](https://cloud.tencent.com/document/product/647/81970#updateVideoQuality) | 设置本地视频流的编码参数 |
|
|
123
|
+
| [roomEngine.updateAudioQuality](https://cloud.tencent.com/document/product/647/81970#updateAudioQuality) | 设置本地音频的参数 |
|
|
133
124
|
| [roomEngine.startPushLocalVideo](https://cloud.tencent.com/document/product/647/81970#startPushLocalVideo) | 开始向远端推本地视频流 |
|
|
134
125
|
| [roomEngine.stopPushLocalVideo](https://cloud.tencent.com/document/product/647/81970#stopPushLocalVideo) | 停止向远端推本地视频流 |
|
|
135
126
|
| [roomEngine.startPushLocalAudio](https://cloud.tencent.com/document/product/647/81970#startPushLocalAudio) | 开始向远端推本地音频流 |
|
|
136
127
|
| [roomEngine.stopPushLocalAudio](https://cloud.tencent.com/document/product/647/81970#stopPushLocalAudio) | 停止向远端推本地音频流 |
|
|
137
|
-
| [roomEngine.
|
|
128
|
+
| [roomEngine.setRemoteVideoView](https://cloud.tencent.com/document/product/647/81970#setRemoteVideoView) | 设置远端流渲染的区域 |
|
|
138
129
|
| [roomEngine.startPlayRemoteVideo](https://cloud.tencent.com/document/product/647/81970#startPlayRemoteVideo) | 开始播放远端用户视频流 |
|
|
139
130
|
| [roomEngine.stopPlayRemoteVideo](https://cloud.tencent.com/document/product/647/81970#stopPlayRemoteVideo) | 停止播放远端用户视频流 |
|
|
131
|
+
| [roomEngine.muteRemoteAudioStream](https://cloud.tencent.com/document/product/647/81970#muteRemoteAudioStream) | 停止播放远端用户的音频流 |
|
|
140
132
|
| [roomEngine.changeUserRole](https://cloud.tencent.com/document/product/647/81970#changeUserRole) | 改变用户的角色 |
|
|
141
|
-
| [roomEngine.
|
|
142
|
-
| [roomEngine.
|
|
143
|
-
| [roomEngine.
|
|
133
|
+
| [roomEngine.kickRemoteUserOutOfRoom](https://cloud.tencent.com/document/product/647/81970#kickRemoteUserOutOfRoom) | 将用户踢出房间 |
|
|
134
|
+
| [roomEngine.disableDeviceForAllUserByAdmin](https://cloud.tencent.com/document/product/647/81970#disableDeviceForAllUserByAdmin) | 所有用户的设备是否允许被使用 |
|
|
135
|
+
| [roomEngine.disableSendingMessageForAllUser](https://cloud.tencent.com/document/product/647/81970#disableSendingMessageForAllUser) | 所有用户的是否允许发消息 |
|
|
136
|
+
| [roomEngine.disableSendingMessageByAdmin](https://cloud.tencent.com/document/product/647/81970#disableSendingMessageByAdmin) | 特定用户是否被允许发消息 |
|
|
144
137
|
| [roomEngine.sendTextMessage](https://cloud.tencent.com/document/product/647/81970#sendTextMessage) | 发送文本消息 |
|
|
145
138
|
| [roomEngine.sendCustomMessage](https://cloud.tencent.com/document/product/647/81970#sendCustomMessage) | 发送自定义消息 |
|
|
146
139
|
| [roomEngine.startScreenSharing](https://cloud.tencent.com/document/product/647/81970#startScreenSharing) | 开始屏幕共享 |
|