@tencentcloud/tuiroom-engine-js 2.2.1 → 2.2.3

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/types.d.ts DELETED
@@ -1,743 +0,0 @@
1
- export declare enum TUIErrorCode {
2
- ERR_SUCC = 0,
3
- ERR_FAILED = -1,
4
- ERR_FREQ_LIMIT = -2,
5
- ERR_REPEAT_OPERATION = -3,
6
- ERR_SDKAPPID_NOT_FOUND = -1000,
7
- ERR_INVALID_PARAMETER = -1001,
8
- ERR_SDK_NOT_INITIALIZED = -1002,
9
- ERR_PERMISSION_DENIED = -1003,
10
- ERR_REQUIRE_PAYMENT = -1004,
11
- ERR_CAMERA_START_FAILED = -1100,
12
- ERR_CAMERA_NOT_AUTHORIZED = -1101,
13
- ERR_CAMERA_OCCUPIED = -1102,
14
- ERR_CAMERA_DEVICE_EMPTY = -1103,
15
- ERR_MICROPHONE_START_FAILED = -1104,
16
- ERR_MICROPHONE_NOT_AUTHORIZED = -1105,
17
- ERR_MICROPHONE_OCCUPIED = -1106,
18
- ERR_MICROPHONE_DEVICE_EMPTY = -1107,
19
- ERR_GET_SCREEN_SHARING_TARGET_FAILED = -1108,
20
- ERR_START_SCREEN_SHARING_FAILED = -1109,
21
- ERR_ROOM_ID_NOT_EXIST = -2100,
22
- ERR_OPERATION_INVALID_BEFORE_ENTER_ROOM = -2101,
23
- ERR_EXIT_NOT_SUPPORTED_FOR_ROOM_OWNER = -2102,
24
- ERR_OPERATION_NOT_SUPPORTED_IN_CURRENT_ROOM_TYPE = -2103,
25
- ERR_OPERATION_NOT_SUPPORTED_IN_CURRENT_SPEECH_MODE = -2104,
26
- ERR_ROOM_ID_INVALID = -2105,
27
- ERR_ROOM_ID_OCCUPIED = -2106,
28
- ERR_ROOM_NAME_INVALID = -2107,
29
- ERR_ALREADY_IN_OTHER_ROOM = -2108,
30
- ERR_USER_NOT_EXIST = -2200,
31
- ERR_USER_NOT_ENTERED = -2201,
32
- ERR_NEED_OWNER_PERMISSION = -2300,
33
- ERR_NEED_ADMIN_PERMISSION = -2301,
34
- ERR_REQUEST_NO_PERMISSION = -2310,
35
- ERR_REQUEST_ID_INVALID = -2311,
36
- ERR_REQUEST_ID_REPEAT = -2312,
37
- ERR_REQUEST_ID_CONFLICT = -2313,
38
- ERR_MAX_SEAT_COUNT_LIMIT = -2340,
39
- ERR_ALREADY_IN_SEAT = -2341,
40
- ERR_SEAT_OCCUPIED = -2342,
41
- ERR_SEAT_LOCKED = -2343,
42
- ERR_SEAT_INDEX_NOT_EXIST = -2344,
43
- ERR_USER_NOT_IN_SEAT = -2345,
44
- ERR_ALL_SEAT_OCCUPIED = -2346,
45
- ERR_SEAT_NOT_SUPPORT_LINK_MIC = -2347,
46
- ERR_OPEN_MICROPHONE_NEED_SEAT_UNLOCK = -2360,
47
- ERR_OPEN_MICROPHONE_NEED_PERMISSION_FROM_ADMIN = -2361,
48
- ERR_OPEN_CAMERA_NEED_SEAT_UNLOCK = -2370,
49
- ERR_OPEN_CAMERA_NEED_PERMISSION_FROM_ADMIN = -2371,
50
- ERR_OPEN_SCREEN_SHARE_NEED_SEAT_UNLOCK = -2372,
51
- ERR_OPEN_SCREEN_SHARE_NEED_PERMISSION_FROM_ADMIN = -2373,
52
- ERR_SEND_MESSAGE_DISABLED_FOR_ALL = -2380,
53
- ERR_SEND_MESSAGE_DISABLED_FOR_CURRENT = -2381
54
- }
55
- export type TUIRoomInfo = {
56
- roomId: string;
57
- roomName: string;
58
- roomType: TUIRoomType;
59
- isSeatEnabled: boolean;
60
- seatMode: TUISeatMode;
61
- isMicrophoneDisableForAllUser: boolean;
62
- isScreenShareDisableForAllUser: boolean;
63
- isCameraDisableForAllUser: boolean;
64
- isMessageDisableForAllUser: boolean;
65
- maxSeatCount: number;
66
- roomOwner: string;
67
- createTime: number;
68
- roomMemberCount: number;
69
- };
70
- export type TUILoginUserInfo = {
71
- userId: string;
72
- userName: string;
73
- avatarUrl: string;
74
- customInfo: Record<string, any>;
75
- };
76
- export type TUISeatLockParams = {
77
- lockSeat: boolean;
78
- lockVideo: boolean;
79
- lockAudio: boolean;
80
- };
81
- export declare enum TUIRole {
82
- kRoomOwner = 0,
83
- kAdministrator = 1,
84
- kGeneralUser = 2
85
- }
86
- /**
87
- * 消息结构体
88
- * @typedef {object} TUIMessage
89
- * @property {string} messageId 消息 Id
90
- * @property {string} message 消息内容
91
- * @property {number} timestamp 时间戳信息, 精确到秒
92
- * @property {TUIRole} userId 用户 Id
93
- * @property {boolean} userName 用户名称
94
- * @property {boolean} avatarUrl 用户头像地址
95
- */
96
- export type TUIMessage = {
97
- messageId: string;
98
- message: string;
99
- timestamp: number;
100
- userId: string;
101
- userName: string;
102
- avatarUrl: string;
103
- };
104
- export declare enum TUIVideoQuality {
105
- kVideoQuality_360p = 1,
106
- kVideoQuality_540p = 2,
107
- kVideoQuality_720p = 3,
108
- kVideoQuality_1080p = 4
109
- }
110
- export declare enum TUIAudioQuality {
111
- kAudioProfileSpeech = 0,
112
- kAudioProfileDefault = 1,
113
- kAudioProfileMusic = 2
114
- }
115
- export declare enum TUIVideoStreamType {
116
- kCameraStream = 0,
117
- kScreenStream = 1,
118
- kCameraStreamLow = 2
119
- }
120
- export declare enum TUINetworkQuality {
121
- kQualityUnknown = 0,
122
- kQualityExcellent = 1,
123
- kQualityGood = 2,
124
- kQualityPoor = 3,
125
- kQualityBad = 4,
126
- kQualityVeryBad = 5,
127
- kQualityDown = 6
128
- }
129
- /**
130
- * 消息结构体
131
- * @typedef {object} TUINetwork
132
- * @property {string} userId 用户 Id
133
- * @property {TUINetworkQuality} quality 网络质量
134
- * @property {number} upLoss 上行丢包率,单位 (%) 该数值越小越好,目前仅本地用户有该信息
135
- * @property {TUIRole} downLoss 下行丢包率,单位 (%) 该数值越小越好,目前仅本地用户有该信息
136
- * @property {Number} delay 网络延迟,单位 ms,目前仅本地用户有该信息
137
- */
138
- export type TUINetwork = {
139
- userId: string;
140
- quality: TUINetworkQuality;
141
- upLoss: number;
142
- downLoss: number;
143
- delay: number;
144
- };
145
- /**
146
- * 视频编码参数
147
- * @typedef {object} TUIVideoEncoderParams
148
- * @property {number} fps 帧率设置
149
- * @property {number} bitrate 目标编码码率设置
150
- * @property {TUIVideoQuality} quality 上行视频分辨率
151
- * @property {TUIVideoQuality} videoResolution 上行视频分辨率(自 v1.6.0 版本开始支持,v1.6.0 之前版本请使用 quality 参数)
152
- * @property {TUIResolutionMode} resolutionMode 横竖屏模式
153
- */
154
- export type TUIVideoEncoderParams = {
155
- quality?: TUIVideoQuality;
156
- videoResolution: TUIVideoQuality;
157
- fps: number;
158
- bitrate: number;
159
- resolutionMode: TUIResolutionMode;
160
- };
161
- export declare enum TUIRoomType {
162
- kConference = 1,
163
- kLivingRoom = 2
164
- }
165
- export declare enum TUISpeechMode {
166
- kFreeToSpeak = 1,
167
- kApplyToSpeak = 2,
168
- kSpeakAfterTakingSeat = 3
169
- }
170
- export declare enum TUISeatMode {
171
- kFreeToTake = 1,
172
- kApplyToTake = 2
173
- }
174
- export declare enum TUIMediaDevice {
175
- kMicrophone = 1,
176
- kCamera = 2,
177
- kScreen = 3
178
- }
179
- export declare enum TUICaptureSourceType {
180
- kWindow = 0,
181
- kScreen = 1
182
- }
183
- export declare enum TUIChangeReason {
184
- kChangedBySelf = 0,
185
- kChangedByAdmin = 1
186
- }
187
- export declare enum TUIKickedOutOfRoomReason {
188
- kKickedByAdmin = 0,
189
- kKickedByLoggedOnOtherDevice = 1,
190
- kKickedByServer = 2
191
- }
192
- export declare enum TUIRequestAction {
193
- kInvalidAction = 0,
194
- kRequestToOpenRemoteCamera = 1,
195
- kRequestToOpenRemoteMicrophone = 2,
196
- kRequestToConnectOtherRoom = 3,
197
- kRequestToTakeSeat = 4,
198
- kRequestRemoteUserOnSeat = 5,
199
- kApplyToAdminToOpenLocalCamera = 6,
200
- kApplyToAdminToOpenLocalMicrophone = 7,
201
- kApplyToAdminToOpenLocalScreenShare = 8
202
- }
203
- export declare enum TUIRequestCallbackType {
204
- kRequestAccepted = 0,
205
- kRequestRejected = 1,
206
- kRequestCancelled = 2,
207
- kRequestTimeout = 3,
208
- kRequestError = 4
209
- }
210
- export declare enum TRTCRole {
211
- kAnchor = 0,
212
- kAudience = 1
213
- }
214
- export declare enum TUIResolutionMode {
215
- kResolutionMode_Landscape = 0,
216
- kResolutionMode_Portrait = 1
217
- }
218
- export type TUIUserInfo = {
219
- userId: string;
220
- userName: string;
221
- avatarUrl: string;
222
- userRole: TUIRole;
223
- hasAudioStream: boolean;
224
- hasVideoStream: boolean;
225
- hasScreenStream: boolean;
226
- roomCustomInfo: Record<string, any>;
227
- };
228
- export type TUISeatInfo = {
229
- index: number;
230
- userId: string;
231
- locked: boolean;
232
- isVideoLocked: boolean;
233
- isAudioLocked: boolean;
234
- };
235
- export type TUIRequest = {
236
- requestAction: TUIRequestAction;
237
- timestamp: number;
238
- requestId: string;
239
- userId: string;
240
- content: string;
241
- };
242
- export type TUIRequestCallback = {
243
- requestCallbackType: TUIRequestCallbackType;
244
- requestId: string;
245
- userId: string;
246
- code: number;
247
- message: string;
248
- };
249
- export declare enum TUIMediaDeviceType {
250
- kMediaDeviceTypeUnknown = -1,
251
- kMediaDeviceTypeAudioInput = 0,
252
- kMediaDeviceTypeAudioOutput = 1,
253
- kMediaDeviceTypeVideoCamera = 2
254
- }
255
- export declare enum TUIMediaDeviceState {
256
- kMediaDeviceStateAdd = 0,
257
- kMediaDeviceStateRemove = 1,
258
- kMediaDeviceStateActive = 2
259
- }
260
- export declare enum TUIAudioRoute {
261
- kAudioRouteSpeakerphone = 0,
262
- kAudioRouteEarpiece = 1
263
- }
264
- export type TUIDeviceInfo = {
265
- deviceId: string;
266
- deviceName: string;
267
- deviceProperties?: {
268
- supportedResolution?: {
269
- width: number;
270
- height: number;
271
- }[];
272
- };
273
- };
274
- /**
275
- * **TUIRoomEngine 事件列表**<br>
276
- * @namespace TUIRoomEvents
277
- * @example
278
- * import TUIRoomEngine, { TUIRoomEvents } from '@tencentcloud/tuiroom-engine-js';
279
- * const roomEngine = new TUIRoomEngine();
280
- * roomEngine.on(TUIRoomEvents.onError, (error) => {
281
- * console.log('roomEngine.error', error);
282
- * })
283
- */
284
- export declare enum TUIRoomEvents {
285
- /**
286
- *
287
- * @description 错误事件
288
- * @event TUIRoomEvents#onError
289
- * @param {object} options
290
- * @param {number} options.code 错误代码
291
- * @param {string} options.message 错误信息
292
- * @example
293
- * const roomEngine = new TUIRoomEngine();
294
- * roomEngine.on(TUIRoomEvents.onError, (error) => {
295
- * console.log('TUIRoomError error', error);
296
- * })
297
- */
298
- onError = "onError",
299
- /**
300
- * @description 踢出房间事件
301
- * @default 'onKickedOutOfRoom'
302
- * @event TUIRoomEvents#onKickedOutOfRoom
303
- * @param {object} options
304
- * @param {string} options.roomId 房间号
305
- * @param {TUIKickedOutOfRoomReason} options.reason 用户被踢出房间枚举
306
- * @param {string} options.message 踢出房间信息
307
- * @example
308
- * const roomEngine = new TUIRoomEngine();
309
- * roomEngine.on(TUIRoomEvents.onKickedOutOfRoom, ({ roomId, reason, message }) => {
310
- * console.log('roomEngine.onKickedOutOfRoom', roomId, reason, message);
311
- * });
312
- */
313
- onKickedOutOfRoom = "onKickedOutOfRoom",
314
- /**
315
- * @description 当前用户被踢下线
316
- * @default 'onKickedOffLine'
317
- * @event TUIRoomEvents#onKickedOffLine
318
- * @param {string} options.message 用户被踢下线信息
319
- * @example
320
- * const roomEngine = new TUIRoomEngine();
321
- * roomEngine.on(TUIRoomEvents.onKickedOffLine, ({ message }) => {
322
- * console.log('roomEngine.onKickedOffLine', message);
323
- * });
324
- */
325
- onKickedOffLine = "onKickedOffLine",
326
- /**
327
- * @description userSig 过期事件
328
- * @default 'onUserSigExpired'
329
- * @event TUIRoomEvents#onUserSigExpired
330
- * @example
331
- * const roomEngine = new TUIRoomEngine();
332
- * roomEngine.on(TUIRoomEvents.onUserSigExpired, () => {
333
- * console.log('roomEngine.onUserSigExpired');
334
- * });
335
- */
336
- onUserSigExpired = "onUserSigExpired",
337
- /**
338
- * @description 主持人销毁房间事件
339
- * @default 'onRoomDismissed'
340
- * @event TUIRoomEvents#onRoomDismissed
341
- * @param {object} options
342
- * @param {string} options.roomId 房间号
343
- * @example
344
- * const roomEngine = new TUIRoomEngine();
345
- * roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId }) => {
346
- * console.log('roomEngine.onRoomDismissed', roomId);
347
- * });
348
- */
349
- onRoomDismissed = "onRoomDismissed",
350
- /**
351
- * @description 房间名字修改事件
352
- * @default 'onRoomNameChanged'
353
- * @event TUIRoomEvents#onRoomChanged
354
- * @param {object} options
355
- * @param {string} options.roomName 房间名字
356
- * @example
357
- * const roomEngine = new TUIRoomEngine();
358
- * roomEngine.on(TUIRoomEvents.onRoomNameChanged, ({ roomId, roomName }) =>{
359
- * console.log('roomEngine.onRoomNameChanged', roomId, roomName);
360
- * });
361
- */
362
- onRoomNameChanged = "onRoomNameChanged",
363
- /**
364
- * @description 房间模式修改事件
365
- * @deprecated 该事件自 v2.0.0 版本废弃
366
- * @default 'onRoomSpeechModeChanged'
367
- * @event TUIRoomEvents#onRoomSpeechModeChanged
368
- * @param {object} options
369
- * @param {TUISpeechMode} options.speechMode 房间模式
370
- * @example
371
- * const roomEngine = new TUIRoomEngine();
372
- * roomEngine.on(TUIRoomEvents.onRoomSpeechModeChanged, ({ roomId, speechMode }) =>{
373
- * console.log('roomEngine.onRoomSpeechModeChanged', roomId, speechMode);
374
- * });
375
- */
376
- onRoomSpeechModeChanged = "onRoomSpeechModeChanged",
377
- /**
378
- * @description 上麦模式修改事件
379
- * @default 'onRoomSeatModeChanged'
380
- * @event TUIRoomEvents#onRoomSeatModeChanged
381
- * @param {object} options
382
- * @param {TUISeatMode} options.seatMode 房间上麦模式
383
- * @example
384
- * const roomEngine = new TUIRoomEngine();
385
- * roomEngine.on(TUIRoomEvents.onRoomSeatModeChanged, ({ roomId, seatMode }) =>{
386
- * console.log('roomEngine.onRoomSeatModeChanged', roomId, seatMode);
387
- * });
388
- */
389
- onRoomSeatModeChanged = "onRoomSeatModeChanged",
390
- /**
391
- * @description 所有成员摄像头使用权限改变事件
392
- * @default 'onAllUserCameraDisableChanged'
393
- * @event TUIRoomEvents#onAllUserCameraDisableChanged
394
- * @param {object} options
395
- * @param {boolean} options.isDisable 是否允许使用摄像头
396
- * @example
397
- * const roomEngine = new TUIRoomEngine();
398
- * roomEngine.on(TUIRoomEvents.onAllUserCameraDisableChanged, ({ isDisable }) =>{
399
- * console.log('roomEngine.onAllUserCameraDisableChanged', isDisable);
400
- * });
401
- */
402
- onAllUserCameraDisableChanged = "onAllUserCameraDisableChanged",
403
- /**
404
- * @since v2.2.0
405
- * @description 房间内所有用户屏幕分享被禁用事件
406
- * @default 'onScreenShareForAllUserDisableChanged'
407
- * @event TUIRoomEvents#onScreenShareForAllUserDisableChanged
408
- * @param {object} options
409
- * @param {boolean} options.isDisable 是否开启禁止屏幕分享
410
- * @example
411
- * const roomEngine = new TUIRoomEngine();
412
- * roomEngine.on(TUIRoomEvents.onScreenShareForAllUserDisableChanged, ({ isDisable }) =>{
413
- * console.log('roomEngine.onScreenShareForAllUserDisableChanged', isDisable);
414
- * });
415
- */
416
- onScreenShareForAllUserDisableChanged = "onScreenShareForAllUserDisableChanged",
417
- /**
418
- * @description 所有成员麦克风使用权限改变事件
419
- * @default 'onAllUserMicrophoneDisableChanged'
420
- * @event TUIRoomEvents#onAllUserMicrophoneDisableChanged
421
- * @param {object} options
422
- * @param {boolean} options.isDisable 是否允许使用麦克风
423
- * @example
424
- * const roomEngine = new TUIRoomEngine();
425
- * roomEngine.on(TUIRoomEvents.onAllUserMicrophoneDisableChanged, ({ isDisable }) =>{
426
- * console.log('roomEngine.onAllUserMicrophoneDisableChanged', isDisable);
427
- * });
428
- */
429
- onAllUserMicrophoneDisableChanged = "onAllUserMicrophoneDisableChanged",
430
- /**
431
- * @description 所有成员发送消息权限改变事件
432
- * @default 'onSendMessageForAllUserDisableChanged'
433
- * @event TUIRoomEvents#OnSendMessageForAllUserDisableChanged
434
- * @param {object} options
435
- * @param {boolean} options.isDisable 是否被允许
436
- * @example
437
- * const roomEngine = new TUIRoomEngine();
438
- * roomEngine.on(TUIRoomEvents.onSendMessageForAllUserDisableChanged, ({ isDisable }) =>{
439
- * console.log('roomEngine.onSendMessageForAllUserDisableChanged', isDisable);
440
- * });
441
- */
442
- onSendMessageForAllUserDisableChanged = "onSendMessageForAllUserDisableChanged",
443
- /**
444
- * @description 房间最大麦位数修改事件
445
- * @default 'onRoomMaxSeatCountChanged'
446
- * @event TUIRoomEvents#onRoomMaxSeatCountChanged
447
- * @param {object} options
448
- * @param {boolean} options.maxSeatNumber 最大麦位数
449
- * @example
450
- * const roomEngine = new TUIRoomEngine();
451
- * roomEngine.on(TUIRoomEvents.onRoomMaxSeatCountChanged, ({ maxSeatNumber }) =>{
452
- * console.log('roomEngine.onRoomMaxSeatCountChanged', maxSeatNumber);
453
- * });
454
- */
455
- onRoomMaxSeatCountChanged = "onRoomMaxSeatCountChanged",
456
- /**
457
- * @description 远端用户进入房间事件
458
- * @default 'onRemoteUserEnterRoom'
459
- * @event TUIRoomEvents#onRemoteUserEnterRoom
460
- * @param {object} options
461
- * @param {string} options.roomId 房间号
462
- * @param {TUIUserInfo} options.userInfo 用户信息
463
- * @example
464
- * const roomEngine = new TUIRoomEngine();
465
- * roomEngine.on(TUIRoomEvents.onRemoteUserEnterRoom, ({ roomId, userInfo }) => {
466
- * console.log('roomEngine.onRemoteUserEnterRoom', roomId, userInfo);
467
- * });
468
- */
469
- onRemoteUserEnterRoom = "onRemoteUserEnterRoom",
470
- /**
471
- * @description 远端用户离开房间事件
472
- * @default 'onRemoteUserLeaveRoom'
473
- * @event TUIRoomEvents#onRemoteUserLeaveRoom
474
- * @param {object} options
475
- * @param {string} options.roomId 房间号
476
- * @param {TUIUserInfo} options.userInfo 用户信息
477
- * @example
478
- * const roomEngine = new TUIRoomEngine();
479
- * roomEngine.on(TUIRoomEvents.onRemoteUserLeaveRoom, ({ roomId, userInfo }) => {
480
- * console.log('roomEngine.onRemoteUserLeaveRoom', roomId, userInfo);
481
- * });
482
- */
483
- onRemoteUserLeaveRoom = "onRemoteUserLeaveRoom",
484
- /**
485
- * @description 用户角色改变事件
486
- * @default 'onKickedOutOfRoom'
487
- * @event TUIRoomEvents#onUserRoleChanged
488
- * @param {object} options
489
- * @param {string} options.userId 用户Id
490
- * @param {TUIRole} options.userRole 用户变更后的角色
491
- * @example
492
- * const roomEngine = new TUIRoomEngine();
493
- * roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userId, userRole }) => {
494
- * console.log('roomEngine.onUserRoleChanged', userId, userRole);
495
- * });
496
- */
497
- onUserRoleChanged = "onUserRoleChanged",
498
- /**
499
- * @description 用户视频状态改变事件
500
- * @default 'onUserVideoStateChanged'
501
- * @event TUIRoomEvents#onUserVideoStateChanged
502
- * @param {object} options
503
- * @param {string} options.userId 用户Id
504
- * @param {TUIVideoStreamType} options.streamType 用户流类型
505
- * @param {boolean} options.hasVideo 是否有视频流
506
- * @param {TUIChangeReason} options.reason 变更原因
507
- * @example
508
- * const roomEngine = new TUIRoomEngine();
509
- * roomEngine.on(TUIRoomEvents.onUserVideoStateChanged, ({ userId, streamType, hasVideo, reason }) => {
510
- * console.log('roomEngine.onUserVideoStateChanged', userId, streamType, hasVideo, reason);
511
- * });
512
- */
513
- onUserVideoStateChanged = "onUserVideoStateChanged",
514
- /**
515
- * @description 用户音频状态改变事件
516
- * @default 'onUserAudioStateChanged'
517
- * @event TUIRoomEvents#onUserAudioStateChanged
518
- * @param {object} options
519
- * @param {string} options.userId 用户Id
520
- * @param {boolean} options.hasVideo 是否有音频流
521
- * @param {TUIChangeReason} options.reason 原因
522
- * @example
523
- * const roomEngine = new TUIRoomEngine();
524
- * roomEngine.on(TUIRoomEvents.onUserAudioStateChanged, ({ userId, hasAudio, reason }) => {
525
- * console.log('roomEngine.onUserAudioStateChanged', userId, hasAudio, reason);
526
- * });
527
- */
528
- onUserAudioStateChanged = "onUserAudioStateChanged",
529
- /**
530
- * @description 用户发送消息状态改变事件
531
- * @default 'onSendMessageForUserDisableChanged'
532
- * @event TUIRoomEvents#onSendMessageForUserDisableChanged
533
- * @param {object} options
534
- * @param {string} options.userId 成员 Id
535
- * @param {boolean} options.isDisable 是否被允许
536
- * @example
537
- * const roomEngine = new TUIRoomEngine();
538
- * roomEngine.on(TUIRoomEvents.onSendMessageForUserDisableChanged, ({ userId, isDisable }) =>{
539
- * console.log('roomEngine.onSendMessageForUserDisableChanged', isDisable);
540
- * });
541
- */
542
- onSendMessageForUserDisableChanged = "onSendMessageForUserDisableChanged",
543
- /**
544
- * @description 用户音量改变事件
545
- * @default 'onUserVoiceVolumeChanged'
546
- * @event TUIRoomEvents#onUserVoiceVolumeChanged
547
- * @param {object} options
548
- * @param {Array<TRTCVolumeInfo>} options.userVolumeList 房间内所有用户的音量, 包含 userId 及 volume 信息,volume 区间为 1~100;
549
- * @example
550
- * const roomEngine = new TUIRoomEngine();
551
- * roomEngine.on(TUIRoomEvents.onUserVoiceVolumeChanged, ({ userVolumeList }) => {
552
- * userVolumeList.forEach(userVolume => {
553
- * console.log('roomEngine.onUserVoiceVolumeChanged', userVolume.userId, userVolume.volume);
554
- * })
555
- * });
556
- */
557
- onUserVoiceVolumeChanged = "onUserVoiceVolumeChanged",
558
- /**
559
- * @description 用户网络质量改变事件
560
- * @default 'onUserNetworkQualityChanged'
561
- * @event TUIRoomEvents#onUserNetworkQualityChanged
562
- * @param {object} options
563
- * @param {TUINetwork} options.userNetworkList 网络质量信息
564
- * @example
565
- * const roomEngine = new TUIRoomEngine();
566
- * roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, ({ userNetworkList }) => {
567
- * userNetworkList.forEach(userNetwork => {
568
- * console.log('roomEngine.onUserNetworkQualityChanged',
569
- * userNetwork.userId, userNetwork.quality, userNetwork.upLoss, userNetwork.downLoss, userNetwork.delay);
570
- * })
571
- * });
572
- */
573
- onUserNetworkQualityChanged = "onUserNetworkQualityChanged",
574
- /**
575
- * @description 麦位列表改变事件
576
- * @default 'onSeatListChanged'
577
- * @event TUIRoomEvents#onSeatListChanged
578
- * @param {object} options
579
- * @param {Array<TUISeatInfo>} options.seatList 麦位列表
580
- * @param {Array<TUISeatInfo>} options.seatedList 新增麦位列表
581
- * @param {Array<TUISeatInfo>} options.leftList 离开的麦位列表
582
- * @example
583
- * const roomEngine = new TUIRoomEngine();
584
- * roomEngine.on(TUIRoomEvents.onSeatListChanged, ({ seatList, seatedList, leftList }) => {
585
- * console.log('roomEngine.onSeatListChanged',seatList, seatedList, leftList);
586
- * });
587
- */
588
- onSeatListChanged = "onSeatListChanged",
589
- /**
590
- * @description 当前用户被踢下麦事件
591
- * @default 'onKickedOffSeat'
592
- * @event TUIRoomEvents#onKickedOffSeat
593
- * @example
594
- * const roomEngine = new TUIRoomEngine();
595
- * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
596
- * console.log('roomEngine.onKickedOffSeat', userId);
597
- * });
598
- */
599
- onKickedOffSeat = "onKickedOffSeat",
600
- /**
601
- * @description 请求接收事件
602
- * @default 'onRequestReceived'
603
- * @event TUIRoomEvents#onRequestReceived
604
- * @param {object} options
605
- * @param {TUIRequest} options.request 请求接收
606
- * @example
607
- * const roomEngine = new TUIRoomEngine();
608
- * roomEngine.on(TUIRoomEvents.onRequestReceived, ({ request }) => {
609
- * console.log('roomEngine.onRequestReceived', request);
610
- * });
611
- */
612
- onRequestReceived = "onRequestReceived",
613
- /**
614
- * @description 请求取消事件
615
- * @default 'onRequestCancelled'
616
- * @event TUIRoomEvents#onRequestCancelled
617
- * @param {object} options
618
- * @param {string} options.requestId 请求Id
619
- * @param {string} options.userId 取消请求的用户Id
620
- * @example
621
- * const roomEngine = new TUIRoomEngine();
622
- * roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ requestId, userId }) => {
623
- * console.log('roomEngine.onRequestCancelled', requestId, userId);
624
- * });
625
- */
626
- onRequestCancelled = "onRequestCancelled",
627
- /**
628
- * @description 请求被其他 管理员/房主 处理事件
629
- * @default 'onRequestProcessed'
630
- * @event TUIRoomEvents#onRequestProcessed
631
- * @param {object} options
632
- * @param {string} options.requestId 请求Id
633
- * @param {string} options.userId 处理该请求的 管理员/房主 的用户ID
634
- * @example
635
- * const roomEngine = new TUIRoomEngine();
636
- * roomEngine.on(TUIRoomEvents.onRequestProcessed, ({ requestId, userId }) => {
637
- * console.log('roomEngine.onRequestProcessed', requestId, userId);
638
- * });
639
- */
640
- onRequestProcessed = "onRequestProcessed",
641
- /**
642
- * @description 接收文本消息事件
643
- * @deprecated 该接口自 v2.0.0 版本废弃,请使用 tim 实例监听收消息事件
644
- * @default 'onReceiveTextMessage'
645
- * @event TUIRoomEvents#onReceiveTextMessage
646
- * @param {object} options
647
- * @param {string} options.roomId 房间Id
648
- * @param {TUIMessage} options.message 接收的文本消息
649
- * @example
650
- * const roomEngine = new TUIRoomEngine();
651
- * roomEngine.on(TUIRoomEvents.onReceiveTextMessage, ({ roomId, message }) => {
652
- * console.log('roomEngine.onReceiveTextMessage', roomId, message);
653
- * });
654
- */
655
- onReceiveTextMessage = "onReceiveTextMessage",
656
- /**
657
- * @description 接收自定义消息事件
658
- * @deprecated 该接口自 v2.0.0 版本废弃,请使用 tim 实例监听收消息事件
659
- * @default 'onReceiveCustomMessage'
660
- * @event TUIRoomEvents#onReceiveCustomMessage
661
- * @param {object} options
662
- * @param {string} options.roomId 房间Id
663
- * @param {TUIMessage} options.message 接收的自定义消息
664
- * @example
665
- * const roomEngine = new TUIRoomEngine();
666
- * roomEngine.on(TUIRoomEvents.onReceiveCustomMessage, ({ roomId, message }) => {
667
- * console.log('roomEngine.onReceiveCustomMessage', roomId, message);
668
- * });
669
- */
670
- onReceiveCustomMessage = "onReceiveCustomMessage",
671
- /**
672
- * @description 设备变更事件
673
- * @default 'onDeviceChange'
674
- * @event TUIRoomEvents#onDeviceChange
675
- * @param {object} options
676
- * @param {string} options.deviceId 设备 Id
677
- * @param {TRTCDeviceType} options.type 设备类型
678
- * @param {TRTCDeviceState} options.state 设备变更状态
679
- * @example
680
- * const roomEngine = new TUIRoomEngine();
681
- * roomEngine.on(TUIRoomEvents.onDeviceChange, ({ deviceId, type, state }) => {
682
- * console.log('roomEngine.onDeviceChange', deviceId, type, state);
683
- * });
684
- */
685
- onDeviceChange = "onDeviceChange",
686
- /**
687
- * @description 屏幕分享停止事件,当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时,该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。
688
- * @default 'onUserScreenCaptureStopped'
689
- * @event TUIRoomEvents#onUserScreenCaptureStopped
690
- * @example
691
- * const roomEngine = new TUIRoomEngine();
692
- * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, () => {
693
- * console.log('roomEngine.onUserScreenCaptureStopped');
694
- * });
695
- */
696
- onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
697
- }
698
- export declare enum TUIRoomDeviceMangerEvents {
699
- /**
700
- * @description 设备变更事件
701
- * @default 'onDeviceChange'
702
- * @event TUIRoomDeviceMangerEvents#onDeviceChange
703
- * @param {object} options
704
- * @param {string} options.deviceId 设备 Id
705
- * @param {TRTCDeviceType} options.type 设备类型
706
- * @param {TRTCDeviceState} options.state 设备变更状态
707
- * @example
708
- * const roomEngine = new TUIRoomEngine();
709
- * const deviceManager = roomEngine.getDeviceManager();
710
- * deviceManager.on(TUIRoomDeviceMangerEvents.onDeviceChange, ({ deviceId, type, state }) => {
711
- * console.log('deviceManager.onDeviceChange', deviceId, type, state);
712
- * });
713
- */
714
- onDeviceChanged = "onDeviceChanged",
715
- /**
716
- * @description 麦克风测试音量
717
- * @default 'onTestMicVolume'
718
- * @event TUIRoomDeviceMangerEvents#onTestMicVolume
719
- * @param {object} options
720
- * @param {number} options.volume 麦克风测试音量(0-100)
721
- * @example
722
- * const roomEngine = new TUIRoomEngine();
723
- * const deviceManager = roomEngine.getDeviceManager();
724
- * deviceManager.on(TUIRoomDeviceMangerEvents.onTestMicVolume, ({ volume }) => {
725
- * console.log('deviceManager.onTestMicVolume', volume);
726
- * });
727
- */
728
- onTestMicVolume = "onTestMicVolume",
729
- /**
730
- * @description 扬声器测试音量,仅 Electron 端支持
731
- * @default 'onTestSpeakerVolume'
732
- * @event TUIRoomDeviceMangerEvents#onTestSpeakerVolume
733
- * @param {object} options
734
- * @param {number} options.volume 扬声器测试音量(0-100)
735
- * @example
736
- * const roomEngine = new TUIRoomEngine();
737
- * const deviceManager = roomEngine.getDeviceManager();
738
- * deviceManager.on(TUIRoomDeviceMangerEvents.onTestSpeakerVolume, ({ volume }) => {
739
- * console.log('deviceManager.onTestSpeakerVolume', volume);
740
- * });
741
- */
742
- onTestSpeakerVolume = "onTestSpeakerVolume"
743
- }