@rongcloud/plugin-rtc 5.3.11 → 5.3.13

package/dist/core/room/RCAudienceLivingRoom.d.ts

@@ -0,0 +1,305 @@
+import { RTCPluginContext, IRuntime, IServerRTCRoomEntry } from '@rongcloud/engine';
+import { RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack } from '../tracks/RCRemoteTrack';
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { IRCRTCInitOptions, IRCRTCReportListener, IRCRTCTrackEventListener, ISubscribeAttr, IAudioLevelChangeHandler } from '../interfaces';
+import PolarisReporter from '../PolarisReporter';
+import { IBroadcastSubReqBody } from '../service';
+import RCLocalMediaStream from './RCLocalMediaStream';
+import { RCResolution } from '../enums/RCResolution';
+import { RCFrameRate } from '../enums/RCFrameRate';
+import { RCLivingType } from '../enums/RCLivingType';
+import RCRTCPeerConnection from '../webrtc/RCRTCPeerConnection';
+export interface IAudienceRoomEventListener extends IRCRTCTrackEventListener {
+    /**
+     * 主播加入
+     * @param userIds 加入主播的 id 列表
+     */
+    onAnchorJoin?(userId: string[]): void;
+    /**
+     * 主播退出
+     * @param userIds 退出主播的 id 列表
+     */
+    onAnchorLeave?(userId: string[]): void;
+    /**
+     * 房间内合流发布资源
+     * @param tracks 新发布的合流音轨与视轨数据列表，包含新发布的 RCRemoteAudioTrack 与 RCRemoteVideoTrack 实例
+     * @description
+     * 当房间内某个主播第一次发布资源时触发
+     */
+    onTrackPublish?(tracks: RCRemoteTrack[]): void;
+    /**
+     * 房间内取消合流发布资源
+     * @param tracks 被取消发布的合流音轨与视轨数据列表
+     * @description
+     * 当房间内全部主播退出房间时，SDK 内部会取消对资源的订阅，业务层仅需处理 UI 业务
+     */
+    onTrackUnpublish?(tracks: RCRemoteTrack[]): void;
+    /**
+     * 房间内主播发布资源
+     * @param tracks 主播新发布的音轨与视轨数据列表，包含新发布的 RCRemoteAudioTrack 与 RCRemoteVideoTrack 实例
+     */
+    onAnchorTrackPublish?(tracks: RCRemoteTrack[]): void;
+    /**
+     * 房间内主播取消发布资源
+     * @param tracks 被主播取消发布的音轨与视轨数据列表
+     * @description 当资源被取消发布时，SDK 内部会取消对相关资源的订阅，业务层仅需处理 UI 业务
+     */
+    onAnchorTrackUnpublish?(tracks: RCRemoteTrack[]): void;
+    /**
+     * 房间主播禁用/启用音频
+     * @param audioTrack RCRemoteAudioTrack 类实例
+     */
+    onAudioMuteChange?(audioTrack: RCRemoteAudioTrack): void;
+    /**
+    * 房间主播禁用/启用视频
+    * @param videoTrack RCRemoteVideoTrack 类实例对象
+    */
+    onVideoMuteChange?(videoTrack: RCRemoteVideoTrack): void;
+    /**
+     * 房间内主播把发布的资源推至 CDN
+     */
+    onCDNInfoEnable?(CDNInfo: {
+        resolution: RCResolution;
+        fps: RCFrameRate;
+    }): void;
+    /**
+     * 主播停止推 CDN
+     */
+    onCDNInfoDisable?(): void;
+    /**
+     * 主播改变推 CDN 的分辨率或帧率
+     */
+    onCDNInfoChange?(CDNInfo: {
+        resolution: RCResolution;
+        fps: RCFrameRate;
+    }): void;
+}
+/**
+ * 观众直播房间类
+ * 处理：
+ * 1、通知观众房间内 人员变更、资源变更
+ * 2、观众订阅、取消订阅资源
+ */
+export default class RCAudienceLivingRoom {
+    private readonly _context;
+    private readonly _runtime;
+    private readonly _initOptions;
+    readonly _roomId: string;
+    private readonly _joinResData;
+    readonly _livingType: RCLivingType;
+    private readonly _service;
+    /**
+     * 主播列表
+     */
+    private _roomAnchorList;
+    /**
+     * 合流、分流资源
+     */
+    private _roomRes;
+    /**
+     * 主播分流资源
+     */
+    private _roomAnchorRes;
+    /**
+     * 合流、分流 remoteTracks
+     */
+    private _remoteTracks;
+    private _appListener;
+    private _pc;
+    private _subscribedList;
+    private _sessionId;
+    private _destroyed;
+    /**
+     * 北极星上报实例
+     */
+    protected _polarisReport: PolarisReporter | null;
+    /**
+     * 音量上报实例
+     */
+    private _audioLevelReport;
+    /**
+     * cdn_uris 资源
+     */
+    private _CDNUris;
+    constructor(_context: RTCPluginContext, _runtime: IRuntime, _initOptions: IRCRTCInitOptions, _roomId: string, _joinResData: {
+        token: string;
+        kvEntries: IServerRTCRoomEntry[];
+    }, _livingType: RCLivingType);
+    /**
+     * 解析服务端返回的 KV 数据，赋值 room 内数据
+     */
+    private _setInitData;
+    protected _assertRoomDestroyed(): RCRTCCode | undefined;
+    /**
+     * @description 信令数据处理
+     * @param roomId 数据对应的房间 Id
+     * @param singalData 拉取到的数据
+     * * key RC_ANCHOR_LIST value: 为主播 ID 集合
+     * * key RC_RES_`userId` value: 为主播发布的资源
+     * * key RC_RTC_SESSIONID value: sessionId
+     * * key RC_CDN value: CDN 资源数据
+     */
+    private singalDataChange;
+    /**
+     * 计算加入离开的主播 ID 列表
+     */
+    private _diffAnchorList;
+    private _handleNewJoinedAnchor;
+    private _handleLeftedAnchor;
+    /**
+     * 计算新发布和取消发布的合流资源
+     */
+    private _diffRoomResource;
+    /**
+     * 计算主播发布和取消发布的资源，以及资源的状态变更
+    */
+    private _diffAnchorResource;
+    private _onUserUnpublish;
+    private _callAppListener;
+    /**
+     * ice 断线后，尝试重新走 exchange
+    */
+    private _reTryExchange;
+    /**
+     * 获取 subscribe 接口的请求体数据
+     * @param subscribeList 订阅清单
+     * @param publishedStreams 已发布流
+     * @param iceRestart
+     */
+    protected _createSubscribeParams(subscribeList: ISubscribeAttr[], publishedStreams: {
+        [msid: string]: RCLocalMediaStream;
+    }, iceRestart: boolean): Promise<{
+        reqBody: IBroadcastSubReqBody;
+        offer: RTCSessionDescriptionInit;
+        dynamicBitrate: {
+            min: number;
+            max: number;
+        };
+    }>;
+    private _subscribeHandle;
+    private _getReqHeaders;
+    private _exchangeHandle;
+    private _updateSubListHandle;
+    /**
+     * 对比 cdn_uris 资源
+     * @param newCDNUris 新的 cdn_uris 数据
+     */
+    private _diffCDNUris;
+    /**
+     * 获取 CDN 资源对应的拉流地址
+     * _CDNUris 无 url 时，说明未开启 CDN 推送
+     * @returns CDNPlayUrl
+     */
+    private _getCDNPlayUrl;
+    /**
+     * 获取 CDN 资源对应的拉流地址
+     * @returns CDNPlayUrl
+     */
+    getCDNPlayUrl(resolution?: RCResolution, fps?: RCFrameRate): Promise<{
+        code: RCRTCCode;
+        CDNPlayUrl?: string;
+    }>;
+    /**
+     * 订阅资源
+     * @param tracks
+     */
+    subscribe(tracks: (RCRemoteTrack | ISubscribeAttr)[]): Promise<{
+        code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
+    }>;
+    private __unsubscribe;
+    /**
+     * 取消订阅资源
+     * @param tracks
+     */
+    unsubscribe(tracks: RCRemoteTrack[]): Promise<{
+        code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
+    }>;
+    /**
+     * 退出房间并销毁当前房间实例，退出后该房间的所有方法将不可用
+     */
+    __destroy(quitRoom: boolean): Promise<void>;
+    /**
+     * 根据 trackId 获取房间内的远端资源
+     * @param trackId
+     */
+    getRemoteTrack(trackId: string): RCRemoteTrack;
+    /**
+     * 获取 _pc 实例
+     */
+    __getPC(): RCRTCPeerConnection;
+    /**
+     * TODO 待优化
+     * @param trackId
+     */
+    getLocalTrack(trackId: string): RCRemoteTrack;
+    /**
+     * 断线重连后处理逻辑, SDK 内部处理调用
+     */
+    __onReconnected(): Promise<void>;
+    /**
+     * 观众房间事件注册
+     * @param tag 参数描述
+     */
+    registerRoomEventListener(listener: IAudienceRoomEventListener | null): void;
+    /**
+     * 音量上报
+     * @param handler 业务端传入的音量上报事件
+     * @param gap 上报时间间隔
+     */
+    onAudioLevelChange(handler: IAudioLevelChangeHandler | null, gap?: number): void;
+    /**
+     * 注册房间数据监控
+     * @param listener
+     */
+    registerReportListener(listener: IRCRTCReportListener | null): void;
+    /**
+     * 获取房间 Id
+     */
+    getRoomId(): string;
+    /**
+     * 获取当前 userId
+     */
+    getCrtUserId(): string;
+    /**
+     * 获取房间当前会话 Id，当房间内已无成员时房间会回收，重新加入时 sessionId 将更新
+     */
+    getSessionId(): string;
+    /**
+     * 获取远程主播用户列表
+     */
+    getRemoteUserIds(): string[];
+    /**
+     * 获取远端用户的资源列表
+     * @param userId
+     * @returns
+     */
+    getRemoteTracksByUserId(userId: string): RCRemoteTrack[];
+    /**
+     * 获取房间内所有已发布的远端资源列表, 包含合流资源
+     * @returns
+     */
+    getRemoteTracks(): RCRemoteTrack[];
+    /**
+     * 获取远端 RTC tracks
+     */
+    getRemoteRTCTracks(): RCRemoteTrack[];
+    /**
+     * 获取远端 MCU tracks
+     */
+    getRemoteMCUTracks(): RCRemoteTrack[];
+    /**
+     * 获取房间内 CDN 信息
+     */
+    getCDNInfo(): {
+        resolution: RCResolution;
+        fps: RCFrameRate;
+        CDNEnable: boolean | undefined;
+    } | {
+        CDNEnable: boolean;
+        resolution?: undefined;
+        fps?: undefined;
+    };
+}
+//# sourceMappingURL=RCAudienceLivingRoom.d.ts.map

