@rongcloud/plugin-rtc 5.2.4-beem.4 → 5.2.4-beem.7

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 /*
- * RCRTC - v5.2.4-beem.4
- * CommitId - a3cdebb13c1c9a8f31555277f185522a69f7e42f
- * Fri May 20 2022 19:05:14 GMT+0800 (China Standard Time)
+ * RCRTC - v5.2.4-beem.7
+ * CommitId - 7525a60bf7217da8a14cafdd6e90765248f86136
+ * Sat May 28 2022 13:58:08 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
-import { EventEmitter, LogLevel, RTCMode, IRuntime, RTCPluginContext, IServerRTCRoomEntry, IJoinRTCRoomData, IReceivedMessage, KVString, RTCJoinType, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
+import { EventEmitter, LogLevel, RTCPluginContext, IRuntime, IServerRTCRoomEntry, RTCMode, IJoinRTCRoomData, IReceivedMessage, KVString, RTCJoinType, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
 export { RTCJoinType } from '@rongcloud/engine';
 
 /**
@@ -105,20 +105,6 @@ declare enum RCMediaType {
     AUDIO_VIDEO = 2
 }
 
-/**
- * 资源大小流标识枚举
- */
-declare enum RCStreamType {
-    /**
-     * 普通流（大流）
-     */
-    NORMAL = 1,
-    /**
-     * 小流
-     */
-    TINY = 2
-}
-
 declare enum RCFrameRate {
     FPS_10 = "FPS_10",
     FPS_15 = "FPS_15",
@@ -142,20 +128,6 @@ declare enum RCResolution {
     W1920_H1080 = "W1920_H1080"
 }
 
-/**
- * 流状态
- */
-declare enum TrackState {
-    /**
-     * 不可用
-     */
-    DISABLE = 0,
-    /**
-     * 可用
-     */
-    ENABLE = 1
-}
-
 declare abstract class RCTrack extends EventEmitter {
     private readonly _tag;
     private readonly _userId;
@@ -361,40 +333,7 @@ declare class RCRemoteVideoTrack extends RCRemoteTrack {
     constructor(tag: string, userId: string, roomId?: string);
 }
 
-interface IStatParser {
-    /**
-     * 取消发布后，需把 _latestPacketsSent 中 key 为 resourceId 存储的数据清除掉
-     */
-    clearLatestpacketsSent(resourceIds: string[]): void;
-    /**
-     * 取消订阅后，需把 _latestPacketsRecv 中 key 为 resourceId 存储的数据清除掉
-     */
-    clearLatestPacketsRecv(resourceIds: string[]): void;
-    parseRTCStatsReport(reports: RTCStatsReport): {
-        [key: string]: any;
-    };
-    formatRCRTCStateReport(stats: {
-        [key: string]: any;
-    }): IInnerRCRTCStateReport;
-    getAudioLevelList(stats: {
-        [key: string]: any;
-    }): {
-        trackId: string;
-        audioLevel: number | null;
-    }[];
-}
-
 declare type ISdpSemantics = 'plan-b' | 'unified-plan';
-interface IOfferInfo {
-    type: 'offer';
-    sdp: string;
-    semantics: ISdpSemantics;
-}
-declare type OutboundVideoInfo = {
-    trackId: string;
-    simulcast: RCStreamType;
-    resolution: string;
-};
 
 declare enum RCInnerCDNPullKind {
     RTMP = "rtmp",
@@ -635,83 +574,6 @@ interface IRCCandidatePairStat {
      */
     availableIncomingBitrate: number | null;
 }
-/**
- * iceCandidatePair 所有字段
- * 含 peerConnection 抛出给用户的 iceCandidatePair 字段
- * 含 北极星上报 R3、R4 所需的 totalPacketsLost
- */
-interface IInnerIcePair extends IRCCandidatePairStat {
-    /**
-     * 上、下行总丢包率
-     */
-    totalPacketsLost?: number;
-}
-/**
- * send track 所有字段
- * 含 peerConnection 抛出给用户的 track 字段
- * 含 北极星上报 R3 track 所需字段
- */
-interface ISendTrackState extends IRCTrackStat {
-    /**
-     * （Round-Trip-Time）往返时延，单位 ms
-     */
-    rtt: number | null;
-    /**
-     * 编码方式
-     */
-    encoderImplementation: string | null;
-    /**
-     * PLI 请求数
-     */
-    pliCount: number;
-    /**
-     * nack 数量
-     */
-    nackCount: number;
-    /**
-     * 第一个关键帧是否正常收到
-     */
-    googFirsSent: number;
-    /**
-     * 音频采样率
-     */
-    samplingRate: number;
-    /**
-     * 接收卡顿(间隔时间, 单位: ms)
-     */
-    googRenderDelayMs: number;
-    /**
-     * 流状态(0:不可用, 1:可用)
-     */
-    trackState: TrackState;
-}
-/**
- * receive track 所有字段
- * 含 peerConnection 抛出给用户的 track 字段
- * 含 北极星上报 R4 track 所需字段
- */
-interface IRecvTrackState extends IRCTrackStat {
-    /**
-     * 解码方式
-     */
-    codecImplementationName: string | null;
-    samplingRate: number;
-    nackCount: number;
-    pliCount: number;
-    rtt: number | null;
-    googFirsReceived: number;
-    googRenderDelayMs: number;
-    trackState: TrackState;
-}
-/**
- * peerConnection stats 解析出来业务所需的所有字段
- */
-interface IInnerRCRTCStateReport {
-    timestamp: number;
-    iceCandidatePair?: IInnerIcePair;
-    senders: ISendTrackState[];
-    receivers: IRecvTrackState[];
-}
 /**
  * /**
  * peerConnection stats 抛给用户的字段
@@ -924,11 +786,6 @@ declare enum RCInnerCDNPushMode {
     MANUAL = 1
 }
 
-declare enum RCInnerCDNBroadcast {
-    SPREAD = 0,
-    NO_SPREAD = -1
-}
-
 /**
  * 与 MediaServer 交互所需的 Request Header 信息
  */
@@ -959,13 +816,6 @@ interface IRTCReqHeader {
      */
     'Session-Id'?: string;
 }
-interface IMCUReqHeaders {
-    'App-Key': string;
-    Token: string;
-    RoomId: string;
-    UserId: string;
-    SessionId: string;
-}
 /**
  * exchange 接口的请求体结构
  */
@@ -1018,34 +868,6 @@ interface IExchangeReqBody {
      */
     switchstream: boolean;
 }
-interface ILiveUrls {
-    /**
-     * MCU 服务地址，直播模式中用于向 MCU 服务提交 CDN 及合流配置
-     */
-    configUrl: string;
-    /**
-     * 观众端订阅地址，由业务层分发
-     */
-    liveUrl: string;
-    /**
-     * 自动推 CDN 模式下，发布资源后返回的 CDN 信息
-     */
-    pull_url?: string;
-}
-interface IRTCResponse {
-    /**
-     * 请求响应码，只有在 resultCode 值为 `10000` 时才为正常响应
-     */
-    resultCode: RCRTCCode;
-    /**
-   * 与 resultCode 相应的可读性文字信息
-   */
-    message: string;
-    /**
-     * 客户端发送的 Request-Id
-     */
-    'Request-Id': string;
-}
 /**
  * /exchange 响应结果
  */
@@ -1140,35 +962,6 @@ interface IBroadcastSubReqBody {
      */
     newVersionFlag?: boolean;
 }
-interface IBroadcastSubRespBody extends IRTCResponse {
-    /**
-     * 已订阅的资源列表
-     */
-    subscribedList: IResource[];
-    /**
-     * 远端 SDP
-     */
-    sdp: {
-        type: 'answer';
-        sdp: string;
-    };
-}
-/**
- * 获取 CDN 资源拉流地址请求 headers
- */
-interface ICDNPlayUrlReqHeaders extends IMCUReqHeaders {
-}
-/**
- * 获取 CDN 资源拉流地址响应
- */
-interface ICDNPlayUrlResponse extends IRTCResponse {
-    data: {
-        fps: number;
-        h: number;
-        'pull_url': string;
-        w: number;
-    };
-}
 /**
  * cdn_uris 里面包含的字段
  */
@@ -1236,11 +1029,6 @@ declare enum MixVideoRenderMode {
     WHOLE = 2
 }
 
-declare enum RCInnerCDNModel {
-    OPEN = 1,
-    STOP = 2
-}
-
 /**
  * 合流后的 video 输出编码配置，包含分辨率、帧率、码率配置项
  */
@@ -1262,17 +1050,6 @@ interface IMCUOutputVideoAttrs {
      */
     bitrate?: number;
 }
-/**
- * 自定义布局中的单一视频流布局
- */
-interface IMCUInputVideoLayout {
-    user_id: string;
-    stream_id: string;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
 /**
  * 图片配置，用于水印、视频流背景图
  */
@@ -1363,100 +1140,6 @@ interface IMCUOutputConfig {
         pushurl: string;
     }[];
 }
-/**
- * 时间戳参数，用于水印
- */
-interface ITimestampAttrs {
-    /**
-     * 时区
-     */
-    timezone: number;
-    /**
-     * 字体像素大小
-     */
-    fontSize: number;
-    /**
-     * 字体颜色
-     */
-    color: 'black' | 'white';
-    /**
-     * 透明度，有效值 `0.0` 至 `1.0`
-     */
-    alpha: number;
-    /**
-     * 相较于整体画布的 x 坐标（百分比），有效值 `0.0` 至 `1.0`
-     */
-    x: number;
-    /**
-     * 相较于整体画布的 y 坐标（百分比），有效值 `0.0` 至 `1.0`
-     */
-    y: number;
-}
-/**
- * 文本参数，用于水印
- */
-interface ITextAttrs {
-    /**
-     * 文字内容
-     */
-    content: string;
-    /**
-     * 文字像素
-     */
-    fontSize: number;
-    /**
-     * 文字颜色
-     */
-    color: 'black' | 'white';
-    /**
-     * 透明度，有效值 `0.0` 至 `1.0`
-     */
-    alpha: number;
-    /**
-     * 相较于整体画布的 x 坐标（百分比），有效值 `0.0` 至 `1.0`
-     */
-    x: number;
-    /**
-     * 相较于整体画布的 y 坐标（百分比），有效值 `0.0` 至 `1.0`
-     */
-    y: number;
-}
-/**
- * 屏幕水印配置
- */
-interface IWaterMarkConfig {
-    /**
-     * 时间戳水印配置
-     */
-    timestamp?: ITimestampAttrs;
-    /**
-     * 图片水印配置
-     */
-    picture?: IPictureAttrs[];
-    /**
-     * 文字水印配置
-     */
-    text: ITextAttrs[];
-}
-/**
- * 合流前的单一视频流水印配置
- */
-interface IMCUSignalScreenWaterMarkConfig extends IWaterMarkConfig {
-    /**
-     * 媒体流的 msid
-     */
-    streamId: string;
-}
-interface IMCUWaterMarkConfig {
-    /**
-     * 合流后的屏幕水印配置
-     */
-    mixScreen: IWaterMarkConfig;
-    /**
-     * 合流前的单人视频流水印配置
-     */
-    signalScreen: IMCUSignalScreenWaterMarkConfig[];
-}
 /**
  * 发布到服务器的 MCU 配置数据
  */
@@ -1488,18 +1171,6 @@ interface IMCUConfig {
      */
     waterMark?: IMCUWaterMarkConfig;
 }
-/**
- * 设置开启、停用内置 CDN 数据
- */
-interface ISetEnableCDN {
-    version: 2;
-    output: {
-        /**
-         * 手动开启/停用内置 CDN
-         */
-        inCDNModel: RCInnerCDNModel;
-    };
-}
 
 declare class RCMediaService {
     private readonly _runtime;
@@ -1909,20 +1580,6 @@ declare class RCAudienceLivingRoom {
     };
 }
 
-/**
- * 北极星上报角色
- */
-declare enum PolarisRole {
-    /**
-     * 会议参会者、主播
-     */
-    MeetingOrAnchor = 1,
-    /**
-     * 观众
-     */
-    Audience = 2
-}
-
 declare class PolarisReporter {
     private readonly _context;
     private readonly _runtime;
@@ -1941,7 +1598,7 @@ declare class PolarisReporter {
      * @param resourceId userId_11_1_tiny 改为 userId_11_tiny_video
      */
     private _getPolarisTrackId;
-    sendR3R4Data(data: IInnerRCRTCStateReport): void;
+    sendR3R4Data(data: IInnerRCRTCStateReport): Promise<boolean>;
     /**
      * 加入房间
      */
@@ -1972,6 +1629,7 @@ declare class RCRTCPeerConnection extends EventEmitter {
     private pubLocalTracks;
     private _reTryExchangeTimer;
     private _reportStatsTimer;
+    private _reportR3R4ToPolarisTimer;
     constructor(
     /**
      * _reTryExchange 方法
@@ -1986,8 +1644,8 @@ declare class RCRTCPeerConnection extends EventEmitter {
     private _onICEConnectionStateChange;
     private _onTrackReady;
     setBitrate(max: number, min: number, start?: number): Promise<void>;
-    createOffer(iceRestart: boolean): Promise<IOfferInfo>;
-    setRemoteAnswer(answer: string): Promise<RCRTCCode>;
+    createOffer(iceRestart: boolean): Promise<__ASdpStrategy.IOfferInfo>;
+    setRemoteAnswer(answer: string): Promise<_____.RCRTCCode>;
     getLocalTrack(trackId: string): RCLocalTrack | null;
     addLocalTrack(track: RCLocalTrack): void;
     removeLocalTrackById(trackId: string): void;
@@ -1998,7 +1656,7 @@ declare class RCRTCPeerConnection extends EventEmitter {
     /**
      * 获取当前已发布视频流信息
      */
-    getOutboundVideoInfo(): OutboundVideoInfo[];
+    getOutboundVideoInfo(): __ASdpStrategy.OutboundVideoInfo[];
     private _onLocalTrackMuted;
     private _onLocalTrackDestroied;
     private _reportListener;
@@ -2022,6 +1680,14 @@ declare class RCRTCPeerConnection extends EventEmitter {
      * @todo
      */
     private _reportHandle;
+    /**
+     * 北极星上报 R3、R4 数据
+     */
+    private _sendR3R4Data;
+    /**
+     * 2s 给北极星上报一次 R3、R4
+     */
+    __reportR3R4ToPolaris(): Promise<void>;
     getRTCPeerConn(): RTCPeerConnection;
     destroy(): void;
     clearReTryExchangeTimer(): void;