@rongcloud/plugin-rtc 5.5.4-alpha.1 → 5.5.4-alpha.3

package/dist/index.d.ts

@@ -1,11 +1,10 @@
 /*
- * RCRTC - v5.5.4-alpha.1
- * CommitId - 5979242633209b9a8830d449c1d7a425a1868f7b
- * Fri Sep 30 2022 20:48:58 GMT+0800 (China Standard Time)
+ * RCRTC - v5.5.4-alpha.3
+ * CommitId - 3f61ac223f73eedac265c308f3a0f311af3985a7
+ * Sun Oct 09 2022 21:12:19 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
-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';
+import { EventEmitter, BasicLogger, INaviInfo, RTCPluginContext, AbsCodec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, ConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, EnableLogL, IPluginGenerator } from '@rongcloud/engine';
 
 /**
  * 错误码，与移动端对齐
@@ -20,6 +19,8 @@ import { EventEmitter, RTCPluginContext, AbsCodec, IPromiseResult, ErrorCode, KV
 declare enum RCRTCCode {
     /** 成功 */
     SUCCESS = 10000,
+    /** PB 错误 */
+    PB_ERROR = 40001,
     /** IM 服务未连接 */
     SIGNAL_DISCONNECTED = 50000,
     /** 参数错误 */
@@ -172,6 +173,7 @@ declare abstract class RCTrack extends EventEmitter {
     protected readonly _streamId: string;
     protected _msTrack?: MediaStreamTrack;
     private _msStream;
+    protected _logger: BasicLogger | null;
     constructor(_tag: string, _userId: string, _kind: 'audio' | 'video', _isLocalTrack: boolean, _roomId?: string | undefined);
     /**
      * 获取音视轨所属的 streamId，streamId 相同的音轨和视轨可认为属于统一道流
@@ -1279,6 +1281,13 @@ declare const keymaps: {
     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;
 
@@ -1344,6 +1353,9 @@ interface IJoinRTCRoomData extends IRTCUsers {
     }[];
     kvEntries: IServerRTCRoomEntry[];
     offlineKickTime: number;
+    codeFormat?: string;
+    roomCreateTime?: number;
+    userJoinTime?: number;
 }
 interface IReqRoomPKOptions {
     /**
@@ -1449,11 +1461,42 @@ 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>);
+    logger: BasicLogger | null;
     joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): IPromiseResult<IJoinRTCRoomData>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
     getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
@@ -1485,6 +1528,10 @@ 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;
@@ -1504,7 +1551,7 @@ declare class RTCContext {
         roomId: any;
     };
     getCurrentId(): string;
-    getNaviInfo(): _rongcloud_engine.INaviInfo | null;
+    getNaviInfo(): IRTCNaviInfo | null;
     getConnectionStatus(): ConnectionStatus;
     getAppkey(): string;
     rtcPing(roomId: string, roomMode: number, broadcastType?: number): Promise<ErrorCode>;
@@ -1562,7 +1609,7 @@ declare class RCMediaService {
     private static msInDetector;
     private static detectorTime;
     private static detectValidMinute;
-    private static naviRefetchCount;
+    static jwtToken: string;
     private _msList;
     constructor(_runtime: IRuntime, _context: RTCContext, 
     /**
@@ -1708,7 +1755,7 @@ declare class RCRTCPeerCManager {
     /**
      * 北极星上报模块
      */
-    _polarisReport?: PolarisReporter | undefined);
+    _polarisReport?: PolarisHttpReporter | undefined);
     get useMutilPeerC(): boolean;
     /**
      * 根据 track 判断是否为上行
@@ -1828,7 +1875,7 @@ declare abstract class ReadableStore {
     readonly roomId: string;
     readonly crtUserId: string;
     readonly roomMode: RTCMode;
-    readonly polarisReport: PolarisReporter;
+    readonly polarisReport: PolarisHttpReporter;
     readonly isUpgrade?: boolean | undefined;
     readonly isMainRoom?: boolean | undefined;
     /**
@@ -1860,7 +1907,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: PolarisReporter, isUpgrade?: boolean | undefined, isMainRoom?: boolean | undefined);
+    constructor(context: RTCContext, service: RCMediaService, peerMgr: RCRTCPeerCManager, roomId: string, crtUserId: string, roomMode: RTCMode, polarisReport: PolarisHttpReporter, isUpgrade?: boolean | undefined, isMainRoom?: boolean | undefined);
     get useMutilPeerC(): boolean;
     getResourcesByUserId(userId: string): IPublishedResource[] | undefined;
     getRemoteTrack(trackId: string): RCRemoteTrack | undefined;
@@ -1960,7 +2007,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: PolarisReporter, isUpgrade?: boolean, isMainRoom?: boolean);
+    constructor(context: RTCContext, service: RCMediaService, peerMrg: RCRTCPeerCManager, roomId: string, crtUserId: string, mode: RTCMode, reporter: PolarisHttpReporter, isUpgrade?: boolean, isMainRoom?: boolean);
     /**
      * 获取 store 存储实例，返回值类型 `ReadableStore`，避免非 command 定义中修改内存
      */
