@rongcloud/plugin-rtc 5.5.4-alpha.2 → 5.5.4

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 /*
- * RCRTC - v5.5.4-alpha.2
- * CommitId - 6a4ddd72afc98e179707633218f3c02265a15869
- * Sat Oct 08 2022 23:09:53 GMT+0800 (China Standard Time)
+ * RCRTC - v5.5.4
+ * CommitId - 80b0c1d49cb6cbe32c4b66a016063568d6893014
+ * Sun Oct 09 2022 17:26:05 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
-import { EventEmitter, INaviInfo, RTCPluginContext, AbsCodec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, ConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, LogLevel, IPluginGenerator } from '@rongcloud/engine';
+import * as _rongcloud_engine from '@rongcloud/engine';
+import { EventEmitter, RTCPluginContext, AbsCodec, IPromiseResult, ErrorCode, KVString, IAsyncRes, ConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, IRuntime, LogLevel, IPluginGenerator } from '@rongcloud/engine';
 
 /**
  * 错误码，与移动端对齐
@@ -19,8 +20,6 @@ import { EventEmitter, INaviInfo, RTCPluginContext, AbsCodec, IPromiseResult, Er
 declare enum RCRTCCode {
     /** 成功 */
     SUCCESS = 10000,
-    /** PB 错误 */
-    PB_ERROR = 40001,
     /** IM 服务未连接 */
     SIGNAL_DISCONNECTED = 50000,
     /** 参数错误 */
@@ -647,19 +646,7 @@ declare enum RTCMode {
     /**
     * 跨应用直播
     */
-    CROSS_LIVE = 8,
-    /**
-     * sip呼叫
-     */
-    SIP = 4,
-    /**
-     * 呼叫模式.包括单呼和群呼
-     */
-    CALL = 5,
-    /**
-     * 会议
-     */
-    MEETING = 6
+    CROSS_LIVE = 8
 }
 
 /**
@@ -1279,14 +1266,6 @@ declare const keymaps: {
     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 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", "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"];
 };
 declare type RTCKeyMaps = typeof keymaps;
 
@@ -1352,9 +1331,6 @@ interface IJoinRTCRoomData extends IRTCUsers {
     }[];
     kvEntries: IServerRTCRoomEntry[];
     offlineKickTime: number;
-    codeFormat?: string;
-    roomCreateTime?: number;
-    userJoinTime?: number;
 }
 interface IReqRoomPKOptions {
     /**
@@ -1460,40 +1436,10 @@ interface IEndRoomPKOptions {
      */
     keys: string[];
 }
-interface IRTCNaviInfo extends INaviInfo {
-    /**
-     * jwt token
-    */
-    jwt?: string;
-    /**
-     * http3 上报域名
-    */
-    logServer?: string;
-    /**
-     * 数据中心
-    */
-    dc?: string;
-    /**
-     *  openGzip  开启标识,默认是false,开启使用true
-    */
-    openGzip?: boolean;
-}
-
-/**
- * 自定义上报北极星数据响应 code
-*/
-declare enum RCSendCode {
-    NOT_REPORT = -1,
-    REPORT_SUCCESS = 10000,
-    REPORT_FAIL = 0,
-    PB_ERROR = 40001
-}
 
 declare class RTCContext {
     private context;
     private codec;
-    roomCreateTime: number | undefined;
-    userJoinTime: number | undefined;
     constructor(context: RTCPluginContext, codec: AbsCodec<RTCKeyMaps>);
     joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): IPromiseResult<IJoinRTCRoomData>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
