@rongcloud/plugin-rtc 5.3.12 → 5.3.13

package/dist/core/webrtc/stat-parser/AbstractStatParser.d.ts

@@ -0,0 +1,116 @@
+import IStatParser from './IStatParser';
+import { IInnerRCRTCStateReport } from '../../interfaces';
+export default abstract class AbstractStatParser implements IStatParser {
+    protected readonly _rtcPeerConn: RTCPeerConnection;
+    protected readonly _sdpSemantics: string;
+    constructor(_rtcPeerConn: RTCPeerConnection, _sdpSemantics: string);
+    /**
+     * 最近的上行发送包数据统计
+     */
+    protected _latestPacketsSent: {
+        [resourceId: string]: {
+            packetsLost?: number;
+            packetsSent?: number;
+            crtPacketsSent?: number;
+        };
+    };
+    /**
+     * 最近的上行发送字节数统计
+     */
+    protected _latestBytesSent: {
+        [resourceId: string]: {
+            bytesSent: number;
+            timestamp: number;
+        };
+    };
+    /**
+     * 最近的下行接收字节数统计
+     */
+    protected _latestBytesRecv: {
+        [resourceId: string]: {
+            bytesRecv: number;
+            timestamp: number;
+        };
+    };
+    /**
+     * 最近的下行接收包数据统计
+     */
+    protected _latestPacketsRecv: {
+        [resourceId: string]: {
+            packetsLost: number;
+            packetsRecv: number;
+        };
+    };
+    /**
+     * 更新上行码率存储，返回计算出的码率
+     * @param resourceId
+     * @param bytesSent 本次发送的字节数
+     * @param timestamp
+     * @returns bitrate
+     */
+    protected updateBytesSent(resourceId: string, bytesSent: number, timestamp: number): number;
+    /**
+     * 更新下行码率存储，返回计算出的码率
+     * @param resourceId
+     * @param bytesRecv
+     * @param timestamp
+     * @returns bitrate
+     */
+    protected updateBytesRecv(resourceId: string, bytesRecv: number, timestamp: number): number;
+    /**
+     * 更新上行丢包总数，返回计算出的丢包率
+     * 计算丢包率
+     * 上行数据统计中，packageLost 的统计具有延时性
+     * 会导致瞬时的 packetsLost - prePacketsLost 值大于 packetsSent - prePacketsSent，从而丢包率可能大于 1
+     * 因此此处计算只在 packetsLost - prePacketsLost !== 0 时计算丢包率，其他时间丢包为 0
+     * packetsSent 只在 packetsLost 有变化时更新
+     */
+    protected updateSenderPacketsLost(resourceId: string, packetsLost: number, packetsSent: number): number;
+    /**
+     * 更新下行丢包总数，返回计算出的丢包率
+     */
+    protected updateReceiverPacketsLost(resourceId: string, packetsLost: number, packetsReceived: number): number;
+    /**
+     * 取消发布后，需把 _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;
+    }[];
+    /**
+     * 从 offer 和 answer 的 sdp 中获取 ssrc 对应的 msid
+     * @param statInfo outbound 和 inbound 对应值
+     * @returns resourceId
+     */
+    protected getResourceIdByParseSdp(statInfo: {
+        [key: string]: any;
+    }): string;
+    /**
+     * 从 offer sdp 中查找 ssrc 对应的通道是否可用
+     * @param outboundInfo
+     */
+    protected isValidSender(outboundInfo: {
+        [key: string]: any;
+    }): boolean;
+    /**
+     * 从 answer sdp 中查找 ssrc 对应的通道是否可用
+     * @param inboundInfo
+     */
+    protected isValidReceiver(inboundInfo: {
+        [key: string]: any;
+    }): boolean;
+}
+//# sourceMappingURL=AbstractStatParser.d.ts.map

package/dist/core/webrtc/stat-parser/ChromeStatParser.d.ts

