@rongcloud/plugin-rtc 5.1.10 → 5.2.2

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 /*
- * RCRTC - v5.1.10
- * CommitId - bc94ea172bcd0a0304a8ab2de9c4dedb50085367
- * Fri Sep 24 2021 17:55:33 GMT+0800 (China Standard Time)
+ * RCRTC - v5.2.2
+ * CommitId - cbd066a7185af8c1b56ef6bf88f1332ec9444daa
+ * Thu Nov 25 2021 17:52:32 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
-import { EventEmitter, LogLevel, RTCMode, IRuntime, RTCPluginContext, IServerRTCRoomEntry, IJoinRTCRoomData, IReceivedMessage, KVString, ErrorCode, IPluginGenerator } from '@rongcloud/engine';
+import { EventEmitter, LogLevel, RTCMode, IRuntime, RTCPluginContext, IServerRTCRoomEntry, IJoinRTCRoomData, IReceivedMessage, KVString, RTCJoinType, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
+export { RTCJoinType } from '@rongcloud/engine';
 
 /**
  * 错误码，与移动端对齐
@@ -79,7 +80,11 @@ declare enum RCRTCCode {
     /** 单个用户发布资源超过限制 （ MediaServer 限制最多 10 个 track ） */
     PUBLISH_TRACK_LIMIT_EXCEEDED = 53026,
     /** 房间内无主播推 CDN */
-    CDN_RESOURCE_IS_EMPTY = 53027
+    CDN_RESOURCE_IS_EMPTY = 53027,
+    /** 加入 RTC 房间 joinTYype 为 1 时，当前有其他端在房间时的应答码 */
+    SIGNAL_JOIN_RTC_ROOM_REFUSED = 53028,
+    /** 设置音频输出设备时，无权限使用请求的设备 */
+    NO_PERMISSION_TO_USE_REQUESTED_DEVICE = 53029
 }
 
 /**
@@ -218,6 +223,7 @@ declare abstract class RCTrack extends EventEmitter {
      */
     play(element?: HTMLVideoElement, options?: {
         volume?: number;
+        audioDeviceId: string;
     }): Promise<{
         code: RCRTCCode;
     }>;
@@ -401,6 +407,36 @@ declare enum RCInnerCDNPullIsHttps {
     HTTPS = 1
 }
 
+declare enum RCKickReason {
+    /**
+     * Server 主动踢（掉 Server API 踢出）
+     */
+    SERVER_KICK = 1,
+    /**
+     * 其他设备登陆后，本端被踢
+     */
+    OTHER_KICK = 2
+}
+
+declare enum RCRTCPingResult {
+    SUCCESS = "Success",
+    FAIL = "Fail"
+}
+
+/**
+ * 直播角色
+ */
+declare enum RCRTCLiveRole {
+    /**
+     * 主播
+     */
+    ANCHOR = 1,
+    /**
+     * 观众
+     */
+    AUDIENCE = 2
+}
+
 interface IRCTrackBitrate {
     /**
      * 最大码率
@@ -706,7 +742,7 @@ interface IRCRTCReportListener {
     onStateReport?(report: IRCRTCStateReport): void;
     /**
      * ~ICE 连接状态变更通知~
-     * @deprecated
+     * @since version 5.1.5
      */
     onICEConnectionStateChange?(state: RTCIceConnectionState): void;
     /**
@@ -734,7 +770,7 @@ interface IRoomEventListener extends IRCRTCTrackEventListener {
      * 另一种可能是己方 rtcPing 失败次数超出上限
      * @param byServer 当值为 `false` 时，说明本端 rtcPing 超时；当值为 `true` 时，说明本端收到被踢出房间通知
      */
-    onKickOff?(byServer: boolean): void;
+    onKickOff?(byServer: boolean, state?: RCKickReason): void;
     /**
      * 接收到房间信令时回调，用户可通过房间实例的 sendMessage 接口发送信令
      * @param name 信令名
@@ -784,6 +820,15 @@ interface IRoomEventListener extends IRCRTCTrackEventListener {
      * 主播开启、停止推 CDN 状态通知
      */
     onCDNEnableChange?(enable: boolean): void;
+    /**
+     * RTC 每次 Ping 的结果
+     * @since version: 5.1.5
+     */
+    onPing?(result: RCRTCPingResult): void;
+    /**
+     * 主播和观众切换身份通知
+     */
+    onSwitchRole?(userId: string, role: RCRTCLiveRole): void;
 }
 /**
  * RTCClient 初始化配置
@@ -1031,6 +1076,15 @@ interface IExchangeResponse extends IRTCResponse {
      * 主播发布为具体资源，会议模式为空数组
      */
     mcuPublishList?: IResource[];
