@tencentcloud/tuiroom-engine-electron 1.2.0 → 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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tencentcloud/tuiroom-engine-electron",
3
- "version": "1.2.0",
3
+ "version": "1.2.1",
4
4
  "description": "TUIRoomEngine Electron SDK",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
package/types.d.ts CHANGED
@@ -189,17 +189,6 @@ export declare enum TUIRoomEvents {
189
189
  * })
190
190
  */
191
191
  onError = "onError",
192
- /**
193
- * @description 当前用户被踢下麦事件
194
- * @default 'onKickedOffSeat'
195
- * @event TUIRoomEvents#onKickedOffSeat
196
- * @example
197
- * const roomEngine = new TUIRoomEngine();
198
- * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
199
- * console.log('roomEngine.onKickedOffSeat', userId);
200
- * });
201
- */
202
- onKickedOffSeat = "onKickedOffSeat",
203
192
  /**
204
193
  * @description 踢出房间事件
205
194
  * @default 'onKickedOutOfRoom'
@@ -277,7 +266,7 @@ export declare enum TUIRoomEvents {
277
266
  */
278
267
  onRoomSpeechModeChanged = "onRoomSpeechModeChanged",
279
268
  /**
280
- * @description 所有成员摄像头使用权限修改事件
269
+ * @description 所有成员摄像头使用权限改变事件
281
270
  * @default 'onAllUserCameraDisableChanged'
282
271
  * @event TUIRoomEvents#onAllUserCameraDisableChanged
283
272
  * @param {object} options
@@ -290,7 +279,7 @@ export declare enum TUIRoomEvents {
290
279
  */
291
280
  onAllUserCameraDisableChanged = "onAllUserCameraDisableChanged",
292
281
  /**
293
- * @description 所有成员麦克风使用权限修改事件
282
+ * @description 所有成员麦克风使用权限改变事件
294
283
  * @default 'onAllUserMicrophoneDisableChanged'
295
284
  * @event TUIRoomEvents#onAllUserMicrophoneDisableChanged
296
285
  * @param {object} options
@@ -303,7 +292,7 @@ export declare enum TUIRoomEvents {
303
292
  */
304
293
  onAllUserMicrophoneDisableChanged = "onAllUserMicrophoneDisableChanged",
305
294
  /**
306
- * @description 修改所有成员发送消息状态事件
295
+ * @description 所有成员发送消息权限改变事件
307
296
  * @default 'onSendMessageForAllUserDisableChanged'
308
297
  * @event TUIRoomEvents#OnSendMessageForAllUserDisableChanged
309
298
  * @param {object} options
@@ -315,20 +304,6 @@ export declare enum TUIRoomEvents {
315
304
  * });
316
305
  */
317
306
  onSendMessageForAllUserDisableChanged = "onSendMessageForAllUserDisableChanged",
318
- /**
319
- * @description 修改特定成员发送消息状态事件
320
- * @default 'onSendMessageForUserDisableChanged'
321
- * @event TUIRoomEvents#onSendMessageForUserDisableChanged
322
- * @param {object} options
323
- * @param {string} options.userId 成员 Id
324
- * @param {boolean} options.isDisable 是否被允许
325
- * @example
326
- * const roomEngine = new TUIRoomEngine();
327
- * roomEngine.on(TUIRoomEvents.onSendMessageForUserDisableChanged, ({ userId, isDisable }) =>{
328
- * console.log('roomEngine.onSendMessageForUserDisableChanged', isDisable);
329
- * });
330
- */
331
- onSendMessageForUserDisableChanged = "onSendMessageForUserDisableChanged",
332
307
  /**
333
308
  * @description 房间最大麦位数修改事件
334
309
  * @default 'onRoomMaxSeatCountChanged'
@@ -384,20 +359,6 @@ export declare enum TUIRoomEvents {
384
359
  * });
385
360
  */
386
361
  onUserRoleChanged = "onUserRoleChanged",
387
- /**
388
- * @description 用户禁止发文字消息状态改变事件
389
- * @default 'onUserMuteStateChanged'
390
- * @event TUIRoomEvents#onUserMuteStateChanged
391
- * @param {object} options
392
- * @param {string} options.userId 用户 Id
393
- * @param {boolean} options.muted 是否被禁止发文字消息
394
- * @example
395
- * const roomEngine = new TUIRoomEngine();
396
- * roomEngine.on(TUIRoomEvents.onUserMuteStateChanged, ({ userId, muted }) => {
397
- * console.log('roomEngine.onUserMuteStateChanged', userId, muted);
398
- * });
399
- */
400
- onUserMuteStateChanged = "onUserMuteStateChanged",
401
362
  /**
402
363
  * @description 用户视频状态改变事件
403
364
  * @default 'onUserVideoStateChanged'
@@ -429,6 +390,20 @@ export declare enum TUIRoomEvents {
429
390
  * });
430
391
  */
431
392
  onUserAudioStateChanged = "onUserAudioStateChanged",
393
+ /**
394
+ * @description 用户发送消息状态改变事件
395
+ * @default 'onSendMessageForUserDisableChanged'
396
+ * @event TUIRoomEvents#onSendMessageForUserDisableChanged
397
+ * @param {object} options
398
+ * @param {string} options.userId 成员 Id
399
+ * @param {boolean} options.isDisable 是否被允许
400
+ * @example
401
+ * const roomEngine = new TUIRoomEngine();
402
+ * roomEngine.on(TUIRoomEvents.onSendMessageForUserDisableChanged, ({ userId, isDisable }) =>{
403
+ * console.log('roomEngine.onSendMessageForUserDisableChanged', isDisable);
404
+ * });
405
+ */
406
+ onSendMessageForUserDisableChanged = "onSendMessageForUserDisableChanged",
432
407
  /**
433
408
  * @description 用户音量改变事件
434
409
  * @default 'onUserVoiceVolumeChanged'
@@ -474,6 +449,17 @@ export declare enum TUIRoomEvents {
474
449
  * });
475
450
  */
476
451
  onSeatListChanged = "onSeatListChanged",
452
+ /**
453
+ * @description 当前用户被踢下麦事件
454
+ * @default 'onKickedOffSeat'
455
+ * @event TUIRoomEvents#onKickedOffSeat
456
+ * @example
457
+ * const roomEngine = new TUIRoomEngine();
458
+ * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
459
+ * console.log('roomEngine.onKickedOffSeat', userId);
460
+ * });
461
+ */
462
+ onKickedOffSeat = "onKickedOffSeat",
477
463
  /**
478
464
  * @description 请求接收事件
479
465
  * @default 'onRequestReceived'
@@ -545,10 +531,10 @@ export declare enum TUIRoomEvents {
545
531
  */
546
532
  onDeviceChange = "onDeviceChange",
547
533
  /**
548
- * @description 屏幕分享停止事件,当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时,该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。
534
+ * @description 屏幕分享停止事件,当屏幕分享停止时,用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。
549
535
  * @default 'onUserScreenCaptureStopped'
550
536
  * @event TUIRoomEvents#onUserScreenCaptureStopped
551
- * @param {TUIChangeReason} options.reason 设备变更状态
537
+ * @param {number} options.reason 屏幕分享停止原因,0:表示用户主动停止;1:表示屏幕分享窗口被关闭
552
538
  * @example
553
539
  * const roomEngine = new TUIRoomEngine();
554
540
  * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, ({ reason }) => {