@rongcloud/plugin-rtc 5.4.2 → 5.4.3

package/dist/core/command/MCUConfigFlushCommand.d.ts

@@ -0,0 +1,18 @@
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { Invoker } from '../Invoker';
+import { IMCUConfig, ISetEnableCDN } from '../service';
+import { Store } from '../Store';
+import { BaseCommand } from './BaseCommand';
+export declare class MCUConfigFlushCommand extends BaseCommand<{
+    code: RCRTCCode;
+    res?: any;
+}> {
+    private data;
+    private cdnValues;
+    constructor(data: IMCUConfig | ISetEnableCDN, cdnValues: IMCUConfig);
+    execute(store: Store, invoker: Invoker): Promise<{
+        code: RCRTCCode;
+        res?: any;
+    }>;
+}
+//# sourceMappingURL=MCUConfigFlushCommand.d.ts.map

package/dist/core/command/OnRemoteUserUnpubCommand.d.ts

@@ -0,0 +1,13 @@
+import { Invoker } from '../Invoker';
+import { Store } from '../Store';
+import { RCRemoteTrack } from '../tracks/RCRemoteTrack';
+import { BaseCommand } from './BaseCommand';
+import { Subhook } from './UpdateSubListCommand';
+export declare class OnRemoteUserUnpubCommand extends BaseCommand<void> {
+    private subhook;
+    private tracks;
+    private onTrackUnpublish;
+    constructor(subhook: Subhook, tracks: RCRemoteTrack[], onTrackUnpublish: (tracks: RCRemoteTrack[]) => void);
+    execute(store: Store, invoker: Invoker): Promise<void>;
+}
+//# sourceMappingURL=OnRemoteUserUnpubCommand.d.ts.map

package/dist/core/command/OnSignalReconnectedCommand.d.ts

@@ -0,0 +1,38 @@
+import { IJoinRTCRoomData } from '@rongcloud/engine';
+import { RCLivingType } from '../enums/RCLivingType';
+import { Invoker } from '../Invoker';
+import { Store } from '../Store';
+import { RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack } from '../tracks/RCRemoteTrack';
+import { BaseCommand, CommandPriority } from './BaseCommand';
+import { Subhook } from './UpdateSubListCommand';
+export declare type ReconnectedCommandCallback = {
+    onPeerClosed: () => void;
+    onUserJoin: (userIds: string[]) => void;
+    onUserLeave: (userIds: string[]) => void;
+    onTrackPublish: (tracks: RCRemoteTrack[]) => void;
+    onTrackUnpublish: (tracks: RCRemoteTrack[]) => void;
+    onAudioMuteChange: (track: RCRemoteAudioTrack) => void;
+    onVideoMuteChange: (track: RCRemoteVideoTrack) => void;
+    onCDNEnableChange: (bool: boolean) => void;
+};
+export declare class OnSignalReconnectedCommand extends BaseCommand<{
+    data: IJoinRTCRoomData | undefined;
+} | void> {
+    private subhook;
+    private callbacks;
+    private livingType?;
+    constructor(subhook: Subhook, callbacks: ReconnectedCommandCallback, livingType?: RCLivingType | undefined);
+    /**
+     * @override
+     */
+    get priority(): CommandPriority;
+    execute(store: Store, invoker: Invoker): Promise<{
+        data: IJoinRTCRoomData | undefined;
+    } | void>;
+    /**
+     * 主播端断线重连后，需更新内存中的 CDN 数据
+     * 判断房间内 CDN 状态是否和内存数据一致，不一致时需通知到客户端
+     */
+    private executeInLivingRoom;
+}
+//# sourceMappingURL=OnSignalReconnectedCommand.d.ts.map

package/dist/core/command/ParseRemoteResCommand.d.ts

