trtc-sdk-v5 5.2.0-beta.8 → 5.2.0-beta.9

package/index.d.ts

@@ -301,7 +301,85 @@
 	    'AIDenoiser': undefined;
 	    'CDNStreaming': CDNStreamingOptions;
 	};
+	declare interface TRTCStatistics {
+	    rtt: number;
+	    downLoss: number;
+	    upLoss: number;
+	    bytesSent: number;
+	    bytesReceived: number;
+	    localStatistics: LocalStatistic;
+	    remoteStatistics: RemoteStatistic[];
+	}
+	interface LocalStatistic {
+	    audio: {
+	        bitrate: number;
+	        audioLevel: number;
+	    };
+	    video: {
+	        width: number;
+	        height: number;
+	        frameRate: number;
+	        bitrate: number;
+	        videoType: TRTCVideoType;
+	    }[];
+	}
+	declare enum TRTCVideoType {
+	    Big = "big",
+	    Small = "small",
+	    Sub = "sub"
+	}
+	interface RemoteStatistic {
+	    audio: {
+	        bitrate: number;
+	        audioLevel: number;
+	    };
+	    video: {
+	        width: number;
+	        height: number;
+	        frameRate: number;
+	        bitrate: number;
+	        videoType: TRTCVideoType;
+	    }[];
+	    userId: string;
+	}
 
+	/**
+	   * @typedef TRTCStatistics TRTC 通话统计信息
+	   * @property {number} rtt 从 SDK 与 云端的往返延时（一个网络包经历 “SDK -> 云端 -> SDK” 的总耗时），单位 ms。
+	   * @property {number} upLoss 从 SDK 到云端的上行丢包率，单位 (%)
+	   * @property {number} downLoss 从云端到 SDK 的下行丢包率，单位 (%)
+	   * @property {number} bytesSent 总发送字节数（包含信令数据和音视频数据），单位：字节数（Bytes）。
+	   * @property {number} bytesReceived 总接收字节数（包含信令数据和音视频数据），单位：字节数（Bytes）。
+	   * @property {TRTCLocalStatistics} localStatistics 本地的音视频统计信息
+	   * @property {TRTCRemoteStatistics[]} remoteStatistics 远端的音视频统计信息
+	   */
+	/**
+	   * 本地的音视频统计信息
+	   * @typedef TRTCLocalStatistics
+	   * @property {TRTCAudioStatistic} audio 本地音频统计信息
+	   * @property {TRTCVideoStatistic[]} video 本地视频统计信息
+	   */
+	/**
+	   * 远端的音视频统计信息
+	   * @typedef TRTCRemoteStatistics
+	   * @property {string} userId 远端用户的 userId
+	   * @property {TRTCAudioStatistic} audio 远端音频统计信息
+	   * @property {TRTCVideoStatistic[]} video 远端视频统计信息
+	   */
+	/**
+	   * 音频统计信息
+	   * @typedef TRTCAudioStatistic
+	   * @property {number} bitrate 音频码率，单位：Kbps
+	   * @property {number} audioLevel 音量大小，0 ~ 1 的浮点数。
+	   */
+	/** 视频统计信息
+	   * @typedef TRTCVideoStatistic
+	   * @property {number} bitrate 视频码率，单位：Kbps
+	   * @property {number} width 视频宽度
+	   * @property {number} height 视频高度
+	   * @property {number} frameRate 视频帧率
+	   * @property {'big'|'small'|'sub'} videoType 视频类型，大流、小流、辅流。
+	   */
 	/**
 	 * **TRTC事件列表**<br>
 	 * <br>
@@ -339,7 +417,7 @@
 	     * @example
 	     * trtc.on(TRTC.EVENT.AUTOPLAY_FAILED, event => {
 	     *   // 引导用户点击页面，当用户点击页面时，SDK 会自动恢复播放。
-	     *   // v5.1.3+
+	     *   // 自 v5.1.3+ 新增 userId 参数，表示哪个用户出现自动播放失败。
 	     *   console.log(event.userId);
 	     * });
 	     */
@@ -652,6 +730,20 @@
 	     * })
 	     */
 	    readonly SEI_MESSAGE: "sei-message";
+	    /**
+	     * @description 通话相关数据指标。<br>
+	     *
+	     * - 监听该事件后，SDK 会以 2s 一次的频率定时抛出该事件。
+	     * - 您可以从该事件中可以获取通话的网络质量（rtt、丢包率）、上行和下行的音视频统计信息（音量大小、宽高、帧率、码率）等信息。详细参数说明请参考：{@link TRTCStatistics}
+	     * @default 'statistics'
+	     * @since v5.2.0
+	     * @memberof module:EVENT
+	     * @example
+	     * trtc.on(TRTC.EVENT.STATISTICS, statistics => {
+	     *    console.warn(statistics.rtt, statistics.upLoss, statistics.downLoss);
+	     * })
+	     */
+	    readonly STATISTICS: "statistics";
 	};
 	declare interface TRTCEventTypes {
 	    [TRTCEvent.ERROR]: [RtcError];
@@ -722,6 +814,7 @@
 	        data: Uint8Array;
 	        userId: string;
 	    }];
+	    [TRTCEvent.STATISTICS]: [statistics: TRTCStatistics];
 	}
  class TRTC extends EventEmitter<TRTCEventTypes> {
 	    /**
@@ -1408,6 +1501,7 @@
 	        readonly DEVICE_CHANGED: "device-changed";
 	        readonly PUBLISH_STATE_CHANGED: "publish-state-changed";
 	        readonly SEI_MESSAGE: "sei-message";
+	        readonly STATISTICS: "statistics";
 	    };
 	    static ERROR_CODE: {
 	        INVALID_PARAMETER: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-sdk-v5",
-  "version": "5.2.0-beta.8",
+  "version": "5.2.0-beta.9",
   "description": "Tencent Cloud RTC SDK for Web",
   "main": "trtc.js",
   "types": "index.d.ts",