@@ -0,0 +1,14 @@
+import { IInnerRCRTCStateReport } from '../../interfaces';
+import AbstractStatParser from './AbstractStatParser';
+export default class RTCReportParser extends AbstractStatParser {
+    formatRCRTCStateReport(stats: {
+        [key: string]: any;
+    }): IInnerRCRTCStateReport;
+    getAudioLevelList(stats: {
+        [key: string]: any;
+    }): {
+        trackId: string;
+        audioLevel: number | null;
+    }[];
+}
+//# sourceMappingURL=ChromeStatParser.d.ts.map

package/dist/core/webrtc/stat-parser/FirefoxStatParser.d.ts

@@ -0,0 +1,14 @@
+import { IInnerRCRTCStateReport } from '../../interfaces';
+import AbstractStatParser from './AbstractStatParser';
+export default class RTCReportParser extends AbstractStatParser {
+    formatRCRTCStateReport(stats: {
+        [key: string]: any;
+    }): IInnerRCRTCStateReport;
+    getAudioLevelList(stats: {
+        [key: string]: any;
+    }): {
+        trackId: string;
+        audioLevel: number | null;
+    }[];
+}
+//# sourceMappingURL=FirefoxStatParser.d.ts.map

package/dist/core/webrtc/stat-parser/IStatParser.d.ts

@@ -0,0 +1,24 @@
+import { IInnerRCRTCStateReport } from '../../interfaces';
+export default 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;
+    }[];
+}
+//# sourceMappingURL=IStatParser.d.ts.map

package/dist/core/webrtc/stat-parser/SafariStatParser.d.ts

@@ -0,0 +1,14 @@
+import { IInnerRCRTCStateReport } from '../../interfaces';
+import AbstractStatParser from './AbstractStatParser';
+export default class RTCReportParser extends AbstractStatParser {
+    formatRCRTCStateReport(stats: {
+        [key: string]: any;
+    }): IInnerRCRTCStateReport;
+    getAudioLevelList(stats: {
+        [key: string]: any;
+    }): {
+        trackId: string;
+        audioLevel: number | null;
+    }[];
+}
+//# sourceMappingURL=SafariStatParser.d.ts.map

package/dist/device.d.ts

@@ -0,0 +1,6 @@
+export declare const device: {
+    getCameras: () => Promise<MediaDeviceInfo[]>;
+    getMicrophones: () => Promise<MediaDeviceInfo[]>;
+    getSpeakers: () => Promise<MediaDeviceInfo[]>;
+};
+//# sourceMappingURL=device.d.ts.map

package/dist/helper.d.ts