@@ -0,0 +1,38 @@
+import { RCRTCMessageType } from '../enums/inner/RCRTCMessageType';
+import { IPublishedResource } from '../interfaces';
+import { Invoker } from '../Invoker';
+import { ICDNUris } from '../service';
+import { Store } from '../Store';
+import { RCRemoteTrack } from '../tracks/RCRemoteTrack';
+import { BaseCommand, CommandPriority } from './BaseCommand';
+import { Subhook } from './UpdateSubListCommand';
+export declare type ResourceMsgContent = {
+    /**
+     * 旧版本兼容参数，当收到非 `RTCMessageName.TOTAL_CONTENT_RESOURCE` 时：
+     * * ignore 值为 `true` 表示该消息由 signal server 向旧版本 RTCLib 提供的兼容消息，无需处理
+     * * 否则认为该消息是由旧版本 RTCLib 主动发出的增量变更消息，需要处理
+     */
+    ignore?: boolean;
+    /**
+     * 发布到房间内的资源列表，`RTCMessageName.TOTAL_CONTENT_RESOURCE` 消息携带全量数据，否则为增量数据
+     */
+    uris: IPublishedResource[];
+    cdn_uris?: ICDNUris[];
+};
+export declare class ParseRemoteResCommand extends BaseCommand<void> {
+    private msgContent;
+    private messageType;
+    private senderId;
+    private subhook;
+    private callback;
+    constructor(msgContent: ResourceMsgContent, messageType: RCRTCMessageType.PUBLISH | RCRTCMessageType.UNPUBLISH | RCRTCMessageType.MODIFY | RCRTCMessageType.TOTAL_CONTENT_RESOURCE, senderId: string, subhook: Subhook, callback: {
+        onTrackPublish: (tracks: RCRemoteTrack[]) => void;
+        onTrackUnublish: (tracks: RCRemoteTrack[]) => void;
+        onAudioMute: (track: RCRemoteTrack) => void;
+        onVideoMute: (track: RCRemoteTrack) => void;
+        onCDNEnableChange: (bool: boolean) => void;
+    });
+    get priority(): CommandPriority;
+    execute(store: Store, invoker: Invoker): Promise<void>;
+}
+//# sourceMappingURL=ParseRemoteResCommand.d.ts.map

package/dist/core/command/ParseUserStateCommand.d.ts

@@ -0,0 +1,57 @@
+import { RCRTCLiveRole } from '../enums/RCRTCLiveRole';
+import { Invoker } from '../Invoker';
+import { Store } from '../Store';
+import { BaseCommand, CommandPriority } from './BaseCommand';
+import { Subhook } from './UpdateSubListCommand';
+declare type StateMsgContent = {
+    users: {
+        userId: string;
+        /**
+         * 状态值，其中
+         * * `0`: 进入房间
+         * * `1`: 退出房间
+         * * `2`: 用户离线，当作离开房间处理
+         */
+        state: '0' | '1' | '2';
+        /**
+         * 角色切换类型，0 代表非切换身份发生的加入、退出房间行为
+         */
+        switchRoleType: RCRTCLiveRole | 0;
+        /**
+         * 加房间的身份标识，保存主房间 roomId
+         */
+        extra?: {
+            [key: string]: string;
+        };
+    }[];
+};
+/**
+ * RCRTC:State 消息解析结果
+ */
+export interface IParseUserStateRes {
+    /**
+     * 新加入人员 ID 列表
+     */
+    joined: string[];
+    /**
+     * 退出人员 ID 列表
+     */
+    left: string[];
+    /**
+     * 通过观众升级成为主播的主播 ID 列表
+     */
+    upgrade: string[];
+    /**
+     * 由主播降级为观众的人员 ID 列表
+     */
+    downgrade: string[];
+}
+export declare class ParseUserStateCommand extends BaseCommand<IParseUserStateRes> {
+    private msgContent;
+    private subhook;
+    constructor(msgContent: StateMsgContent, subhook: Subhook);
+    get priority(): CommandPriority;
+    execute(store: Store, invoker: Invoker): Promise<IParseUserStateRes>;
+}
+export {};
+//# sourceMappingURL=ParseUserStateCommand.d.ts.map

package/dist/core/command/PubCommand.d.ts

@@ -0,0 +1,34 @@
+import { BaseCommand } from './BaseCommand';
+import { IMutilPeerC, IPublishAttrs, IPubSuccessRes } from '../interfaces';
+import { Store } from '../Store';
+import { RCLocalTrack } from '../tracks/RCLocalTrack';
+import { IPushOtherRooms, IRTCReqHeader } from '../service';
+import { Invoker } from '../Invoker';
+export declare type PubhookPeerItem = IMutilPeerC & {
+    headers: IRTCReqHeader;
+};
+export declare type PubhookRes = {
+    plist: PubhookPeerItem[];
+    pushOtherRooms: IPushOtherRooms[];
+};
+export declare type Pubhook = (tracks: (RCLocalTrack | IPublishAttrs)[]) => PubhookRes;
+/**
+ * 资源发布命令
+ */
+export declare class PubCommand extends BaseCommand<IPubSuccessRes> {
+    private tracks;
+    private pubhook;
+    constructor(tracks: (RCLocalTrack | IPublishAttrs)[], pubhook: Pubhook);
+    /**
+     * 从 pc 移除当次发布失败的资源
+     */
+    private _removePubFailedTracks;
+    private __publish;
+    /**
+     * 处理批量 /exhcange 的返回数据，作为一次 publish 接口返回
+     * @param pubResList 每一个 tag 的发布结果[]
+     */
+    private _mergePublishRes;
+    execute(store: Store, invoker: Invoker): Promise<IPubSuccessRes>;
+}
+//# sourceMappingURL=PubCommand.d.ts.map