+    /**
+     * 订阅成功的资源
+     */
+    subscribedList?: {
+        mediaType: RCMediaType.AUDIO_ONLY | RCMediaType.VIDEO_ONLY;
+        msid: string;
+        userId: string;
+        simulcast?: RCStreamType;
+    }[];
 }
 interface IBroadcastSubReqBody {
     /**
@@ -1734,6 +1788,7 @@ declare class RCAudienceLivingRoom {
      */
     subscribe(tracks: (RCRemoteTrack | ISubscribeAttr)[]): Promise<{
         code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
     }>;
     private __unsubscribe;
     /**
@@ -1742,6 +1797,7 @@ declare class RCAudienceLivingRoom {
      */
     unsubscribe(tracks: RCRemoteTrack[]): Promise<{
         code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
     }>;
     /**
      * 退出房间并销毁当前房间实例，退出后该房间的所有方法将不可用
@@ -1978,6 +2034,7 @@ declare abstract class RCAbstractRoom {
     private _audioLevelReport;
     constructor(_context: RTCPluginContext, _runtime: IRuntime, _roomId: string, data: IJoinRTCRoomData, _roomMode: RTCMode, _service: RCMediaService, _initOptions: IRCRTCInitOptions, _ntfClearRoomItem: Function, isUpgrade?: boolean);
     private _initRemoteTracks;
+    private _handlePingResult;
     /**
      * 设置房间上行资源的总码率配置
      * @description
@@ -2195,6 +2252,7 @@ declare abstract class RCAbstractRoom {
      */
     subscribe(tracks: (RCRemoteTrack | ISubscribeAttr)[]): Promise<{
         code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
     }>;
     private __subscribe;
     /**
@@ -2203,6 +2261,7 @@ declare abstract class RCAbstractRoom {
      */
     unsubscribe(tracks: RCRemoteTrack[]): Promise<{
         code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
     }>;
     private __unsubscribe;
     protected _assertRoomDestroyed(): RCRTCCode | undefined;
@@ -2261,10 +2320,6 @@ declare abstract class RCAbstractRoom {
      * 观众切换为主播后直接处理人员变更及资源变更
      */
     protected _afterChangedRole(data: IJoinRTCRoomData): void;
-    /**
-     * 主播身份降级，取消己端已发布的所有资源
-     */
-    __unpublishToSingal(): Promise<ErrorCode>;
     /**
      * 销毁远端资源
      */
@@ -2620,7 +2675,7 @@ declare class RCRTCClient {
      * 加入普通音视频房间
      * @param roomId
      */
-    joinRTCRoom(roomId: string): Promise<{
+    joinRTCRoom(roomId: string, joinType?: RTCJoinType): Promise<{
         room?: RCRTCRoom;
         code: RCRTCCode;
         userIds?: string[];
@@ -2778,6 +2833,14 @@ declare class RCRTCClient {
         room?: RCAudienceLivingRoom;
         code: RCRTCCode;
     }>;
+    /**
+     * 获取在房间内用户信息
+     * @since version 5.2.1
+     */
+    getJoinedRoomInfo(): Promise<{
+        code: RCRTCCode;
+        data?: IRTCJoinedInfo[];
+    }>;
 }
 
 /**
@@ -2827,4 +2890,4 @@ declare const helper: {
     ifSupportScreenShare: typeof ifSupportScreenShare;
 };
 
-export { BackgroundPictureFillMode, ICameraVideoProfile, IMCUOutputConfig, IMCUOutputVideoConfig, IMicphoneAudioProfile, IPublishAttrs, IPublishedResource, IRCCandidatePairStat, IRCRTCInitOptions, IRCRTCReportListener, IRCRTCStateReport, IRCTrackStat, IRoomEventListener, ISubscribeAttr, IVideoProfile, MixLayoutMode, MixVideoRenderMode, RCAbstractRoom, RCAudienceClient, RCAudienceLivingRoom, RCCameraVideoTrack, RCFrameRate, RCInnerCDNPullIsHttps, RCInnerCDNPullKind, RCLivingRoom, RCLivingType, RCLocalAudioTrack, RCLocalFileAudioTrack, RCLocalFileTrack, RCLocalFileVideoTrack, RCLocalTrack, RCLocalVideoTrack, RCMCUConfigBuilder, RCMediaType, RCMicphoneAudioTrack, RCRTCClient, RCRTCCode, RCRTCRoom, RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack, RCResolution, RCScreenVideoTrack, RCTag, RCTrack, device, helper, installer };
+export { BackgroundPictureFillMode, ICameraVideoProfile, IMCUOutputConfig, IMCUOutputVideoConfig, IMicphoneAudioProfile, IPublishAttrs, IPublishedResource, IRCCandidatePairStat, IRCRTCInitOptions, IRCRTCReportListener, IRCRTCStateReport, IRCTrackStat, IRoomEventListener, ISubscribeAttr, IVideoProfile, MixLayoutMode, MixVideoRenderMode, RCAbstractRoom, RCAudienceClient, RCAudienceLivingRoom, RCCameraVideoTrack, RCFrameRate, RCInnerCDNPullIsHttps, RCInnerCDNPullKind, RCKickReason, RCLivingRoom, RCLivingType, RCLocalAudioTrack, RCLocalFileAudioTrack, RCLocalFileTrack, RCLocalFileVideoTrack, RCLocalTrack, RCLocalVideoTrack, RCMCUConfigBuilder, RCMediaType, RCMicphoneAudioTrack, RCRTCClient, RCRTCCode, RCRTCLiveRole, RCRTCPingResult, RCRTCRoom, RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack, RCResolution, RCScreenVideoTrack, RCTag, RCTrack, device, helper, installer };