@rongcloud/plugin-rtc 5.36.1-nctest-alpha.2 → 5.38.0-alpha.1

package/dist/index.d.ts

@@ -1,7 +1,5 @@
-import { LogL, EnableLogL, IPluginGenerator } from '@nexconn/engine';
-import { EventEmitter, IPromiseResult, IRuntime, IAsyncRes, RTCMode as RTCMode$1 } from 'common-utils';
-import * as _base_imlib_wrapper from '@base/imlib-wrapper';
-import { BasicLogger, IRTCPluginContext, ErrorCode, IRTCNaviInfo, ConversationType, ISendMsgOptions, IReceivedMessage, RCConnectionStatus } from '@base/imlib-wrapper';
+import * as _rongcloud_engine from '@rongcloud/engine';
+import { EventEmitter, BasicLogger, INaviInfo, RTCPluginContext, Codec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, RCConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, LogL, EnableLogL, RTCMode as RTCMode$1, IPluginGenerator } from '@rongcloud/engine';
 
 /**
  * 错误码，与移动端对齐
@@ -918,6 +916,11 @@ interface ICDNUris {
     'pull_safe': boolean;
 }
 
+declare enum RCRTCAISwitchType {
+    OPEN = 1,
+    CLOSE = 0
+}
+
 /**
  * 设置 RTC 人员 inner、outer 数据
  */
@@ -1089,6 +1092,28 @@ interface IEndRoomPKOptions {
      */
     keys: string[];
 }