package/dist/core/command/RTCIdentityChangeCommand.d.ts

@@ -0,0 +1,17 @@
+import { ErrorCode, IJoinRTCRoomData } from '@rongcloud/engine';
+import { RCLivingType } from '../enums/RCLivingType';
+import { BaseInvoker } from '../Invoker';
+import { Store } from '../Store';
+import { BaseCommand } from './BaseCommand';
+export declare class RTCIdentityChangeCommand extends BaseCommand<{
+    code: ErrorCode;
+    data?: IJoinRTCRoomData;
+}> {
+    private livingType;
+    constructor(livingType: RCLivingType);
+    execute(store: Store, invoker: BaseInvoker<Store>): Promise<{
+        code: ErrorCode;
+        data?: IJoinRTCRoomData;
+    }>;
+}
+//# sourceMappingURL=RTCIdentityChangeCommand.d.ts.map

package/dist/core/command/RetryExchangeCommand.d.ts

@@ -0,0 +1,18 @@
+import { Invoker } from '../Invoker';
+import { IPushOtherRooms, IRTCReqHeader } from '../service';
+import { Store } from '../Store';
+import { BaseCommand, CommandPriority } from './BaseCommand';
+export declare type RetryHookRes = {
+    pushOtherRooms: IPushOtherRooms[];
+    headers: IRTCReqHeader;
+};
+export declare type RetryHook = (pcName: string) => RetryHookRes;
+export declare class RetryExchangeCommand extends BaseCommand<void> {
+    private pcName;
+    private isPub;
+    private retryHook;
+    constructor(pcName: string, isPub: boolean, retryHook: RetryHook);
+    get priority(): CommandPriority;
+    execute(store: Store, invoker: Invoker): Promise<void>;
+}
+//# sourceMappingURL=RetryExchangeCommand.d.ts.map

package/dist/core/command/SubCommand.d.ts

@@ -0,0 +1,21 @@
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { ISubscribeAttr } from '../interfaces';
+import { Invoker } from '../Invoker';
+import { Store } from '../Store';
+import { RCRemoteTrack } from '../tracks/RCRemoteTrack';
+import { BaseCommand } from './BaseCommand';
+import { Subhook } from './UpdateSubListCommand';
+export declare class SubCommand extends BaseCommand<{
+    code: RCRTCCode;
+    failedList?: ISubscribeAttr[];
+}> {
+    private readonly tracks;
+    private subhook;
+    private readonly forceReq?;
+    constructor(tracks: (RCRemoteTrack | ISubscribeAttr)[], subhook: Subhook, forceReq?: boolean | undefined);
+    execute(store: Store, invoker: Invoker): Promise<{
+        code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
+    }>;
+}
+//# sourceMappingURL=SubCommand.d.ts.map

package/dist/core/command/UnpubCommand.d.ts

@@ -0,0 +1,20 @@
+import { IPublishAttrs, IPubSuccessRes } from '../interfaces';
+import { Invoker } from '../Invoker';
+import { IPushOtherRooms, IRTCReqHeader } from '../service/interface';
+import { Store } from '../Store';
+import { RCLocalTrack } from '../tracks/RCLocalTrack';
+import { BaseCommand } from './BaseCommand';
+export declare type UnpubhookRes = {
+    pushOtherRooms: IPushOtherRooms[];
+    headers: IRTCReqHeader;
+};
+export declare type Unpubhook = (tracks: (RCLocalTrack | IPublishAttrs)[], pcName: string) => UnpubhookRes;
+export declare class UnpubCommand extends BaseCommand<IPubSuccessRes> {
+    private tracks;
+    private unpubhook;
+    constructor(tracks: RCLocalTrack[], unpubhook: Unpubhook);
+    private __unpublish;
+    private _mergeUnpublishRes;
+    execute(store: Store, invoker: Invoker): Promise<IPubSuccessRes>;
+}
+//# sourceMappingURL=UnpubCommand.d.ts.map

package/dist/core/command/UnpubPrevCommand.d.ts