@@ -2165,7 +2212,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     /**
      * 北极星上报实例
      */
-    protected _polarisReport: PolarisReporter | null;
+    protected _polarisReport: PolarisHttpReporter | null;
     /**
      * 音量上报实例
      */
@@ -2589,7 +2636,7 @@ declare class RCAudienceLivingRoom {
     /**
      * 北极星上报实例
      */
-    protected _polarisReport: PolarisReporter | null;
+    protected _polarisReport: PolarisHttpReporter | null;
     /**
      * 音量上报实例
      */
@@ -2837,7 +2884,7 @@ declare class PolarisReporter {
      * @param resourceId userId_11_1_tiny 改为 userId_11_tiny_video
      */
     private _getPolarisTrackId;
-    sendR3R4Data(data: IInnerRCRTCStateReport): Promise<boolean>;
+    sendR3R4Data(data: IInnerRCRTCStateReport): Promise<RCSendCode>;
     /**
      * 加入房间
      */
@@ -2849,6 +2896,43 @@ 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;
+    private _refetchNaviInfo;
+    /**
+     * 小流需去掉 _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 实例管理类
  */
@@ -2880,6 +2964,7 @@ declare class RCRTCPeerConnection extends EventEmitter {
     private _isDestroyed;
     private _reportStatsData?;
     private _originReportStatsData?;
+    private _logger;
     constructor(
     /**
      * peerConnection 对应名称
@@ -2896,7 +2981,7 @@ declare class RCRTCPeerConnection extends EventEmitter {
     /**
      * 北极星上传实例
      */
-    _polarisReport?: PolarisReporter | undefined);
+    _polarisReport?: PolarisHttpReporter | undefined);
     getName(): string;
     getLocalTracks(): RCLocalTrack[];
     private _onConnectionStateChange;
@@ -3260,6 +3345,216 @@ 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 的详细状态数据
@@ -3379,16 +3674,16 @@ interface IRCRTCInitOptions {
     /**
      * 输出日志等级，生产环境默认使用 WARN，开发环境默认为 DEBUG
      * @description
-     * * 0 - DEBUG
-     * * 1 - INFO
+     * * 4 - DEBUG
+     * * 3 - INFO
      * * 2 - WARN
-     * * 3 - ERROR
+     * * 1 - ERROR
      */
-    logLevel?: LogLevel;
+    logLevel?: EnableLogL;
     /**
      * 修改默认的 log 输出函数
      */
-    logStdout?: (logLevel: LogLevel, content: string) => void;
+    logStdout?: (logLevel: EnableLogL, content: string) => void;
     /**
      * 与 MediaServer 的 http 请求超时时间，单位为毫秒，默认值为 `5000`，有效值 `5000-30000`。
      * 优先级：用户配置 > 导航配置 > 默认时间。