package/dist/core/room/RCAudioLevelReport.d.ts

@@ -0,0 +1,17 @@
+import { IAudioLevelChangeHandler } from '../interfaces';
+import RCAbstractRoom from './RCAbstractRoom';
+import RCAudienceLivingRoom from './RCAudienceLivingRoom';
+export default class RCAudioLevelReport {
+    private readonly _room;
+    private _pc;
+    private _audioLevelChangeHandler;
+    private _timer;
+    constructor(_room: RCAbstractRoom | RCAudienceLivingRoom);
+    /**
+     * 通知业务端音量 > 0 的数据，数组每一项包含 track、audioLevel
+     */
+    private _audioLevelReport;
+    onAudioLevelChange(handler: IAudioLevelChangeHandler | null, gap: number): void;
+    clearAudioLevelReportTimer(): void;
+}
+//# sourceMappingURL=RCAudioLevelReport.d.ts.map

package/dist/core/room/RCLivingPKHandler.d.ts

@@ -0,0 +1,176 @@
+import { ErrorCode, IReceivedMessage, IRuntime, RTCPluginContext } from '@rongcloud/engine';
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { IPKInfo, IPKEndInfo, IPKInviteAnswerInfo, IPKInviteInfo, IRCRTCInitOptions, IReqResPKOptions } from '../interfaces';
+import RCMediaService from '../service/RCMediaService';
+import { RCRemoteTrack } from '../tracks/RCRemoteTrack';
+import RCLivingRoom from './RCLivingRoom';
+export type IOnRecvPKMsg = (msg: IReceivedMessage) => void;
+export interface IRoomPKEventListener {
+    /**
+     * 收到连麦邀请
+     */
+    onRequestJoinOtherRoom: (info: IPKInviteInfo) => {};
+    /**
+     * 收到取消连麦邀请
+     */
+    onCancelRequestOtherRoom: (info: IPKInviteInfo) => {};
+    /**
+     * 收到连麦 PK 请求响应结果
+     */
+    onResponseJoinOtherRoom: (info: IPKInviteAnswerInfo) => {};
+    /**
+     * 收到 PK 结束
+     */
+    onFinishOtherRoom: (info: IPKEndInfo) => {};
+}
+export declare class RCLivingPKHandler {
+    private _PKInfo;
+    private readonly _context;
+    private readonly _runtime;
+    private readonly _service;
+    private readonly _initOptions;
+    /**
+     * 主直播房间
+     */
+    private readonly _mainLivingRoom;
+    private readonly _registerPKMsgListener;
+    /**
+     * 加入 PK 房间回调
+     */
+    private readonly _onJoinedPKRoom;
+    /**
+     * 退出 PK 房间回调
+     */
+    private readonly _onLeavePKRoom;
+    /**
+     * PK 邀请超时时间，默认 30s
+     */
+    private readonly _inviteTimeout;
+    /**
+     * PK 房间信息
+     */
+    private _appListener;
+    private _mainRoomId;
+    /**
+     * 跨房间连麦加入的 PK 房间
+     */
+    private _joinedPKRooms;
+    constructor(_PKInfo: IPKInfo, _context: RTCPluginContext, _runtime: IRuntime, _service: RCMediaService, _initOptions: IRCRTCInitOptions, 
+    /**
+     * 主直播房间
+     */
+    _mainLivingRoom: RCLivingRoom, _registerPKMsgListener: (listener: IOnRecvPKMsg) => void, 
+    /**
+     * 加入 PK 房间回调
+     */
+    _onJoinedPKRoom: (roomId: string, room: RCLivingRoom) => void, 
+    /**
+     * 退出 PK 房间回调
+     */
+    _onLeavePKRoom: (roomId: string) => void);
+    private _callAppListener;
+    /**
+     * 收到连麦邀请
+     */
+    private _onInvite;
+    /**
+     * 收到取消连麦
+     */
+    private _onCancelInvite;
+    private _onInviteTimeout;
+    /**
+     * 收到响应连麦
+     */
+    private _onInviteAnswer;
+    /**
+     * 收到连麦结束
+     */
+    private _onPKEnd;
+    /**
+     * 处理跨房间连麦相关消息
+     */
+    private _onRecvPKMsg;
+    /**
+     * 注册跨房间连麦监听事件
+     */
+    registerRoomPKEventListener(listener: IRoomPKEventListener): void;
+    /**
+     * 发起跨房间连麦请求
+     * @param inviteeRoomId 被邀请者所处的房间 roomId
+     * @param inviteeUserId 被邀请者 userId
+     * @param options.autoMix 是否要把邀请者发布的资源，合并到被邀请者房间内的 MCU 流中
+     * @param options.extra 拓展字段，可随邀请连麦消息透传给被邀请者
+     */
+    requestJoinOtherRoom(inviteeRoomId: string, inviteeUserId: string, options?: IReqResPKOptions): Promise<{
+        code: RCRTCCode | ErrorCode;
+    }>;
+    /**
+     * 取消跨房间连麦请求
+     * @param inviteeRoomId 被邀请者所处的房间 roomId
+     * @param inviteeUserId 被邀请者 userId
+     * @param extra 附加信息，可随取消邀请连麦消息透传给被邀请者
+     */
+    cancelRequestJoinOtherRoom(inviteeRoomId: string, inviteeUserId: string, extra?: string): Promise<{
+        code: RCRTCCode | ErrorCode;
+    }>;
+    /**
+     * 响应跨房间连麦请求
+     * @param inviterRoomId 邀请者所处的房间 roomId
+     * @param inviterUserId 邀请者 userId
+     * @param agree 是否同意连麦
+     * @param options.autoMix 是否要把被邀请者发布的资源，合并到邀请者房间内的 MCU 流中
+     * @param options.extra 附加信息，可随响应连麦消息透传给邀请者
+     */
+    responseJoinOtherRoom(inviterRoomId: string, inviterUserId: string, agree: boolean, options?: IReqResPKOptions): Promise<{
+        code: RCRTCCode | ErrorCode;
+    }>;
+    /**
+     * 结束跨房间连麦
+     * @param roomId 需要结束连麦的房间 roomId
+     */
+    private _quitRoomPK;
+    private _relaseCrtRoom;
+    /**
+     * 加入副直播房间
+     * @roomId 副房间的 roomId
+     */
+    joinOtherRoom(roomId: string): Promise<{
+        code: RCRTCCode;
+        room?: RCLivingRoom;
+        userIds?: string[];
+        tracks?: RCRemoteTrack[];
+        CDNEnable?: boolean;
+    }>;
+    /**
+     * 退出副房间
+     * @param room 要退出的副房间的 room 实例
+     * @param isQuitPK 是否要结束连麦
+     */
+    leaveOtherRoom(room: RCLivingRoom, isQuitPK?: boolean): Promise<{
+        code: RCRTCCode;
+    }>;
+    private _leaveOtherRoom;
+    /**
+     * 获取连麦信息
+     * @param roomId 连麦房间的 roomId
+     */
+    getPKInfo(roomId: string): {
+        inviteSessionId: string;
+        inviterRoomId: string;
+        inviterUserId: string;
+        inviterUserAutoMix?: boolean | undefined;
+        inviteeRoomId: string;
+        inviteeUserAutoMix?: boolean | undefined;
+    };
+    /**
+     * 获取所有连麦信息
+     */
+    getAllPKInfo(): IPKInfo;
+    /**
+     * 获取已加入的副房间
+     */
+    getJoinedPKRooms(): {
+        [roomId: string]: RCLivingRoom;
+    };
+}
+//# sourceMappingURL=RCLivingPKHandler.d.ts.map