@@ -0,0 +1,6 @@
+import { Store } from '../Store';
+import { BaseCommand } from './BaseCommand';
+export declare class UnpubPrevCommand extends BaseCommand<void> {
+    execute(store: Store): Promise<void>;
+}
+//# sourceMappingURL=UnpubPrevCommand.d.ts.map

package/dist/core/command/UnsubCommand.d.ts

@@ -0,0 +1,20 @@
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { ISubscribeAttr } from '../interfaces';
+import { Invoker } from '../Invoker';
+import { Store } from '../Store';
+import { RCRemoteTrack } from '../tracks/RCRemoteTrack';
+import { BaseCommand } from './BaseCommand';
+import { Subhook } from './UpdateSubListCommand';
+export declare class UnsubCommand extends BaseCommand<{
+    code: RCRTCCode;
+    failedList?: ISubscribeAttr[];
+}> {
+    private tracks;
+    private subhook;
+    constructor(tracks: RCRemoteTrack[], subhook: Subhook);
+    execute(store: Store, invoker: Invoker): Promise<{
+        code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
+    }>;
+}
+//# sourceMappingURL=UnsubCommand.d.ts.map

package/dist/core/command/UpdateSubListCommand.d.ts

@@ -0,0 +1,28 @@
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { ISubscribeAttr } from '../interfaces';
+import { Invoker } from '../Invoker';
+import { IPushOtherRooms, IRTCReqHeader } from '../service';
+import { Store } from '../Store';
+import { RCRemoteTrack } from '../tracks/RCRemoteTrack';
+import RCRTCPeerConnection from '../webrtc/RCRTCPeerConnection';
+import { BaseCommand } from './BaseCommand';
+export declare type SubhookRes = {
+    pc: RCRTCPeerConnection;
+    pushOtherRooms: IPushOtherRooms[];
+    headers: IRTCReqHeader;
+};
+export declare type Subhook = (tracks: (RCRemoteTrack | ISubscribeAttr)[]) => SubhookRes;
+export declare class UpdateSubListCommand extends BaseCommand<{
+    code: RCRTCCode;
+    failedList?: ISubscribeAttr[];
+}> {
+    private readonly tracks;
+    private subhook;
+    private readonly forceReq?;
+    constructor(tracks: (RCRemoteTrack | ISubscribeAttr)[], subhook: Subhook, forceReq?: boolean | undefined);
+    execute(store: Store, invoker: Invoker): Promise<{
+        code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
+    }>;
+}
+//# sourceMappingURL=UpdateSubListCommand.d.ts.map

package/dist/core/command/helper.d.ts

@@ -0,0 +1,20 @@
+import { RCRTCCode } from '../enums/RCRTCCode';
+import { ISubscribeAttr } from '../interfaces';
+import { IExchangeReqBody } from '../service';
+import { ReadableStore } from '../Store';
+import RCRTCPeerConnection from '../webrtc/RCRTCPeerConnection';
+/**
+ * 获取 exchange 接口的请求体数据
+ * @param subscribeList 订阅清单
+ * @param iceRestart
+ * @param pc RCRTCPeerConnection 实例
+ * @param store: Store
+ */
+export declare function createExchangeParams(subscribeList: ISubscribeAttr[], iceRestart: boolean, pc: RCRTCPeerConnection, store: ReadableStore): Promise<IExchangeReqBody>;
+/**
+   * 开启、停用 CDN 推资源后发信令
+   */
+export declare function sendCDNInfoSignal(store: ReadableStore): Promise<{
+    code: RCRTCCode;
+}>;
+//# sourceMappingURL=helper.d.ts.map

package/dist/core/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const STAT_NONE = -1;
+//# sourceMappingURL=constants.d.ts.map

package/dist/core/enums/BackgroundPictureFillMode.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 自定义合流布局时，背景图片填充方式
+ */
+export declare enum BackgroundPictureFillMode {
+    /**
+     * 裁剪（默认）
+     */
+    CROP = 1,
+    /**
+     * 不裁剪
+     */
+    WHOLE = 2
+}
+//# sourceMappingURL=BackgroundPictureFillMode.d.ts.map

package/dist/core/enums/MixLayoutMode.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 直播布局模式定义
+ */
+export declare enum MixLayoutMode {
+    /**
+     * 自定义布局
+     */
+    CUSTOMIZE = 1,
+    /**
+     * 悬浮布局（默认）
+     */
+    SUSPENSION = 2,
+    /**
+     * 自适应布局
+     */
+    ADAPTATION = 3
+}
+//# sourceMappingURL=MixLayoutMode.d.ts.map

