trtc-sdk-v5 5.2.0-beta.6 → 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> {
 	    /**
@@ -871,7 +964,7 @@
 	    * - 一个 trtc 实例只能开启一路麦克风，若您需要在已经开启一路麦克风的情况下，再开启一路麦克风用于测试，可以创建多个 trtc 实例实现。
 	    *
 	    * @param {object} [config] - 配置项
-	    * @param {boolean} [config.publish] - 是否将本地音频发布到房间中，默认为true。若在进房前调用该接口，并且 publish = true，则在进房后 SDK 会自动发布。
+	    * @param {boolean} [config.publish] - 是否将本地音频发布到房间中，默认为true。若在进房前调用该接口，并且 publish = true，则在进房后 SDK 会自动发布。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @param {object} [config.option] - 本地音频选项
 	    * @param {string} [config.option.microphoneId]- 指定使用哪个麦克风
 	    * @param {MediaStreamTrack} [config.option.audioTrack] - 自定义采集的 audioTrack。{@tutorial 20-advanced-customized-capture-rendering}。
@@ -903,7 +996,7 @@
 	    * - 调用时机：该接口需在 {@link TRTC#startLocalAudio startLocalAudio()} 成功后调用，可以多次调用。
 	    * - 本方法采用增量更新方式：只更新传入的参数，不传入的参数保持不变。
 	    * @param {object} [config]
-	    * @param {boolean} [config.publish] - 是否将本地音频发布到房间中，默认为 true
+	    * @param {boolean} [config.publish] - 是否将本地音频发布到房间中，默认为 true。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @param {boolean} [config.mute] - 静音麦克风。参考：{@tutorial 15-basic-dynamic-add-video}。
 	    * @param {object} [config.option] - 本地音频配置
 	    * @param {string} [config.option.microphoneId] - 指定使用哪个麦克风，用来切换麦克风。
@@ -981,7 +1074,7 @@
 	    *
 	    * @param {object} [config]
 	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 本地视频预览的 HTMLElement 实例或者 Id， 如果不传或传入 null， 则不会播放视频。
-	    * @param {boolean} [config.publish] - 是否将本地视频发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布（若 publish=true）。
+	    * @param {boolean} [config.publish] - 是否将本地视频发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布（若 publish=true）。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @param {object} [config.option] - 本地视频配置
 	    * @param {string} [config.option.cameraId] - 指定使用哪个摄像头，用于切换摄像头。
 	    * @param {boolean} [config.option.useFrontCamera] - 是否使用前置摄像头
@@ -1033,7 +1126,7 @@
 	    * - 本方法采用增量更新方式：只更新传入的参数，不传入的参数保持不变。
 	    * @param {object} [config]
 	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 预览摄像头的 HTMLElement 实例或者 Id， 如果不传或传入null， 则不会渲染视频， 但会仍然会推流消耗带宽的容器
-	    * @param {boolean} [config.publish] - 是否将本地视频发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布。
+	    * @param {boolean} [config.publish] - 是否将本地视频发布到房间中。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @param {boolean} [config.mute] - 是否暂停摄像头采集，参考：{@tutorial 15-basic-dynamic-add-video}。
 	    * @param {object} [config.option] - 本地视频配置
 	    * @param {string} [config.option.cameraId] - 指定使用哪个摄像头，
@@ -1101,7 +1194,7 @@
 	    * - 开启屏幕分享后，房间内其他用户会收到 {@link module:EVENT.REMOTE_VIDEO_AVAILABLE REMOTE_VIDEO_AVAILABLE} 事件，streamType 为 {@link module:TYPE.STREAM_TYPE_SUB STREAM_TYPE_SUB}，其他用户可以通过 {@link TRTC#startRemoteVideo startRemoteVideo} 播放屏幕分享。
 	    * @param {object} [config]
 	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 预览本地屏幕分享的 HTMLElement 实例或 Id， 如果不传或传入 null， 则不会渲染本地屏幕分享。
-	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布。
+	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @param {object} [config.option] - 屏幕分享配置
 	    * @param {boolean} [config.option.systemAudio] - 是否采集系统声音，默认为 false。
 	    * @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - 视频填充模式。默认为 `contain`，参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit CSS object-fit} 属性。
@@ -1128,7 +1221,7 @@
 	    * - 本方法采用增量更新方式：只更新传入的参数，不传入的参数保持不变。
 	    * @param {object} [config]
 	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 屏幕分享预览的 HTMLElement 实例或 Id， 如果不传或传入 null， 则不会渲染屏幕分享。
-	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中
+	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @param {object} [config.option] - 屏幕分享配置
 	    * @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - 视频填充模式。默认为 `contain`，参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit CSS object-fit} 属性。
 	    * @param {QOS_PREFERENCE_SMOOTH|QOS_PREFERENCE_CLEAR} [config.option.qosPreference] - 设置弱网时，视频编码策略。流畅度优先（{@link module:TYPE.QOS_PREFERENCE_SMOOTH QOS_PREFERENCE_SMOOTH}）或 （默认）清晰度优先（{@link module:TYPE.QOS_PREFERENCE_CLEAR QOS_PREFERENCE_CLEAR}）
@@ -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.6",
+  "version": "5.2.0-beta.9",
   "description": "Tencent Cloud RTC SDK for Web",
   "main": "trtc.js",
   "types": "index.d.ts",