@@ -0,0 +1,176 @@
+import { INaviInfo, IRTCUsers, IServerRTCRoomEntry } from '@rongcloud/engine';
+import { RCFrameRate } from './core/enums/RCFrameRate';
+import { RCResolution } from './core/enums/RCResolution';
+import { RCRTCMessageType } from './core/enums/inner/RCRTCMessageType';
+import { IPKInfo, IPublishAttrs, IPublishedResource, IResource, RoomData } from './core/interfaces';
+import { RCMediaType } from './core/enums/RCMediaType';
+import { RCLocalTrack } from './core/tracks/RCLocalTrack';
+import { RCRemoteTrack } from './core/tracks/RCRemoteTrack';
+/**
+ * 构建增量消息内容
+ * @param objectname 消息名
+ * @param uris 增量变更资源
+ */
+export declare const buildPlusMessage: (messageName: RCRTCMessageType, uris: IPublishedResource[]) => {
+    name: RCRTCMessageType;
+    content: string;
+};
+/**
+ * 构建预发布的全量资源变更消息
+ * @param uris 全量资源数据
+ */
+export declare const buildTotalURIMessageContent: (uris: IPublishedResource[]) => string;
+/**
+ * roomId 有效性验证
+ * @param roomId
+ */
+export declare const isValidRoomId: (roomId: string) => boolean;
+/**
+ * 验证 tag 是否有效
+ * @param tag
+ * @returns
+ */
+export declare const isValidTag: (tag: string) => boolean;
+/**
+ * 页面地址有效性检测
+ */
+export declare const isValidLocation: boolean;
+/**
+ * 获取视频流的分辨率及帧率数据，若无法获取真实值，则返回 0
+ * @param track
+ */
+export declare const getVideoTrackInfo: (track: MediaStreamTrack) => {
+    width: number;
+    height: number;
+    frameRate: number;
+};
+/**
+ * 取视频流动态码率
+ * @param track
+ * @returns
+ */
+export declare const getDynamicBitrate: (track: MediaStreamTrack) => {
+    min: number;
+    max: number;
+};
+/**
+ * 获取资源唯一性标识
+ * @param item
+ */
+export declare const getTrackId: (item: IResource) => string;
+/**
+ * 解析 trackId 以获取资源信息
+ * @param trackId
+ */
+export declare const parseTrackId: (trackId: string) => {
+    mediaType: RCMediaType;
+    tag: string;
+    userId: string;
+};
+export declare const parseStreamId: (streamId: string) => {
+    tag: string;
+    userId: string;
+};
+export declare const formatStreamId: (userId: string, tag: string) => string;
+export declare const deepCopyResources: <T>(resources: T[]) => T[];
+/**
+ * 比对资源找出新增、状态变更及取消发布的资源
+ * @param prevResources 原资源数据
+ * @param resources 变更的全量资源
+ */
+export declare const diffPublishResources: (prevResources: IPublishedResource[], resources: IPublishedResource[], isReconnect?: boolean) => {
+    publishedList: IPublishedResource[];
+    unpublishedList: IPublishedResource[];
+    modifiedList: IPublishedResource[];
+};
+export declare const diffPubResOnReconnect: (prevResources: IPublishedResource[], resources: IPublishedResource[]) => {
+    publishedList: IPublishedResource[];
+    unpublishedList: IPublishedResource[];
+    modifiedList: IPublishedResource[];
+};
+export declare const getUUID22: () => string;
+/**
+ * 转化 RCResolution 枚举值为分辨率宽高
+ * @param resolution
+ * @returns
+ */
+export declare const transResolution: (resolution: RCResolution) => {
+    width: number;
+    height: number;
+};
+/**
+ * 判断枚举值有效性
+ * @param resolution
+ * @returns
+ */
+export declare const isValidResolution: (resolution?: RCResolution) => boolean;
+/**
+ * 判断帧率枚举值有效性
+ * @param fps
+ * @returns
+ */
+export declare const isValidFPS: (fps?: RCFrameRate) => boolean;
+/**
+ * 获取枚举值对应的帧率
+ * @param fps
+ * @returns
+ */
+export declare const transFrameRate: (fps: RCFrameRate) => number;
+export type IBrowserDetails = {
+    browser: string;
+    version?: number;
+    supportsUnifiedPlan: boolean;
+};
+export declare const browserInfo: IBrowserDetails;
+/**
+ * 验证浏览器是否支持创建自定义文件流
+ * @returns
+ */
+export declare function ifSupportLocalFileTrack(): boolean;
+/**
+ * 验证浏览器是否支持屏幕共享
+ * @returns
+ */
+export declare function ifSupportScreenShare(): boolean;
+/**
+ * 检查参数是否为 null
+*/
+export declare const isNull: (val: any) => boolean;
+/**
+ * 公有云连接私有云 SDK 为非法连接
+ */
+export declare const isIllegalConnection: (navi: INaviInfo) => boolean;
+/**
+ * 获取将要发布的 track 数量
+ * 需要发布小流的算两个 track
+ */
+export declare const calcTracksNum: (tracks: (RCLocalTrack | IPublishAttrs)[]) => number;
+/**
+ * 解析房间数据
+ */
+export declare const parseRoomData: (data: IRTCUsers, mainRoomId: string) => RoomData;
+/**
+ * 从加房间返回的数据中获取加入的副房间
+ */
+export declare const getPKInfoByRoomData: (mainRoomId: string, roomInfo: {
+    key: string;
+    value: string;
+}[]) => IPKInfo;
+/**
+ * 解析观众加房间 kv 数据
+ * 远端无人员时，kvEntries 的 key 不包含 RC_ANCHOR_LIST
+ * 远端无资源时，key 不包含 RC_RES_、RC_CDN
+ * 远端有资源、无 CDN 资源时，key 不包含 RC_CDN
+ * 服务端 bug，偶现无 RC_RTC_SESSIONID
+ */
+export declare const parseAudienceRoomData: (roomId: string, kvEntries: IServerRTCRoomEntry[]) => {
+    sessionId: string;
+    remoteUserIds: string[];
+    remoteRTCUris: IPublishedResource[];
+    remoteMUCUris: IPublishedResource[];
+    remoteRTCTracks: RCRemoteTrack[];
+    remoteMCUTracks: RCRemoteTrack[];
+    remoteTracks: RCRemoteTrack[];
+    CDNUris: any;
+};
+//# sourceMappingURL=helper.d.ts.map

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.3.12
- * CommitId - 567f104279e4a211af4cf0145b67f50faf481848
- * Mon May 30 2022 14:26:02 GMT+0800 (China Standard Time)
+ * RCRTC - v5.3.13
+ * CommitId - 367040ff8de440fde7e136452ae17b1eeea24c97
+ * Mon Nov 28 2022 15:48:19 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, LogLevel, RTCMode, IRuntime, RTCPluginContext, IServerRTCRoomEntry, IReceivedMessage, ErrorCode, IJoinRTCRoomData, KVString, RTCJoinType, IRTCUserData, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
@@ -386,13 +386,13 @@ interface IStatParser {
     }[];
 }
 
