trtc-sdk-v5 5.3.0-beta.2 → 5.3.0-beta.5

package/index.d.ts

@@ -14,7 +14,7 @@
 	        profile?: keyof typeof videoProfileMap | VideoProfile;
 	        fillMode?: 'contain' | 'cover' | 'fill';
 	        mirror?: boolean;
-	        small?: keyof typeof videoProfileMap | VideoProfile | boolean;
+	        small?: keyof typeof videoProfileMap | VideoProfile;
 	        qosPreference?: typeof TRTCType.QOS_PREFERENCE_SMOOTH | typeof TRTCType.QOS_PREFERENCE_CLEAR;
 	        videoTrack?: MediaStreamTrack;
 	    };
@@ -112,6 +112,7 @@
 	    option?: {
 	        volume?: number;
 	    };
+	    mediaTrack?: MediaStreamTrack | null;
 	}
 	declare interface StopRemoteAudioConfig {
 	    userId: string;
@@ -410,7 +411,7 @@
 	     * @example
 	     *
 	     * trtc.on(TRTC.EVENT.ERROR, error => {
-	     *   console.error('client error observed: ' + error);
+	     *   console.error('trtc error observed: ' + error);
 	     *   const errorCode = error.code;
 	     *   const extraCode = error.extraCode;
 	     * });
@@ -531,7 +532,7 @@
 	    readonly REMOTE_VIDEO_UNAVAILABLE: "remote-video-unavailable";
 	    /**
 	     * @description 音量大小事件<br>
-	     * 调用 {@link Client#enableAudioVolumeEvaluation enableAudioVolumeEvaluation} 接口开启音量大小回调后，SDK 会定时抛出该事件，通知每个 userId 的音量大小。<br>
+	     * 调用 {@link TRTC#enableAudioVolumeEvaluation enableAudioVolumeEvaluation} 接口开启音量大小回调后，SDK 会定时抛出该事件，通知每个 userId 的音量大小。<br>
 	     * **Note**
 	     * - 回调中包含本地麦克风音量及远端用户的音量，无论是否有人说话，都会触发该回调。
 	     * - 回调 event.result 会根据音量大小，按大到小进行排序。
@@ -563,7 +564,7 @@
 	     *    其枚举值及含义如下表所示：
 	     *    | 数值 | 含义 |
 	     *    | :--- | :---- |
-	     *    | 0 | 网络状况未知，表示当前 client 实例还没有建立上行/下行连接 |
+	     *    | 0 | 网络状况未知，表示当前 trtc 实例还没有建立上行/下行连接 |
 	     *    | 1 | 网络状况极佳 |
 	     *    | 2 | 网络状况较好|
 	     *    | 3 | 网络状况一般 |
@@ -604,7 +605,7 @@
 	     * @default 'connection-state-changed'
 	     * @memberof module:EVENT
 	     * @example
-	     * client.on(TRTC.CONNECTION_STATE_CHANGED, event => {
+	     * trtc.on(TRTC.CONNECTION_STATE_CHANGED, event => {
 	     *   const prevState = event.prevState;
 	     *   const curState = event.state;
 	     * });
@@ -750,6 +751,7 @@
 	     * })
 	     */
 	    readonly STATISTICS: "statistics";
+	    readonly TRACK: "track";
 	};
 	declare interface TRTCEventTypes {
 	    [TRTCEvent.ERROR]: [RtcError];
@@ -821,6 +823,11 @@
 	        userId: string;
 	    }];
 	    [TRTCEvent.STATISTICS]: [statistics: TRTCStatistics];
