trtc-sdk-v5 5.11.2-beta.3 → 5.11.2-beta.4

package/index.d.ts

@@ -12,8 +12,8 @@ import { InitAudioProcessorOptions, UpdateAudioProcessorOptions } from 'trtc-js-
 
 export { CDNStreamingOptions, DeviceDetectorOptions, VirtualBackgroundOptions, UpdateVirtualBackgroundOptions, WatermarkOptions, BeautyOptions, UpdateBeautyOptions, BasicBeautyOptions, StartCrossRoomOption, UpdateCrossRoomOption, StopCrossRoomOption, SmallStreamAutoSwitcherOptions, VideoMixerOptions };
 type TRTCPlugin = typeof CrossRoom | typeof CDNStreaming | typeof DeviceDetector | typeof VirtualBackground | typeof Watermark | typeof Beauty | typeof BasicBeauty | typeof CustomEncryption | typeof SmallStreamAutoSwitcher | typeof VideoMixer;
-export declare const enum ExperimentalAPIFunction {
-  EnableAudioFrameEvent = 'enableAudioFrameEvent'
+export declare type ExperimentalAPIFunctionMap = {
+  'enableAudioFrameEvent': EnableAudioFrameEventOptions;
 }
 export declare type PluginStartOptionsMap = {
   'AudioMixer': AudioMixerOptions;
@@ -692,6 +692,13 @@ export declare interface VideoFrameConfig {
 export declare const enum AutoStartPluginName {
   Debug = 'Debug'
 }
+export declare interface EnableAudioFrameEventOptions {
+  enable: boolean
+  userId: string
+  sampleRate?: number
+  channelCount?: number
+  port?: MessagePort
+}
 
 /**
  * @typedef TRTCStatistics TRTC statistics
@@ -730,6 +737,14 @@ export declare const enum AutoStartPluginName {
  * @property {number} frameRate Video frameRate
  * @property {'big'|'small'|'sub'} videoType Video type: big, small, sub.
  */
+/** enableAudioFrameEvent Options
+ * @typedef EnableAudioFrameEventOptions
+ * @property {boolean} enable Whether to enable callback of audio frame
+ * @property {string} userId The userId of the monitored user. '' indicates local microphone data, '*' indicates monitoring the audio data of all remote users.
+ * @property {number=} [sampleRate=48000] Set the sampling rate of pcm data, the default is 48000. Support 8000, 16000, 32000, 44100, 48000
+ * @property {number=} [channelCount=1] Set the number of channels of pcm data, the default is 1. Support 1, 2
+ * @property {MessagePort=} port Set the MessagePort for the pcm callback
+ */
 /**
  * **TRTC Event List**<br>
  * <br>
@@ -1191,6 +1206,7 @@ export declare interface TRTCEventTypes {
     result: {
       userId: string;
       volume: number;
+      floatVolume: number;
     }[];
   }];
   [TRTCEvent.AUDIO_FRAME]: [{
@@ -1864,7 +1880,7 @@ export declare class TRTC {
   /**
    * Used to control the playback volume of remote audio.<br>
    *
-   * - Since `v5.9.0`, iOS Safari is supported
+   * - Not supported by iOS Safari
    * @param {string} userId - Remote user ID。'*' represents all remote users.
    * @param {number} volume - Volume, ranging from 0 to 100. The default value is 100.<br>
    * Since `v5.1.3+`, the volume can be set higher than 100.
@@ -2099,18 +2115,24 @@ export declare class TRTC {
   /**
    * 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  |
+   * | APIName | name | param |
+   * | --- | --- | --- |
+   * | 'enableAudioFrameEvent' | Config the pcm data of Audio Frame Event | [EnableAudioFrameEventOptions](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/en/global.html#EnableAudioFrameEventOptions) |
    * @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>;
+   * @param {EnableAudioFrameEventOptions} options
+   * @example
+   * // Call back the pcm data of the remote user 'user_A'. The default pcm data is 48kHZ, mono
+   * await trtc.callExperimentalAPI('enableAudioFrameEvent', { enable: true, userId: 'user_A'})
+   * // Call back all remote pcm data and set the pcm data to 16kHZ, stereo
+   * await trtc.callExperimentalAPI('enableAudioFrameEvent', { enable: true, userId: '*', sampleRate: 16000, channelCount: 2 })
+   * // Set the MessagePort for the local microphone pcm data callback
+   * await trtc.callExperimentalAPI('enableAudioFrameEvent', { enable: true, userId: '', port })
+   * // Cancel callback of local microphone pcm data
+   * await trtc.callExperimentalAPI('enableAudioFrameEvent', { enable: false, userId: '' })
+   */
+  callExperimentalAPI<T extends keyof ExperimentalAPIFunctionMap, O extends ExperimentalAPIFunctionMap[T]>(name: O extends undefined ? never : T, options: O): Promise<void>;
+  callExperimentalAPI<T extends keyof ExperimentalAPIFunctionMap, O extends ExperimentalAPIFunctionMap[T]>(name: O extends undefined ? T : never): 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.11.2-beta.3",
+  "version": "5.11.2-beta.4",
   "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.11.2-beta.3",
+  "version": "5.11.2-beta.4",
   "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.11.2-beta.3",
+  "version": "5.11.2-beta.4",
   "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.11.2-beta.3",
+  "version": "5.11.2-beta.4",
   "main": "./custom-encryption.esm.js",
   "module": "./custom-encryption.esm.js",
   "types": "./custom-encryption.esm.d.ts"

package/plugins/device-detector/device-detector.esm.d.ts

@@ -9,7 +9,8 @@ export interface DeviceDetectorOptions {
   },
   cameraDetect?: {
     mirror?: boolean,
-  }
+  },
+  allowSkip?: boolean,
 }
 
 export interface DeviceDetectorResult {