@rongcloud/plugin-rtc 5.6.3-alpha.2 → 5.6.3-alpha.5

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.6.3-alpha.2
- * CommitId - 2fda2b34be0736183519f005f2d4157acd8a3161
- * Sun Nov 13 2022 12:38:30 GMT+0800 (China Standard Time)
+ * RCRTC - v5.6.3-alpha.5
+ * CommitId - 48fe4c6914037db2dfd263f31aba741834041487
+ * Wed Nov 16 2022 17:24:53 GMT+0800 (中国标准时间)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, BasicLogger, INaviInfo, RTCPluginContext, AbsCodec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, ConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, EnableLogL, IPluginGenerator } from '@rongcloud/engine';
@@ -1466,10 +1466,10 @@ declare class RTCContext {
      * @param valueInfo 全量资源数据
      * @param objectName 全量 URI 消息名
      */
-    setRTCTotalRes(roomId: string, message: {
+    setRTCTotalRes(roomId: string, messageList: {
         name: string;
         content: string;
-    }, valueInfo: string, objectName: string, mcuValInfo?: string, cdnValInfo?: string): Promise<ErrorCode>;
+    }[], valueInfo: string, objectName: string, mcuValInfo?: string, cdnValInfo?: string): Promise<ErrorCode>;
     setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
     getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
     removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
@@ -1655,7 +1655,7 @@ declare class RCMediaService {
     /**
      * 房间内观众获取 CDN 资源信息、拉流地址
      */
-    getCDNResourceInfo(headers: ICDNPlayUrlReqHeaders, url: string): Promise<{
+    getCDNResourceInfo(headers: ICDNPlayUrlReqHeaders, url: string, traceId: string): Promise<{
         code: RCRTCCode;
         res?: ICDNPlayUrlResponse;
     }>;
@@ -1859,15 +1859,83 @@ declare enum RCLivingType {
 }
 
 declare enum RCCommandKind {
-    Unknow = 0,
-    Publish = 1,
-    UnPublish = 2,
-    JoinRoom = 3,
-    LeaveRoom = 4,
-    UpdateSubscribeTask = 5,
-    SubscribedTask = 6,
-    UnSubscribedTask = 7,
-    AsyncCommand = "AsyncCommand"
+    /**
+     * 发信令取消加入房间之前的资源
+     */
+    UNPUBLISH_PREV = "UnpublishPrevCommand",
+    /**
+     * 拉取房间内数据
+     */
+    PULL_RTCROOM_STATUS = "PullRTCRoomStatusCommand",
+    /**
+     * 加入房间
+     */
+    JOINROOM = "JoinRoomCommand",
+    /**
+     * 解析远端资源数据
+     */
+    PARSE_REMOTERES = "ParseRemoteResCommand",
+    /**
+     * 解析远端人员数据
+     */
+    PARSE_USERSTATE = "ParseUserStateCommand",
+    /**
+     * 本端 track 禁用/启用
+     */
+    LOCAL_TRACK_MUTE = "LocalTrackMuteCommand",
+    /**
+     * 发布资源
+     */
+    PUBLISH = "PublishCommand",
+    /**
+     * 恢复 ice 连接
+     */
+    RETRY_EXCHANGE = "RetryExchangeCommand",
+    /**
+     * 取消发布
+     */
+    UNPUBLISH = "UnpublishCommand",
+    /**
+     * 订阅
+     */
+    SUBSCRIBE = "SubscribeCommand",
+    /**
+     * 异步订阅、取消订阅、全量订阅
+     */
+    ASYNC_COMMAND = "AsyncCommand",
+    /**
+     * 取消订阅
+     */
+    UNSUBSCRIBE = "UnsubscribeCommand",
+    /**
+     * 全量订阅
+     */
+    UPDATE_SUBSCRIBE_LIST = "UpdateSubscribeListCommand",
+    /**
+     * im 重连房间内人员、资源处理
+     */
+    ON_SIGNAL_RECONNECTED = "OnSignalReconnectedCommand",
+    /**
+     * 退出副房间
+     */
+    LEAVE_OTHER_ROOM = "LeaveOtherRoomCommand",
+    /**
+     * 主播、观众切换身份
+     */
+    RTC_IDENTITY_CHANGE = "RTCIdentityChangeCommand",
+    /**
+     * 开/关 CDN
+     */
+    ENABLE_INNER_CDN = "EnableInnerCDNCommand",
+    /**
+     * 携带副房间信息重新发 /exchange 请求
+     */
+    EXCHANGE_WITH_PUSH_OTHER_ROOM = "ExchangeWithPushOtherRoomCommand",
+    /**
+     * 发送 MCU 请求
+     */
+    MCUCONFIG_FLUSH = "MCUConfigFlushCommand",
+    UNKNOWN = "Unknown"
 }
 
 declare enum CommandPriority {
@@ -1924,6 +1992,10 @@ declare class RCRTCPeerCManager {
      * context
      */
     protected readonly _initOptions?: IRCRTCInitOptions | undefined;
+    /**
+     * 是否是观众
+     */
+    private readonly _isAudience?;
     /**
      * 存储创建的所有 peerC，key 为 pcName，/exchange 请求中 request header 中的 Peer-Connection-Id 值
      */
@@ -1957,7 +2029,11 @@ declare class RCRTCPeerCManager {
     /**
      * context
      */
-    _initOptions?: IRCRTCInitOptions | undefined);
+    _initOptions?: IRCRTCInitOptions | undefined, 
+    /**
+     * 是否是观众
+     */
+    _isAudience?: boolean | undefined);
     get useMutilPeerC(): boolean;
     /**
      * 根据 track 判断是否为上行
@@ -2076,6 +2152,7 @@ declare class RCRTCPeerCManager {
 }
 
 declare class BaseInvoker<STORE> {
+    private context;
     /**
      * 内存数据管理实例
      */
@@ -2084,7 +2161,7 @@ declare class BaseInvoker<STORE> {
      * 命令终止时返回的错误码定义
      */
     private abortCode;
-    constructor(
+    constructor(context: RTCContext, 
     /**
      * 内存数据管理实例
      */
@@ -2100,7 +2177,7 @@ declare class BaseInvoker<STORE> {
     push<R>(command: BaseCommand<R, STORE>): Promise<R>;
     private _isDestroyed;
     /**
-     * 查找出 RCCommandKind.AsyncCommand 类型的 Command，并将其从队列中删除
+     * 查找出 RCCommandKind.ASYNC_COMMAND 类型的 Command，并将其从队列中删除
      * 并使用最新的一次 Command 接管它的 resolve & reject
      * @param resolve
      * @param reject
@@ -2183,7 +2260,7 @@ declare class RCLivingPKHandler {
     /**
      * 加入 PK 房间回调
      */
-    _onJoinedPKRoom: (roomId: string, room: RCLivingRoom) => void, _clientSessionId?: string | undefined);
+    _onJoinedPKRoom: (roomId: string, traceId: string) => void, _clientSessionId?: string | undefined);
     private _callAppListener;
     /**
      * 收到连麦邀请
@@ -2350,6 +2427,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
      * 是否使用多 peerConnection
      */
     _useMutilPeerC?: boolean | undefined, _clientSessionId?: string, signalRetryTime?: number);
+    private _pullRTCRoomStatus;
     /**
      * 拉取房间数据
      * @param roomId 房间 id