package/dist/core/room/RCLivingRoom.d.ts

@@ -0,0 +1,145 @@
+import { IJoinRTCRoomData, RTCPluginContext, IRuntime } from '@rongcloud/engine';
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { IRCRTCInitOptions, IPublishedResource } from '../interfaces';
+import { RCMediaService, ICDNUris, IExchangeReqBody } from '../service';
+import RCAbstractRoom, { IPushOtherRooms } from './RCAbstractRoom';
+import RCMCUConfigBuilder from './RCMCUConfigBuilder';
+import { RCLivingType } from '../enums/RCLivingType';
+import { RCInnerCDNPushMode } from '../enums/RCInnerCDNPushMode';
+import { RCLivingPKHandler } from './RCLivingPKHandler';
+/**
+ * 直播房间
+ */
+export default class RCLivingRoom extends RCAbstractRoom {
+    private _livingType;
+    /**
+     * 是否是主房间
+     */
+    protected _isMainRoom: boolean;
+    readonly _mcuConfigBuilder: RCMCUConfigBuilder;
+    /**
+     * cdn_uris 信令扩散数据
+     */
+    private _CDNUris;
+    private _CDNEnable;
+    /**
+     * 跨房间连麦管理器
+     */
+    private readonly _roomPKHandler;
+    constructor(context: RTCPluginContext, runtime: IRuntime, roomId: string, data: IJoinRTCRoomData, service: RCMediaService, initOptions: IRCRTCInitOptions, clientEvent: Function, _livingType: RCLivingType, isUpgrage: boolean | undefined, 
+    /**
+     * 是否是主房间
+     */
+    _isMainRoom: boolean);
+    /**
+     * resourceId 有效性验证
+     * @param resourceId
+     */
+    protected _isValidResourceId(resourceId: string): boolean;
+    getLivingType(): RCLivingType;
+    /**
+     * 获取 MCU 配置构建对象
+     */
+    getMCUConfigBuilder(): RCMCUConfigBuilder | {
+        code: RCRTCCode;
+    };
+    /**
+     * 接收 MCU 配置并向 MediaServer 提交
+     * @param data
+     */
+    private _onMCUConfigFlush;
+    /**
+     * 主播端断线重连后，需更新内存中的 CDN 数据
+     * 判断房间内 CDN 状态是否和内存数据一致，不一致时需通知到客户端
+     */
+    __onReconnected(): Promise<void>;
+    /**
+     * 开启/停用推 CDN
+     */
+    enableInnerCDN(enable: boolean): Promise<{
+        code: RCRTCCode;
+    }>;
+    /**
+     * 开启、停用 CDN 推资源后发信令
+     */
+    private _sendCDNInfoSignal;
+    /**
+     * 扩散 cdn_uris 资源
+     */
+    private _spreadCDNInfo;
+    /**
+     * 给房间设置 CDN 数据
+     */
+    private _setRoomCDNInfo;
+    /**
+     * 资源变化时触发
+     * 直播房间需单独处理 cdn_uris
+     */
+    protected _resourceHandle(content: {
+        /**
+         * 旧版本兼容参数，当收到非 `RTCMessageName.TOTAL_CONTENT_RESOURCE` 时：
+         * * ignore 值为 `true` 表示该消息由 signal server 向旧版本 RTCLib 提供的兼容消息，无需处理
+         * * 否则认为该消息是由旧版本 RTCLib 主动发出的增量变更消息，需要处理
+         */
+        ignore?: boolean;
+        /**
+         * 发布到房间内的资源列表，`RTCMessageName.TOTAL_CONTENT_RESOURCE` 消息携带全量数据，否则为增量数据
+         */
+        uris: IPublishedResource[];
+        cdn_uris?: ICDNUris[];
+    }, messageType: string, userId: string): Promise<void>;
+    /**
+     * 重写父类 _exchangeHandle 方法
+     */
+    protected _exchangeHandle(body: IExchangeReqBody): Promise<{
+        code: RCRTCCode;
+        data?: import("../service").IExchangeResponse | undefined;
+    }>;
+    /**
+     * 观众切换为主播后直接处理人员变更及资源变更
+     */
+    protected _afterChangedRole(data: IJoinRTCRoomData): void;
+    /**
+     * 返回 CDN 是否可用
+     * @returns boolean
+     */
+    __getCDNEnable(): boolean | undefined;
+    /**
+     * 返回 CDN 推送模式: 自动 or 手动
+     * @returns boolean
+     */
+    __getCDNPushMode(): RCInnerCDNPushMode | undefined;
+    /**
+     * 加入 PK 房间回调
+     */
+    private _onJoinedPKRoom;
+    /**
+     * 离开 PK 房间后，如果参与过连麦，pushOtherRooms 需去掉退出的连麦房间配置，重新和 mediaServer 交互
+     */
+    private _onLeavePKRoom;
+    /**
+     * @override
+     */
+    protected _getPushOtherRoomsParams(): IPushOtherRooms[];
+    /**
+     * 携带 pushOtherRooms 与 mediaServer 重新交互
+     */
+    private _exchangeWithPushOtherRoom;
+    /**
+     * 获取 PK 业务处理器
+     * @since version 5.3.0
+     */
+    getRoomPKHandler(): {
+        code: RCRTCCode;
+        roomPKHandler?: RCLivingPKHandler;
+    };
+    /**
+     * 退出所有连麦房间
+     */
+    protected _quitAllPKRoom(): void;
+    /**
+     * 是否是主房间
+     */
+    isMainRoom(): boolean;
+}
+//# sourceMappingURL=RCLivingRoom.d.ts.map

package/dist/core/room/RCLocalMediaStream.d.ts

@@ -0,0 +1,8 @@
+export default class RCLocalMediaStream {
+    readonly msid: string;
+    readonly mediaStream: MediaStream;
+    readonly tinyStream: MediaStream;
+    readonly tag: string;
+    constructor(msid: string);
+}
+//# sourceMappingURL=RCLocalMediaStream.d.ts.map