@@ -1526,10 +1472,6 @@ declare class RTCContext {
     getRTCOutData(roomId: string, userIds: string[]): IPromiseResult<unknown>;
     getRTCToken(roomId: string, mode: number, broadcastType?: number): IPromiseResult<IRtcTokenData>;
     setRTCState(roomId: string, report: string): Promise<ErrorCode>;
-    /**
-     * 通过 http 方式上报 rtc state
-    */
-    setRTCStateByHttp(logServer: string, runtime: IRuntime, report: IRCRTCReportData, reportType: string): Promise<RCSendCode | RCRTCCode>;
     getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
     joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
         token: string;
@@ -1544,12 +1486,12 @@ declare class RTCContext {
     getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
     pullRTCRoomEntry(roomId: string): Promise<IAsyncRes<IChrmKVPullData>>;
     decodeRtcNotify(buffer: Uint8Array): {
-        time: number;
+        time: any;
         type: any;
         roomId: any;
     };
     getCurrentId(): string;
-    getNaviInfo(): IRTCNaviInfo | null;
+    getNaviInfo(): _rongcloud_engine.INaviInfo | null;
     getConnectionStatus(): ConnectionStatus;
     getAppkey(): string;
     rtcPing(roomId: string, roomMode: number, broadcastType?: number): Promise<ErrorCode>;
@@ -1561,9 +1503,6 @@ declare class RTCContext {
     registerMessageListener(listener: (message: IReceivedMessage) => boolean): void;
     getCoreVersion(): string;
     getPluginContext(): RTCPluginContext;
-    reportSDKInfo(versionInfo: {
-        [name: string]: string;
-    }): void;
 }
 
 declare class RCMediaService {
@@ -1607,7 +1546,7 @@ declare class RCMediaService {
     private static msInDetector;
     private static detectorTime;
     private static detectValidMinute;
-    static jwtToken: string;
+    private static naviRefetchCount;
     private _msList;
     constructor(_runtime: IRuntime, _context: RTCContext, 
     /**
@@ -1618,7 +1557,7 @@ declare class RCMediaService {
      * 请求超时时长
      */
     _timeout?: number);
-    detectorMediaSever(newNaviInfo?: INaviInfo | null): void;
+    detectorMediaSever(): void;
     /**
      *  地址探测
      *  RTC 初始化时检测是否可以拿到 navi，可以拿到开始嗅探
@@ -1753,7 +1692,7 @@ declare class RCRTCPeerCManager {
     /**
      * 北极星上报模块
      */
-    _polarisReport?: PolarisHttpReporter | undefined);
+    _polarisReport?: PolarisReporter | undefined);
     get useMutilPeerC(): boolean;
     /**
      * 根据 track 判断是否为上行
@@ -1873,7 +1812,7 @@ declare abstract class ReadableStore {
     readonly roomId: string;
     readonly crtUserId: string;
     readonly roomMode: RTCMode;
-    readonly polarisReport: PolarisHttpReporter;
+    readonly polarisReport: PolarisReporter;
     readonly isUpgrade?: boolean | undefined;
     readonly isMainRoom?: boolean | undefined;
     /**
@@ -1905,7 +1844,7 @@ declare abstract class ReadableStore {
     protected _CDNUris: ICDNUris | null;
     protected _CDNEnable: boolean;
     protected _destroyed: boolean;
-    constructor(context: RTCContext, service: RCMediaService, peerMgr: RCRTCPeerCManager, roomId: string, crtUserId: string, roomMode: RTCMode, polarisReport: PolarisHttpReporter, isUpgrade?: boolean | undefined, isMainRoom?: boolean | undefined);
+    constructor(context: RTCContext, service: RCMediaService, peerMgr: RCRTCPeerCManager, roomId: string, crtUserId: string, roomMode: RTCMode, polarisReport: PolarisReporter, isUpgrade?: boolean | undefined, isMainRoom?: boolean | undefined);
     get useMutilPeerC(): boolean;
     getResourcesByUserId(userId: string): IPublishedResource[] | undefined;
     getRemoteTrack(trackId: string): RCRemoteTrack | undefined;
@@ -2005,7 +1944,7 @@ declare class BaseInvoker<STORE> {
  * 房间任务队列管理
  */
 declare class Invoker extends BaseInvoker<Store> {
-    constructor(context: RTCContext, service: RCMediaService, peerMrg: RCRTCPeerCManager, roomId: string, crtUserId: string, mode: RTCMode, reporter: PolarisHttpReporter, isUpgrade?: boolean, isMainRoom?: boolean);
+    constructor(context: RTCContext, service: RCMediaService, peerMrg: RCRTCPeerCManager, roomId: string, crtUserId: string, mode: RTCMode, reporter: PolarisReporter, isUpgrade?: boolean, isMainRoom?: boolean);
     /**
      * 获取 store 存储实例，返回值类型 `ReadableStore`，避免非 command 定义中修改内存
      */
@@ -2210,7 +2149,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     /**
      * 北极星上报实例
      */
-    protected _polarisReport: PolarisHttpReporter | null;
+    protected _polarisReport: PolarisReporter | null;
     /**
      * 音量上报实例
      */
@@ -2634,7 +2573,7 @@ declare class RCAudienceLivingRoom {
     /**
      * 北极星上报实例
      */
-    protected _polarisReport: PolarisHttpReporter | null;
+    protected _polarisReport: PolarisReporter | null;
     /**
      * 音量上报实例
      */
@@ -2882,7 +2821,7 @@ declare class PolarisReporter {
      * @param resourceId userId_11_1_tiny 改为 userId_11_tiny_video
      */
     private _getPolarisTrackId;
-    sendR3R4Data(data: IInnerRCRTCStateReport): Promise<RCSendCode>;
+    sendR3R4Data(data: IInnerRCRTCStateReport): Promise<boolean>;
     /**
      * 加入房间
      */
@@ -2894,42 +2833,6 @@ declare class PolarisReporter {
     sendR2(action: string, status: string, trackIds: string[]): void;
 }
 
-declare class PolarisHttpReporter {
-    private readonly _context;
-    private readonly _runtime;
-    private readonly _roomId;
-    private readonly _crtRTCRoom;
-    private readonly _userRole;
-    protected _polarisSignalReporter: PolarisReporter | null;
-    private _useHttp;
-    constructor(_context: RTCContext, _runtime: IRuntime, _roomId: string, _crtRTCRoom: RCAbstractRoom | RCAudienceLivingRoom, _userRole?: PolarisRole);
-    private _send;
-    /**
-     * 小流需去掉 _tiny，小流 resourceId 为 userId_tag_mediaType_tiny
-     */
-    private _getRealResourceId;
-    /**
-     * 生成北极星上报的 trackId
-     * @param resourceId userId_11_1_tiny 改为 userId_11_tiny_video
-     */
-    private _getPolarisTrackId;
-    private _formatReportBaseData;
-    private _formatReportData;
-    private _formatR1Data;
-    private _formatR2Data;
-    private _formatR3R4Data;
-    sendR3R4Data(data: IInnerRCRTCStateReport): Promise<RCSendCode>;
-    /**
-     * 加入房间
-     */
-    sendR1(): Promise<void>;
-    /**
-     * RTC 和 LIVE 发布、取消发布
-     * RTC 订阅、取消订阅
-     */
-    sendR2(action: string, status: string, trackIds: string[]): Promise<void>;
-}
-
 /**
  * PC 实例管理类
  */
@@ -2959,8 +2862,6 @@ declare class RCRTCPeerConnection extends EventEmitter {
     private _reportStatsTimer;
     private _reportR3R4ToPolarisTimer;
     private _isDestroyed;
-    private _reportStatsData?;
-    private _originReportStatsData?;
     constructor(
     /**
      * peerConnection 对应名称
@@ -2977,12 +2878,10 @@ declare class RCRTCPeerConnection extends EventEmitter {
     /**
      * 北极星上传实例
      */
-    _polarisReport?: PolarisHttpReporter | undefined);
+    _polarisReport?: PolarisReporter | undefined);
     getName(): string;
     getLocalTracks(): RCLocalTrack[];
     private _onConnectionStateChange;
-    private startAutoExecute;
-    private stopAutoExecute;
     private _onICEConnectionStateChange;
     private _onTrackReady;
     /**
@@ -3017,7 +2916,7 @@ declare class RCRTCPeerConnection extends EventEmitter {
      * @returns 返回格式化后的数据
      */
     private _getStatsData;
-    getAudioLevelReportData(gap?: number): Promise<{
+    getAudioLevelReportData(): Promise<{
         trackId: string;
         audioLevel: number | null;
     }[] | undefined>;
@@ -3026,10 +2925,6 @@ declare class RCRTCPeerConnection extends EventEmitter {
      * @todo
      */
     private _reportHandle;
-    /**
-     * 获取缓存的本地质量数据
-     */
-    _getCacheStatsData(): IInnerRCRTCStateReport | null | undefined;
     /**
      * 北极星上报 R3、R4 数据
      */
@@ -3079,8 +2974,10 @@ interface IResource {
     uri: string;
     /**
      * 资源特征，simulcast 代表这道流支持大小流
+     * @description 此参数存疑，MediaServer 似乎并未下发此字段，Web 端暂不启用
+     * @deprecated
      */
-    simulcast: number;
+    features?: ['simulcast'] | [];
 }
 /**
  * 向房间内发布的媒体数据
@@ -3341,216 +3238,6 @@ interface IRCRTCStateReport {
      */
     receivers: IRCTrackStat[];
 }
-/**
- * http3 北极星上报基础数据
-*/
-interface IRCRTCReportBaseData {
-    /**
-     * 上报数据类型 R1-R4
-    */
-    type: string;
-    appKey: string;
-    /**
-     * 房间通话id
-    */
-    sessionId: string;
-    roomId: string;
-    /**
-     * 房间创建时间
-    */
-    roomCreateTime: number;
-    userId: string;
-    userRole: number;
-    joinTime: number;
-    /**
-     * signal 数据中心
-     * */
-    signalDataCenter: string;
-}
-/**
- * http3 北极星上报 R1 数据
-*/
-interface IR1Info {
-    /**
-     * 用户加入房间的时间
-    */
-    joinTime: number;
-    /**
-     * RTC 版本号
-    */
-    rtcVersion: string;
-    /**
-     * IM SDK 版本
-    */
-    imVersion: string;
-    /**
-     * 平台(如：Android、iOS、Web)
-    */
-    platform: string;
-    /**
-     * 设备信息(手机名称+型号)
-    */
-    device: string;
-    /**
-     * 系统版本(手机系统版本)
-    */
-    os: string;
-    /**
-     * 浏览器名称, 没有用 -1 表示
-    */
-    browserName?: string;
-    /**
-     * 浏览器版本, 没有用 -1 表示
-    */
-    browserVersion?: string;
-}
-/**
- * http3 北极星上报 R2 数据
-*/
-interface IR2Info {
-    /**
-     * 用户加入房间的时间
-    */
-    joinTime: number;
-    /**
-     * 客户端 发布/取消发布 订阅/取消订阅 资源的时间
-    */
-    sendTime: number;
-    /**
-     * 发布类型  subscribe : 订阅   publish : 发布
-    */
-    rtcActionType: string;
-    /**
-     * 发布状态  begin : 开始   tend : 结束
-    */
-    rtcActionStatus: string;
-    trackId: string[];
-}
-/**
- * http3 北极星上报 R3 数据
-*/
-interface IR3R4Info {
-    info: IR3R4CommonInfo;
-}
-interface IR3R4CommonInfo {
-    /**
-     * 用户加入房间的时间
-    */
-    joinTime?: number;
-    /**
-     * 总码率
-    */
-    totalBitRate?: number;
-    /**
-     * APP CPU占用率
-    */
-    appCPUUsage?: number;
-    /**
-     * 系统 CPU占用率
-    */
-    systemCPUUsage?: number;
-    /**
-     * 系统CPU频率 (安卓8.0以上)
-    */
-    systemCPUFrequency?: number;
-    /**
-     * 实时网络状态(2g、3g、4g、wifi)
-    */
-    networkStatus?: string;
-    /**
-     * Goog rtt 网络延迟
-    */
-    googleRTTNetwork?: number;
-    /**
-     * ip地址
-    */
-    ipAddress?: string;
-    /**
-     * 可接收带宽(单位: bit)
-    */
-    useReceiveBroadBand?: string;
-    /**
-     * 可用发送带宽(单位: bit)
-    */
-    useSendBroadBand?: string;
-    /**
-     * 丢包数
-    */
-    packetLossCount?: string;
-    streams?: IR3R4StreamInfo[];
-}
-/**
- * http3 北极星上报 R3、R4 streamInfo 数据
-*/
-interface IR3R4StreamInfo {
-    trackId: string;
-    /**
-     * 编解码名称
-    */
-    codeName?: string;
-    /**
-     * 音频播放音量
-    */
-    volume?: string;
-    /**
-     * 音频采样率
-    */
-    samplingRate: number;
-    /**
-     * 下行码率
-    */
-    bitRate?: number;
-    packetLossRate?: number;
-    /**
-     * 视频接收帧率(单位:fps)
-    */
-    frameRate?: number;
-    /**
-     * 视频分辨率(格式:640*480)
-    */
-    resolution?: string;
-    /**
-     * 接收卡顿(间隔时间, 单位: ms)
-    */
-    blockTime?: number;
-    /**
-     * jitter数据抖动
-    */
-    jitterData?: number;
-    /**
-     * nack数量
-    */
-    nAckCount?: string;
-    /**
-     * PLI请求数
-    */
-    pliCount?: string;
-    /**
-     * googRtt往返时长
-    */
-    googleRTTTotalTime?: number;
-    /**
-     * 第一个关键帧是否正常收到
-    */
-    isReceiveFirstFrameRate?: number;
-    /**
-     * 编码方式
-    */
-    codeType?: string;
-    /**
-     * 当前流的状态是否可用
-    */
-    isEnabled?: number;
-}
-/**
- * http3 北极星上报总数据
-*/
-interface IRCRTCReportData extends IRCRTCReportBaseData {
-    r1Info?: IR1Info;
-    r2Info?: IR2Info;
-    r3Info?: IR3R4Info;
-    r4Info?: IR3R4Info;
-}
 interface IRCRTCReportListener {
     /**
      * RTCPeerConnection 的详细状态数据
@@ -4519,7 +4206,6 @@ declare class RCRTCClient extends RCMediaStreamCapture {
         code: RCRTCCode | ErrorCode;
         data?: IRTCJoinedInfo[];
     }>;
-    reportSDKInfo(): void;
 }
 
 /**