-declare type ISdpSemantics = 'plan-b' | 'unified-plan';
+type ISdpSemantics = 'plan-b' | 'unified-plan';
 interface IOfferInfo {
     type: 'offer';
     sdp: string;
     semantics: ISdpSemantics;
 }
-declare type OutboundVideoInfo = {
+type OutboundVideoInfo = {
     trackId: string;
     simulcast: RCStreamType;
     resolution: string;
@@ -884,8 +884,26 @@ interface ICameraVideoProfile extends IVideoProfile {
     faceMode?: 'user' | 'environment';
 }
 interface IMicphoneAudioProfile {
+    /**
+     * 指定采录的 AudioInputDevice
+     */
     micphoneId?: string;
+    /**
+     * 音频采样率
+     */
     sampleRate?: number;
+    /**
+     * 噪声抑制开关，未配置时以浏览器默认行为为准
+     */
+    noiseSuppression?: boolean;
+    /**
+     * 回声消除开关，未配置时以浏览器默认行为为准
+     */
+    echoCancellation?: boolean;
+    /**
+     * 自动增益开关，未配置时以浏览器默认行为为准
+     */
+    autoGainControl?: boolean;
 }
 interface ICreateLocalTrackOptions {
     /**
@@ -909,7 +927,7 @@ interface IAudioLevelChangeHandler {
 /**
  * 房间资源数据
  */
-declare type RoomData = {
+type RoomData = {
     [userId: string]: IPublishedResource[];
 };
 /**
@@ -2155,7 +2173,7 @@ declare class RCRTCPeerConnection extends EventEmitter {
     clearReTryExchangeTimer(): void;
 }
 
-declare type IOnRecvPKMsg = (msg: IReceivedMessage) => void;
+type IOnRecvPKMsg = (msg: IReceivedMessage) => void;
 interface IRoomPKEventListener {
     /**
      * 收到连麦邀请
@@ -3207,6 +3225,7 @@ declare class RCRTCClient {
         code: RCRTCCode;
         track?: RCCameraVideoTrack;
     }>;
+    private _formatAudioProfile;
     /**
      * 通过摄像头与麦克风采集音视频轨道数据
      * @param tag