trtc-sdk-v5 5.10.2-beta.4 → 5.10.2-beta.5

package/index.d.ts

@@ -9,7 +9,9 @@ import { CustomEncryption, EncryptionOptions } from './plugins/custom-encryption
 
 export { CDNStreamingOptions, DeviceDetectorOptions, VirtualBackgroundOptions, UpdateVirtualBackgroundOptions, WatermarkOptions, BeautyOptions, UpdateBeautyOptions, BasicBeautyOptions, StartCrossRoomOption, UpdateCrossRoomOption, StopCrossRoomOption };
 type TRTCPlugin = typeof CrossRoom | typeof CDNStreaming | typeof DeviceDetector | typeof VirtualBackground | typeof Watermark | typeof Beauty | typeof BasicBeauty | typeof CustomEncryption;
-
+export declare const enum ExperimentalAPIFunction {
+  EnableAudioFrameEvent = 'enableAudioFrameEvent'
+}
 export declare type PluginStartOptionsMap = {
   'AudioMixer': AudioMixerOptions;
   'AIDenoiser': AIDenoiserOptions;
@@ -101,7 +103,7 @@ export declare class RtcError extends Error implements RTCErrorInterface {
   static convertFrom(originError: Error, fnName?: string, fnParams?: any): RtcError;
 }
 
-export declare enum LOG_LEVEL {
+export declare const enum LOG_LEVEL {
   /**
    * 输出所有日志
    */
@@ -366,13 +368,6 @@ export interface PlayoutDelay {
   max: number;
 }
 
-export declare interface SwitchRoomConfig {
-	roomId?: number,
-	strRoomId?: string;
-	privateMapKey?: string;
-	userSig?: string;
-}
-
 export declare interface ScreenShareConfig {
   view?: string | HTMLElement | HTMLElement[] | null;
   publish?: boolean;
@@ -453,12 +448,12 @@ export declare const enum TRTCStreamType {
   Main = 'main',
   Sub = 'sub'
 }
-export declare enum TRTCDeviceType {
+export declare const enum TRTCDeviceType {
   Camera = 'camera',
   Microphone = 'microphone',
   Speaker = 'speaker'
 }
-export declare enum TRTCDeviceAction {
+export declare const enum TRTCDeviceAction {
   Remove = 'remove',
   Add = 'add',
   Active = 'active'
@@ -647,7 +642,7 @@ export declare interface LocalStatistic {
     videoType: TRTCVideoType;
   }[];
 }
-export declare enum TRTCVideoType {
+export declare const enum TRTCVideoType {
   Big = 'big',
   Small = 'small',
   Sub = 'sub'
@@ -670,7 +665,7 @@ export declare interface VideoFrameConfig {
   userId?: string;
   streamType?: TRTCStreamType;
 }
-export declare enum AutoStartPluginName {
+export declare const enum AutoStartPluginName {
   Debug = 'Debug'
 }
 
@@ -1372,58 +1367,27 @@ export declare class TRTC {
    * await trtc.switchRole(TRTC.TYPE.ROLE_ANCHOR, { privateMapKey: 'your new privateMapKey' });
    */
   switchRole(role: UserRole, option?: {
-		privateMapKey?: string;
-		latencyLevel?: number;
-	}): Promise<void>;
-	/**
-   * Switch a video call room.<br>
-   * - Switch the video call room that the audience is watching in live scene. It is faster than exit old room and then entering the new room, and can optimize the opening time in live broadcast and other scenarios.
-   * - [Contact us](https://trtc.io/contact) to enable this API.
-   *
-   * @param {object} options Switch room parameters
-   * @param {string} options.userSig UserSig signature <br>
-   * Please refer to [UserSig related](https://www.tencentcloud.com/document/product/647/35166) for the calculation method of userSig.
-   * <font color="red">Note: If you omit this parameter, SDK will reuse the userSig passed in {@link TRTC#enterRoom enterRoom()}. If it has expired, switching room will fail.</font>
-   * @param {string=} options.strRoomId
-   * @param {number=} options.roomId
-   * the value must be an integer between 1 and 4294967294<br>
-   * <font color="red">Note: The type of the new room must be the same as the old room. For example, both are numeric type roomId.</font>
-   * @param {string=} options.strRoomId
-   * String type room id, the length is limited to 64 bytes, and only supports the following characters:
-   * - Uppercase and lowercase English letters (a-zA-Z)
-   * - Numbers (0-9)
-   * - Space ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
-   * <font color="red">Note: One of roomId and strRoomId must be passed in. If both are passed in, the numeric type roomId will be selected first.</font>
-   * @param {boolean} [options.privateMapKey] Key for entering a room. If permission control is required, please carry this parameter (empty or incorrect value will cause a failure in entering the room).<br>[privateMapKey permission configuration](https://www.tencentcloud.com/document/product/647/35157?lang=en&pg=).
-   * @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.SERVER_ERROR SERVER_ERROR}
+    privateMapKey?: string;
+    latencyLevel?: number;
+  }): Promise<void>;
+  /**
+   * Destroy the TRTC instance <br/>
+   *
+   * After exiting the room, if the business side no longer needs to use trtc, you need to call this interface to destroy the trtc instance in time and release related resources.
+   *
+   * Note:
+   *  - The trtc instance after destruction cannot be used again.
+   *  - If you have entered the room, you need to call the {@link TRTC#exitRoom TRTC.exitRoom} interface to exit the room successfully before calling this interface to destroy trtc.
+   *
    * @example
-   * const trtc = TRTC.create();
-   * await trtc.enterRoom({ roomId: 8888, sdkAppId, userId, userSig });
-   * await trtc.switchRoom({ roomId: 9999 });
-   */
-	switchRoom(params: SwitchRoomConfig): Promise<void>;
-	/**
-	 * Destroy the TRTC instance <br/>
-	 *
-	 * After exiting the room, if the business side no longer needs to use trtc, you need to call this interface to destroy the trtc instance in time and release related resources.
-	 *
-	 * Note:
-	 *  - The trtc instance after destruction cannot be used again.
-	 *  - If you have entered the room, you need to call the {@link TRTC#exitRoom TRTC.exitRoom} interface to exit the room successfully before calling this interface to destroy trtc.
-	 *
-	 * @example
-	 * // When the call is over
-	 * await trtc.exitRoom();
-	 * // If the trtc is no longer needed, destroy the trtc and release the reference.
-	 * trtc.destroy();
-	 * trtc = null;
-	 * @throws {@link module:ERROR_CODE.OPERATION_FAILED OPERATION_FAILED}
-	 * @memberof TRTC
-	 */
+   * // When the call is over
+   * await trtc.exitRoom();
+   * // If the trtc is no longer needed, destroy the trtc and release the reference.
+   * trtc.destroy();
+   * trtc = null;
+   * @throws {@link module:ERROR_CODE.OPERATION_FAILED OPERATION_FAILED}
+   * @memberof TRTC
+   */
   destroy(): void;
   /**
    * Start collecting audio from the local microphone and publish it to the current room.
@@ -2060,6 +2024,21 @@ export declare class TRTC {
    * })
    */
   sendCustomMessage(message: CustomMessageData): void;
+  /**
+   * call experimental API
+   *
+   * | API name            | options                                | description                                                        |
+   * | ------------------- | ----------------------------------------------- | ------------------------------------------------------------ |
+   * | enableAudioFrameEvent | - enable type: `boolean` <br></br> - userId type: `string` <br></br> - sampleRate type: `number` <br></br> - channelCount type: `number` <br></br>| Configure the callback data of {@link module:EVENT.AUDIO_FRAME AUDIO_FRAME} event  |
+   * @private
+   * @param {string} name
+   * @param {object} options
+   * @example
+   * await trtc.callExperimentalAPI('enableAudioFrameEvent', { enable: true, userId: 'user_A'}) // 监听远端用户 user_A 的音频数据，默认 pcm 数据为 48kHZ，单声道
+   * await trtc.callExperimentalAPI('enableAudioFrameEvent', { enable: true, userId: '*', sampleRate: 16000, channelCount: 2 }) // 监听所有远端音频数据，设置 pcm 数据为 16kHZ，双声道
+   * await trtc.callExperimentalAPI('enableAudioFrameEvent', { enable: false, userId: '', sampleRate: 48000, channelCount: 1 }) // 取消监听本地麦克风数据
+   */
+  callExperimentalAPI(name: ExperimentalAPIFunction, options: any): Promise<void>;
   static EVENT: typeof TRTCEvent;
   static ERROR_CODE: {
     INVALID_PARAMETER: number;

package/package.json

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

package/plugins/cdn-streaming/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/cdn-streaming",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "description": "TRTC Web SDK 5.x CDN streaming plugin",
   "main": "./cdn-streaming.esm.js",
   "module": "./cdn-streaming.esm.js",

package/plugins/cross-room/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/cross-room",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "description": "TRTC Web SDK 5.x Cross Room plugin",
   "main": "./cross-room.esm.js",
   "module": "./cross-room.esm.js",

package/plugins/custom-encryption/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/custom-encryption",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "main": "./custom-encryption.esm.js",
   "module": "./custom-encryption.esm.js",
   "types": "./custom-encryption.esm.d.ts"

package/plugins/device-detector/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/device-detector",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "description": "TRTC Web SDK 5.x device detector plugin",
   "main": "./device-detector.esm.js",
   "module": "./device-detector.esm.js",

package/plugins/video-decoder/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/video-decoder",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "description": "Video decoder plugin for TRTC",
   "main": "./video-decoder.esm.js",
   "module": "./video-decoder.esm.js",

package/plugins/video-effect/basic-beauty/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/basic-beauty",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "description": "TRTC Web SDK 5.x basic-beauty plugin",
   "main": "./basic-beauty.esm.js",
   "module": "./basic-beauty.esm.js",

package/plugins/video-effect/beauty/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/beauty",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "description": "TRTC Web SDK 5.x beauty plugin",
   "main": "./beauty.esm.js",
   "module": "./beauty.esm.js",

package/plugins/video-effect/virtual-background/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/virtual-background",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "description": "TRTC Web SDK 5.x virtual background plugin",
   "main": "./virtual-background.esm.js",
   "module": "./virtual-background.esm.js",

package/plugins/video-effect/watermark/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/watermark",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "description": "TRTC Web SDK 5.x watermark plugin",
   "main": "./watermark.esm.js",
   "module": "./watermark.esm.js",

package/plugins/voice-changer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/voice-changer",
-  "version": "5.10.2-beta.4",
+  "version": "5.10.2-beta.5",
   "description": "",
   "main": "./voice-changer.esm.js",
   "keywords": [],