+	    [TRTCEvent.TRACK]: [{
+	        userId: string;
+	        streamType?: TRTCStreamType;
+	        track: MediaStreamTrack;
+	    }];
 	}
  class TRTC extends EventEmitter<TRTCEventTypes> {
 	    /**
@@ -1474,12 +1481,66 @@
 	        readonly NETWORK_QUALITY: "network-quality";
 	        readonly CONNECTION_STATE_CHANGED: "connection-state-changed";
 	        readonly AUDIO_PLAY_STATE_CHANGED: "audio-play-state-changed";
+	        /**
+	         * 进入一个音视频通话房间（以下简称"进房"）。<br>
+	         * - 进房代表开始一个音视频通话会话，只有进房成功后才能和房间内的其他用户进行音视频通话。
+	         * - 可以通过 {@link TRTC#startLocalVideo startLocalVideo()} 和  {@link TRTC#startLocalAudio startLocalAudio()}发布本地音视频流，发布成功后，房间内其他用户会收到
+	         * {@link module:EVENT.REMOTE_AUDIO_AVAILABLE REMOTE_AUDIO_AVAILABLE} 和 {@link module:EVENT.REMOTE_VIDEO_AVAILABLE REMOTE_VIDEO_AVAILABLE} 事件通知。
+	         * - 默认情况下 SDK 会自动播放远端音频，您需要在调用 {@link TRTC#startRemoteVideo startRemoteVideo()} 来播放远端视频画面。
+	         *
+	         * @param {object} options 进房参数
+	         * @param {number} options.sdkAppId sdkAppId <br>
+	         * 在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 单击 **应用管理** > **创建应用** 创建新应用之后，即可在 **应用信息** 中获取 sdkAppId 信息。
+	         * @param {string} options.userId 用户ID <br>
+	         * 建议限制长度为32字节，只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
+	         * @param {string} options.userSig userSig 签名 <br>
+	         * 计算 userSig 的方式请参考 [UserSig 相关](https://cloud.tencent.com/document/product/647/17275)。
+	         * @param {number=} options.roomId
+	         * 数字类型的房间号，取值要求为 [1, 4294967294] 的整数;<br>
+	         * <font color="red">如果需要使用字符串类型的房间号请使用 strRoomId 参数，roomId 和 strRoomId 必须填一个。若两者都填，则优先选择 roomId。</font>
+	        * @param {string=} options.strRoomId
+	        * 字符串类型的房间号，限制长度为64字节，且仅支持以下范围的字符集：
+	         * - 大小写英文字母（a-zA-Z）
+	         * - 数字（0-9）
+	         * - 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
+	          *
+	          * <font color="red">注意：建议采用数字类型的 roomId，字符串类型的房间号 "123" 与 数字类型的房间号 123 不互通。</font>
+	        * @param {string} [options.scene] 应用场景，目前支持以下两种场景：
+	          * - {@link module:TYPE.SCENE_RTC TRTC.TYPE.SCENE_RTC}（默认）实时通话场景，该模式适合 1对1 的音视频通话，或者参会人数在 300 人以内的在线会议。[支持最大50人同时开麦](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/zh-cn/tutorial-04-info-uplink-limits.html)。
+	          * - {@link module:TYPE.SCENE_LIVE TRTC.TYPE.SCENE_LIVE} 互动直播场景，该模式适合十万人以内的在线直播场景，但需要您在接下来介绍的 options 参数中指定 角色(role) 这个字段
+	         * @param {string=} [options.role] 用户角色，仅在 {@link module:TYPE.SCENE_LIVE TRTC.TYPE.SCENE_LIVE} 场景下有意义，{@link module:TYPE.SCENE_RTC TRTC.TYPE.SCENE_RTC} 场景无需指定 role，目前支持两种角色：
+	         * - {@link module:TYPE.ROLE_ANCHOR TRTC.TYPE.ROLE_ANCHOR}（默认） 主播
+	         * - {@link module:TYPE.ROLE_AUDIENCE TRTC.TYPE.ROLE_AUDIENCE} 观众
+	         * <br>
+	         * 注意：观众角色没有发布本地音视频的权限，只有收看远端流的权限。如果观众想要连麦跟主播互动，
+	         * 请先通过 {@link TRTC#switchRole switchRole()} 切换角色到主播后再发布本地音视频。
+	         * @param {boolean} [options.autoReceiveAudio=true] 是否自动接收音频。当远端用户发布音频后，SDK 自动播放远端用户的音频。
+	         * @param {boolean} [options.autoReceiveVideo=true] 是否自动接收视频。当远端用户发布视频后，SDK 自动拉流并解码远端视频，您需要调用 {@link TRTC#startRemoteVideo startRemoteVideo} 播放远端视频。
+	         * @param {boolean} [options.enableAutoPlayDialog] 是否开启 SDK 自动播放失败弹窗，默认：true。
+	         * - 默认开启，当出现自动播放失败时，SDK 会弹窗引导用户点击页面，来恢复音视频播放。
+	         * - 可设置为 false 关闭，建议接入侧参考{@tutorial 21-advanced-auto-play-policy}来处理自动播放失败相关问题。
+	         * @param {string=} options.userDefineRecordId 用于设置云端录制的 userDefineRecordId(选填）。
+	         * - 【推荐取值】限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。
+	         * - 【参考文档】[云端录制](https://cloud.tencent.com/document/product/647/16823)。
+	         * @param {string|ProxyServer} [options.proxy] 设置代理服务器。参考最佳实践：{@tutorial 34-advanced-proxy}。
+	         * @param {boolean} [options.privateMapKey] 进房钥匙，若需要权限控制请携带该参数（传空或传错会导致进房失败）。<br>[privateMapKey 权限设置](https://cloud.tencent.com/document/product/647/32240)
+	         * @throws
+	         * - {@link module:ERROR_CODE.INVALID_PARAMETER INVALID_PARAMETER}
+	         * - {@link module:ERROR_CODE.OPERATION_FAILED OPERATION_FAILED}
+	         * - {@link module:ERROR_CODE.OPERATION_ABORT OPERATION_ABORT}
+	         * - {@link module:ERROR_CODE.ENV_NOT_SUPPORTED ENV_NOT_SUPPORTED}
+	         * - {@link module:ERROR_CODE.SERVER_ERROR SERVER_ERROR}
+	         * @example
+	         * const trtc = TRTC.create();
+	         * await trtc.enterRoom({ roomId: 8888, sdkAppId, userId, userSig });
+	         */
 	        readonly VIDEO_PLAY_STATE_CHANGED: "video-play-state-changed";
 	        readonly SCREEN_SHARE_STOPPED: "screen-share-stopped";
 	        readonly DEVICE_CHANGED: "device-changed";
 	        readonly PUBLISH_STATE_CHANGED: "publish-state-changed";
 	        readonly SEI_MESSAGE: "sei-message";
 	        readonly STATISTICS: "statistics";
+	        readonly TRACK: "track";
 	    };
 	    static ERROR_CODE: {
 	        INVALID_PARAMETER: number;

package/package.json

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