@rongcloud/plugin-rtc 5.6.10 → 5.6.12

package/dist/index.d.ts

@@ -236,7 +236,7 @@ declare abstract class RCTrack extends EventEmitter {
      * 发布者是否已禁用该轨道数据，在 RCLocalTrack 实例中，则其值始终等于 `isLocalMuted()`
      */
     isOwnerMuted(): boolean;
-    private _element?;
+    protected _element?: HTMLMediaElement;
     /**
      * 播放
      * @param element 用于承载媒体流的元素标签，音频流可传空
@@ -441,7 +441,7 @@ declare class RCScreenVideoTrack extends RCLocalVideoTrack {
 declare class RCScreenAudioTrack extends RCLocalAudioTrack {
 }
 
-declare class RCRemoteTrack extends RCTrack {
+declare abstract class RCRemoteTrack extends RCTrack {
     constructor(logger: BasicLogger, tag: string, userId: string, kind: 'audio' | 'video', roomId?: string);
     /**
      * 根据房间数据更新状态
@@ -458,6 +458,12 @@ declare class RCRemoteTrack extends RCTrack {
 }
 declare class RCRemoteAudioTrack extends RCRemoteTrack {
     constructor(logger: BasicLogger, tag: string, userId: string, roomId?: string);
+    /**
+     * 获取播放时指定的输出音量。若当前未播放，则返回 0。
+     * 注意：该音量为对媒体输出设备设定的输出音量，与当前音频内容的 audioLevel 是不同概念。
+     * @since - v5.6.12
+     */
+    getVolume(): number;
 }
 declare class RCRemoteVideoTrack extends RCRemoteTrack {
     constructor(logger: BasicLogger, tag: string, userId: string, roomId?: string);
@@ -532,14 +538,15 @@ declare enum RTCMode {
      * 跨应用多人房间
      */
     CROSS_MUTI = 7,
-    /**
-    * 跨应用直播
-    */
-    CROSS_LIVE = 8,
     /**
      * sip呼叫
      */
-    SIP = 4
+    SIP = 4,
+    /**
+     * 内部 Callplus 呼叫房间类型，请勿使用
+     * @hidden
+     */
+    CALL = 5
 }
 
 /**
@@ -1064,8 +1071,8 @@ declare abstract class ReadableStore {
     protected _roomStatusVersion: number;
     constructor(_logger: BasicLogger, clientSessionId: string, appkey: string, roomId: string, crtUserId: string, roomMode: RTCMode, isUpgrade?: boolean | undefined, isMainRoom?: boolean | undefined);
     getResourcesByUserId(userId: string): IPublishedResource[] | undefined;
-    getRemoteTrack(trackId: string): RCRemoteTrack | undefined;
-    getRemoteTracksByUserId(userId: string): RCRemoteTrack[];
+    getRemoteTrack(trackId: string): RCRemoteAudioTrack | RCRemoteVideoTrack | undefined;
+    getRemoteTracksByUserId(userId: string): (RCRemoteAudioTrack | RCRemoteVideoTrack)[];
     getRemoteTracks(): {
         [trackId: string]: RCRemoteAudioTrack | RCRemoteVideoTrack;
     };
@@ -1094,7 +1101,7 @@ declare class Store extends ReadableStore {
     setResourcesByUserId(userId: string, arr: IPublishedResource[]): void;
     removeRemoteTrack(trackId: string): void;
     removeResourcesByUserId(userId: string): void;
-    addRemoteTrack(track: RCRemoteTrack): void;
+    addRemoteTrack(track: RCRemoteAudioTrack | RCRemoteVideoTrack): void;
     removeRemoteTracks(): void;
     setCDNEnabel(bool: boolean): void;
     setCDNUris(uris: ICDNUris | null): void;
@@ -3696,7 +3703,7 @@ declare class RCLivingPKHandler {
      * 发起跨房间连麦请求
      * @param inviteeRoomId 被邀请者所处的房间 roomId
      * @param inviteeUserId 被邀请者 userId
-     * @param options.autoMix 是否要把邀请者发布的资源，合并到被邀请者房间内的 MCU 流中
+     * @param options.autoMix 是否将本房间资源合并到被邀请者所处房间的 MCU 合流中
      * @param options.extra 拓展字段，可随邀请连麦消息透传给被邀请者
      */
     requestJoinOtherRoom(inviteeRoomId: string, inviteeUserId: string, options?: IReqResPKOptions): Promise<{
@@ -3716,7 +3723,7 @@ declare class RCLivingPKHandler {
      * @param inviterRoomId 邀请者所处的房间 roomId
      * @param inviterUserId 邀请者 userId
      * @param agree 是否同意连麦
-     * @param options.autoMix 是否要把被邀请者发布的资源，合并到邀请者房间内的 MCU 流中
+     * @param options.autoMix 是否将本房间资源合并到邀请者所处房间的 MCU 合流中
      * @param options.extra 附加信息，可随响应连麦消息透传给邀请者
      */
     responseJoinOtherRoom(inviterRoomId: string, inviterUserId: string, agree: boolean, options?: IReqResPKOptions): Promise<{
@@ -4052,7 +4059,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
      * @param trackId
      * @returns
      */
-    getRemoteTrack(trackId: string): RCRemoteTrack | null;
+    getRemoteTrack(trackId: string): RCRemoteAudioTrack | RCRemoteVideoTrack | null;
     /**
      * 获取当前已经订阅的全量资源
      * returns subscribedTracks ISubscribeAttr[]
@@ -4072,8 +4079,8 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     registerReportListener(listener: IRCRTCReportListener | null): void;
     /**
      * 音量上报
-     * @param handler 业务端传入的音量上报事件
-     * @param _ - 参数已废弃~~上报时间间隔~~
+     * @param handler 音量事件监听函数
+     * @param _ - 参数已废弃，SDK 默认以每秒一次进行回调~~上报时间间隔~~
      */
     onAudioLevelChange(handler: IAudioLevelChangeHandler | null, _?: number): void;
     /**
@@ -4673,23 +4680,23 @@ declare class RCRTCClient extends RCMediaStreamCapture {
      * @param {RTCJoinType} [joinType] - 要加入的房间类型。
      * @param {IRTCUserData} [outerUserDatas] - 加入房间的用户的用户数据。
      * @param {boolean} [_] - 已废弃~~（是否使用多条 PeerConnection 链路）~~
-     * @param {RTCMode} roomType - RTCMode = RTCMode.RTC,
+     * @param {RTCMode} roomType - 房间类型，请谨慎修改，默认为 RTCMode.RTC
      */
-    joinRTCRoom(roomId: string, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, _?: boolean, roomType?: RTCMode): Promise<{
+    joinRTCRoom(roomId: string, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, _?: boolean, roomType?: RTCMode.RTC | RTCMode.SIP | RTCMode.CALL): Promise<{
         room?: RCRTCRoom;
         code: RCRTCCode;
         userIds?: string[];
         tracks?: RCRemoteTrack[];
     }>;
     /**
-     * 加入跨AppKey音视频房间
+     * 加入跨 AppKey 音视频房间
      * @param roomId
      * @param joinType 多端处理方式
      * @param outerUserDatas 业务层设置人员属性
      * @param _ 参数已废弃
-     * @param roomType 加入房间的类型 默认参数 RTCMode.CROSS_MUTI
+     * @param __ 参数已废弃
      */
-    joinCrossRTCRoom(roomId: string, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, _?: boolean, roomType?: RTCMode): Promise<{
+    joinCrossRTCRoom(roomId: string, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, _?: boolean, __?: RTCMode): Promise<{
         room?: RCRTCRoom;
         code: RCRTCCode;
         userIds?: string[];
@@ -4776,14 +4783,13 @@ declare class RCRTCClient extends RCMediaStreamCapture {
         CDNUris?: IJoinResCDNInfo;
     }>;
     /**
-     * 获取在房间内用户信息
+     * 验证本用户是否存在于某个 RTC 房间内
      * @since version 5.2.1
      */
     getJoinedRoomInfo(): Promise<{
         code: RCRTCCode | ErrorCode;
         data?: IRTCJoinedInfo[];
     }>;
-    reportSDKInfo(): void;
 }
 
 /**