trtc-sdk-v5 5.10.2-wasm.2 → 5.10.2-wasm.3

package/index.d.ts

@@ -6,9 +6,11 @@ import { Beauty, BeautyOptions, UpdateBeautyOptions } from './plugins/video-effe
 import { BasicBeauty, BasicBeautyOptions } from './plugins/video-effect/basic-beauty';
 import { CrossRoom, StartCrossRoomOption, UpdateCrossRoomOption, StopCrossRoomOption } from './plugins/cross-room';
 import { CustomEncryption, EncryptionOptions } from './plugins/custom-encryption';
+import { VideoMixerOptions, VideoMixer} from './plugins/video-effect/video-mixer'
+import { SmallStreamAutoSwitcher, SmallStreamAutoSwitcherOptions } from './plugins/small-stream-auto-switcher';
 
-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 { 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'
 }
@@ -18,18 +20,22 @@ export declare type PluginStartOptionsMap = {
   'CDNStreaming': CDNStreamingOptions;
   'VirtualBackground': VirtualBackgroundOptions;
   'Watermark': WatermarkOptions;
+  'VideoMixer': VideoMixerOptions;
   'Beauty': BeautyOptions;
   'BasicBeauty': BasicBeautyOptions;
   'DeviceDetector': DeviceDetectorOptions;
   'Debug': undefined;
   'CrossRoom': StartCrossRoomOption;
   'CustomEncryption': EncryptionOptions;
+  'SmallStreamAutoSwitcher': SmallStreamAutoSwitcherOptions;
 };
 
 export declare type PluginUpdateOptionsMap = {
   'AudioMixer': UpdateAudioMixerOptions;
   'CDNStreaming': CDNStreamingOptions;
   'VirtualBackground': UpdateVirtualBackgroundOptions;
+  'Watermark': WatermarkOptions;
+  'VideoMixer': VideoMixerOptions;
   'Beauty': UpdateBeautyOptions;
   'BasicBeauty': BasicBeautyOptions;
   'CrossRoom': UpdateCrossRoomOption;
@@ -41,11 +47,13 @@ export declare type PluginStopOptionsMap = {
   'CDNStreaming': CDNStreamingOptions;
   'VirtualBackground': undefined;
   'Watermark': undefined;
+  'VideoMixer': undefined;
   'Beauty': undefined;
   'BasicBeauty': undefined;
   'DeviceDetector': undefined;
   'Debug': undefined;
   'CrossRoom': StopCrossRoomOption | undefined;
+  'SmallStreamAutoSwitcher': undefined;
 };
 
 export declare class RtcError extends Error implements RTCErrorInterface {
@@ -327,6 +335,7 @@ export declare interface LocalVideoConfig {
     qosPreference?: typeof TRTCType.QOS_PREFERENCE_SMOOTH | typeof TRTCType.QOS_PREFERENCE_CLEAR;
     videoTrack?: MediaStreamTrack;
     avoidCropping?: boolean;
+    rotation?: 0 | 90 | 180 | 270;
   };
 }
 export interface TurnServerOptions {
@@ -368,6 +377,13 @@ 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;
@@ -1137,6 +1153,7 @@ export declare interface TRTCEventTypes {
   [TRTCEvent.ERROR]: [RtcError];
   [TRTCEvent.AUTOPLAY_FAILED]: [{
     userId: string;
+    mediaType: 'audio' | 'video' | 'screen';
     resume: () => Promise<void>;
   }];
   [TRTCEvent.KICKED_OUT]: [{
@@ -1232,6 +1249,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();
@@ -1367,27 +1392,61 @@ 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>;
-  /**
-   * 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.
-   *
+		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 {number=} options.roomId
+   * the value must be an integer between 1 and 4294967294<br>
+   * <font color="red">Note: <br>1. The room to be switched and the current room must be of the same room type (both digital rooms or string rooms)<br> 2. Either roomId or strRoomId must be filled in. If both are filled in, roomId is preferred. </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 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
+   * @param {string} options.userSig UserSig signature <br>
+   * Please refer to [UserSig related](https://trtc.io/document/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 {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}
    * @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
-   */
+   * const trtc = TRTC.create();
+   * await trtc.enterRoom({
+   *    ...
+   *    roomId: 8888,
+   *    scene: TRTC.TYPE.SCENE_LIVE,
+   *    role: TRTC.TYPE.ROLE_AUDIENCE
+   * });
+   * 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
+	 */
   destroy(): void;
   /**
    * Start collecting audio from the local microphone and publish it to the current room.
@@ -1521,6 +1580,7 @@ export declare class TRTC {
    * @param {string | VideoProfile} [config.option.profile] - Video encoding parameters for the main video.
    * @param {string | boolean | VideoProfile} [config.option.small] - Video encoding parameters for the small video. Refer to {@tutorial 27-advanced-small-stream}
    * @param {QOS_PREFERENCE_SMOOTH|QOS_PREFERENCE_CLEAR} [config.option.qosPreference] - Set the video encoding strategy for weak networks. Smooth first(default) ({@link module:TYPE.QOS_PREFERENCE_SMOOTH QOS_PREFERENCE_SMOOTH}) or Clear first ({@link module:TYPE.QOS_PREFERENCE_CLEAR QOS_ PREFERENCE_SMOOTH})
+   * @param {0 | 90 | 180 | 270} [config.option.rotation] - Set the clockwise rotation angle of the local camera when publishing. Supports 90, 180, and 270
    * @throws
    * - {@link module:ERROR_CODE.ENV_NOT_SUPPORTED ENV_NOT_SUPPORTED}
    * - {@link module:ERROR_CODE.INVALID_PARAMETER INVALID_PARAMETER}
@@ -1583,6 +1643,7 @@ export declare class TRTC {
    * @param {string | VideoProfile} [config.option.profile] - Video encoding parameters for the main stream
    * @param {string | boolean | VideoProfile} [config.option.small] - Video encoding parameters for the small video. Refer to {@tutorial 27-advanced-small-stream}
    * @param {QOS_PREFERENCE_SMOOTH|QOS_PREFERENCE_CLEAR} [config.option.qosPreference] - Set the video encoding strategy for weak networks. Smooth first ({@link module:TYPE.QOS_PREFERENCE_SMOOTH QOS_PREFERENCE_SMOOTH}) or Clear first ({@link module:TYPE.QOS_PREFERENCE_CLEAR QOS_ PREFERENCE_SMOOTH})
+   * @param {0 | 90 | 180 | 270} [config.option.rotation] - Set the clockwise rotation angle of the local camera when publishing. Supports 90, 180, and 270
    * @throws
    * - {@link module:ERROR_CODE.INVALID_PARAMETER INVALID_PARAMETER}
    * - {@link module:ERROR_CODE.DEVICE_ERROR DEVICE_ERROR}
@@ -1901,7 +1962,7 @@ export declare class TRTC {
    * @param {STREAM_TYPE_MAIN|STREAM_TYPE_SUB} [config.streamType] - stream type:
    * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: Main stream (user's camera)(default)
    * - {@link module:TYPE.STREAM_TYPE_SUB TRTC.TYPE.STREAM_TYPE_SUB}: Sub stream (user's screen sharing)
-   * @param {boolean} [config.processed=false] - Whether to get the processed videoTrack. The processed videoTrack is the videoTrack after the SDK processes the video frame, such as virtual background, mirror, watermark. The default value is false.
+   * @param {boolean} [config.processed=false] - Whether to get the processed videoTrack. The processed videoTrack is the videoTrack after the SDK processes the video frame, such as virtual background, mirror, watermark, rotation. The default value is false.
    * @returns {MediaStreamTrack|null} Video track
    * @memberof TRTC
    * @example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-sdk-v5",
-  "version": "5.10.2-wasm.2",
+  "version": "5.10.2-wasm.3",
   "description": "Tencent Cloud RTC SDK for Web",
   "module": "trtc.esm.js",
   "type": "module",

package/plugins/cdn-streaming/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/cdn-streaming",
-  "version": "5.10.2-wasm.2",
+  "version": "5.10.2-wasm.3",
   "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-wasm.2",
+  "version": "5.10.2-wasm.3",
   "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-wasm.2",
+  "version": "5.10.2-wasm.3",
   "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-wasm.2",
+  "version": "5.10.2-wasm.3",
   "description": "TRTC Web SDK 5.x device detector plugin",
   "main": "./device-detector.esm.js",
   "module": "./device-detector.esm.js",

package/plugins/small-stream-auto-switcher/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@rtc-plugin/small-stream-auto-switcher",
+  "version": "5.10.2-wasm.3",
+  "description": "",
+  "main": "./small-stream-auto-switcher.esm.js",
+  "keywords": [],
+  "module": "./small-stream-auto-switcher.esm.js",
+  "types": "./small-stream-auto-switcher.esm.d.ts"
+}

package/plugins/small-stream-auto-switcher/small-stream-auto-switcher.esm.d.ts

@@ -0,0 +1,19 @@
+
+export interface SmallStreamAutoSwitcherOptions {
+  rttPoorLimit?: number;
+  lossPoorLimit?: number;
+  poorDuration?: number;
+  rttGoodLimit?: number;
+  lossGoodLimit?: number;
+  goodDuration?: number;
+  sleepTime?: number;
+  maxAutoSwitchToSmallCount?: number;
+}
+
+export declare class SmallStreamAutoSwitcher {
+  start(options: SmallStreamAutoSwitcherOptions): Promise<void>;
+  update(options: SmallStreamAutoSwitcherOptions): Promise<void>;
+  stop(): Promise<void>;
+}
+
+export default SmallStreamAutoSwitcher;