@tencentcloud/tuiroom-engine-electron 3.3.1 → 3.6.0-beta.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 +1 -1
- package/index.cjs.js +2 -2
- package/index.d.ts +581 -209
- package/index.esm.js +2 -2
- package/index.js +2 -2
- package/package.json +2 -2
package/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ChatSDK } from '@tencentcloud/chat';
|
|
2
2
|
export { default as TIM, default as TencentCloudChat } from '@tencentcloud/chat';
|
|
3
3
|
import TRTCCloud, { TRTCScreenCaptureSourceInfo, TRTCDeviceInfo } from 'trtc-electron-sdk';
|
|
4
|
-
export { Rect, default as TRTCCloud, TRTCDeviceInfo, TRTCDeviceState, TRTCDeviceType, TRTCScreenCaptureProperty, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, TRTCVideoEncParam, TRTCVideoFillMode, TRTCVideoMirrorType, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCVideoRotation, TRTCVideoStreamType, TRTCVolumeInfo } from 'trtc-electron-sdk';
|
|
4
|
+
export { Rect, TRTCCameraCaptureMode, default as TRTCCloud, TRTCDeviceInfo, TRTCDeviceState, TRTCDeviceType, TRTCMediaMixingEncParam, TRTCMediaMixingEvent, TRTCMediaSource, TRTCMediaSourceType, TRTCScreenCaptureProperty, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, TRTCVideoEncParam, TRTCVideoFillMode, TRTCVideoMirrorType, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCVideoRotation, TRTCVideoStreamType, TRTCVolumeInfo } from 'trtc-electron-sdk';
|
|
5
5
|
|
|
6
6
|
declare enum TUIErrorCode {
|
|
7
7
|
ERR_SUCC = 0,
|
|
@@ -245,7 +245,8 @@ declare enum TUIRequestCallbackType {
|
|
|
245
245
|
kRequestRejected = 1,
|
|
246
246
|
kRequestCancelled = 2,
|
|
247
247
|
kRequestTimeout = 3,
|
|
248
|
-
kRequestError = 4
|
|
248
|
+
kRequestError = 4,
|
|
249
|
+
kRequestSuccess = 5
|
|
249
250
|
}
|
|
250
251
|
declare enum TRTCRole {
|
|
251
252
|
kAnchor = 0,
|
|
@@ -265,6 +266,7 @@ type TUIUserInfo = {
|
|
|
265
266
|
nameCard: string;
|
|
266
267
|
avatarUrl: string;
|
|
267
268
|
userRole: TUIRole;
|
|
269
|
+
level: number;
|
|
268
270
|
hasAudioStream: boolean;
|
|
269
271
|
hasVideoStream: boolean;
|
|
270
272
|
hasScreenStream: boolean;
|
|
@@ -281,6 +283,11 @@ type TUISeatInfo = {
|
|
|
281
283
|
isVideoLocked: boolean;
|
|
282
284
|
isAudioLocked: boolean;
|
|
283
285
|
};
|
|
286
|
+
declare enum TUIMoveSeatPolicy {
|
|
287
|
+
kAbortWhenOccupied = 0,
|
|
288
|
+
kForceReplace = 1,
|
|
289
|
+
kSwapPosition = 2
|
|
290
|
+
}
|
|
284
291
|
type TUIRequest = {
|
|
285
292
|
requestAction: TUIRequestAction;
|
|
286
293
|
timestamp: number;
|
|
@@ -374,7 +381,7 @@ type TUIInvitation = {
|
|
|
374
381
|
* @namespace TUIRoomEvents
|
|
375
382
|
* @example
|
|
376
383
|
* import TUIRoomEngine, { TUIRoomEvents } from '@tencentcloud/tuiroom-engine-electron';
|
|
377
|
-
* const roomEngine =
|
|
384
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
378
385
|
* roomEngine.on(TUIRoomEvents.onError, (error) => {
|
|
379
386
|
* console.log('roomEngine.error', error);
|
|
380
387
|
* })
|
|
@@ -388,7 +395,7 @@ declare enum TUIRoomEvents {
|
|
|
388
395
|
* @param {number} options.code 错误代码
|
|
389
396
|
* @param {string} options.message 错误信息
|
|
390
397
|
* @example
|
|
391
|
-
* const roomEngine =
|
|
398
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
392
399
|
* roomEngine.on(TUIRoomEvents.onError, (error) => {
|
|
393
400
|
* console.log('TUIRoomError error', error);
|
|
394
401
|
* })
|
|
@@ -403,7 +410,7 @@ declare enum TUIRoomEvents {
|
|
|
403
410
|
* @param {TUIKickedOutOfRoomReason} options.reason 用户被踢出房间枚举
|
|
404
411
|
* @param {string} options.message 踢出房间信息
|
|
405
412
|
* @example
|
|
406
|
-
* const roomEngine =
|
|
413
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
407
414
|
* roomEngine.on(TUIRoomEvents.onKickedOutOfRoom, ({ roomId, reason, message }) => {
|
|
408
415
|
* console.log('roomEngine.onKickedOutOfRoom', roomId, reason, message);
|
|
409
416
|
* });
|
|
@@ -415,7 +422,7 @@ declare enum TUIRoomEvents {
|
|
|
415
422
|
* @event TUIRoomEvents#onKickedOffLine
|
|
416
423
|
* @param {string} options.message 用户被踢下线信息
|
|
417
424
|
* @example
|
|
418
|
-
* const roomEngine =
|
|
425
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
419
426
|
* roomEngine.on(TUIRoomEvents.onKickedOffLine, ({ message }) => {
|
|
420
427
|
* console.log('roomEngine.onKickedOffLine', message);
|
|
421
428
|
* });
|
|
@@ -426,7 +433,7 @@ declare enum TUIRoomEvents {
|
|
|
426
433
|
* @default 'onUserSigExpired'
|
|
427
434
|
* @event TUIRoomEvents#onUserSigExpired
|
|
428
435
|
* @example
|
|
429
|
-
* const roomEngine =
|
|
436
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
430
437
|
* roomEngine.on(TUIRoomEvents.onUserSigExpired, () => {
|
|
431
438
|
* console.log('roomEngine.onUserSigExpired');
|
|
432
439
|
* });
|
|
@@ -440,7 +447,7 @@ declare enum TUIRoomEvents {
|
|
|
440
447
|
* @param {string} options.roomId 房间号
|
|
441
448
|
* @param {TUIRoomDismissedReason} options.reason 房间解散原因枚举,该字段自 v2.3.0 开始支持
|
|
442
449
|
* @example
|
|
443
|
-
* const roomEngine =
|
|
450
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
444
451
|
* roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId,reason }) => {
|
|
445
452
|
* console.log('roomEngine.onRoomDismissed', roomId,reason);
|
|
446
453
|
* });
|
|
@@ -453,7 +460,7 @@ declare enum TUIRoomEvents {
|
|
|
453
460
|
* @param {object} options
|
|
454
461
|
* @param {string} options.roomName 房间名字
|
|
455
462
|
* @example
|
|
456
|
-
* const roomEngine =
|
|
463
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
457
464
|
* roomEngine.on(TUIRoomEvents.onRoomNameChanged, ({ roomId, roomName }) =>{
|
|
458
465
|
* console.log('roomEngine.onRoomNameChanged', roomId, roomName);
|
|
459
466
|
* });
|
|
@@ -466,7 +473,7 @@ declare enum TUIRoomEvents {
|
|
|
466
473
|
* @param {object} options
|
|
467
474
|
* @param {TUISeatMode} options.seatMode 房间上麦模式
|
|
468
475
|
* @example
|
|
469
|
-
* const roomEngine =
|
|
476
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
470
477
|
* roomEngine.on(TUIRoomEvents.onRoomSeatModeChanged, ({ roomId, seatMode }) =>{
|
|
471
478
|
* console.log('roomEngine.onRoomSeatModeChanged', roomId, seatMode);
|
|
472
479
|
* });
|
|
@@ -480,7 +487,7 @@ declare enum TUIRoomEvents {
|
|
|
480
487
|
* @param {string} options.roomId 房间号
|
|
481
488
|
* @param {number} options.userCount 房间内人数
|
|
482
489
|
* @example
|
|
483
|
-
* const roomEngine =
|
|
490
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
484
491
|
* roomEngine.on(TUIRoomEvents.onRoomUserCountChanged, ({ roomId, userCount }) =>{
|
|
485
492
|
* console.log('roomEngine.onRoomUserCountChanged', roomId, userCount);
|
|
486
493
|
* });
|
|
@@ -493,7 +500,7 @@ declare enum TUIRoomEvents {
|
|
|
493
500
|
* @param {object} options
|
|
494
501
|
* @param {boolean} options.isDisable 是否允许使用摄像头
|
|
495
502
|
* @example
|
|
496
|
-
* const roomEngine =
|
|
503
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
497
504
|
* roomEngine.on(TUIRoomEvents.onAllUserCameraDisableChanged, ({ isDisable }) =>{
|
|
498
505
|
* console.log('roomEngine.onAllUserCameraDisableChanged', isDisable);
|
|
499
506
|
* });
|
|
@@ -507,7 +514,7 @@ declare enum TUIRoomEvents {
|
|
|
507
514
|
* @param {object} options
|
|
508
515
|
* @param {boolean} options.isDisable 是否开启禁止屏幕分享
|
|
509
516
|
* @example
|
|
510
|
-
* const roomEngine =
|
|
517
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
511
518
|
* roomEngine.on(TUIRoomEvents.onScreenShareForAllUserDisableChanged, ({ isDisable }) =>{
|
|
512
519
|
* console.log('roomEngine.onScreenShareForAllUserDisableChanged', isDisable);
|
|
513
520
|
* });
|
|
@@ -520,7 +527,7 @@ declare enum TUIRoomEvents {
|
|
|
520
527
|
* @param {object} options
|
|
521
528
|
* @param {boolean} options.isDisable 是否允许使用麦克风
|
|
522
529
|
* @example
|
|
523
|
-
* const roomEngine =
|
|
530
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
524
531
|
* roomEngine.on(TUIRoomEvents.onAllUserMicrophoneDisableChanged, ({ isDisable }) =>{
|
|
525
532
|
* console.log('roomEngine.onAllUserMicrophoneDisableChanged', isDisable);
|
|
526
533
|
* });
|
|
@@ -533,7 +540,7 @@ declare enum TUIRoomEvents {
|
|
|
533
540
|
* @param {object} options
|
|
534
541
|
* @param {boolean} options.isDisable 是否被允许
|
|
535
542
|
* @example
|
|
536
|
-
* const roomEngine =
|
|
543
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
537
544
|
* roomEngine.on(TUIRoomEvents.onSendMessageForAllUserDisableChanged, ({ isDisable }) =>{
|
|
538
545
|
* console.log('roomEngine.onSendMessageForAllUserDisableChanged', isDisable);
|
|
539
546
|
* });
|
|
@@ -546,7 +553,7 @@ declare enum TUIRoomEvents {
|
|
|
546
553
|
* @param {object} options
|
|
547
554
|
* @param {boolean} options.maxSeatNumber 最大麦位数
|
|
548
555
|
* @example
|
|
549
|
-
* const roomEngine =
|
|
556
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
550
557
|
* roomEngine.on(TUIRoomEvents.onRoomMaxSeatCountChanged, ({ maxSeatNumber }) =>{
|
|
551
558
|
* console.log('roomEngine.onRoomMaxSeatCountChanged', maxSeatNumber);
|
|
552
559
|
* });
|
|
@@ -560,7 +567,7 @@ declare enum TUIRoomEvents {
|
|
|
560
567
|
* @param {string} options.roomId 房间号
|
|
561
568
|
* @param {TUIUserInfo} options.userInfo 用户信息
|
|
562
569
|
* @example
|
|
563
|
-
* const roomEngine =
|
|
570
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
564
571
|
* roomEngine.on(TUIRoomEvents.onRemoteUserEnterRoom, ({ roomId, userInfo }) => {
|
|
565
572
|
* console.log('roomEngine.onRemoteUserEnterRoom', roomId, userInfo);
|
|
566
573
|
* });
|
|
@@ -574,7 +581,7 @@ declare enum TUIRoomEvents {
|
|
|
574
581
|
* @param {string} options.roomId 房间号
|
|
575
582
|
* @param {TUIUserInfo} options.userInfo 用户信息
|
|
576
583
|
* @example
|
|
577
|
-
* const roomEngine =
|
|
584
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
578
585
|
* roomEngine.on(TUIRoomEvents.onRemoteUserLeaveRoom, ({ roomId, userInfo }) => {
|
|
579
586
|
* console.log('roomEngine.onRemoteUserLeaveRoom', roomId, userInfo);
|
|
580
587
|
* });
|
|
@@ -588,7 +595,7 @@ declare enum TUIRoomEvents {
|
|
|
588
595
|
* @param {object} options
|
|
589
596
|
* @param {TUIUserInfo} options.userInfo 用户信息
|
|
590
597
|
* @example
|
|
591
|
-
* const roomEngine =
|
|
598
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
592
599
|
* roomEngine.on(TUIRoomEvents.onUserInfoChanged, ({ userInfo }) => {
|
|
593
600
|
* console.log('roomEngine.onUserInfoChanged', userInfo);
|
|
594
601
|
* });
|
|
@@ -604,7 +611,7 @@ declare enum TUIRoomEvents {
|
|
|
604
611
|
* @param {TUIRole} options.userRole 用户变更后的角色
|
|
605
612
|
* @param {TUIUserInfo} options.userInfo 用户信息,该字段自 v2.3.0 开始支持
|
|
606
613
|
* @example
|
|
607
|
-
* const roomEngine =
|
|
614
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
608
615
|
* roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userInfo }) => {
|
|
609
616
|
* console.log('roomEngine.onUserRoleChanged', userInfo);
|
|
610
617
|
* });
|
|
@@ -620,7 +627,7 @@ declare enum TUIRoomEvents {
|
|
|
620
627
|
* @param {boolean} options.hasVideo 是否有视频流
|
|
621
628
|
* @param {TUIChangeReason} options.reason 变更原因
|
|
622
629
|
* @example
|
|
623
|
-
* const roomEngine =
|
|
630
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
624
631
|
* roomEngine.on(TUIRoomEvents.onUserVideoStateChanged, ({ userId, streamType, hasVideo, reason }) => {
|
|
625
632
|
* console.log('roomEngine.onUserVideoStateChanged', userId, streamType, hasVideo, reason);
|
|
626
633
|
* });
|
|
@@ -635,7 +642,7 @@ declare enum TUIRoomEvents {
|
|
|
635
642
|
* @param {boolean} options.hasVideo 是否有音频流
|
|
636
643
|
* @param {TUIChangeReason} options.reason 原因
|
|
637
644
|
* @example
|
|
638
|
-
* const roomEngine =
|
|
645
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
639
646
|
* roomEngine.on(TUIRoomEvents.onUserAudioStateChanged, ({ userId, hasAudio, reason }) => {
|
|
640
647
|
* console.log('roomEngine.onUserAudioStateChanged', userId, hasAudio, reason);
|
|
641
648
|
* });
|
|
@@ -649,7 +656,7 @@ declare enum TUIRoomEvents {
|
|
|
649
656
|
* @param {string} options.userId 成员 Id
|
|
650
657
|
* @param {boolean} options.isDisable 是否被允许
|
|
651
658
|
* @example
|
|
652
|
-
* const roomEngine =
|
|
659
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
653
660
|
* roomEngine.on(TUIRoomEvents.onSendMessageForUserDisableChanged, ({ userId, isDisable }) =>{
|
|
654
661
|
* console.log('roomEngine.onSendMessageForUserDisableChanged', isDisable);
|
|
655
662
|
* });
|
|
@@ -662,7 +669,7 @@ declare enum TUIRoomEvents {
|
|
|
662
669
|
* @param {object} options
|
|
663
670
|
* @param {Array<TRTCVolumeInfo>} options.userVolumeList 房间内所有用户的音量, 包含 userId 及 volume 信息,volume 区间为 1~100;
|
|
664
671
|
* @example
|
|
665
|
-
* const roomEngine =
|
|
672
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
666
673
|
* roomEngine.on(TUIRoomEvents.onUserVoiceVolumeChanged, ({ userVolumeList }) => {
|
|
667
674
|
* userVolumeList.forEach(userVolume => {
|
|
668
675
|
* console.log('roomEngine.onUserVoiceVolumeChanged', userVolume.userId, userVolume.volume);
|
|
@@ -677,7 +684,7 @@ declare enum TUIRoomEvents {
|
|
|
677
684
|
* @param {object} options
|
|
678
685
|
* @param {TUINetwork} options.userNetworkList 网络质量信息
|
|
679
686
|
* @example
|
|
680
|
-
* const roomEngine =
|
|
687
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
681
688
|
* roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, ({ userNetworkList }) => {
|
|
682
689
|
* userNetworkList.forEach(userNetwork => {
|
|
683
690
|
* console.log('roomEngine.onUserNetworkQualityChanged',
|
|
@@ -695,7 +702,7 @@ declare enum TUIRoomEvents {
|
|
|
695
702
|
* @param {Array<TUISeatInfo>} options.seatedList 新增麦位列表
|
|
696
703
|
* @param {Array<TUISeatInfo>} options.leftList 离开的麦位列表
|
|
697
704
|
* @example
|
|
698
|
-
* const roomEngine =
|
|
705
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
699
706
|
* roomEngine.on(TUIRoomEvents.onSeatListChanged, ({ seatList, seatedList, leftList }) => {
|
|
700
707
|
* console.log('roomEngine.onSeatListChanged',seatList, seatedList, leftList);
|
|
701
708
|
* });
|
|
@@ -708,7 +715,7 @@ declare enum TUIRoomEvents {
|
|
|
708
715
|
* @param {number} options.seatIndex 麦位编号,该字段自 v2.3.0 开始支持
|
|
709
716
|
* @param {TUIUserInfo} options.userInfo 操作踢人的(主持人/管理员)用户信息,该字段自 v2.3.0 开始支持
|
|
710
717
|
* @example
|
|
711
|
-
* const roomEngine =
|
|
718
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
712
719
|
* roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ seatIndex, userInfo }) => {
|
|
713
720
|
* console.log('roomEngine.onKickedOffSeat', seatIndex, userInfo);
|
|
714
721
|
* });
|
|
@@ -721,7 +728,7 @@ declare enum TUIRoomEvents {
|
|
|
721
728
|
* @param {object} options
|
|
722
729
|
* @param {TUIRequest} options.request 请求接收
|
|
723
730
|
* @example
|
|
724
|
-
* const roomEngine =
|
|
731
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
725
732
|
* roomEngine.on(TUIRoomEvents.onRequestReceived, ({ request }) => {
|
|
726
733
|
* console.log('roomEngine.onRequestReceived', request);
|
|
727
734
|
* });
|
|
@@ -737,7 +744,7 @@ declare enum TUIRoomEvents {
|
|
|
737
744
|
* @param {TUIRequest} options.request 请求信息,该字段自 v2.3.0 开始支持
|
|
738
745
|
* @param {TUIUserInfo} options.userInfo 处理该请求的 管理员/房主 的用户信息,该字段自 v2.3.0 开始支持
|
|
739
746
|
* @example
|
|
740
|
-
* const roomEngine =
|
|
747
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
741
748
|
* roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ request, userInfo }) => {
|
|
742
749
|
* console.log('roomEngine.onRequestCancelled', request, userInfo);
|
|
743
750
|
* });
|
|
@@ -753,7 +760,7 @@ declare enum TUIRoomEvents {
|
|
|
753
760
|
* @param {TUIRequest} options.request 请求信息,该字段自 v2.3.0 开始支持
|
|
754
761
|
* @param {TUIUserInfo} options.userInfo 处理该请求的 管理员/房主 的用户信息,该字段自 v2.3.0 开始支持
|
|
755
762
|
* @example
|
|
756
|
-
* const roomEngine =
|
|
763
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
757
764
|
* roomEngine.on(TUIRoomEvents.onRequestProcessed, ({ request, userInfo }) => {
|
|
758
765
|
* console.log('roomEngine.onRequestProcessed', request, userInfo);
|
|
759
766
|
* });
|
|
@@ -772,7 +779,7 @@ declare enum TUIRoomEvents {
|
|
|
772
779
|
* @param {object} options.extensionInfo 扩展信息
|
|
773
780
|
* @param {string} options.timestampInSecond 时间戳
|
|
774
781
|
* @example
|
|
775
|
-
* const roomEngine =
|
|
782
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
776
783
|
* roomEngine.on(TUIRoomEvents.onReceiveTextMessage, (message) => {
|
|
777
784
|
* console.log('roomEngine.onReceiveTextMessage', message);
|
|
778
785
|
* });
|
|
@@ -791,7 +798,7 @@ declare enum TUIRoomEvents {
|
|
|
791
798
|
* @param {number} options.sequence 消息序号
|
|
792
799
|
* @param {string} options.timestampInSecond 时间戳
|
|
793
800
|
* @example
|
|
794
|
-
* const roomEngine =
|
|
801
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
795
802
|
* roomEngine.on(TUIRoomEvents.onReceiveCustomMessage, (message) => {
|
|
796
803
|
* console.log('roomEngine.onReceiveCustomMessage', message);
|
|
797
804
|
* });
|
|
@@ -806,7 +813,7 @@ declare enum TUIRoomEvents {
|
|
|
806
813
|
* @param {TRTCDeviceType} options.type 设备类型
|
|
807
814
|
* @param {TRTCDeviceState} options.state 设备变更状态
|
|
808
815
|
* @example
|
|
809
|
-
* const roomEngine =
|
|
816
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
810
817
|
* roomEngine.on(TUIRoomEvents.onDeviceChange, ({ deviceId, type, state }) => {
|
|
811
818
|
* console.log('roomEngine.onDeviceChange', deviceId, type, state);
|
|
812
819
|
* });
|
|
@@ -817,7 +824,7 @@ declare enum TUIRoomEvents {
|
|
|
817
824
|
* @default 'onUserScreenCaptureStopped'
|
|
818
825
|
* @event TUIRoomEvents#onUserScreenCaptureStopped
|
|
819
826
|
* @example
|
|
820
|
-
* const roomEngine =
|
|
827
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
821
828
|
* roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, () => {
|
|
822
829
|
* console.log('roomEngine.onUserScreenCaptureStopped');
|
|
823
830
|
* });
|
|
@@ -828,7 +835,7 @@ declare enum TUIRoomEvents {
|
|
|
828
835
|
* @default 'onAutoPlayFailed'
|
|
829
836
|
* @event TUIRoomEvents#onAutoPlayFailed
|
|
830
837
|
* @example
|
|
831
|
-
* const roomEngine =
|
|
838
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
832
839
|
* roomEngine.on(TUIRoomEvents.onAutoPlayFailed, ({userId, resume}) => {
|
|
833
840
|
* // 自动播放失败,引导用户与页面进行交互
|
|
834
841
|
* });
|
|
@@ -839,7 +846,7 @@ declare enum TUIRoomEvents {
|
|
|
839
846
|
* @default 'onRoomMetadataChanged'
|
|
840
847
|
* @event TUIRoomEvents#onRoomMetadataChanged
|
|
841
848
|
* @example
|
|
842
|
-
* const roomEngine =
|
|
849
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
843
850
|
* roomEngine.on(TUIRoomEvents.onRoomMetadataChanged, ({key, value}) => {
|
|
844
851
|
* console.log(key, value);
|
|
845
852
|
* });
|
|
@@ -856,7 +863,7 @@ declare enum TUIRoomDeviceMangerEvents {
|
|
|
856
863
|
* @param {TRTCDeviceType} options.type 设备类型
|
|
857
864
|
* @param {TRTCDeviceState} options.state 设备变更状态
|
|
858
865
|
* @example
|
|
859
|
-
* const roomEngine =
|
|
866
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
860
867
|
* const deviceManager = roomEngine.getDeviceManager();
|
|
861
868
|
* deviceManager.on(TUIRoomDeviceMangerEvents.onDeviceChange, ({ deviceId, type, state }) => {
|
|
862
869
|
* console.log('deviceManager.onDeviceChange', deviceId, type, state);
|
|
@@ -870,7 +877,7 @@ declare enum TUIRoomDeviceMangerEvents {
|
|
|
870
877
|
* @param {object} options
|
|
871
878
|
* @param {number} options.volume 麦克风测试音量(0-100)
|
|
872
879
|
* @example
|
|
873
|
-
* const roomEngine =
|
|
880
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
874
881
|
* const deviceManager = roomEngine.getDeviceManager();
|
|
875
882
|
* deviceManager.on(TUIRoomDeviceMangerEvents.onTestMicVolume, ({ volume }) => {
|
|
876
883
|
* console.log('deviceManager.onTestMicVolume', volume);
|
|
@@ -884,7 +891,7 @@ declare enum TUIRoomDeviceMangerEvents {
|
|
|
884
891
|
* @param {object} options
|
|
885
892
|
* @param {number} options.volume 扬声器测试音量(0-100)
|
|
886
893
|
* @example
|
|
887
|
-
* const roomEngine =
|
|
894
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
888
895
|
* const deviceManager = roomEngine.getDeviceManager();
|
|
889
896
|
* deviceManager.on(TUIRoomDeviceMangerEvents.onTestSpeakerVolume, ({ volume }) => {
|
|
890
897
|
* console.log('deviceManager.onTestSpeakerVolume', volume);
|
|
@@ -906,7 +913,7 @@ declare enum TUIConferenceListManagerEvents {
|
|
|
906
913
|
* @param {string} options.conferenceInfo 会议信息。
|
|
907
914
|
*
|
|
908
915
|
* @example
|
|
909
|
-
* const roomEngine =
|
|
916
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
910
917
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
911
918
|
* conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceScheduled, ({ conferenceInfo }) => {
|
|
912
919
|
* console.log('conferenceListManager.onConferenceScheduled', conferenceInfo);
|
|
@@ -921,7 +928,7 @@ declare enum TUIConferenceListManagerEvents {
|
|
|
921
928
|
* @param {string} options.conferenceInfo 会议信息。
|
|
922
929
|
*
|
|
923
930
|
* @example
|
|
924
|
-
* const roomEngine =
|
|
931
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
925
932
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
926
933
|
* conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceWillStart, ({ conferenceInfo }) => {
|
|
927
934
|
* console.log('conferenceListManager.onConferenceWillStart', conferenceInfo);
|
|
@@ -930,6 +937,7 @@ declare enum TUIConferenceListManagerEvents {
|
|
|
930
937
|
onConferenceWillStart = "onConferenceWillStart",
|
|
931
938
|
/**
|
|
932
939
|
* @description 会议取消回调
|
|
940
|
+
* @deprecated 该接口自 v3.6 版本废弃,请使用 onConferenceDidCancelled'.
|
|
933
941
|
*
|
|
934
942
|
* @param {object} options
|
|
935
943
|
* @param {string} options.roomId 会议Id,即房间 roomId 。
|
|
@@ -937,13 +945,29 @@ declare enum TUIConferenceListManagerEvents {
|
|
|
937
945
|
* @param {TUIUserInfo} options.operateUser 取消会议操作者信息。
|
|
938
946
|
*
|
|
939
947
|
* @example
|
|
940
|
-
* const roomEngine =
|
|
948
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
941
949
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
942
950
|
* conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceCancelled, ({ roomId, reason, operateUser }) => {
|
|
943
951
|
* console.log('conferenceListManager.onConferenceCancelled', roomId, reason, operateUser);
|
|
944
952
|
* })
|
|
945
953
|
*/
|
|
946
954
|
onConferenceCancelled = "onConferenceCancelled",
|
|
955
|
+
/**
|
|
956
|
+
* @description 会议取消回调 代替 onConferenceCancelled
|
|
957
|
+
*
|
|
958
|
+
* @param {object} options
|
|
959
|
+
* @param {TUIConferenceInfo} options.conferenceInfo 会议信息。
|
|
960
|
+
* @param {TUIConferenceCancelReason} options.reason 会议取消原因。
|
|
961
|
+
* @param {TUIUserInfo} options.operateUser 取消会议操作者信息。
|
|
962
|
+
*
|
|
963
|
+
* @example
|
|
964
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
965
|
+
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
966
|
+
* conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceDidCancelled, ({ conferenceInfo, reason, operateUser }) => {
|
|
967
|
+
* console.log('conferenceListManager.onConferenceDidCancelled', conferenceInfo, reason, operateUser);
|
|
968
|
+
* })
|
|
969
|
+
*/
|
|
970
|
+
onConferenceDidCancelled = "onConferenceDidCancelled",
|
|
947
971
|
/**
|
|
948
972
|
* @description 会议信息变更回调
|
|
949
973
|
*
|
|
@@ -951,7 +975,7 @@ declare enum TUIConferenceListManagerEvents {
|
|
|
951
975
|
* @param {TUIConferenceModifyInfo} options.conferenceModifyInfo 会议信息。
|
|
952
976
|
*
|
|
953
977
|
* @example
|
|
954
|
-
* const roomEngine =
|
|
978
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
955
979
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
956
980
|
* conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceInfoChanged, ({ conferenceModifyInfo }) => {
|
|
957
981
|
* console.log('conferenceListManager.onConferenceInfoChanged', conferenceModifyInfo);
|
|
@@ -960,6 +984,7 @@ declare enum TUIConferenceListManagerEvents {
|
|
|
960
984
|
onConferenceInfoChanged = "onConferenceInfoChanged",
|
|
961
985
|
/**
|
|
962
986
|
* @description 参会人员变更回调
|
|
987
|
+
* @deprecated 该接口自 v3.6 版本废弃,请使用 onScheduleAttendeesUpdated'.
|
|
963
988
|
*
|
|
964
989
|
* @param {object} options
|
|
965
990
|
* @param {string} options.roomId 会议Id,即房间roomId。
|
|
@@ -967,28 +992,60 @@ declare enum TUIConferenceListManagerEvents {
|
|
|
967
992
|
* @param {Array<TUIUserInfo>} options.joinedUsers 新加入成员列表。
|
|
968
993
|
*
|
|
969
994
|
* @example
|
|
970
|
-
* const roomEngine =
|
|
995
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
971
996
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
972
997
|
* conferenceListManager.on(TUIConferenceListManagerEvents.onScheduleAttendeesChanged, ({ roomId, leftUsers, joinedUsers }) => {
|
|
973
998
|
* console.log('conferenceListManager.onScheduleAttendeesChanged', roomId, leftUsers, joinedUsers);
|
|
974
999
|
* })
|
|
975
1000
|
*/
|
|
976
1001
|
onScheduleAttendeesChanged = "onScheduleAttendeesChanged",
|
|
1002
|
+
/**
|
|
1003
|
+
* @description 参会人员变更回调 代替 onScheduleAttendeesChanged
|
|
1004
|
+
*
|
|
1005
|
+
* @param {object} options
|
|
1006
|
+
* @param {TUIConferenceInfo} options.conferenceInfo 会议信息。
|
|
1007
|
+
* @param {Array<TUIUserInfo>} options.leftUsers 离开成员列表。
|
|
1008
|
+
* @param {Array<TUIUserInfo>} options.joinedUsers 新加入成员列表。
|
|
1009
|
+
*
|
|
1010
|
+
* @example
|
|
1011
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1012
|
+
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
1013
|
+
* conferenceListManager.on(TUIConferenceListManagerEvents.onScheduleAttendeesUpdated, ({ conferenceInfo, leftUsers, joinedUsers }) => {
|
|
1014
|
+
* console.log('conferenceListManager.onScheduleAttendeesUpdated', conferenceInfo, leftUsers, joinedUsers);
|
|
1015
|
+
* })
|
|
1016
|
+
*/
|
|
1017
|
+
onScheduleAttendeesUpdated = "onScheduleAttendeesUpdated",
|
|
977
1018
|
/**
|
|
978
1019
|
* @description 会议状态变更回调
|
|
1020
|
+
* @deprecated 该接口自 v3.6 版本废弃,请使用 onConferenceStatusUpdated'.
|
|
979
1021
|
*
|
|
980
1022
|
* @param {object} options
|
|
981
1023
|
* @param {string} options.roomId 会议Id,即房间roomId。
|
|
982
1024
|
* @param {TUIConferenceStatus} options.status 会议状态。
|
|
983
1025
|
*
|
|
984
1026
|
* @example
|
|
985
|
-
* const roomEngine =
|
|
1027
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
986
1028
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
987
1029
|
* conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceStatusChanged, ({ roomId, status }) => {
|
|
988
1030
|
* console.log('conferenceListManager.onConferenceStatusChanged', roomId, status );
|
|
989
1031
|
* })
|
|
990
1032
|
*/
|
|
991
|
-
onConferenceStatusChanged = "onConferenceStatusChanged"
|
|
1033
|
+
onConferenceStatusChanged = "onConferenceStatusChanged",
|
|
1034
|
+
/**
|
|
1035
|
+
* @description 会议状态变更回调
|
|
1036
|
+
*
|
|
1037
|
+
* @param {object} options
|
|
1038
|
+
* @param {TUIConferenceInfo} options.conferenceInfo 会议Id,即房间roomId。
|
|
1039
|
+
* @param {TUIConferenceStatus} options.status 会议状态。
|
|
1040
|
+
*
|
|
1041
|
+
* @example
|
|
1042
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1043
|
+
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
1044
|
+
* conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceStatusUpdated, ({ conferenceInfo, status }) => {
|
|
1045
|
+
* console.log('conferenceListManager.onConferenceStatusUpdated', conferenceInfo, status );
|
|
1046
|
+
* })
|
|
1047
|
+
*/
|
|
1048
|
+
onConferenceStatusUpdated = "onConferenceStatusUpdated"
|
|
992
1049
|
}
|
|
993
1050
|
/**
|
|
994
1051
|
* @since v2.6.0
|
|
@@ -1007,7 +1064,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1007
1064
|
*
|
|
1008
1065
|
*
|
|
1009
1066
|
* @example
|
|
1010
|
-
* const roomEngine =
|
|
1067
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1011
1068
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1012
1069
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onReceiveInvitation, ({ roomInfo, invitation, extensionInfo }) => {
|
|
1013
1070
|
* console.log('conferenceInvitationManager.onReceiveInvitation', roomInfo, invitation, extensionInfo);
|
|
@@ -1024,7 +1081,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1024
1081
|
*
|
|
1025
1082
|
*
|
|
1026
1083
|
* @example
|
|
1027
|
-
* const roomEngine =
|
|
1084
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1028
1085
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1029
1086
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationHandledByOtherDevice, ({ roomInfo, accepted }) => {
|
|
1030
1087
|
* console.log('conferenceInvitationManager.onInvitationHandledByOtherDevice', roomInfo, accepted);
|
|
@@ -1041,7 +1098,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1041
1098
|
*
|
|
1042
1099
|
*
|
|
1043
1100
|
* @example
|
|
1044
|
-
* const roomEngine =
|
|
1101
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1045
1102
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1046
1103
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationCancelled, ({ roomInfo, invitation }) => {
|
|
1047
1104
|
* console.log('conferenceInvitationManager.onInvitationCancelled', roomInfo, invitation);
|
|
@@ -1058,7 +1115,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1058
1115
|
*
|
|
1059
1116
|
*
|
|
1060
1117
|
* @example
|
|
1061
|
-
* const roomEngine =
|
|
1118
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1062
1119
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1063
1120
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAccepted, ({ roomInfo, invitation }) => {
|
|
1064
1121
|
* console.log('conferenceInvitationManager.onInvitationAccepted', roomInfo, invitation);
|
|
@@ -1077,7 +1134,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1077
1134
|
*
|
|
1078
1135
|
*
|
|
1079
1136
|
* @example
|
|
1080
|
-
* const roomEngine =
|
|
1137
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1081
1138
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1082
1139
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRejected, ({ roomInfo, invitation, reason }) => {
|
|
1083
1140
|
* console.log('conferenceInvitationManager.onInvitationRejected', roomInfo, invitation, reason);
|
|
@@ -1094,7 +1151,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1094
1151
|
*
|
|
1095
1152
|
*
|
|
1096
1153
|
* @example
|
|
1097
|
-
* const roomEngine =
|
|
1154
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1098
1155
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1099
1156
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationTimeout, ({ roomInfo, invitation }) => {
|
|
1100
1157
|
* console.log('conferenceInvitationManager.onInvitationTimeout', roomInfo, invitation);
|
|
@@ -1112,7 +1169,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1112
1169
|
*
|
|
1113
1170
|
*
|
|
1114
1171
|
* @example
|
|
1115
|
-
* const roomEngine =
|
|
1172
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1116
1173
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1117
1174
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRevokedByAdmin, ({ roomInfo, invitation, userRole }) => {
|
|
1118
1175
|
* console.log('conferenceInvitationManager.onInvitationRevokedByAdmin', roomInfo, invitation, operateUser);
|
|
@@ -1129,7 +1186,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1129
1186
|
*
|
|
1130
1187
|
*
|
|
1131
1188
|
* @example
|
|
1132
|
-
* const roomEngine =
|
|
1189
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1133
1190
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1134
1191
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, ({ roomInfo, invitation }) => {
|
|
1135
1192
|
* console.log('conferenceInvitationManager.onInvitationAdded', roomInfo, invitation);
|
|
@@ -1146,7 +1203,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1146
1203
|
*
|
|
1147
1204
|
*
|
|
1148
1205
|
* @example
|
|
1149
|
-
* const roomEngine =
|
|
1206
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1150
1207
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1151
1208
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, ({ roomInfo, invitation }) => {
|
|
1152
1209
|
* console.log('conferenceInvitationManager.onInvitationRemoved', roomInfo, invitation);
|
|
@@ -1163,7 +1220,7 @@ declare enum TUIConferenceInvitationManagerEvents {
|
|
|
1163
1220
|
*
|
|
1164
1221
|
*
|
|
1165
1222
|
* @example
|
|
1166
|
-
* const roomEngine =
|
|
1223
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1167
1224
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
1168
1225
|
* conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, ({ roomInfo, invitation }) => {
|
|
1169
1226
|
* console.log('conferenceInvitationManager.onInvitationStatusChanged', roomInfo, invitation);
|
|
@@ -1200,6 +1257,25 @@ type TUILiveInfo = {
|
|
|
1200
1257
|
readonly lebEncrypted?: string;
|
|
1201
1258
|
readonly lebSignature?: string;
|
|
1202
1259
|
};
|
|
1260
|
+
type StartLiveOptions = {
|
|
1261
|
+
roomId: string;
|
|
1262
|
+
roomType?: TUIRoomType;
|
|
1263
|
+
name: string;
|
|
1264
|
+
notice?: string;
|
|
1265
|
+
isMessageDisableForAllUser?: boolean;
|
|
1266
|
+
isGiftEnabled?: boolean;
|
|
1267
|
+
isLikeEnabled?: boolean;
|
|
1268
|
+
isPublicVisible?: boolean;
|
|
1269
|
+
isSeatEnabled?: boolean;
|
|
1270
|
+
keepOwnerOnSeat?: boolean;
|
|
1271
|
+
seatLayoutTemplateId?: number;
|
|
1272
|
+
maxSeatCount?: number;
|
|
1273
|
+
seatMode?: TUISeatMode;
|
|
1274
|
+
coverUrl?: string;
|
|
1275
|
+
backgroundUrl?: string;
|
|
1276
|
+
categoryList?: Array<number>;
|
|
1277
|
+
activityStatus?: number;
|
|
1278
|
+
};
|
|
1203
1279
|
/**
|
|
1204
1280
|
* 直播连线用户信息
|
|
1205
1281
|
*/
|
|
@@ -1210,6 +1286,18 @@ type TUILiveConnectionUser = {
|
|
|
1210
1286
|
avatarUrl: string;
|
|
1211
1287
|
joinConnectionTime: number;
|
|
1212
1288
|
};
|
|
1289
|
+
/**
|
|
1290
|
+
* 发起连线请求的结果状态码
|
|
1291
|
+
*/
|
|
1292
|
+
declare enum TUIConnectionCode {
|
|
1293
|
+
TUIConnectionCodeUnknown = -1,
|
|
1294
|
+
TUIConnectionCodeSuccess = 0,
|
|
1295
|
+
TUIConnectionCodeRoomNotExist = 1,
|
|
1296
|
+
TUIConnectionCodeConnecting = 2,
|
|
1297
|
+
TUIConnectionCodeConnectingOtherRoom = 3,
|
|
1298
|
+
TUIConnectionCodeFull = 4,
|
|
1299
|
+
TUIConnectionCodeRetry = 5
|
|
1300
|
+
}
|
|
1213
1301
|
type TUILiveModifyInfo = {
|
|
1214
1302
|
roomId: string;
|
|
1215
1303
|
isPublicVisible?: boolean;
|
|
@@ -1248,21 +1336,30 @@ declare enum TUILiveListManagerEvents {
|
|
|
1248
1336
|
* @default 'onLiveInfoChanged'
|
|
1249
1337
|
* @event TUILiveListManagerEvents#onLiveInfoChanged
|
|
1250
1338
|
* @param {object} options
|
|
1251
|
-
* @param {
|
|
1252
|
-
* @param {TUILiveModifyFlag} options.modifyFlag 直播间修改标识
|
|
1339
|
+
* @param {TUILiveModifyInfo} options.liveModifyInfo 直播间变更信息
|
|
1253
1340
|
*
|
|
1254
1341
|
* @example
|
|
1255
|
-
* const roomEngine =
|
|
1342
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1256
1343
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
1257
|
-
* liveListManager.on(TUILiveListManagerEvents.onLiveInfoChanged, ({
|
|
1258
|
-
* console.log('liveListManager.onLiveInfoChanged',
|
|
1344
|
+
* liveListManager.on(TUILiveListManagerEvents.onLiveInfoChanged, ({ liveModifyInfo}) => {
|
|
1345
|
+
* console.log('liveListManager.onLiveInfoChanged', liveModifyInfo);
|
|
1259
1346
|
* });
|
|
1260
1347
|
*/
|
|
1261
|
-
onLiveInfoChanged = "onLiveInfoChanged"
|
|
1348
|
+
onLiveInfoChanged = "onLiveInfoChanged",
|
|
1349
|
+
/**
|
|
1350
|
+
* @since v3.5.0
|
|
1351
|
+
* @description 直播间统计信息发生变化事件回调
|
|
1352
|
+
* @default 'onLiveStatisticsChanged'
|
|
1353
|
+
* @event TUILiveListManagerEvents#onLiveStatisticsChanged
|
|
1354
|
+
* @param {object} options
|
|
1355
|
+
* @param {string} options.roomId 直播间 ID
|
|
1356
|
+
* @param {TUILiveStatisticsData} options.statistics 直播间统计变更信息
|
|
1357
|
+
*/
|
|
1358
|
+
onLiveStatisticsChanged = "onLiveStatisticsChanged"
|
|
1262
1359
|
}
|
|
1263
1360
|
declare enum TUILiveLayoutManagerEvents {
|
|
1264
1361
|
/**
|
|
1265
|
-
* const roomEngine =
|
|
1362
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1266
1363
|
* const liveLayoutManager = roomEngine.getLiveLayoutManager();
|
|
1267
1364
|
* const callback = (roomId, layoutInfo) => {
|
|
1268
1365
|
* console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
|
|
@@ -1280,7 +1377,7 @@ declare enum TUILiveLayoutManagerEvents {
|
|
|
1280
1377
|
* @param {TUISeatLayout} option.seatLayout 麦位排版信息
|
|
1281
1378
|
*
|
|
1282
1379
|
* @example
|
|
1283
|
-
* const roomEngine =
|
|
1380
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1284
1381
|
* const liveLayoutManager = roomEngine.getLiveLayoutManager();
|
|
1285
1382
|
* const callback = ({ roomId, seatLayout }) => {
|
|
1286
1383
|
* console.log('liveLayoutManager.onSeatLayoutChanged', roomId, seatLayout);
|
|
@@ -1354,14 +1451,27 @@ type TUISeatLayout = {
|
|
|
1354
1451
|
* @property {number} totalGiftCoins 礼物总价值
|
|
1355
1452
|
* @property {number} totalUniqueGiftSenders 礼物发送者总数
|
|
1356
1453
|
* @property {number} totalLikesReceived 点赞总数
|
|
1454
|
+
* @property {number} totalMessageCount 消息总数
|
|
1455
|
+
* @property {number} liveDuration 直播时长,单位秒
|
|
1357
1456
|
*/
|
|
1358
1457
|
type TUILiveStatisticsData = {
|
|
1359
|
-
totalViewers
|
|
1360
|
-
totalGiftsSent
|
|
1361
|
-
totalGiftCoins
|
|
1362
|
-
totalUniqueGiftSenders
|
|
1363
|
-
totalLikesReceived
|
|
1458
|
+
totalViewers?: number;
|
|
1459
|
+
totalGiftsSent?: number;
|
|
1460
|
+
totalGiftCoins?: number;
|
|
1461
|
+
totalUniqueGiftSenders?: number;
|
|
1462
|
+
totalLikesReceived?: number;
|
|
1463
|
+
totalMessageCount?: number;
|
|
1464
|
+
liveDuration?: number;
|
|
1364
1465
|
};
|
|
1466
|
+
declare enum TUILiveStatisticsModifyFlag {
|
|
1467
|
+
kNone = 0,
|
|
1468
|
+
kTotalViewers = 1,
|
|
1469
|
+
kTotalGiftsSent = 2,
|
|
1470
|
+
kTotalGiftCoins = 4,
|
|
1471
|
+
kTotalUniqueGiftSenders = 8,
|
|
1472
|
+
kTotalLikesReceived = 16,
|
|
1473
|
+
kTotalMessageCount = 32
|
|
1474
|
+
}
|
|
1365
1475
|
/**
|
|
1366
1476
|
* @since v3.0.5
|
|
1367
1477
|
* **TUILiveConnectionManager** 事件列表<br>
|
|
@@ -1377,7 +1487,7 @@ declare enum TUILiveConnectionManagerEvents {
|
|
|
1377
1487
|
* @param {string} options.extensionInfo 扩展信息
|
|
1378
1488
|
*
|
|
1379
1489
|
* @example
|
|
1380
|
-
* const roomEngine =
|
|
1490
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1381
1491
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
1382
1492
|
* liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReceived, ({ inviter, inviteeList, extensionInfo }) => {
|
|
1383
1493
|
* console.log('liveConnectionManager.onConnectionRequestReceived', inviter, inviteeList, extensionInfo);
|
|
@@ -1394,7 +1504,7 @@ declare enum TUILiveConnectionManagerEvents {
|
|
|
1394
1504
|
* @param {Array<TUILiveConnectionUser>} options.leavedList 本次事件变更离开连线房间的主播列表
|
|
1395
1505
|
*
|
|
1396
1506
|
* @example
|
|
1397
|
-
* const roomEngine =
|
|
1507
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1398
1508
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
1399
1509
|
* liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionUserListChanged, ({ connectedList, joinedList, leavedList }) => {
|
|
1400
1510
|
* console.log('liveConnectionManager.onConnectionUserListChanged', connectedList, joinedList, leavedList);
|
|
@@ -1409,7 +1519,7 @@ declare enum TUILiveConnectionManagerEvents {
|
|
|
1409
1519
|
* @param {TUILiveConnectionUser} options.inviter 连线邀请者
|
|
1410
1520
|
*
|
|
1411
1521
|
* @example
|
|
1412
|
-
* const roomEngine =
|
|
1522
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1413
1523
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
1414
1524
|
* liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestCancelled, ({ inviter }) => {
|
|
1415
1525
|
* console.log('liveConnectionManager.onConnectionRequestCancelled', inviter);
|
|
@@ -1424,7 +1534,7 @@ declare enum TUILiveConnectionManagerEvents {
|
|
|
1424
1534
|
* @param {TUILiveConnectionUser} options.invitee 连线被邀请者
|
|
1425
1535
|
*
|
|
1426
1536
|
* @example
|
|
1427
|
-
* const roomEngine =
|
|
1537
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1428
1538
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
1429
1539
|
* liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestAccept, ({ invitee }) => {
|
|
1430
1540
|
* console.log('liveConnectionManager.onConnectionRequestAccept', invitee);
|
|
@@ -1439,7 +1549,7 @@ declare enum TUILiveConnectionManagerEvents {
|
|
|
1439
1549
|
* @param {TUILiveConnectionUser} options.invitee 连线被邀请者
|
|
1440
1550
|
*
|
|
1441
1551
|
* @example
|
|
1442
|
-
* const roomEngine =
|
|
1552
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1443
1553
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
1444
1554
|
* liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReject, ({ invitee }) => {
|
|
1445
1555
|
* console.log('liveConnectionManager.onConnectionRequestReject', invitee);
|
|
@@ -1455,7 +1565,7 @@ declare enum TUILiveConnectionManagerEvents {
|
|
|
1455
1565
|
* @param {TUILiveConnectionUser} option.invitee 连线被邀请者
|
|
1456
1566
|
*
|
|
1457
1567
|
* @example
|
|
1458
|
-
* const roomEngine =
|
|
1568
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1459
1569
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
1460
1570
|
* liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestTimeout, ({ invitee, inviter }) => {
|
|
1461
1571
|
* console.log('liveConnectionManager.onConnectionRequestTimeout', invitee, inviter);
|
|
@@ -1520,7 +1630,7 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1520
1630
|
* @param {TUIBattleInfo} battleInfo PK信息
|
|
1521
1631
|
*
|
|
1522
1632
|
* @example
|
|
1523
|
-
* const roomEngine =
|
|
1633
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1524
1634
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1525
1635
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onBattleStarted, ({ battleInfo }) => {
|
|
1526
1636
|
* console.log('liveBattleManager.onBattleStarted', battleInfo);
|
|
@@ -1536,7 +1646,7 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1536
1646
|
* @param {TUIBattleStoppedReason} reason PK结束原因
|
|
1537
1647
|
*
|
|
1538
1648
|
* @example
|
|
1539
|
-
* const roomEngine =
|
|
1649
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1540
1650
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1541
1651
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onBattleEnded, ({ battleInfo, reason }) => {
|
|
1542
1652
|
* console.log('liveBattleManager.onBattleEnded', battleInfo, reason);
|
|
@@ -1552,7 +1662,7 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1552
1662
|
* @param {TUIBattleUser} user PK用户信息
|
|
1553
1663
|
*
|
|
1554
1664
|
* @example
|
|
1555
|
-
* const roomEngine =
|
|
1665
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1556
1666
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1557
1667
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onUserJoinBattle, ({ battleId, user }) => {
|
|
1558
1668
|
* console.log('liveBattleManager.onUserJoinBattle', battleId, user);
|
|
@@ -1568,7 +1678,7 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1568
1678
|
* @param {TUIBattleUser} user PK用户信息
|
|
1569
1679
|
*
|
|
1570
1680
|
* @example
|
|
1571
|
-
* const roomEngine =
|
|
1681
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1572
1682
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1573
1683
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onUserExitBattle, ({ battleId, user }) => {
|
|
1574
1684
|
* console.log('liveBattleManager.onUserExitBattle', battleId, user);
|
|
@@ -1584,7 +1694,7 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1584
1694
|
* @param {Array<TUIBattleUser>} battleUserList PK用户信息列表
|
|
1585
1695
|
*
|
|
1586
1696
|
* @example
|
|
1587
|
-
* const roomEngine =
|
|
1697
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1588
1698
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1589
1699
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onBattleScoreChanged, ({ battleId, battleUserList }) => {
|
|
1590
1700
|
* console.log('liveBattleManager.onBattleScoreChanged', battleId, battleUserList);
|
|
@@ -1601,7 +1711,7 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1601
1711
|
* @param {TUIBattleUser} invitee 接收PK请求的用户
|
|
1602
1712
|
*
|
|
1603
1713
|
* @example
|
|
1604
|
-
* const roomEngine =
|
|
1714
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1605
1715
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1606
1716
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestReceived, ({ battleInfo, inviter, invitee }) => {
|
|
1607
1717
|
* console.log('liveBattleManager.onBattleRequestReceived', battleInfo, inviter, invitee);
|
|
@@ -1618,7 +1728,7 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1618
1728
|
* @param {TUIBattleUser} invitee 接收PK请求的用户
|
|
1619
1729
|
*
|
|
1620
1730
|
* @example
|
|
1621
|
-
* const roomEngine =
|
|
1731
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1622
1732
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1623
1733
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestCancelled, ({ battleInfo, inviter, invitee }) => {
|
|
1624
1734
|
* console.log('liveBattleManager.onBattleRequestCancelled', battleInfo, inviter, invitee);
|
|
@@ -1635,7 +1745,7 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1635
1745
|
* @param {TUIBattleUser} invitee 接收PK请求的用户
|
|
1636
1746
|
*
|
|
1637
1747
|
* @example
|
|
1638
|
-
* const roomEngine =
|
|
1748
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1639
1749
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1640
1750
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestTimeout, ({ battleInfo, inviter, invitee }) => {
|
|
1641
1751
|
* console.log('liveBattleManager.onBattleRequestTimeout', battleInfo, inviter, invitee);
|
|
@@ -1652,7 +1762,7 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1652
1762
|
* @param {TUIBattleUser} invitee 接收PK请求的用户
|
|
1653
1763
|
*
|
|
1654
1764
|
* @example
|
|
1655
|
-
* const roomEngine =
|
|
1765
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1656
1766
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1657
1767
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestAccept, ({ battleInfo, inviter, invitee }) => {
|
|
1658
1768
|
* console.log('liveBattleManager.onBattleRequestAccept', battleInfo, inviter, invitee);
|
|
@@ -1669,13 +1779,93 @@ declare enum TUILiveBattleManagerEvents {
|
|
|
1669
1779
|
* @param {TUIBattleUser} invitee 接收PK请求的用户
|
|
1670
1780
|
*
|
|
1671
1781
|
* @example
|
|
1672
|
-
* const roomEngine =
|
|
1782
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1673
1783
|
* const liveBattleManager = roomEngine.TUILiveBattleManager();
|
|
1674
1784
|
* liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestReject, ({ battleInfo, inviter, invitee }) => {
|
|
1675
1785
|
* console.log('liveBattleManager.onBattleRequestReject', battleInfo, inviter, invitee);
|
|
1676
1786
|
* });
|
|
1677
1787
|
*/
|
|
1678
1788
|
onBattleRequestReject = "onBattleRequestReject"
|
|
1789
|
+
}
|
|
1790
|
+
/**
|
|
1791
|
+
* 礼物信息
|
|
1792
|
+
*/
|
|
1793
|
+
type GiftInfo = {
|
|
1794
|
+
giftID: string;
|
|
1795
|
+
name: string;
|
|
1796
|
+
desc: string;
|
|
1797
|
+
iconUrl: string;
|
|
1798
|
+
resourceUrl: string;
|
|
1799
|
+
level: number;
|
|
1800
|
+
coins: number;
|
|
1801
|
+
extensionInfo: Record<string, string>;
|
|
1802
|
+
};
|
|
1803
|
+
type TUIGiftInfo = GiftInfo;
|
|
1804
|
+
/**
|
|
1805
|
+
* 礼物分类信息
|
|
1806
|
+
*/
|
|
1807
|
+
type GiftCategory = {
|
|
1808
|
+
categoryID: string;
|
|
1809
|
+
name: string;
|
|
1810
|
+
desc: string;
|
|
1811
|
+
extensionInfo: Record<string, string>;
|
|
1812
|
+
giftList: GiftInfo[];
|
|
1813
|
+
};
|
|
1814
|
+
type TUIGiftCategory = GiftCategory;
|
|
1815
|
+
declare enum TUILiveGiftManagerEvents {
|
|
1816
|
+
/**
|
|
1817
|
+
* @description 接收到礼物数量发送变化监听事件
|
|
1818
|
+
* @default 'onGiftCountChanged'
|
|
1819
|
+
* @event TUILiveGiftManagerEvents#onGiftCountChanged
|
|
1820
|
+
* @param {object} options
|
|
1821
|
+
* @param {String} roomId 房间Id
|
|
1822
|
+
* @param {Number} totalGiftsSent 总礼物数
|
|
1823
|
+
* @param {Number} totalGiftCoins 总礼物价值
|
|
1824
|
+
* @param {Number} totalUniqueGiftSenders 总礼物发送者数量
|
|
1825
|
+
*
|
|
1826
|
+
* @example
|
|
1827
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1828
|
+
* const liveGiftManager = roomEngine.TUILiveGiftManager();
|
|
1829
|
+
* liveGiftManager.on(TUILiveGiftManagerEvents.onGiftCountChanged, ({ roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders }) => {
|
|
1830
|
+
* console.log('liveGiftManager.onGiftCountChanged', roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders);
|
|
1831
|
+
* });
|
|
1832
|
+
*/
|
|
1833
|
+
onGiftCountChanged = "onGiftCountChanged",
|
|
1834
|
+
/**
|
|
1835
|
+
* @description 接收到礼物消息的监听事件
|
|
1836
|
+
* @default 'onReceiveGiftMessage'
|
|
1837
|
+
* @event TUILiveGiftManagerEvents#onReceiveGiftMessage
|
|
1838
|
+
* @param {object} options
|
|
1839
|
+
* @param {String} roomId 房间Id
|
|
1840
|
+
* @param {GiftInfo} giftInfo 礼物信息
|
|
1841
|
+
* @param {number} count 礼物数量
|
|
1842
|
+
* @param {TUIUserInfo} sender 发送者信息
|
|
1843
|
+
*
|
|
1844
|
+
* @example
|
|
1845
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1846
|
+
* const liveGiftManager = roomEngine.TUILiveGiftManager();
|
|
1847
|
+
* liveGiftManager.on(TUILiveGiftManagerEvents.onReceiveGiftMessage, ({ roomId, giftInfo, count, sender }) => {
|
|
1848
|
+
* console.log('liveGiftManager.onReceiveGiftMessage', roomId, giftInfo, count, sender);
|
|
1849
|
+
* });
|
|
1850
|
+
*/
|
|
1851
|
+
onReceiveGiftMessage = "onReceiveGiftMessage",
|
|
1852
|
+
/**
|
|
1853
|
+
* @description 接收到点赞消息的监听事件
|
|
1854
|
+
* @default 'onReceiveLikesMessage'
|
|
1855
|
+
* @event TUILiveGiftManagerEvents#onReceiveLikesMessage
|
|
1856
|
+
* @param {object} options
|
|
1857
|
+
* @param {String} roomId 房间Id
|
|
1858
|
+
* @param {number} totalLikesReceived 总点赞数
|
|
1859
|
+
* @param {TUIUserInfo} sender 发送者信息
|
|
1860
|
+
*
|
|
1861
|
+
* @example
|
|
1862
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1863
|
+
* const liveGiftManager = roomEngine.TUILiveGiftManager();
|
|
1864
|
+
* liveGiftManager.on(TUILiveGiftManagerEvents.onReceiveLikesMessage, ({ roomId, totalLikesReceived, sender }) => {
|
|
1865
|
+
* console.log('liveGiftManager.onReceiveLikesMessage', roomId, totalLikesReceived, sender);
|
|
1866
|
+
* });
|
|
1867
|
+
*/
|
|
1868
|
+
onReceiveLikesMessage = "onReceiveLikesMessage"
|
|
1679
1869
|
}
|
|
1680
1870
|
|
|
1681
1871
|
declare class Logger {
|
|
@@ -1726,7 +1916,7 @@ declare class TUIRoomDeviceManager {
|
|
|
1726
1916
|
* @param {TRTCDeviceType} type 设备类型
|
|
1727
1917
|
* @example
|
|
1728
1918
|
* // 获取设备管理 Manager
|
|
1729
|
-
* const roomEngine =
|
|
1919
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1730
1920
|
* const deviceManager = roomEngine.getDeviceManager();
|
|
1731
1921
|
*
|
|
1732
1922
|
* // 获取摄像头设备列表
|
|
@@ -1746,7 +1936,7 @@ declare class TUIRoomDeviceManager {
|
|
|
1746
1936
|
* @param {string} deviceId 设备 Id
|
|
1747
1937
|
* @example
|
|
1748
1938
|
* // 获取设备管理 Manager
|
|
1749
|
-
* const roomEngine =
|
|
1939
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1750
1940
|
* const deviceManager = roomEngine.getDeviceManager();
|
|
1751
1941
|
*
|
|
1752
1942
|
* // 设置当前麦克风设备
|
|
@@ -1776,7 +1966,7 @@ declare class TUIRoomDeviceManager {
|
|
|
1776
1966
|
* @param {TUIMediaDeviceType} options.type 设备类型
|
|
1777
1967
|
* @example
|
|
1778
1968
|
* // 获取设备管理 Manager
|
|
1779
|
-
* const roomEngine =
|
|
1969
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1780
1970
|
* const deviceManager = roomEngine.getDeviceManager();
|
|
1781
1971
|
* @returns {TUIDeviceInfo}
|
|
1782
1972
|
*/
|
|
@@ -1790,7 +1980,7 @@ declare class TUIRoomDeviceManager {
|
|
|
1790
1980
|
* @returns {Promise<void>}
|
|
1791
1981
|
*
|
|
1792
1982
|
* @example
|
|
1793
|
-
* const roomEngine =
|
|
1983
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1794
1984
|
* await roomEngine.startCameraDeviceTest({ view: 'test-preview' });
|
|
1795
1985
|
*/
|
|
1796
1986
|
startCameraDeviceTest(options: {
|
|
@@ -1800,7 +1990,7 @@ declare class TUIRoomDeviceManager {
|
|
|
1800
1990
|
* 停止摄像头测试
|
|
1801
1991
|
* @returns {Promise<void>}
|
|
1802
1992
|
* @example
|
|
1803
|
-
* const roomEngine =
|
|
1993
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1804
1994
|
* await roomEngine.stopCameraDeviceTest();
|
|
1805
1995
|
*/
|
|
1806
1996
|
stopCameraDeviceTest(): Promise<void>;
|
|
@@ -1849,7 +2039,7 @@ declare class TUIRoomDeviceManager {
|
|
|
1849
2039
|
* @returns {void}
|
|
1850
2040
|
*
|
|
1851
2041
|
* @example
|
|
1852
|
-
* const roomEngine =
|
|
2042
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1853
2043
|
* const deviceManager = roomEngine.getDeviceManager();
|
|
1854
2044
|
* deviceManager.on(event, func);
|
|
1855
2045
|
*/
|
|
@@ -1909,7 +2099,7 @@ declare class TUIConferenceListManager {
|
|
|
1909
2099
|
* @returns {Promise<void>}
|
|
1910
2100
|
*
|
|
1911
2101
|
* @example
|
|
1912
|
-
* const roomEngine =
|
|
2102
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1913
2103
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
1914
2104
|
* await conferenceListManager.scheduleConference({
|
|
1915
2105
|
* roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
|
|
@@ -1942,7 +2132,7 @@ declare class TUIConferenceListManager {
|
|
|
1942
2132
|
* @returns {Promise<void>}
|
|
1943
2133
|
*
|
|
1944
2134
|
* @example
|
|
1945
|
-
* const roomEngine =
|
|
2135
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1946
2136
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
1947
2137
|
* await conferenceListManager.cancelConference({
|
|
1948
2138
|
* roomId: '12345', // 填入您要取消的会议 Id ,即房间 roomId 。
|
|
@@ -1962,7 +2152,7 @@ declare class TUIConferenceListManager {
|
|
|
1962
2152
|
* @returns {Promise<void>}
|
|
1963
2153
|
*
|
|
1964
2154
|
* @example
|
|
1965
|
-
* const roomEngine =
|
|
2155
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1966
2156
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
1967
2157
|
* await conferenceListManager.updateConferenceInfo({
|
|
1968
2158
|
* roomId: '12345', // 填入您要更新的会议房间 roomId 。
|
|
@@ -1986,7 +2176,7 @@ declare class TUIConferenceListManager {
|
|
|
1986
2176
|
* @param {number} options.count 本次拉取数量。
|
|
1987
2177
|
*
|
|
1988
2178
|
* @example
|
|
1989
|
-
* const roomEngine =
|
|
2179
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
1990
2180
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
1991
2181
|
* const conferenceList = [];
|
|
1992
2182
|
* let result;
|
|
@@ -2012,7 +2202,7 @@ declare class TUIConferenceListManager {
|
|
|
2012
2202
|
* @param {number} options.count 本次拉取数量。
|
|
2013
2203
|
*
|
|
2014
2204
|
* @example
|
|
2015
|
-
* const roomEngine =
|
|
2205
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2016
2206
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
2017
2207
|
* const attendeeList = [];
|
|
2018
2208
|
* let result;
|
|
@@ -2041,7 +2231,7 @@ declare class TUIConferenceListManager {
|
|
|
2041
2231
|
* @returns {Promise<void>}
|
|
2042
2232
|
*
|
|
2043
2233
|
* @example
|
|
2044
|
-
* const roomEngine =
|
|
2234
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2045
2235
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
2046
2236
|
* await conferenceListManager.addAttendeesByAdmin({
|
|
2047
2237
|
* roomId: '12345', // 填入您要添加成员的会议 Id ,即房间 roomId 。
|
|
@@ -2061,7 +2251,7 @@ declare class TUIConferenceListManager {
|
|
|
2061
2251
|
* @returns {Promise<void>}
|
|
2062
2252
|
*
|
|
2063
2253
|
* @example
|
|
2064
|
-
* const roomEngine =
|
|
2254
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2065
2255
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
2066
2256
|
* await conferenceListManager.removeAttendeesByAdmin({
|
|
2067
2257
|
* roomId: '12345', // 填入您要移除成员的会议 Id ,即房间 roomId 。
|
|
@@ -2079,7 +2269,7 @@ declare class TUIConferenceListManager {
|
|
|
2079
2269
|
* @returns {void}
|
|
2080
2270
|
*
|
|
2081
2271
|
* @example
|
|
2082
|
-
* const roomEngine =
|
|
2272
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2083
2273
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
2084
2274
|
* conferenceListManager.on(event, func);
|
|
2085
2275
|
*/
|
|
@@ -2093,7 +2283,7 @@ declare class TUIConferenceListManager {
|
|
|
2093
2283
|
* @returns {void}
|
|
2094
2284
|
*
|
|
2095
2285
|
* @example
|
|
2096
|
-
* const roomEngine =
|
|
2286
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2097
2287
|
* const conferenceListManager = roomEngine.getConferenceListManager();
|
|
2098
2288
|
* conferenceListManager.off(event, func);
|
|
2099
2289
|
*/
|
|
@@ -2133,7 +2323,7 @@ declare class TUIConferenceInvitationManager {
|
|
|
2133
2323
|
* @returns {Promise<void>}
|
|
2134
2324
|
*
|
|
2135
2325
|
* @example
|
|
2136
|
-
* const roomEngine =
|
|
2326
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2137
2327
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
2138
2328
|
* await conferenceInvitationManager.inviteUsers({
|
|
2139
2329
|
* roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
|
|
@@ -2156,7 +2346,7 @@ declare class TUIConferenceInvitationManager {
|
|
|
2156
2346
|
* @returns {Promise<void>}
|
|
2157
2347
|
*
|
|
2158
2348
|
* @example
|
|
2159
|
-
* const roomEngine =
|
|
2349
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2160
2350
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
2161
2351
|
* await conferenceInvitationManager.cancelInvitation({
|
|
2162
2352
|
* roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
|
|
@@ -2175,7 +2365,7 @@ declare class TUIConferenceInvitationManager {
|
|
|
2175
2365
|
* @returns {Promise<void>}
|
|
2176
2366
|
*
|
|
2177
2367
|
* @example
|
|
2178
|
-
* const roomEngine =
|
|
2368
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2179
2369
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
2180
2370
|
* await conferenceInvitationManager.accept({
|
|
2181
2371
|
* roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
|
|
@@ -2193,7 +2383,7 @@ declare class TUIConferenceInvitationManager {
|
|
|
2193
2383
|
* @returns {Promise<void>}
|
|
2194
2384
|
*
|
|
2195
2385
|
* @example
|
|
2196
|
-
* const roomEngine =
|
|
2386
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2197
2387
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
2198
2388
|
* await conferenceInvitationManager.reject({
|
|
2199
2389
|
* roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
|
|
@@ -2214,7 +2404,7 @@ declare class TUIConferenceInvitationManager {
|
|
|
2214
2404
|
* @returns {Promise<Array<TUIInvitation>>}
|
|
2215
2405
|
*
|
|
2216
2406
|
* @example
|
|
2217
|
-
* const roomEngine =
|
|
2407
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2218
2408
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
2219
2409
|
* const invitationList = [];
|
|
2220
2410
|
* let result;
|
|
@@ -2241,7 +2431,7 @@ declare class TUIConferenceInvitationManager {
|
|
|
2241
2431
|
* @returns {void}
|
|
2242
2432
|
*
|
|
2243
2433
|
* @example
|
|
2244
|
-
* const roomEngine =
|
|
2434
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2245
2435
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
2246
2436
|
* conferenceInvitationManager.on(event, func);
|
|
2247
2437
|
*/
|
|
@@ -2254,7 +2444,7 @@ declare class TUIConferenceInvitationManager {
|
|
|
2254
2444
|
* @returns {void}
|
|
2255
2445
|
*
|
|
2256
2446
|
* @example
|
|
2257
|
-
* const roomEngine =
|
|
2447
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2258
2448
|
* const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
|
|
2259
2449
|
* conferenceInvitationManager.off(event, func);
|
|
2260
2450
|
*/
|
|
@@ -2306,13 +2496,13 @@ declare class TUILiveListManager {
|
|
|
2306
2496
|
* isPublicVisible: false,
|
|
2307
2497
|
* keepOwnerOnSeat: false,
|
|
2308
2498
|
* };
|
|
2309
|
-
* const roomEngine =
|
|
2499
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2310
2500
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
2311
2501
|
* const resultLiveInfo = await liveListManager.startLive(liveInfo);
|
|
2312
2502
|
* console.log('直播开始成功,CDN流地址:', resultLiveInfo.cdnStreamUrl);
|
|
2313
2503
|
* ```
|
|
2314
2504
|
*/
|
|
2315
|
-
startLive(liveInfo: TUILiveInfo): Promise<TUILiveInfo>;
|
|
2505
|
+
startLive(liveInfo: StartLiveOptions | TUILiveInfo): Promise<TUILiveInfo>;
|
|
2316
2506
|
/**
|
|
2317
2507
|
* 停止直播
|
|
2318
2508
|
*
|
|
@@ -2326,7 +2516,7 @@ declare class TUILiveListManager {
|
|
|
2326
2516
|
* @example
|
|
2327
2517
|
* ```typescript
|
|
2328
2518
|
* try {
|
|
2329
|
-
* const roomEngine =
|
|
2519
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2330
2520
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
2331
2521
|
* const statistics = await liveListManager.stopLive();
|
|
2332
2522
|
* console.log('直播结束,统计数据:', {
|
|
@@ -2355,7 +2545,7 @@ declare class TUILiveListManager {
|
|
|
2355
2545
|
* @example
|
|
2356
2546
|
* ```typescript
|
|
2357
2547
|
* try {
|
|
2358
|
-
* const roomEngine =
|
|
2548
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2359
2549
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
2360
2550
|
* const liveInfo = await liveListManager.joinLive('live_room_123');
|
|
2361
2551
|
* console.log('成功加入直播间:', {
|
|
@@ -2383,7 +2573,7 @@ declare class TUILiveListManager {
|
|
|
2383
2573
|
* @example
|
|
2384
2574
|
* ```typescript
|
|
2385
2575
|
* try {
|
|
2386
|
-
* const roomEngine =
|
|
2576
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2387
2577
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
2388
2578
|
* await liveListManager.leaveLive();
|
|
2389
2579
|
* console.log('成功离开直播间');
|
|
@@ -2406,7 +2596,7 @@ declare class TUILiveListManager {
|
|
|
2406
2596
|
* @returns {Promise<void>}
|
|
2407
2597
|
*
|
|
2408
2598
|
* @example
|
|
2409
|
-
* const roomEngine =
|
|
2599
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2410
2600
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
2411
2601
|
* liveListManager.setLiveInfo({
|
|
2412
2602
|
* roomId: "141569",
|
|
@@ -2434,7 +2624,7 @@ declare class TUILiveListManager {
|
|
|
2434
2624
|
* @returns {Promise<TUILiveInfo>}
|
|
2435
2625
|
*
|
|
2436
2626
|
* @example
|
|
2437
|
-
* const roomEngine =
|
|
2627
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2438
2628
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
2439
2629
|
* const result = await liveListManager.getLiveInfo({ roomId: "141569" });
|
|
2440
2630
|
*/
|
|
@@ -2450,7 +2640,7 @@ declare class TUILiveListManager {
|
|
|
2450
2640
|
* @returns {Promise<TUILiveListResult>}
|
|
2451
2641
|
*
|
|
2452
2642
|
* @example
|
|
2453
|
-
* const roomEngine =
|
|
2643
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2454
2644
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
2455
2645
|
* const liveList = [];
|
|
2456
2646
|
* let cursor = '';
|
|
@@ -2502,7 +2692,7 @@ declare class TUILiveListManager {
|
|
|
2502
2692
|
* @param {Function} func - 事件回调函数
|
|
2503
2693
|
*
|
|
2504
2694
|
* @example
|
|
2505
|
-
* const roomEngine =
|
|
2695
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2506
2696
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
2507
2697
|
* const callback = ({ liveModifyInfo }) => {
|
|
2508
2698
|
* console.log('liveListManager.onLiveInfoChanged', liveModifyInfo);
|
|
@@ -2516,7 +2706,7 @@ declare class TUILiveListManager {
|
|
|
2516
2706
|
* @param {Function} func - 事件回调函数
|
|
2517
2707
|
*
|
|
2518
2708
|
* @example
|
|
2519
|
-
* const roomEngine =
|
|
2709
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2520
2710
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
2521
2711
|
* const callback = ({ liveModifyInfo }) => {
|
|
2522
2712
|
* console.log('liveListManager.onLiveInfoChanged', liveModifyInfo);
|
|
@@ -2550,7 +2740,7 @@ declare class TUILiveLayoutManager {
|
|
|
2550
2740
|
* @param func 事件回调函数
|
|
2551
2741
|
*
|
|
2552
2742
|
* @example
|
|
2553
|
-
* const roomEngine =
|
|
2743
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2554
2744
|
* const liveLayoutManager = roomEngine.getLiveLayoutManager();
|
|
2555
2745
|
* const callback = (roomId, layoutInfo) => {
|
|
2556
2746
|
* console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
|
|
@@ -2564,7 +2754,7 @@ declare class TUILiveLayoutManager {
|
|
|
2564
2754
|
* @param {Function} func 事件回调函数
|
|
2565
2755
|
*
|
|
2566
2756
|
* @example
|
|
2567
|
-
* const roomEngine =
|
|
2757
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2568
2758
|
* const liveLayoutManager = roomEngine.getLiveLayoutManager();
|
|
2569
2759
|
* const callback = (roomId, layoutInfo) => {
|
|
2570
2760
|
* console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
|
|
@@ -2580,7 +2770,7 @@ declare class TUILiveLayoutManager {
|
|
|
2580
2770
|
* @returns {Promise<void>}
|
|
2581
2771
|
*
|
|
2582
2772
|
* @example
|
|
2583
|
-
* const roomEngine =
|
|
2773
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2584
2774
|
* const liveLayoutManager = roomEngine.getLiveLayoutManager();
|
|
2585
2775
|
* liveLayoutManager.setLiveStreamLayoutInfo('roomId', '{
|
|
2586
2776
|
* // 设置画布大小
|
|
@@ -2647,7 +2837,7 @@ declare class TUILiveConnectionManager {
|
|
|
2647
2837
|
* @returns {Promise<void>}
|
|
2648
2838
|
*
|
|
2649
2839
|
* @example
|
|
2650
|
-
* const roomEngine =
|
|
2840
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2651
2841
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
2652
2842
|
* liveConnectionManager.requestConnection({
|
|
2653
2843
|
* roomIdList: ['roomId1','roomId2'],
|
|
@@ -2659,7 +2849,7 @@ declare class TUILiveConnectionManager {
|
|
|
2659
2849
|
roomIdList: Array<string>;
|
|
2660
2850
|
timeout: number;
|
|
2661
2851
|
extensionInfo?: string;
|
|
2662
|
-
}): Promise<
|
|
2852
|
+
}): Promise<Map<string, TUIConnectionCode>>;
|
|
2663
2853
|
/**
|
|
2664
2854
|
* 取消跨房连线请求
|
|
2665
2855
|
*
|
|
@@ -2668,7 +2858,7 @@ declare class TUILiveConnectionManager {
|
|
|
2668
2858
|
* @returns {Promise<void>}
|
|
2669
2859
|
*
|
|
2670
2860
|
* @example
|
|
2671
|
-
* const roomEngine =
|
|
2861
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2672
2862
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
2673
2863
|
* liveConnectionManager.cancelConnectionRequest({
|
|
2674
2864
|
* roomIdList: ['roomId1', 'roomId2']
|
|
@@ -2685,7 +2875,7 @@ declare class TUILiveConnectionManager {
|
|
|
2685
2875
|
* @returns {Promise<void>}
|
|
2686
2876
|
*
|
|
2687
2877
|
* @example
|
|
2688
|
-
* const roomEngine =
|
|
2878
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2689
2879
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
2690
2880
|
* liveConnectionManager.acceptConnection({
|
|
2691
2881
|
* roomId: 'roomId'
|
|
@@ -2702,7 +2892,7 @@ declare class TUILiveConnectionManager {
|
|
|
2702
2892
|
* @returns {Promise<void>}
|
|
2703
2893
|
*
|
|
2704
2894
|
* @example
|
|
2705
|
-
* const roomEngine =
|
|
2895
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2706
2896
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
2707
2897
|
* liveConnectionManager.rejectConnection({
|
|
2708
2898
|
* roomId: 'roomId'
|
|
@@ -2717,7 +2907,7 @@ declare class TUILiveConnectionManager {
|
|
|
2717
2907
|
* @returns {Promise<void>}
|
|
2718
2908
|
*
|
|
2719
2909
|
* @example
|
|
2720
|
-
* const roomEngine =
|
|
2910
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2721
2911
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
2722
2912
|
* liveConnectionManager.disconnect();
|
|
2723
2913
|
*/
|
|
@@ -2729,7 +2919,7 @@ declare class TUILiveConnectionManager {
|
|
|
2729
2919
|
* @param func 事件回调函数
|
|
2730
2920
|
*
|
|
2731
2921
|
* @example
|
|
2732
|
-
* const roomEngine =
|
|
2922
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2733
2923
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
2734
2924
|
* const callback = (inviter) => {
|
|
2735
2925
|
* console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
|
|
@@ -2743,7 +2933,7 @@ declare class TUILiveConnectionManager {
|
|
|
2743
2933
|
* @param func 事件回调函数
|
|
2744
2934
|
*
|
|
2745
2935
|
* @example
|
|
2746
|
-
* const roomEngine =
|
|
2936
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2747
2937
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
2748
2938
|
* const callback = (inviter) => {
|
|
2749
2939
|
* console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
|
|
@@ -2777,7 +2967,7 @@ declare class TUILiveBattleManager {
|
|
|
2777
2967
|
* @returns {Promise<void>}
|
|
2778
2968
|
*
|
|
2779
2969
|
* @example
|
|
2780
|
-
* const roomEngine =
|
|
2970
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2781
2971
|
* const liveBattleManager = roomEngine.getLiveBattleManager();
|
|
2782
2972
|
* liveBattleManager.requestBattle({
|
|
2783
2973
|
* config: {duration: 100, needResponse: true},
|
|
@@ -2799,7 +2989,7 @@ declare class TUILiveBattleManager {
|
|
|
2799
2989
|
* @returns {Promise<void>}
|
|
2800
2990
|
*
|
|
2801
2991
|
* @example
|
|
2802
|
-
* const roomEngine =
|
|
2992
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2803
2993
|
* const liveBattleManager = roomEngine.getLiveBattleManager();
|
|
2804
2994
|
* liveBattleManager.cancelBattleRequest({
|
|
2805
2995
|
* battleId: 'battleId',
|
|
@@ -2818,7 +3008,7 @@ declare class TUILiveBattleManager {
|
|
|
2818
3008
|
* @returns {Promise<void>}
|
|
2819
3009
|
*
|
|
2820
3010
|
* @example
|
|
2821
|
-
* const roomEngine =
|
|
3011
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2822
3012
|
* const liveBattleManager = roomEngine.getLiveBattleManager();
|
|
2823
3013
|
* liveBattleManager.acceptBattle({
|
|
2824
3014
|
* battleId: 'battleId',
|
|
@@ -2835,7 +3025,7 @@ declare class TUILiveBattleManager {
|
|
|
2835
3025
|
* @returns {Promise<void>}
|
|
2836
3026
|
*
|
|
2837
3027
|
* @example
|
|
2838
|
-
* const roomEngine =
|
|
3028
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2839
3029
|
* const liveBattleManager = roomEngine.getLiveBattleManager();
|
|
2840
3030
|
* liveBattleManager.rejectBattle({
|
|
2841
3031
|
* battleId: 'battleId',
|
|
@@ -2852,7 +3042,7 @@ declare class TUILiveBattleManager {
|
|
|
2852
3042
|
* @returns {Promise<void>}
|
|
2853
3043
|
*
|
|
2854
3044
|
* @example
|
|
2855
|
-
* const roomEngine =
|
|
3045
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2856
3046
|
* const liveBattleManager = roomEngine.getLiveBattleManager();
|
|
2857
3047
|
* liveBattleManager.exitBattle({
|
|
2858
3048
|
* battleId: 'battleId',
|
|
@@ -2867,7 +3057,7 @@ declare class TUILiveBattleManager {
|
|
|
2867
3057
|
* @param func 事件回调函数
|
|
2868
3058
|
*
|
|
2869
3059
|
* @example
|
|
2870
|
-
* const roomEngine =
|
|
3060
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2871
3061
|
* const liveBattleManager = roomEngine.getLiveBattleManager();
|
|
2872
3062
|
* const callback = (battleInfo) => {
|
|
2873
3063
|
* console.log('liveBattleManager.onBattleStarted', battleInfo);
|
|
@@ -2881,7 +3071,7 @@ declare class TUILiveBattleManager {
|
|
|
2881
3071
|
* @param func 事件回调函数
|
|
2882
3072
|
*
|
|
2883
3073
|
* @example
|
|
2884
|
-
* const roomEngine =
|
|
3074
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
2885
3075
|
* const liveBattleManager = roomEngine.getLiveBattleManager();
|
|
2886
3076
|
* const callback = (battleInfo) => {
|
|
2887
3077
|
* console.log('liveBattleManager.onBattleStarted', battleInfo);
|
|
@@ -2893,6 +3083,151 @@ declare class TUILiveBattleManager {
|
|
|
2893
3083
|
private observerFunction;
|
|
2894
3084
|
}
|
|
2895
3085
|
|
|
3086
|
+
declare class TUILiveGiftManager {
|
|
3087
|
+
private liveGiftManagerWASM;
|
|
3088
|
+
private logger;
|
|
3089
|
+
private static liveGiftManager;
|
|
3090
|
+
constructor(options: {
|
|
3091
|
+
Module: any;
|
|
3092
|
+
logger: Logger;
|
|
3093
|
+
roomEngineWASM: any;
|
|
3094
|
+
});
|
|
3095
|
+
/**
|
|
3096
|
+
* 获取礼物列表
|
|
3097
|
+
*
|
|
3098
|
+
* @param {object} options
|
|
3099
|
+
* @param {String} options.roomId 房间ID
|
|
3100
|
+
* @returns {Promise<{giftCategoryList: GiftCategory[]}>}
|
|
3101
|
+
*
|
|
3102
|
+
* @example
|
|
3103
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3104
|
+
* const liveGiftManager = roomEngine.getLiveGiftManager();
|
|
3105
|
+
* liveGiftManager.getGiftList({
|
|
3106
|
+
* roomId: 'roomId'
|
|
3107
|
+
* });
|
|
3108
|
+
*/
|
|
3109
|
+
getGiftList(options: {
|
|
3110
|
+
roomId: string;
|
|
3111
|
+
}): Promise<{
|
|
3112
|
+
giftCategoryList: GiftCategory[];
|
|
3113
|
+
}>;
|
|
3114
|
+
/**
|
|
3115
|
+
* 发送礼物
|
|
3116
|
+
*
|
|
3117
|
+
* @param {object} options
|
|
3118
|
+
* @param {string} options.roomId 房间ID
|
|
3119
|
+
* @param {string} options.giftId 礼物ID
|
|
3120
|
+
* @param {number} options.count 礼物数量
|
|
3121
|
+
* @returns {Promise<void>}
|
|
3122
|
+
*
|
|
3123
|
+
* @example
|
|
3124
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3125
|
+
* const liveGiftManager = roomEngine.getLiveGiftManager();
|
|
3126
|
+
* liveGiftManager.sendGift({
|
|
3127
|
+
* roomId: 'roomId',
|
|
3128
|
+
* giftId: 'giftId',
|
|
3129
|
+
* count: 1
|
|
3130
|
+
* });
|
|
3131
|
+
*/
|
|
3132
|
+
sendGift(options: {
|
|
3133
|
+
roomId: string;
|
|
3134
|
+
giftId: string;
|
|
3135
|
+
count: number;
|
|
3136
|
+
}): Promise<void>;
|
|
3137
|
+
/**
|
|
3138
|
+
* 发送点赞
|
|
3139
|
+
*
|
|
3140
|
+
* @param {object} options
|
|
3141
|
+
* @param {string} options.roomId 房间ID
|
|
3142
|
+
* @param {number} options.count 点赞数量
|
|
3143
|
+
* @returns {Promise<void>}
|
|
3144
|
+
*
|
|
3145
|
+
* @example
|
|
3146
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3147
|
+
* const liveGiftManager = roomEngine.getLiveGiftManager();
|
|
3148
|
+
* liveGiftManager.sendLikes({
|
|
3149
|
+
* roomId: 'roomId',
|
|
3150
|
+
* count: 1
|
|
3151
|
+
* });
|
|
3152
|
+
*/
|
|
3153
|
+
sendLikes(options: {
|
|
3154
|
+
roomId: string;
|
|
3155
|
+
count: number;
|
|
3156
|
+
}): Promise<void>;
|
|
3157
|
+
/**
|
|
3158
|
+
* 获取礼物数量
|
|
3159
|
+
*
|
|
3160
|
+
* @param {object} options
|
|
3161
|
+
* @param {string} options.roomId 房间ID
|
|
3162
|
+
* @returns {Promise<{totalGiftCoins:number, totalGiftsSent: number, totalUniqueGiftSenders: number}>}
|
|
3163
|
+
*
|
|
3164
|
+
* @example
|
|
3165
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3166
|
+
* const liveGiftManager = roomEngine.getLiveGiftManager();
|
|
3167
|
+
* liveGiftManager.getGiftCountByAnchor({
|
|
3168
|
+
* roomId: 'roomId'
|
|
3169
|
+
* });
|
|
3170
|
+
*/
|
|
3171
|
+
getGiftCountByAnchor(options: {
|
|
3172
|
+
roomId: string;
|
|
3173
|
+
}): Promise<{
|
|
3174
|
+
totalGiftCoins: number;
|
|
3175
|
+
totalGiftsSent: number;
|
|
3176
|
+
totalUniqueGiftSenders: number;
|
|
3177
|
+
}>;
|
|
3178
|
+
/**
|
|
3179
|
+
* 获取点赞数量
|
|
3180
|
+
*
|
|
3181
|
+
* @param {object} options
|
|
3182
|
+
* @param {string} options.roomId 房间ID
|
|
3183
|
+
* @returns {Promise<{totalLikesReceived: number}>}
|
|
3184
|
+
*
|
|
3185
|
+
* @example
|
|
3186
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3187
|
+
* const liveGiftManager = roomEngine.getLiveGiftManager();
|
|
3188
|
+
* liveGiftManager.getLikesCount({
|
|
3189
|
+
* roomId: 'roomId'
|
|
3190
|
+
* });
|
|
3191
|
+
*/
|
|
3192
|
+
getLikesCount(options: {
|
|
3193
|
+
roomId: string;
|
|
3194
|
+
}): Promise<{
|
|
3195
|
+
totalLikesReceived: number;
|
|
3196
|
+
}>;
|
|
3197
|
+
/**
|
|
3198
|
+
* 监听 TUILiveGiftManager 事件
|
|
3199
|
+
* @param {TUILiveGiftManagerEvents} event 事件名
|
|
3200
|
+
* @param func 事件回调函数
|
|
3201
|
+
*
|
|
3202
|
+
* @example
|
|
3203
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3204
|
+
* const liveGiftManager = roomEngine.getLiveGiftManager();
|
|
3205
|
+
*
|
|
3206
|
+
* const callback = ({ roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders }) => {
|
|
3207
|
+
* console.log('Demo onGiftCountChanged', { roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders });
|
|
3208
|
+
* }
|
|
3209
|
+
* liveGiftManager.on(TUILiveGiftManagerEvents.onGiftCountChanged, callback);
|
|
3210
|
+
*/
|
|
3211
|
+
on(event: TUILiveGiftManagerEvents, func: (...args: any[]) => void): void;
|
|
3212
|
+
/**
|
|
3213
|
+
* 取消监听 TUIliveGiftManager 事件
|
|
3214
|
+
* @param {TUILiveGiftManagerEvents} event 事件名
|
|
3215
|
+
* @param func 事件回调函数
|
|
3216
|
+
*
|
|
3217
|
+
* @example
|
|
3218
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3219
|
+
* const liveGiftManager = roomEngine.getLiveGiftManager();
|
|
3220
|
+
*
|
|
3221
|
+
* const callback = ({ roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders }) => {
|
|
3222
|
+
* console.log('Demo onGiftCountChanged', { roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders });
|
|
3223
|
+
* }
|
|
3224
|
+
* liveGiftManager.off(TUILiveGiftManagerEvents.onGiftCountChanged, callback);
|
|
3225
|
+
*/
|
|
3226
|
+
off(event: TUILiveGiftManagerEvents, func: (...args: any[]) => void): void;
|
|
3227
|
+
private JSCallNativeFunctionPromise;
|
|
3228
|
+
private observerFunction;
|
|
3229
|
+
}
|
|
3230
|
+
|
|
2896
3231
|
/**
|
|
2897
3232
|
* TUIRoomEngine 提供了音视频房间的能力
|
|
2898
3233
|
*
|
|
@@ -2910,6 +3245,7 @@ declare class TUIRoomEngine {
|
|
|
2910
3245
|
private liveLayoutManager;
|
|
2911
3246
|
private liveConnectionManager;
|
|
2912
3247
|
private liveBattleManager;
|
|
3248
|
+
private liveGiftManager;
|
|
2913
3249
|
private static userId;
|
|
2914
3250
|
private static sdkAppId;
|
|
2915
3251
|
private static Module;
|
|
@@ -2940,10 +3276,18 @@ declare class TUIRoomEngine {
|
|
|
2940
3276
|
/**
|
|
2941
3277
|
* @private
|
|
2942
3278
|
* 调用 TUIRoomEngineWASM 的 CallAPI 方法
|
|
3279
|
+
* 该接口废弃,后续逐步替换为 JSCallNativeCallAPIPromiseNew 方法
|
|
2943
3280
|
* @param funcName
|
|
2944
3281
|
* @param jsonString
|
|
2945
3282
|
*/
|
|
2946
3283
|
private JSCallNativeCallAPIPromise;
|
|
3284
|
+
/**
|
|
3285
|
+
* 调用 roomEngineWASM 的 CallAPI 方法
|
|
3286
|
+
* @param funcName 函数名
|
|
3287
|
+
* @param args 参数
|
|
3288
|
+
* @returns Promise
|
|
3289
|
+
*/
|
|
3290
|
+
private JSCallNativeCallAPIPromiseNew;
|
|
2947
3291
|
/**
|
|
2948
3292
|
* 登录 TUIRoomEngine
|
|
2949
3293
|
*
|
|
@@ -3046,7 +3390,7 @@ declare class TUIRoomEngine {
|
|
|
3046
3390
|
* @returns {Promise<void>}
|
|
3047
3391
|
*
|
|
3048
3392
|
* @example
|
|
3049
|
-
* const roomEngine =
|
|
3393
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3050
3394
|
* await roomEngine.createRoom({
|
|
3051
3395
|
* roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
|
|
3052
3396
|
* roomName: 'Test Room', // 填入您的房间名称, 房间名称默认为 roomId,最长 30 字节
|
|
@@ -3079,7 +3423,7 @@ declare class TUIRoomEngine {
|
|
|
3079
3423
|
* 该接口返回当前房间信息
|
|
3080
3424
|
*
|
|
3081
3425
|
* @example
|
|
3082
|
-
* const roomEngine =
|
|
3426
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3083
3427
|
* const roomDetailInfo = await roomEngine.enterRoom({
|
|
3084
3428
|
* roomId: '12345',
|
|
3085
3429
|
* roomType: TUIRoomType.kConference, // 设置房间类型为 TUIRoomType.kConference 类型
|
|
@@ -3098,7 +3442,7 @@ declare class TUIRoomEngine {
|
|
|
3098
3442
|
* @returns {Promise<void>}
|
|
3099
3443
|
*
|
|
3100
3444
|
* @example
|
|
3101
|
-
* const roomEngine =
|
|
3445
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3102
3446
|
* await roomEngine.destroyRoom();
|
|
3103
3447
|
*/
|
|
3104
3448
|
destroyRoom(): Promise<void>;
|
|
@@ -3107,7 +3451,7 @@ declare class TUIRoomEngine {
|
|
|
3107
3451
|
* @returns {Promise<void>}
|
|
3108
3452
|
*
|
|
3109
3453
|
* @example
|
|
3110
|
-
* const roomEngine =
|
|
3454
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3111
3455
|
* await roomEngine.exitRoom();
|
|
3112
3456
|
*/
|
|
3113
3457
|
exitRoom(): Promise<void>;
|
|
@@ -3118,7 +3462,7 @@ declare class TUIRoomEngine {
|
|
|
3118
3462
|
* @param {TUIRoomType} options.roomType 要获取信息的房间类型。
|
|
3119
3463
|
* @returns {Promise<TUIRoomInfo>} roomInfo
|
|
3120
3464
|
* @example
|
|
3121
|
-
* const roomEngine =
|
|
3465
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3122
3466
|
* const roomInfo = await roomEngine.fetchRoomInfo({
|
|
3123
3467
|
* roomId: '12345',
|
|
3124
3468
|
* roomType: TUIRoomType.kConference,
|
|
@@ -3134,7 +3478,7 @@ declare class TUIRoomEngine {
|
|
|
3134
3478
|
* @param {string} options.roomName 更新当前房间的名字
|
|
3135
3479
|
* @returns {Promise<void>}
|
|
3136
3480
|
* @example
|
|
3137
|
-
* const roomEngine =
|
|
3481
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3138
3482
|
* await roomEngine.createRoom({ roomId: '12345' });
|
|
3139
3483
|
* await roomEngine.updateRoomNameByAdmin({ roomName: '新的名字' });
|
|
3140
3484
|
*/
|
|
@@ -3150,7 +3494,7 @@ declare class TUIRoomEngine {
|
|
|
3150
3494
|
* @returns {Promise<void>}
|
|
3151
3495
|
*
|
|
3152
3496
|
* @example
|
|
3153
|
-
* const roomEngine =
|
|
3497
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3154
3498
|
* await roomEngine.updateRoomSeatModeByAdmin({
|
|
3155
3499
|
* seatMode: TUISeatMode.kApplyToTake, // 更新为申请上麦模式
|
|
3156
3500
|
* });
|
|
@@ -3167,7 +3511,7 @@ declare class TUIRoomEngine {
|
|
|
3167
3511
|
* @returns {Promise<void>}
|
|
3168
3512
|
*
|
|
3169
3513
|
* @example
|
|
3170
|
-
* const roomEngine =
|
|
3514
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3171
3515
|
* await roomEngine.updateRoomPasswordByAdmin({
|
|
3172
3516
|
* password: '1234', // 更新密码为 1234
|
|
3173
3517
|
* });
|
|
@@ -3185,7 +3529,7 @@ declare class TUIRoomEngine {
|
|
|
3185
3529
|
* result.userInfoList 本次拉取的 userList
|
|
3186
3530
|
*
|
|
3187
3531
|
* @example
|
|
3188
|
-
* const roomEngine =
|
|
3532
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3189
3533
|
* const userList = [];
|
|
3190
3534
|
* let result;
|
|
3191
3535
|
* let nextSequence = 0;
|
|
@@ -3206,7 +3550,7 @@ declare class TUIRoomEngine {
|
|
|
3206
3550
|
* 该接口返回指定用户的用户信息
|
|
3207
3551
|
*
|
|
3208
3552
|
* @example
|
|
3209
|
-
* const roomEngine =
|
|
3553
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3210
3554
|
* const userInfo = await roomEngine.getUserInfo({
|
|
3211
3555
|
* userId: 'user_12345',
|
|
3212
3556
|
* });
|
|
@@ -3224,7 +3568,7 @@ declare class TUIRoomEngine {
|
|
|
3224
3568
|
* @param {object} options.customInfo 用户自定义信息
|
|
3225
3569
|
*
|
|
3226
3570
|
* @example
|
|
3227
|
-
* const roomEngine =
|
|
3571
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3228
3572
|
* await roomEngine.setCustomInfoForUser({
|
|
3229
3573
|
* userId: 'user_12345',
|
|
3230
3574
|
* customInfo: {
|
|
@@ -3245,7 +3589,7 @@ declare class TUIRoomEngine {
|
|
|
3245
3589
|
* @desc 自 v1.6.1 版本起,setLocalVideoView 不再需要传入 streamType 参数
|
|
3246
3590
|
*
|
|
3247
3591
|
* @example
|
|
3248
|
-
* const roomEngine =
|
|
3592
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3249
3593
|
*
|
|
3250
3594
|
* // 设置本地摄像头流的播放区域为 id 是 'preview-camera' 的 div 元素
|
|
3251
3595
|
* roomEngine.setLocalVideoView({
|
|
@@ -3261,7 +3605,7 @@ declare class TUIRoomEngine {
|
|
|
3261
3605
|
* @param {object} options 设置本地流的参数
|
|
3262
3606
|
* @returns {Promise<void>}
|
|
3263
3607
|
* @example
|
|
3264
|
-
* const roomEngine =
|
|
3608
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3265
3609
|
* await roomEngine.openLocalCamera();
|
|
3266
3610
|
*/
|
|
3267
3611
|
openLocalCamera(): Promise<void>;
|
|
@@ -3270,7 +3614,7 @@ declare class TUIRoomEngine {
|
|
|
3270
3614
|
* @returns {Promise<void>}
|
|
3271
3615
|
*
|
|
3272
3616
|
* @example
|
|
3273
|
-
* const roomEngine =
|
|
3617
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3274
3618
|
* await roomEngine.closeLocalCamera();
|
|
3275
3619
|
*/
|
|
3276
3620
|
closeLocalCamera(): Promise<void>;
|
|
@@ -3279,7 +3623,7 @@ declare class TUIRoomEngine {
|
|
|
3279
3623
|
* @returns {Promise<void>}
|
|
3280
3624
|
*
|
|
3281
3625
|
* @example
|
|
3282
|
-
* const roomEngine =
|
|
3626
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3283
3627
|
* await roomEngine.openLocalMicrophone();
|
|
3284
3628
|
*/
|
|
3285
3629
|
openLocalMicrophone(): Promise<void>;
|
|
@@ -3288,7 +3632,7 @@ declare class TUIRoomEngine {
|
|
|
3288
3632
|
* @returns {Promise<void>}
|
|
3289
3633
|
*
|
|
3290
3634
|
* @example
|
|
3291
|
-
* const roomEngine =
|
|
3635
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3292
3636
|
* await roomEngine.closeLocalMicrophone();
|
|
3293
3637
|
*/
|
|
3294
3638
|
closeLocalMicrophone(): Promise<void>;
|
|
@@ -3305,7 +3649,7 @@ declare class TUIRoomEngine {
|
|
|
3305
3649
|
* @returns {Promise<void>}
|
|
3306
3650
|
*
|
|
3307
3651
|
* @example
|
|
3308
|
-
* const roomEngine =
|
|
3652
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3309
3653
|
* await roomEngine.updateVideoQuality({
|
|
3310
3654
|
* quality: TUIVideoQuality.kVideoQuality_360p,
|
|
3311
3655
|
* });
|
|
@@ -3322,7 +3666,7 @@ declare class TUIRoomEngine {
|
|
|
3322
3666
|
* @returns {Promise<void>}
|
|
3323
3667
|
*
|
|
3324
3668
|
* @example
|
|
3325
|
-
* const roomEngine =
|
|
3669
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3326
3670
|
* await roomEngine.setVideoResolutionMode({
|
|
3327
3671
|
* type: TUIVideoStreamType.kCameraStream,
|
|
3328
3672
|
* resolutionMode: TUIResolutionMode.kResolutionMode_Landscape,
|
|
@@ -3340,7 +3684,7 @@ declare class TUIRoomEngine {
|
|
|
3340
3684
|
* @returns {Promise<void>}
|
|
3341
3685
|
*
|
|
3342
3686
|
* @example
|
|
3343
|
-
* const roomEngine =
|
|
3687
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3344
3688
|
* await roomEngine.updateVideoQualityEx({
|
|
3345
3689
|
* streamType: TUIVideoStreamType.kCameraStream,
|
|
3346
3690
|
* encoderParams: {
|
|
@@ -3367,7 +3711,7 @@ declare class TUIRoomEngine {
|
|
|
3367
3711
|
* @returns {Promise<void>}
|
|
3368
3712
|
*
|
|
3369
3713
|
* @example
|
|
3370
|
-
* const roomEngine =
|
|
3714
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3371
3715
|
* await roomEngine.updateAudioQuality({
|
|
3372
3716
|
* quality: TUIAudioQuality.kAudioProfileSpeech,
|
|
3373
3717
|
* });
|
|
@@ -3380,7 +3724,7 @@ declare class TUIRoomEngine {
|
|
|
3380
3724
|
* @returns {Promise<void>}
|
|
3381
3725
|
*
|
|
3382
3726
|
* @example
|
|
3383
|
-
* const roomEngine =
|
|
3727
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3384
3728
|
* await roomEngine.startPushLocalVideo();
|
|
3385
3729
|
*/
|
|
3386
3730
|
startPushLocalVideo(): Promise<void>;
|
|
@@ -3389,7 +3733,7 @@ declare class TUIRoomEngine {
|
|
|
3389
3733
|
* @returns {Promise<void>}
|
|
3390
3734
|
*
|
|
3391
3735
|
* @example
|
|
3392
|
-
* const roomEngine =
|
|
3736
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3393
3737
|
* await roomEngine.startPushLocalVideo();
|
|
3394
3738
|
*/
|
|
3395
3739
|
stopPushLocalVideo(): Promise<void>;
|
|
@@ -3398,7 +3742,7 @@ declare class TUIRoomEngine {
|
|
|
3398
3742
|
* @returns {Promise<void>}
|
|
3399
3743
|
*
|
|
3400
3744
|
* @example
|
|
3401
|
-
* const roomEngine =
|
|
3745
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3402
3746
|
* await roomEngine.muteLocalAudio();
|
|
3403
3747
|
* @since 1.5.1
|
|
3404
3748
|
*/
|
|
@@ -3408,7 +3752,7 @@ declare class TUIRoomEngine {
|
|
|
3408
3752
|
* @returns {Promise<void>}
|
|
3409
3753
|
*
|
|
3410
3754
|
* @example
|
|
3411
|
-
* const roomEngine =
|
|
3755
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3412
3756
|
* await roomEngine.unmuteLocalAudio();
|
|
3413
3757
|
* @since 1.5.1
|
|
3414
3758
|
*/
|
|
@@ -3423,7 +3767,7 @@ declare class TUIRoomEngine {
|
|
|
3423
3767
|
* @returns {Promise<void>}
|
|
3424
3768
|
*
|
|
3425
3769
|
* @example
|
|
3426
|
-
* const roomEngine =
|
|
3770
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3427
3771
|
*
|
|
3428
3772
|
* // 设置远端用户视频流在 id 为 'remote_preview_camera' 的区域播放
|
|
3429
3773
|
* roomEngine.setRemoteVideoView()({
|
|
@@ -3453,7 +3797,7 @@ declare class TUIRoomEngine {
|
|
|
3453
3797
|
* @returns {Promise<void>}
|
|
3454
3798
|
*
|
|
3455
3799
|
* @example
|
|
3456
|
-
* const roomEngine =
|
|
3800
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3457
3801
|
* await roomEngine.startPlayRemoteVideo({
|
|
3458
3802
|
* userId: 'user_1234',
|
|
3459
3803
|
* streamType: TUIVideoStreamType.kCameraStream,
|
|
@@ -3477,7 +3821,7 @@ declare class TUIRoomEngine {
|
|
|
3477
3821
|
* @returns {Promise<void>}
|
|
3478
3822
|
*
|
|
3479
3823
|
* @example
|
|
3480
|
-
* const roomEngine =
|
|
3824
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3481
3825
|
* await roomEngine.stopPlayRemoteVideo({
|
|
3482
3826
|
* userId: 'user_1234',
|
|
3483
3827
|
* streamType: TUIVideoStreamType.kCameraStream,
|
|
@@ -3495,7 +3839,7 @@ declare class TUIRoomEngine {
|
|
|
3495
3839
|
* @returns {Promise<void>}
|
|
3496
3840
|
*
|
|
3497
3841
|
* @example
|
|
3498
|
-
* const roomEngine =
|
|
3842
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3499
3843
|
* await roomEngine.muteRemoteAudioStream({
|
|
3500
3844
|
* userId: 'user_1234',
|
|
3501
3845
|
* isMute: true,
|
|
@@ -3516,7 +3860,7 @@ declare class TUIRoomEngine {
|
|
|
3516
3860
|
* 该接口返回 request 结构体,当 request.requestId 不为 '' 时,用户可调用 cancelRequest 接口取消请求。
|
|
3517
3861
|
*
|
|
3518
3862
|
* @example
|
|
3519
|
-
* const roomEngine =
|
|
3863
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3520
3864
|
* const request = roomEngine.openRemoteDeviceByAdmin({
|
|
3521
3865
|
* userId: 'user_1234',
|
|
3522
3866
|
* device: TUIMediaDevice.kMicrophone //请求的设备为麦克风
|
|
@@ -3561,7 +3905,7 @@ declare class TUIRoomEngine {
|
|
|
3561
3905
|
* 该接口返回 request 结构体,当 request.requestId 不为 '' 时,用户可调用 cancelRequest 接口取消请求。
|
|
3562
3906
|
*
|
|
3563
3907
|
* @example
|
|
3564
|
-
* const roomEngine =
|
|
3908
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3565
3909
|
* const request = roomEngine.applyToAdminToOpenLocalDevice({
|
|
3566
3910
|
* device: TUIMediaDevice.kMicrophone, //请求打开麦克风
|
|
3567
3911
|
* timeout: 0,
|
|
@@ -3602,7 +3946,7 @@ declare class TUIRoomEngine {
|
|
|
3602
3946
|
* @returns {Promise<void>}
|
|
3603
3947
|
*
|
|
3604
3948
|
* @example
|
|
3605
|
-
* const roomEngine =
|
|
3949
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3606
3950
|
* await roomEngine.closeRemoteDeviceByAdmin({
|
|
3607
3951
|
* userId: 'user_1234',
|
|
3608
3952
|
* device: TUIMediaDevice.kMicrophone, //关闭掉麦克风
|
|
@@ -3619,7 +3963,7 @@ declare class TUIRoomEngine {
|
|
|
3619
3963
|
* @returns {Promise<void>}
|
|
3620
3964
|
*
|
|
3621
3965
|
* @example
|
|
3622
|
-
* const roomEngine =
|
|
3966
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3623
3967
|
* await roomEngine.cancelRequest({
|
|
3624
3968
|
* requestId: '', // 请使用实际 requestId
|
|
3625
3969
|
* });
|
|
@@ -3635,7 +3979,7 @@ declare class TUIRoomEngine {
|
|
|
3635
3979
|
* @returns {Promise<void>}
|
|
3636
3980
|
*
|
|
3637
3981
|
* @example
|
|
3638
|
-
* const roomEngine =
|
|
3982
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3639
3983
|
*
|
|
3640
3984
|
* // 同意远端的请求
|
|
3641
3985
|
* await roomEngine.responseRemoteRequest({
|
|
@@ -3713,7 +4057,7 @@ declare class TUIRoomEngine {
|
|
|
3713
4057
|
* @returns {Promise<void>}
|
|
3714
4058
|
*
|
|
3715
4059
|
* @example
|
|
3716
|
-
* const roomEngine =
|
|
4060
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3717
4061
|
* // 将房间移交给用户 user_1234
|
|
3718
4062
|
* await roomEngine.changeUserRole({
|
|
3719
4063
|
* userId: 'user_1234',
|
|
@@ -3739,7 +4083,7 @@ declare class TUIRoomEngine {
|
|
|
3739
4083
|
* @returns {Promise<void>}
|
|
3740
4084
|
*
|
|
3741
4085
|
* @example
|
|
3742
|
-
* const roomEngine =
|
|
4086
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3743
4087
|
* // 修改房间内用户名称
|
|
3744
4088
|
* await roomEngine.changeUserNameCard({
|
|
3745
4089
|
* userId: 'user_1234',
|
|
@@ -3758,7 +4102,7 @@ declare class TUIRoomEngine {
|
|
|
3758
4102
|
* @returns {Promise<void>}
|
|
3759
4103
|
*
|
|
3760
4104
|
* @example
|
|
3761
|
-
* const roomEngine =
|
|
4105
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3762
4106
|
* await roomEngine.kickRemoteUserOutOfRoom({
|
|
3763
4107
|
* userId: 'user_1234',
|
|
3764
4108
|
* });
|
|
@@ -3771,7 +4115,7 @@ declare class TUIRoomEngine {
|
|
|
3771
4115
|
* @returns {Promise<TUISeatInfo[]>}
|
|
3772
4116
|
*
|
|
3773
4117
|
* @example
|
|
3774
|
-
* const roomEngine =
|
|
4118
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3775
4119
|
* const seatList = await roomEngine.getSeatList();
|
|
3776
4120
|
* ;
|
|
3777
4121
|
*/
|
|
@@ -3790,7 +4134,7 @@ declare class TUIRoomEngine {
|
|
|
3790
4134
|
* 该接口返回 request 结构体,当 request.requestId 不为 '' 时,用户可调用 cancelRequest 接口取消上麦请求。
|
|
3791
4135
|
*
|
|
3792
4136
|
* @example
|
|
3793
|
-
* const roomEngine =
|
|
4137
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3794
4138
|
*
|
|
3795
4139
|
* // 情景一:主持人/管理员上麦
|
|
3796
4140
|
* // 情景二:roomInfo.seatMode 为 TUISeatMode.kFreeToTake 模式时,普通用户上麦
|
|
@@ -3836,7 +4180,7 @@ declare class TUIRoomEngine {
|
|
|
3836
4180
|
* @returns {Promise<void>}
|
|
3837
4181
|
*
|
|
3838
4182
|
* @example
|
|
3839
|
-
* const roomEngine =
|
|
4183
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3840
4184
|
* await roomEngine.leaveSeat();
|
|
3841
4185
|
*/
|
|
3842
4186
|
leaveSeat(): Promise<void>;
|
|
@@ -3848,12 +4192,29 @@ declare class TUIRoomEngine {
|
|
|
3848
4192
|
* @param {number} options.targetSeatIndex 移麦目标麦位 index, 移麦成功后您将会在此麦位上。
|
|
3849
4193
|
* @returns {Promise<void>}
|
|
3850
4194
|
* @example
|
|
3851
|
-
* const roomEngine =
|
|
4195
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3852
4196
|
* await roomEngine.moveToSeat({ targetSeatIndex: 1 });
|
|
3853
4197
|
*/
|
|
3854
4198
|
moveToSeat(options: {
|
|
3855
4199
|
targetSeatIndex: number;
|
|
3856
4200
|
}): Promise<void>;
|
|
4201
|
+
/**
|
|
4202
|
+
* 移动麦上的用户(仅支持房主或者管理员使用此接口)
|
|
4203
|
+
* @since v3.4.3
|
|
4204
|
+
* @note 当目标麦位有人时,支持三种移麦策略:
|
|
4205
|
+
* - 目标麦位有人时放弃移动(默认)
|
|
4206
|
+
* - 强制替换 - 将原麦位用户踢下麦
|
|
4207
|
+
* - 交换位置 - 互换两个用户的麦位
|
|
4208
|
+
* @param {string} options.userId 待移动的麦上用户
|
|
4209
|
+
* @param {number} options.targetSeatIndex 移麦目标麦位 index, 移麦成功后您将会在此麦位上。
|
|
4210
|
+
* @param {TUIMoveSeatPolicy} options.policy 移动麦上用户时的策略, 默认为目标麦位有人时放弃移动
|
|
4211
|
+
* @returns {Promise<void>}
|
|
4212
|
+
*/
|
|
4213
|
+
moveUserToSeatByAdmin(options: {
|
|
4214
|
+
userId: string;
|
|
4215
|
+
targetSeatIndex: number;
|
|
4216
|
+
policy: TUIMoveSeatPolicy;
|
|
4217
|
+
}): Promise<void>;
|
|
3857
4218
|
/**
|
|
3858
4219
|
* 邀请其他人上麦(仅房间主持人和管理员可调用此方法)
|
|
3859
4220
|
* @param {object} options 邀请其他人上麦的参数
|
|
@@ -3865,7 +4226,7 @@ declare class TUIRoomEngine {
|
|
|
3865
4226
|
* 该接口返回 request 结构体,当 request.requestId 不为 '' 时,用户可调用 cancelRequest 接口取消请求。
|
|
3866
4227
|
*
|
|
3867
4228
|
* @example
|
|
3868
|
-
* const roomEngine =
|
|
4229
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3869
4230
|
* const request = await roomEngine.takeUserOnSeatByAdmin({
|
|
3870
4231
|
* seatIndex: 0,
|
|
3871
4232
|
* userId: 'user_1234',
|
|
@@ -3907,7 +4268,7 @@ declare class TUIRoomEngine {
|
|
|
3907
4268
|
* @returns {Promise<void>}
|
|
3908
4269
|
*
|
|
3909
4270
|
* @example
|
|
3910
|
-
* const roomEngine =
|
|
4271
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3911
4272
|
* await roomEngine.kickUserOffSeatByAdmin({
|
|
3912
4273
|
* seatIndex: 0,
|
|
3913
4274
|
* userId: 'user_1234',
|
|
@@ -3926,7 +4287,7 @@ declare class TUIRoomEngine {
|
|
|
3926
4287
|
* @returns {Promise<void>}
|
|
3927
4288
|
*
|
|
3928
4289
|
* @example
|
|
3929
|
-
* const roomEngine =
|
|
4290
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3930
4291
|
* await roomEngine.lockSeatByAdmin({
|
|
3931
4292
|
* seatIndex: -1,
|
|
3932
4293
|
* lockParams: {
|
|
@@ -3945,7 +4306,7 @@ declare class TUIRoomEngine {
|
|
|
3945
4306
|
* @returns {Promise<TUIRequest[]>}
|
|
3946
4307
|
*
|
|
3947
4308
|
* @example
|
|
3948
|
-
* const roomEngine =
|
|
4309
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3949
4310
|
* const seatList = await roomEngine.getSeatApplicationList();
|
|
3950
4311
|
* ;
|
|
3951
4312
|
*/
|
|
@@ -3959,7 +4320,7 @@ declare class TUIRoomEngine {
|
|
|
3959
4320
|
* @returns {Promise<void>}
|
|
3960
4321
|
*
|
|
3961
4322
|
* @example
|
|
3962
|
-
* const roomEngine =
|
|
4323
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3963
4324
|
* await roomEngine.sendTextMessage({
|
|
3964
4325
|
* textContent: 'hello, everyone',
|
|
3965
4326
|
* extensionInfo: {}
|
|
@@ -3978,7 +4339,7 @@ declare class TUIRoomEngine {
|
|
|
3978
4339
|
* @returns {Promise<void>}
|
|
3979
4340
|
*
|
|
3980
4341
|
* @example
|
|
3981
|
-
* const roomEngine =
|
|
4342
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
3982
4343
|
* await roomEngine.sendCustomMessage({
|
|
3983
4344
|
* businessId: '111',
|
|
3984
4345
|
* data: '{"msg":"test"}',
|
|
@@ -3996,7 +4357,7 @@ declare class TUIRoomEngine {
|
|
|
3996
4357
|
* @returns {Promise<void>}
|
|
3997
4358
|
*
|
|
3998
4359
|
* @example
|
|
3999
|
-
* const roomEngine =
|
|
4360
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4000
4361
|
* // example 1: 开始屏幕分享
|
|
4001
4362
|
* await roomEngine.startScreenSharing();
|
|
4002
4363
|
* // example 2: 开始屏幕分享(可采集系统音频)
|
|
@@ -4013,7 +4374,7 @@ declare class TUIRoomEngine {
|
|
|
4013
4374
|
* @returns {Promise<void>}
|
|
4014
4375
|
*
|
|
4015
4376
|
* @example
|
|
4016
|
-
* const roomEngine =
|
|
4377
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4017
4378
|
* await roomEngine.stopScreenSharing();
|
|
4018
4379
|
*/
|
|
4019
4380
|
stopScreenSharing(): Promise<void>;
|
|
@@ -4025,7 +4386,7 @@ declare class TUIRoomEngine {
|
|
|
4025
4386
|
* @returns {Promise<void>}
|
|
4026
4387
|
*
|
|
4027
4388
|
* @example
|
|
4028
|
-
* const roomEngine =
|
|
4389
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4029
4390
|
* // example 1: 开始屏幕共享
|
|
4030
4391
|
* await roomEngine.startScreenSharingElectron({ targetId: 'xxx' });
|
|
4031
4392
|
* // example 2: 开始屏幕共享并在本地预览
|
|
@@ -4041,7 +4402,7 @@ declare class TUIRoomEngine {
|
|
|
4041
4402
|
* @returns {Promise<void>}
|
|
4042
4403
|
*
|
|
4043
4404
|
* @example
|
|
4044
|
-
* const roomEngine =
|
|
4405
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4045
4406
|
* await roomEngine.stopScreenSharingElectron();
|
|
4046
4407
|
*/
|
|
4047
4408
|
stopScreenSharingElectron(): Promise<void>;
|
|
@@ -4050,7 +4411,7 @@ declare class TUIRoomEngine {
|
|
|
4050
4411
|
* @returns {Promise<void>}
|
|
4051
4412
|
*
|
|
4052
4413
|
* @example
|
|
4053
|
-
* const roomEngine =
|
|
4414
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4054
4415
|
* const screenList = await roomEngine.getScreenSharingTarget();
|
|
4055
4416
|
*/
|
|
4056
4417
|
getScreenSharingTarget(): Promise<Array<TRTCScreenCaptureSourceInfo>>;
|
|
@@ -4062,7 +4423,7 @@ declare class TUIRoomEngine {
|
|
|
4062
4423
|
* @returns {Promise<void>}
|
|
4063
4424
|
*
|
|
4064
4425
|
* @example
|
|
4065
|
-
* const roomEngine =
|
|
4426
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4066
4427
|
* await roomEngine.selectScreenSharingTarget({ targetId: 'xxx' });
|
|
4067
4428
|
*/
|
|
4068
4429
|
selectScreenSharingTarget(options: {
|
|
@@ -4075,7 +4436,7 @@ declare class TUIRoomEngine {
|
|
|
4075
4436
|
* @returns {void}
|
|
4076
4437
|
*
|
|
4077
4438
|
* @example
|
|
4078
|
-
* const roomEngine =
|
|
4439
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4079
4440
|
* roomEngine.on(event, func);
|
|
4080
4441
|
*/
|
|
4081
4442
|
on(event: TUIRoomEvents, func: (...args: any[]) => void): void;
|
|
@@ -4088,7 +4449,7 @@ declare class TUIRoomEngine {
|
|
|
4088
4449
|
* @returns {void}
|
|
4089
4450
|
*
|
|
4090
4451
|
* @example
|
|
4091
|
-
* const roomEngine =
|
|
4452
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4092
4453
|
* roomEngine.off(event, func);
|
|
4093
4454
|
*/
|
|
4094
4455
|
off(event: string, func: (...args: any[]) => void): void;
|
|
@@ -4097,7 +4458,7 @@ declare class TUIRoomEngine {
|
|
|
4097
4458
|
* 获取摄像头设备列表<br>
|
|
4098
4459
|
* @returns {Promise<TRTCDeviceInfo[]>} 摄像头列表
|
|
4099
4460
|
* @example
|
|
4100
|
-
* const roomEngine =
|
|
4461
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4101
4462
|
* const cameralist = await roomEngine.getCameraDevicesList();
|
|
4102
4463
|
* for (i = 0; i < cameralist.length; i++) {
|
|
4103
4464
|
* var camera = cameralist[i];
|
|
@@ -4109,7 +4470,7 @@ declare class TUIRoomEngine {
|
|
|
4109
4470
|
* 获取麦克风设备列表<br>
|
|
4110
4471
|
* @returns {Promise<TRTCDeviceInfo[]>} 麦克风列表
|
|
4111
4472
|
* @example
|
|
4112
|
-
* const roomEngine =
|
|
4473
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4113
4474
|
* const micList = await roomEngine.getMicDevicesList();
|
|
4114
4475
|
* for (i = 0; i < micList.length; i++) {
|
|
4115
4476
|
* var mic = micList[i];
|
|
@@ -4121,7 +4482,7 @@ declare class TUIRoomEngine {
|
|
|
4121
4482
|
* 获取扬声器设备列表<br>
|
|
4122
4483
|
* @returns {Promise<TRTCDeviceInfo[]>} 扬声器列表
|
|
4123
4484
|
* @example
|
|
4124
|
-
* const roomEngine =
|
|
4485
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4125
4486
|
* const speakerList = await roomEngine.getSpeakerDevicesList();
|
|
4126
4487
|
* for (i = 0; i < speakerList.length; i++) {
|
|
4127
4488
|
* var speaker = speakerList[i];
|
|
@@ -4135,7 +4496,7 @@ declare class TUIRoomEngine {
|
|
|
4135
4496
|
* @param {String} options.deviceId - 从 getCameraDevicesList 中得到的设备 ID
|
|
4136
4497
|
* @returns {Promise<void>}
|
|
4137
4498
|
* @example
|
|
4138
|
-
* const roomEngine =
|
|
4499
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4139
4500
|
* await roomEngine.setCurrentCameraDevice({ deviceId: '' });
|
|
4140
4501
|
*/
|
|
4141
4502
|
setCurrentCameraDevice(options: {
|
|
@@ -4147,7 +4508,7 @@ declare class TUIRoomEngine {
|
|
|
4147
4508
|
* @param {String} options.deviceId - 从 getMicDevicesList 中得到的设备 ID
|
|
4148
4509
|
* @returns {Promise<void>}
|
|
4149
4510
|
* @example
|
|
4150
|
-
* const roomEngine =
|
|
4511
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4151
4512
|
* await roomEngine.setCurrentMicDevice({ deviceId: '' });
|
|
4152
4513
|
*/
|
|
4153
4514
|
setCurrentMicDevice(options: {
|
|
@@ -4159,7 +4520,7 @@ declare class TUIRoomEngine {
|
|
|
4159
4520
|
* @param {String} options.deviceId - 从 getSpeakerDevicesList 中得到的设备 ID
|
|
4160
4521
|
* @returns {Promise<void>}
|
|
4161
4522
|
* @example
|
|
4162
|
-
* const roomEngine =
|
|
4523
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4163
4524
|
* await roomEngine.setCurrentSpeakerDevice({ deviceId: '' });
|
|
4164
4525
|
*/
|
|
4165
4526
|
setCurrentSpeakerDevice(options: {
|
|
@@ -4169,7 +4530,7 @@ declare class TUIRoomEngine {
|
|
|
4169
4530
|
* 获取当前正在使用的摄像头设备
|
|
4170
4531
|
* @returns {TRTCDeviceInfo} 设备信息,能获取设备 ID 和设备名称
|
|
4171
4532
|
* @example
|
|
4172
|
-
* const roomEngine =
|
|
4533
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4173
4534
|
* const currentCameraDevice = roomEngine.getCurrentCameraDevice();
|
|
4174
4535
|
*/
|
|
4175
4536
|
getCurrentCameraDevice(): TRTCDeviceInfo;
|
|
@@ -4177,7 +4538,7 @@ declare class TUIRoomEngine {
|
|
|
4177
4538
|
* 获取当前正在使用的麦克风设备
|
|
4178
4539
|
* @returns {TRTCDeviceInfo} 设备信息,能获取设备 ID 和设备名称
|
|
4179
4540
|
* @example
|
|
4180
|
-
* const roomEngine =
|
|
4541
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4181
4542
|
* const currentMicDevice = roomEngine.getCurrentMicDevice();
|
|
4182
4543
|
*/
|
|
4183
4544
|
getCurrentMicDevice(): TRTCDeviceInfo;
|
|
@@ -4185,7 +4546,7 @@ declare class TUIRoomEngine {
|
|
|
4185
4546
|
* 获取当前正在使用的扬声器设备
|
|
4186
4547
|
* @returns {TRTCDeviceInfo} 设备信息,能获取设备 ID 和设备名称
|
|
4187
4548
|
* @example
|
|
4188
|
-
* const roomEngine =
|
|
4549
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4189
4550
|
* const currentSpeakerDevice = roomEngine.getCurrentSpeakerDevice();
|
|
4190
4551
|
*/
|
|
4191
4552
|
getCurrentSpeakerDevice(): TRTCDeviceInfo;
|
|
@@ -4195,7 +4556,7 @@ declare class TUIRoomEngine {
|
|
|
4195
4556
|
* @returns {Promise<void>}
|
|
4196
4557
|
*
|
|
4197
4558
|
* @example
|
|
4198
|
-
* const roomEngine =
|
|
4559
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4199
4560
|
* await roomEngine.startCameraDeviceTest({ view: 'test-preview' });
|
|
4200
4561
|
*/
|
|
4201
4562
|
startCameraDeviceTest(options: {
|
|
@@ -4205,7 +4566,7 @@ declare class TUIRoomEngine {
|
|
|
4205
4566
|
* 停止摄像头测试
|
|
4206
4567
|
* @returns {void}
|
|
4207
4568
|
* @example
|
|
4208
|
-
* const roomEngine =
|
|
4569
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4209
4570
|
* await roomEngine.stopCameraDeviceTest();
|
|
4210
4571
|
*/
|
|
4211
4572
|
stopCameraDeviceTest(): Promise<void>;
|
|
@@ -4215,7 +4576,7 @@ declare class TUIRoomEngine {
|
|
|
4215
4576
|
* @param {number} options.interval 麦克风音量的回调时间
|
|
4216
4577
|
*
|
|
4217
4578
|
* @example
|
|
4218
|
-
* const roomEngine =
|
|
4579
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4219
4580
|
* await roomEngine.startMicDeviceTest({interval: 200});
|
|
4220
4581
|
*/
|
|
4221
4582
|
startMicDeviceTest(options: {
|
|
@@ -4224,7 +4585,7 @@ declare class TUIRoomEngine {
|
|
|
4224
4585
|
/**
|
|
4225
4586
|
* 停止进行麦克风测试
|
|
4226
4587
|
* @example
|
|
4227
|
-
* const roomEngine =
|
|
4588
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4228
4589
|
* await roomEngine.stopMicDeviceTest();
|
|
4229
4590
|
*/
|
|
4230
4591
|
stopMicDeviceTest(): Promise<void>;
|
|
@@ -4256,7 +4617,7 @@ declare class TUIRoomEngine {
|
|
|
4256
4617
|
* @returns {TUILiveListManager}
|
|
4257
4618
|
*
|
|
4258
4619
|
* @example
|
|
4259
|
-
* const roomEngine =
|
|
4620
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4260
4621
|
* const liveListManager = roomEngine.getLiveListManager();
|
|
4261
4622
|
*/
|
|
4262
4623
|
getLiveListManager(): TUILiveListManager;
|
|
@@ -4267,7 +4628,7 @@ declare class TUIRoomEngine {
|
|
|
4267
4628
|
* @returns {TUILiveLayoutManager}
|
|
4268
4629
|
*
|
|
4269
4630
|
* @example
|
|
4270
|
-
* const roomEngine =
|
|
4631
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4271
4632
|
* const liveLayoutManager = roomEngine.getLiveLayoutManager();
|
|
4272
4633
|
*/
|
|
4273
4634
|
getLiveLayoutManager(): TUILiveLayoutManager;
|
|
@@ -4278,7 +4639,7 @@ declare class TUIRoomEngine {
|
|
|
4278
4639
|
* @returns {TUILiveConnectionManager}
|
|
4279
4640
|
*
|
|
4280
4641
|
* @example
|
|
4281
|
-
* const roomEngine =
|
|
4642
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4282
4643
|
* const liveConnectionManager = roomEngine.getLiveConnectionManager();
|
|
4283
4644
|
*/
|
|
4284
4645
|
getLiveConnectionManager(): TUILiveConnectionManager;
|
|
@@ -4289,10 +4650,21 @@ declare class TUIRoomEngine {
|
|
|
4289
4650
|
* @returns {TUILiveBattleManager}
|
|
4290
4651
|
*
|
|
4291
4652
|
* @example
|
|
4292
|
-
* const roomEngine =
|
|
4653
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4293
4654
|
* const liveBattleManager = roomEngine.getLiveBattleManager();
|
|
4294
4655
|
*/
|
|
4295
4656
|
getLiveBattleManager(): TUILiveBattleManager;
|
|
4657
|
+
/**
|
|
4658
|
+
* v3.4.4 版本起支持 getLiveGiftManager 获取 TUILiveGiftManager 模块
|
|
4659
|
+
*
|
|
4660
|
+
* @since v3.4.4
|
|
4661
|
+
* @returns {TUILiveGiftManager}
|
|
4662
|
+
*
|
|
4663
|
+
* @example
|
|
4664
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4665
|
+
* const liveGiftManager = roomEngine.getLiveGiftManager();
|
|
4666
|
+
*/
|
|
4667
|
+
getLiveGiftManager(): TUILiveGiftManager;
|
|
4296
4668
|
/**
|
|
4297
4669
|
* v2.6.0 版本起支持使用 getConferenceInvitationManager 获取 conferenceInvitation 模块
|
|
4298
4670
|
* @since v2.6.0
|
|
@@ -4310,7 +4682,7 @@ declare class TUIRoomEngine {
|
|
|
4310
4682
|
* web 端 trtcCloud 能力请查看:https://web.sdk.qcloud.com/trtc/webrtc/trtcCloud/doc/this.trtcCloud.html
|
|
4311
4683
|
*
|
|
4312
4684
|
* @example
|
|
4313
|
-
* const roomEngine =
|
|
4685
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4314
4686
|
* const trtcCloud = roomEngine.getTRTCCloud();
|
|
4315
4687
|
*/
|
|
4316
4688
|
getTRTCCloud(): any;
|
|
@@ -4320,7 +4692,7 @@ declare class TUIRoomEngine {
|
|
|
4320
4692
|
* web 端 tim 能力请查看:https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html
|
|
4321
4693
|
*
|
|
4322
4694
|
* @example
|
|
4323
|
-
* const roomEngine =
|
|
4695
|
+
* const roomEngine = TUIRoomEngine.getInstance();
|
|
4324
4696
|
* const trtcCloud = roomEngine.getTIM();
|
|
4325
4697
|
*/
|
|
4326
4698
|
getTIM(): ChatSDK;
|
|
@@ -4335,4 +4707,4 @@ declare class TUIRoomEngine {
|
|
|
4335
4707
|
private static handleSetFramework;
|
|
4336
4708
|
}
|
|
4337
4709
|
|
|
4338
|
-
export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUIBattleCode, type TUIBattleConfig, type TUIBattleInfo, TUIBattleStoppedReason, type TUIBattleUser, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, TUIDeviceStatus, type TUIEnterRoomOptions, TUIErrorCode, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveBattleManagerEvents, TUILiveConnectionManagerEvents, type TUILiveConnectionUser, type TUILiveInfo, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, type TUILiveListResult, TUILiveModifyFlag, type TUILiveModifyInfo, type TUILiveStatisticsData, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, type TUINetwork, TUINetworkQuality, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLayout, type TUISeatLockParams, TUISeatMode, type TUISeatRegion, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
|
|
4710
|
+
export { type GiftCategory, type GiftInfo, type StartLiveOptions, TRTCRole, TUIAudioQuality, TUIAudioRoute, TUIBattleCode, type TUIBattleConfig, type TUIBattleInfo, TUIBattleStoppedReason, type TUIBattleUser, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, TUIConnectionCode, type TUIDeviceInfo, TUIDeviceStatus, type TUIEnterRoomOptions, TUIErrorCode, type TUIGiftCategory, type TUIGiftInfo, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveBattleManagerEvents, TUILiveConnectionManagerEvents, type TUILiveConnectionUser, TUILiveGiftManagerEvents, type TUILiveInfo, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, type TUILiveListResult, TUILiveModifyFlag, type TUILiveModifyInfo, type TUILiveStatisticsData, TUILiveStatisticsModifyFlag, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, TUIMoveSeatPolicy, type TUINetwork, TUINetworkQuality, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLayout, type TUISeatLockParams, TUISeatMode, type TUISeatRegion, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
|