trtc-sdk-v5 5.10.2-beta.6 → 5.10.2-beta.8

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 {
   /**
    * 输出所有日志
    */
@@ -446,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'
@@ -640,7 +642,7 @@ export declare interface LocalStatistic {
     videoType: TRTCVideoType;
   }[];
 }
-export declare enum TRTCVideoType {
+export declare const enum TRTCVideoType {
   Big = 'big',
   Small = 'small',
   Sub = 'sub'
@@ -663,7 +665,7 @@ export declare interface VideoFrameConfig {
   userId?: string;
   streamType?: TRTCStreamType;
 }
-export declare enum AutoStartPluginName {
+export declare const enum AutoStartPluginName {
   Debug = 'Debug'
 }
 
@@ -1135,6 +1137,7 @@ export declare interface TRTCEventTypes {
   [TRTCEvent.ERROR]: [RtcError];
   [TRTCEvent.AUTOPLAY_FAILED]: [{
     userId: string;
+    mediaType: 'audio' | 'video' | 'screen';
     resume: () => Promise<void>;
   }];
   [TRTCEvent.KICKED_OUT]: [{
@@ -1230,6 +1233,14 @@ export declare class TRTC {
    *
    * **Note:**
    * - You must create a TRTC object first and call its methods and listen to its events to implement various functions required by the business.
+   * @param {Array=} options.plugins List of registered plugins (optional).
+   * @param {boolean=} [options.enableSEI=false] Whether to enable SEI sending and receiving function (optional). [Reference document](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/en/TRTC.html#sendSEIMessage)
+   * @param {string=} options.assetsPath The address of the static resource file that the plugin depends on (optional).
+   * - Publish the node_modules/trtc-sdk-v5/assets directory to CDN or static resource server.
+   * - Set the assetsPath parameter to the CDN address, for example: `TRTC.create({ assetsPath: 'https://xxx/assets' })`, the SDK will load the relevant resource files on demand.
+   * @param {string=} options.userDefineRecordId is used to set the userDefineRecordId of cloud recording (optional).
+   * - [Recommended value] The length is limited to 64 bytes, and only uppercase and lowercase English letters (a-zA-Z), numbers (0-9), underscores, and hyphens are allowed.
+   * - [Reference document] [Cloud recording](https://trtc.io/document/45169?product=rtcengine&menulabel=serverfeaturesapis).
    * @example
    * // Create a TRTC object
    * const trtc = TRTC.create();
@@ -2022,6 +2033,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.6",
+  "version": "5.10.2-beta.8",
   "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.6",
+  "version": "5.10.2-beta.8",
   "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.6",
+  "version": "5.10.2-beta.8",
   "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.6",
+  "version": "5.10.2-beta.8",
   "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.6",
+  "version": "5.10.2-beta.8",
   "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.6",
+  "version": "5.10.2-beta.8",
   "description": "Video decoder plugin for TRTC",
   "main": "./video-decoder.esm.js",
   "module": "./video-decoder.esm.js",