package/dist/core/enums/MixVideoRenderMode.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 合流布局对视频的填充模式
+ */
+export declare enum MixVideoRenderMode {
+    /**
+     * 裁剪（默认）
+     */
+    CROP = 1,
+    /**
+     * 不裁剪
+     */
+    WHOLE = 2
+}
+//# sourceMappingURL=MixVideoRenderMode.d.ts.map

package/dist/core/enums/RCBitrate.d.ts

@@ -0,0 +1,48 @@
+import { IRCTrackBitrate } from '../interfaces';
+export declare enum RCAudioBitrate {
+    /**
+     * 标清音质
+     */
+    Speech = "Speech",
+    /**
+     * 音乐音质
+     */
+    Music = "Music",
+    /**
+     * 音乐高清音质
+     */
+    MusicHigh = "MusicHigh"
+}
+export declare const getAudioBitrate: {
+    [key in RCAudioBitrate]: IRCTrackBitrate;
+};
+export declare enum RCVideoBitrate {
+    /**
+     * Bitrate { max: 150, min: 80 }
+     */
+    LEVEL0 = "LEVEL0",
+    /**
+     * Bitrate { max: 280, min: 120 }
+     */
+    LEVEL1 = "LEVEL1",
+    /**
+     * Bitrate { max: 650, min: 150 }
+     */
+    LEVEL2 = "LEVEL2",
+    /**
+     * Bitrate { max: 1000, min: 200 }
+     */
+    LEVEL3 = "LEVEL3",
+    /**
+     * Bitrate { max: 2200, min: 250 }
+     */
+    LEVEL4 = "LEVEL4",
+    /**
+     * Bitrate { max: 4000, min: 400 }
+     */
+    LEVEL5 = "LEVEL5"
+}
+export declare const getVideoBitrate: {
+    [key in RCVideoBitrate]: IRCTrackBitrate;
+};
+//# sourceMappingURL=RCBitrate.d.ts.map

package/dist/core/enums/RCFrameRate.d.ts

@@ -0,0 +1,7 @@
+export declare enum RCFrameRate {
+    FPS_10 = "FPS_10",
+    FPS_15 = "FPS_15",
+    FPS_24 = "FPS_24",
+    FPS_30 = "FPS_30"
+}
+//# sourceMappingURL=RCFrameRate.d.ts.map

package/dist/core/enums/RCInnerCDNBroadcast.d.ts

@@ -0,0 +1,5 @@
+export declare enum RCInnerCDNBroadcast {
+    SPREAD = 0,
+    NO_SPREAD = -1
+}
+//# sourceMappingURL=RCInnerCDNBroadcast.d.ts.map

package/dist/core/enums/RCInnerCDNModel.d.ts

@@ -0,0 +1,5 @@
+export declare enum RCInnerCDNModel {
+    OPEN = 1,
+    STOP = 2
+}
+//# sourceMappingURL=RCInnerCDNModel.d.ts.map

package/dist/core/enums/RCInnerCDNPullIsHttps.d.ts

@@ -0,0 +1,5 @@
+export declare enum RCInnerCDNPullIsHttps {
+    NOT_HTTPS = 0,
+    HTTPS = 1
+}
+//# sourceMappingURL=RCInnerCDNPullIsHttps.d.ts.map

package/dist/core/enums/RCInnerCDNPullKind.d.ts

@@ -0,0 +1,6 @@
+export declare enum RCInnerCDNPullKind {
+    RTMP = "rtmp",
+    FLV = "flv",
+    HLS = "hls"
+}
+//# sourceMappingURL=RCInnerCDNPullKind.d.ts.map

package/dist/core/enums/RCInnerCDNPushMode.d.ts

@@ -0,0 +1,5 @@
+export declare enum RCInnerCDNPushMode {
+    AUTOMATIC = 0,
+    MANUAL = 1
+}
+//# sourceMappingURL=RCInnerCDNPushMode.d.ts.map

package/dist/core/enums/RCKickType.d.ts

@@ -0,0 +1,11 @@
+export declare enum RCKickReason {
+    /**
+     * Server 主动踢（掉 Server API 踢出）
+     */
+    SERVER_KICK = 1,
+    /**
+     * 其他设备登陆后，本端被踢
+     */
+    OTHER_KICK = 2
+}
+//# sourceMappingURL=RCKickType.d.ts.map

package/dist/core/enums/RCLivingType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 直播间类型
+ */
+export declare enum RCLivingType {
+    /**
+     * 音视频直播
+     */
+    VIDEO = 0,
+    /**
+     * 音频直播
+     */
+    AUDIO = 1
+}
+//# sourceMappingURL=RCLivingType.d.ts.map