+interface IRTCNaviInfo extends INaviInfo {
+    /**
+     * jwt token
+    */
+    jwt?: string;
+    /**
+     * http3 上报域名
+    */
+    logServer?: string;
+    /**
+     * 数据中心
+    */
+    dc?: string;
+    /**
+     *  openGzip  开启标识,默认是false,开启使用true
+    */
+    openGzip?: boolean;
+    /**
+     * AI 开关是否打开，1: 打开，0: 关闭
+     */
+    rtcAISwitch?: RCRTCAISwitchType;
+}
 
 declare enum RCRTCOperateSummarizationType {
     OPEN = "2",
@@ -1257,10 +1282,52 @@ declare enum RTCApiType {
 }
 
 declare enum RTCIdentityChangeType {
-    AnchorToViewer = 1,// 主播变观众
+    AnchorToViewer = 1,
     ViewerToAnchor = 2
 }
 
+declare const keymaps: {
+    readonly RtcInput: readonly ["roomType", "broadcastType", "extraInnerData", "needSysChatroom", "identityChangeType", "joinType", "innerDatas", "outerDatas", "supportNtf"];
+    readonly RtcOutput: readonly ["version"];
+    readonly RtcUserListOutput: readonly ["users", "token", "sessionId", "roomInfo", "version"];
+    readonly SetUserStatusInput: readonly ["status"];
+    readonly RtcSetDataInput: readonly ["interior", "target", "key", "value", "objectName", "content"];
+    readonly RtcUserSetDataInput: readonly ["valueInfo", "objectName", "content"];
+    readonly RtcDataInput: readonly ["interior", "target", "key", "objectName", "content"];
+    readonly RtcSetOutDataInput: readonly ["target", "valueInfo", "objectName", "content"];
+    readonly MCFollowInput: readonly ["state"];
+    readonly RtcTokenOutput: readonly ["rtcToken"];
+    readonly RtcQryOutput: readonly ["outInfo"];
+    readonly RtcQryUserOutDataInput: readonly ["userId"];
+    readonly RtcUserOutDataOutput: readonly ["user"];
+    readonly RtcQueryListInput: readonly ["order"];
+    readonly RtcRoomInfoOutput: readonly ["roomId", "roomData", "userCount", "list"];
+    readonly RtcValueInfo: readonly ["key", "value"];
+    readonly RtcKeyDeleteInput: readonly ["key"];
+    readonly RtcNotifyMsg: readonly ["type", "time", "roomId"];
+    readonly RtcPullKV: readonly ["timestamp", "roomId"];
+    readonly RtcKVOutput: readonly ["entries", "bFullUpdate", "syncTime"];
+    readonly RtcQueryUserJoinedInput: readonly ["userId"];
+    readonly RtcQueryUserJoinedOutput: readonly ["info"];
+    readonly RtcInviteInput: readonly ["invitedUserId", "timeoutTime", "invitedRoomId", "inviteInfo", "inviteSessionId"];
+    readonly RtcCancelInviteInput: readonly ["invitedUserId", "invitedRoomId", "inviteInfo", "inviteSessionId"];
+    readonly RtcInviteAnswerInput: readonly ["inviteUserId", "answerCode", "inviteRoomId", "inviteSessionId", "content", "key", "value"];
+    readonly RtcEndInviteInput: readonly ["inviteRoomId", "inviteSessionId", "inviteContent", "inviteRoomKeys"];
+    readonly RtcRoomStatusInput: readonly ["version"];
+    readonly RtcRoomStatusOutput: readonly ["bFullStatus", "version", "usersData", "roomStatus"];
+    readonly RtcReportSDKInput: readonly ["sdkInfo"];
+    readonly RCRTCPBPolaris: readonly ["type", "appKey", "sessionId", "roomId", "roomCreateTime", "userId", "userRole", "joinTime", "signalDataCenter", "r1Info", "r2Info", "r3Info", "r4Info"];
+    readonly RCRTCPBR1Info: readonly ["joinTime", "rtcVersion", "imVersion", "platform", "device", "os", "browserName", "browserVersion"];
+    readonly RCRTCPBR2Info: readonly ["joinTime", "sendTime", "rtcActionType", "rtcActionStatus", "trackId"];
+    readonly RCRTCPBR3Info: readonly ["info"];
+    readonly RCRTCPBR4Info: readonly ["info"];
+    readonly RCRTCPBStatusInfo: readonly ["joinTime", "receiveTime", "totalBitRate", "appCPUUsage", "systemCPUUsage", "systemCPUFrequency", "networkStatus", "googleRTTNetwork", "ipAddress", "useReceiveBroadBand", "useSendBroadBand", "packetLossCount", "streams"];
+    readonly RCRTCPBStreamInfo: readonly ["trackId", "codeName", "volume", "samplingRate", "bitRate", "packetLossRate", "frameRate", "resolution", "blockTime", "jitterData", "nAckCount", "pliCount", "googleRTTTotalTime", "isReceiveFirstFrameRate", "codeType", "isEnabled"];
+    readonly AsrTextMsg: readonly ["bms", "t", "isEnd", "msgId", "lang"];
+    readonly AsrResTextMsg: readonly ["type", "uid", "asr"];
+};
+declare type RTCKeyMaps = typeof keymaps;
+
 /**
  * 自定义上报北极星数据响应 code
 */
@@ -1273,11 +1340,11 @@ declare enum RCSendCode {
 
 declare class RTCContext {
     private context;
+    logger: BasicLogger;
+    private codec;
     roomCreateTime: number | undefined;
     userJoinTime: number | undefined;
-    private codec;
-    constructor(context: IRTCPluginContext);
-    get logger(): _base_imlib_wrapper.BasicLogger;
+    constructor(context: RTCPluginContext, logger: BasicLogger, codec: Codec<RTCKeyMaps>);
     joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData, supportNtf?: boolean): IPromiseResult<IJoinRTCRoomData>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
     getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
@@ -1303,9 +1370,7 @@ declare class RTCContext {
         content: string;
     }[], 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<{
-        [key: string]: string;
-    }>;
+    getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
     removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
         name: string;
         content: string;
@@ -1347,7 +1412,7 @@ declare class RTCContext {
     };
     getCurrentId(): string;
     getNaviInfo(): IRTCNaviInfo | null;
-    getConnectionStatus(): number;
+    getConnectionStatus(): RCConnectionStatus;
     getAppkey(): string;
     /** web 端发 rtcPing */
     webRtcPing(roomId: string, roomMode: RTCMode, broadcastType?: number): Promise<{
@@ -1360,10 +1425,12 @@ declare class RTCContext {
      * 协议栈 rtcping 依赖 imlib 编解码数据
      * web 单独走 imlib 提供的 rtcSignaling 方法，减少对 imlib 的依赖
      */
-    rtcPing(roomId: string, roomMode: RTCMode, broadcastType?: number): Promise<{
-        code: number;
-        data?: _base_imlib_wrapper.IRtcPingData | undefined;
-    }> | undefined;
+    rtcPing(roomId: string, roomMode: RTCMode, broadcastType?: number): Promise<_rongcloud_engine.RCResult<any>> | Promise<{
+        code: ErrorCode;
+        data?: {
+            version: number;
+        } | undefined;
+    }>;
     sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions): IPromiseResult<IReceivedMessage>;
     registerRTCSignalListener(listener?: ((buffer: Uint8Array) => void) | undefined): void;
     registerConnectionStateChangeListener(listener: (status: RCConnectionStatus, code: ErrorCode) => void): void;
@@ -1371,20 +1438,20 @@ declare class RTCContext {
     registerDestroyListener(listener: () => void): void;
     registerMessageListener(listener: (message: IReceivedMessage) => boolean): void;
     getCoreVersion(): string;
-    getPluginContext(): IRTCPluginContext;
+    getPluginContext(): RTCPluginContext;
     reportSDKInfo(versionInfo: {
         [name: string]: string;
     }): void;
     decodeAsrText(buffer: Uint8Array, seiData: number[]): (RCRTCASRContent | RCRTCRealtimeTranslationContent)[];
 }
 
-type ISdpSemantics = 'plan-b' | 'unified-plan';
+declare type ISdpSemantics = 'plan-b' | 'unified-plan';
 interface IOfferInfo {
     type: 'offer';
     sdp: string;
     semantics: ISdpSemantics;
 }
-type OutboundVideoInfo = {
+declare type OutboundVideoInfo = {
     trackId: string;
     simulcast: RCStreamType;
     resolution: string;
@@ -1465,7 +1532,7 @@ declare enum PullRoomStatusEvent {
     RESOURCECHANGE = 3
 }
 
-type RCEncryptFunction = (data: Uint8Array) => Uint8Array;
+declare type RCEncryptFunction = (data: Uint8Array) => Uint8Array;
 interface IRCEncryptorHooks {
     /**
      * @since 5.7.3
@@ -2295,7 +2362,7 @@ interface IAudioLevelChangeHandler {
 /**
  * 房间资源数据
  */
-type RoomData = {
+declare type RoomData = {
     [userId: string]: IPublishedResource[];
 };
 /**
@@ -2953,7 +3020,7 @@ declare class ReportMediaActionLogger {
     /**
      * 加房间
      */
-    reportQualityJoinRoomData: (start: number, code: number, roomType: RTCMode$1, sessionId?: string) => void;
+    reportQualityJoinRoomData: (start: number, code: ErrorCode, roomType: RTCMode$1, sessionId?: string | undefined) => void;
     /**
      * 异常掉线
      */
@@ -3079,7 +3146,7 @@ declare enum RCLivingType {
     AUDIO = 1
 }
 
-type IOnRecvPKMsg = (msg: IReceivedMessage) => void;
+declare type IOnRecvPKMsg = (msg: IReceivedMessage) => void;
 interface IRoomPKEventListener {
     /**
      * 收到连麦邀请
@@ -3235,7 +3302,7 @@ declare class RCLivingPKHandler {
     };
 }
 
-type ResourceMsgContent = {
+declare type ResourceMsgContent = {
     /**
      * 旧版本兼容参数，当收到非 `RTCMessageName.TOTAL_CONTENT_RESOURCE` 时：
      * * ignore 值为 `true` 表示该消息由 signal server 向旧版本 RTCLib 提供的兼容消息，无需处理
@@ -3422,9 +3489,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
      */
     getRoomAttributes(keys?: string[], isInner?: boolean): Promise<{
         code: RCRTCCode;
-        data?: {
-            [key: string]: string;
-        };
+        data?: KVString;
     }>;
     /**
      * 设置当前用户属性（暂不开放）
@@ -4321,7 +4386,7 @@ declare enum CommandPriority {
     NORMAL = 1,
     HIGH = 2
 }
-type ICommandResult<R = void> = {
+declare type ICommandResult<R = void> = {
     code: number;
     data?: R;
 };
@@ -4833,7 +4898,7 @@ declare class RCLivingRoom extends RCAbstractRoom {
     /**
      * @private
      */
-    __innerInitByIdentityChange(traceId: string): Promise<number>;
+    __innerInitByIdentityChange(traceId: string): Promise<ErrorCode>;
     /**
      * 增量发布资源，若发布的资源 tag 及媒体类型重复，后者将覆盖前者进行发布。
      * @param tracks 待发布的 RCLocalTrack 实例
@@ -5167,9 +5232,7 @@ declare class RCRTCClient extends RCMediaStreamCapture {
     private readonly _runtime;
     private _options;
     private readonly _service;
-    static _instance: RCRTCClient | null;
     constructor(_context: RTCContext, _runtime: IRuntime, _options: IRCRTCInitOptions);
-    static init(options: IRCRTCInitOptions | undefined, pluginContext: IRTCPluginContext, runtime: IRuntime): RCRTCClient;
     private _handleMessage;
     /**
      * voip 变更、jwt 变更需要触发重走嗅探逻辑
@@ -5179,10 +5242,6 @@ declare class RCRTCClient extends RCMediaStreamCapture {
      * 获取加入的连麦房间
      */
     private _getJoinedPKRoomList;
-    /**
-     * 获取 RTC 插件上下文（含 logger 等），供 CallPlus 等依赖使用
-     */
-    getPluginContext(): IRTCPluginContext;
     /**
      * 获取当前用户 Id，若 IM 未连接，这返回 `''`
      * @returns
@@ -5364,7 +5423,7 @@ declare const device: {
  * RTC 插件生成器
  * @public
  */
-declare const installer: IPluginGenerator<RCRTCClient, void>;
+declare const installer: IPluginGenerator<RCRTCClient, IRCRTCInitOptions>;
 /**
  * 预定义的资源 tag
  */