@byteplus/rtc 4.36.1 → 4.38.0

package/index.d.ts

@@ -2,551 +2,571 @@
 
 import { EventArgs, EventEmitter, EventNames, ValidEventTypes } from 'eventemitter3';
 
-/**
- * @list 104477
- * @detail 104478
- */
-/** 
- * @list 104477
- * @detail 104478
- */
-export interface IAudioMixingManager {
+declare enum ErrorCode {
 	
 	/** 
-	 * Start playing audio files and mixes. <br>
-	 *         This method can be called many times by passing in different IDs and filepath to realize simultaneous playback of multiple mixing files and mixing overlay.
-	 * @param id Mix ID. For identifying the mix, please ensure that the mix ID is unique. <br>
-	 *         If this method is repeatedly called with the same ID, the previous mix stops and the next mix starts.
-	 * @param filePath  Specify the file path either the absolute path of a local file or the url of online audio.  Files with the extension of mp3 and aac are supported.
-	 * @param config  Mix Sound configuration <br>
-	 *         You can set the number of times the mix is played, whether the mix is played locally, and whether the mix is sent to the remote end. For details.
-	 * @return
-	 * @notes   <br>
-	 *        + If you have already loaded the sound effect into memory through preloadAudioMixing{@link #preloadAudioMixing}, make sure that the ID here is the same as the ID set by preloadAudioMixing{@link #preloadAudioMixing}.  <br>
-	 *        + After you start playing the audio file and mixing, you can call the stopAudioMixing{@link #stopAudioMixing} method to stop playing the audio file. <br>
-	 *        + The mixing data of this method comes from an external file, while the mixing data of enableAudioMixingFrame{@link #enableAudioMixingFrame} comes from an external cache and the audio format is PCM. These two mixing methods can coexist.
-	 * @region Advanced Feature
+	 * Invalid argument of the `engine` object for calling destroyEngine
 	 */
-	startAudioMixing(id: number, filePath: string, options: MixOption): Promise<void>;
+	INVALID_ENGINE = "INVALID_ENGINE",
 	
 	/** 
-	 * Stop playing audio files and mixes
-	 * @param id ID of the mixing
-	 * @notes   <br>
-	 *        + After calling startAudioMixing{@link #startAudioMixing} method to start playing audio files and mixes, you can call this method to stop playing audio files and mixes. <br>
-	 *        + After calling this method to stop playing the audio file, the audio file will be automatically uninstalled.
-	 * @region Advanced Feature
+	 * Invalid argument
 	 */
-	stopAudioMixing(id: number): void;
+	INVALID_PARAMS = "INVALID_PARAMS",
 	
 	/** 
-	 * Pause playing audio files and mixes
-	 * @param id  ID of the mixing
-	 * @notes   <br>
-	 *        + After calling startAudioMixing{@link #startAudioMixing} method to start playing audio files and mixes, you can call this method to pause playing audio files and mixes. <br>
-	 *        + After calling this method to pause playing audio files and mixing, you can call the resumeAudioMixing{@link #resumeAudioMixing} method to resume playing and mixing. <br>
-	 * @region Advanced Feature
+	 * Token is invalid or has expired.
 	 */
-	pauseAudioMixing(id: number): void;
+	INVALID_TOKEN = "INVALID_TOKEN",
 	
 	/** 
-	 * Resume playing audio files and mixing
-	 * @param id  Mixing ID
-	 * @notes After calling the pauseAudioMixing{@link #pauseAudioMixing} method to pause playing audio files and mixing, you can resume playing and mixing by calling this method. <br>
-	 * @region Advanced Feature
+	 * Failure of joining room
 	 */
-	resumeAudioMixing(id: number): void;
+	JOIN_ROOM_FAILED = "JOIN_ROOM_FAILED",
 	
 	/** 
-	 * Preload the specified audio file into memory
-	 * @param id Mix ID. For identifying the mix, please ensure that the mix ID is unique. <br>
-	 *         If this method is called repeatedly with the same ID, the latter overrides the previous. <br>
-	 *         If you call startAudioMixing{@link #startAudioMixing} and then call this method with the same ID, the previous mix stopped, and then the next mix was loaded. <br>
-	 *         After calling this method with an ID to preload A.mp3, if you need to call startAudioMixing{@link #startAudioMixing} to play B.mp3 with the same ID, please call unloadAudioMixing{@link #unloadAudioMixing} to uninstall A.mp3 first, otherwise you will report an error AUDIO_MIXING_ERROR_LOAD_CONFLICT.
-	 * @param filePath  Used for mixing file paths. It can be the absolute path of the local file or the url of the online audio. <br>
-	 * @return
-	 * @notes   <br>
-	 *        + When you need to play an audio file frequently, call this method to preload the file. When playing, you can only load the file once to reduce CPU usage. <br>
-	 *        + This method pre-loads the specified audio file, and only calling startAudioMixing{@link #startAudioMixing} API can you start playing the specified audio file. <br>
-	 *        + The specified audio file preloaded by calling this method can be unloaded through unloadAudioMixing{@link #unloadAudioMixing}.
-	 * @region Advanced Feature
+	 * Join the same room repeatedly.
 	 */
-	preloadAudioMixing(id: number, filePath: string): Promise<void>;
+	REPEAT_JOIN = "REPEAT_JOIN",
 	
 	/** 
-	 * Uninstall the specified audio file
-	 * @param id Mix ID
-	 * @region Advanced Feature
+	 * Publish media stream repeatedly.
 	 */
-	unloadAudioMixing(id: number): void;
+	REPEAT_PUBLISH = "REPEAT_PUBLISH",
 	
 	/** 
-	 * Adjust the volume of audio mixing, including audio files and PCM data.
-	 * @param id Mixing ID
-	 * @param volume The ratio of the mixing volume to the original volume. The range is `[0, 400]`. The recommended range is `[0, 100]`. <br>
-	 *         + 0: Mute <br>
-	 *         + 100: Original volume <br>
-	 *         + 400: Maximum volume (with overflow protection)
-	 * @region Advanced Feature
+	 * Publish before joining a room.
 	 */
-	setAudioMixingVolume(id: number, volume: number): void;
+	PUBLISH_BEFORE_JOIN = "PUBLISH_BEFORE_JOIN",
 	
 	/** 
-	 * Get volume of the audio files.
-	 * @param id Audio mix id
-	 * @return <br>
-	 *         + `0`: Failure<br>
-	 *         + `>0`: Successful. Volume<br>
-	 * @region Advanced Feature
+	 * Un-publish before joining a room.
 	 */
-	getAudioMixingVolume(id: number): number;
+	UNPUBLISH_BEFORE_JOIN = "UNPUBLISH_BEFORE_JOIN",
 	
 	/** 
-	 *   Get audio file duration
-	 * @param id   Mix ID
-	 * @return   <br>
-	 *         + > 0: Success, audio file duration, in milliseconds. <br>
-	 *         + < 0: Failure
-	 * @notes  Before calling this method to obtain the length of the audio file, you need to call preloadAudioMixing{@link #preloadAudioMixing} or startAudioMixing{@link #startAudioMixing}.
-	 * @region Advanced Feature
+	 * Subscribe before joining a room.
 	 */
-	getAudioMixingDuration(id: number): number;
+	SUBSCRIBE_BEFORE_JOIN = "SUBSCRIBE_BEFORE_JOIN",
 	
 	/** 
-	 *   Get audio file playback progress
-	 * @param id   Mix ID
-	 * @return   <br>
-	 *         + > 0: Success, audio file playback progress, in milliseconds. <br>
-	 *         + < 0: Failed
-	 * @notes Before calling this method to get the audio file playback progress, you need to call startAudioMixing{@link #startAudioMixing} to start playing the audio file.
-	 * @region Advanced Feature
+	 * Unsubscribe before joining a room.
 	 */
-	getAudioMixingCurrentPosition(id: number): number;
+	UNSUBSCRIBE_BEFORE_JOIN = "UNSUBSCRIBE_BEFORE_JOIN",
 	
 	/** 
-	 * Set the starting playback position of the audio file
-	 * @param id Mixing ID
-	 * @param position The starting playback position of the audio file in milliseconds.
-	 * @notes  <br>
-	 *       + This method allows you to play an audio file from a specified position as appropriate, without having to play an audio file in its entirety from the beginning to finish.  <br>
-	 *       + Before calling this method to set the playback position of the audio file, you need to call startAudioMixing{@link #startAudioMixing} to start playing the audio file.
-	 * @region Advanced Feature
+	 * Request to publish media stream as an invisible user.
 	 */
-	setAudioMixingPosition(id: number, position: number): void;
+	NO_PUBLISH_PERMISSION = "NO_PUBLISH_PERMISSION",
 	
 	/** 
-	 *  Start PCM mixing. <br>
-	 *        To mix multiple PCM audio data, call this API multiple times with different ids.
-	 * @param type Mixing type <br>
-	 *        Whether the PCM data is mixed locally and sent to the remotes.
-	 * @notes   <br>
-	 *        + After this API, you must call pushAudioMixingFrame{@link #pushAudioMixingFrame} to start mixing. <br>
-	 *        + To end PCM mixing, use disableAudioMixingFrame{@link #disableAudioMixingFrame}.
-	 * @region Advanced Feature
+	 * Request to subscribe or unsubscribe a stream that doesn't exist.
 	 */
-	enableAudioMixingBuffer(type: AudioMixingType): void;
+	STREAM_NOT_EXIST = "STREAM_NOT_EXIST",
 	
 	/** 
-	 * Disable PCM mixing.
-	 * @region Advanced Feature
+	 * Request to publish an empty stream.
 	 */
-	disableAudioMixingBuffer(): void;
+	EMPTY_STREAM = "EMPTY_STREAM",
 	
 	/** 
-	 * Push PCM audio frame data for mixing
-	 * @param buffer Refer to [Browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer)
-	 * @notes Before calling this method, you must start the external audio stream mixing through enableAudioMixingFrame{@link #enableAudioMixingFrame}. <br>
-	 * @region Advanced Feature
+	 * Network disconnected. RTC SDk will emit this error code if you call publish, subscribe or the other related methods while the user has not joined a room.
 	 */
-	pushAudioMixingBuffer(buffer: AudioBuffer): void;
-}
-
-/** 
- * @type keytype
- *   Mix playback channel type
- */
-export declare enum AudioMixingDualMonoMode {
+	NOT_CONNECTED_YET = "NOT_CONNECTED_YET",
 	
 	/** 
-	 *  Consistent with audio files
+	 * Request to send message before the user has joined a room.
 	 */
-	AUTO = 0,
+	IM_BEFORE_JOIN = "IM_BEFORE_JOIN",
 	
 	/** 
-	 *  Only the left channel audio in the audio file can be heard
+	 * The user does not exist.
 	 */
-	MODE_L = 1,
+	USER_NOT_EXIST = "USER_NOT_EXIST",
 	
 	/** 
-	 *  Only the right channel audio in the audio file can be heard
+	 * The user has joined the room.
 	 */
-	MODE_R = 2,
+	ALREADY_IN_ROOM = "ALREADY_IN_ROOM",
 	
 	/** 
-	 *  Can hear the left and right audio channels in the audio file at the same time
+	 * The user is kicked out because a user with the same userId joined the room.
 	 */
-	MODE_MIX = 3
-}
-
-/** 
- * @type keytype
- *  Mixing type
- */
-export declare enum AudioMixingType {
+	DUPLICATE_LOGIN = "DUPLICATE_LOGIN",
 	
 	/** 
-	 *  Played at the local device only
+	 * Enable capture repeatedly.
 	 */
-	PLAYOUT = 0,
+	REPEAT_CAPTURE = "REPEAT_CAPTURE",
 	
 	/** 
-	 *  Sent to the remote devices only
+	 * Failure of video capture
 	 */
-	PUBLISH = 1,
+	GET_VIDEO_TRACK_FAILED = "GET_VIDEO_TRACK_FAILED",
 	
 	/** 
-	 *  Played at the local device and sent to the remote devices.
+	 * Failure of getting audio track
 	 */
-	PLAYOUT_AND_PUBLISH = 2
-}
-declare enum AudioMixingState {
-	
-	AUDIO_MIXING_STATE_PRELOADED = 0,
-	
-	AUDIO_MIXING_STATE_PLAYING = 1,
+	GET_AUDIO_TRACK_FAILED = "GET_AUDIO_TRACK_FAILED",
 	
-	AUDIO_MIXING_STATE_PAUSED = 2,
+	/** 
+	 * Failure of getting screen track
+	 */
+	GET_SCREEN_TRACK_FAILED = "GET_SCREEN_TRACK_FAILED",
 	
-	AUDIO_MIXING_STATE_STOPPED = 3,
+	/** 
+	 * Stream type mismatched. RTC SDK will emit this error code when you enable the local media device after enabling the custom video module.
+	 */
+	STREAM_TYPE_NOT_MATCH = "STREAM_TYPE_NOT_MATCH",
 	
-	AUDIO_MIXING_STATE_FAILED = 4,
+	/** 
+	 * Cannot find the DOM specified to play the video.
+	 */
+	CANT_FIND_DOM = "CANT_FIND_DOM",
 	
-	AUDIO_MIXING_STATE_FINISHED = 5,
+	/** 
+	 * Invalid device ID
+	 */
+	INVALID_DEVICE_ID = "INVALID_DEVICE_ID",
 	
-	AUDIO_MIXING_STATE_PCM_ENABLED = 6,
+	/** 
+	 * No permission for capture
+	 */
+	NO_PERMISSION = "NO_PERMISSION",
 	
-	AUDIO_MIXING_STATE_PCM_DISABLED = 7
-}
-
-/** 
- * @type keytype
- *   Mixing configuration
- */
-export interface MixOption {
+	/** 
+	 * The browser does not support capture.
+	 */
+	NOT_SUPPORTED = "NOT_SUPPORTED",
 	
 	/** 
-	 *  Mix playback times
-	 * @notes   <br>
-	 *        + Play_count < = 0: Infinite loop <br>
-	 *        + Play_count == 1: Play once (default) <br>
-	 *        + Play_count > 1: Play play_count times
+	 * Failure of requesting an ICE node
 	 */
-	playCount: number;
+	ICE_SERVER_WRONG = "ICE_SERVER_WRONG",
 	
 	/** 
-	 *  For mixing playback types. Refer to [AudioMixingType](#audiomixingtype).
+	 * Failure of establishing a datachannel
 	 */
-	type?: AudioMixingType;
-}
-declare class EnhancedEventEmitter<EventTypes extends ValidEventTypes = string | symbol> extends EventEmitter<EventTypes> {
-	constructor();
-	safeEmit<T extends EventNames<EventTypes>>(event: T, ...args: EventArgs<EventTypes, T>): boolean;
-	safeEmitAsPromise(event: string, ...args: any[]): Promise<any>;
-}
-
-/** 
- * Information of media device
- */
-export interface RTCDevice {
+	ESTABLISH_DATACHANNEL_FAILED = "ESTABLISH_DATACHANNEL_FAILED",
 	
 	/** 
-	 * Device ID
-	 * Refer to the [browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
+	 * Failure of loading network resource
 	 */
-	deviceId: MediaDeviceInfo["deviceId"];
+	LOAD_RESOURCES_FAILED = "LOAD_RESOURCES_FAILED",
 	
 	/** 
-	 * Device type
-	 * Refer to the [browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
+	 * Failure of building the signal channel
 	 */
-	deviceType: MediaDeviceInfo["kind"];
+	SIGNALING_CHANNEL_NOT_OPEN = "SIGNALING_CHANNEL_NOT_OPEN",
 	
 	/** 
-	 * Device information
-	 * Refer to the [browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
+	 * Request timeout
 	 */
-	deviceInfo: MediaDeviceInfo;
+	TIME_OUT = "TIME_OUT",
 	
 	/** 
-	 * Device label
-	 * Refer to the [browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
+	 * Request is denied for the reason of network disconnected.
 	 */
-	deviceName: MediaDeviceInfo["label"];
+	REFUSE_OPERATION_IN_DISCONNECT = "REFUSE_OPERATION_IN_DISCONNECT",
 	
 	/** 
-	 * Device state
+	 * Failure of building a peer-connection to the signal server for the failure of building transceiver
 	 */
-	deviceState: "active" | "inactive";
-}
-declare enum ErrorCode {
+	ADD_TRANSCEIVER_FAILED = "ADD_TRANSCEIVER_FAILED",
 	
 	/** 
-	 * Invalid argument of the `engine` object for calling destroyEngine
+	 * Failure of updating media track
 	 */
-	INVALID_ENGINE = "INVALID_ENGINE",
+	UPDATE_TRACK_FAILED = "UPDATE_TRACK_FAILED",
 	
 	/** 
-	 * Invalid argument
+	 * Failure of publishing a media stream
 	 */
-	INVALID_PARAMS = "INVALID_PARAMS",
+	PUBLISH_FAILED = "PUBLISH_FAILED",
 	
 	/** 
-	 * Token is invalid or has expired.
+	 * Failure of un-publishing a media stream
 	 */
-	INVALID_TOKEN = "INVALID_TOKEN",
+	UNPUBLISH_FAILED = "UNPUBLISH_FAILED",
 	
 	/** 
-	 * Failure of joining room
+	 * Failure of subscribing a media stream
 	 */
-	JOIN_ROOM_FAILED = "JOIN_ROOM_FAILED",
+	SUBSCRIBE_FAILED = "SUBSCRIBE_FAILED",
 	
 	/** 
-	 * Join the same room repeatedly.
+	 * Failure of unsubscribing a media stream
 	 */
-	REPEAT_JOIN = "REPEAT_JOIN",
+	UNSUBSCRIBE_FAILED = "UNSUBSCRIBE_FAILED",
 	
 	/** 
-	 * Publish media stream repeatedly.
+	 * Call [leaveRoom](#leaveroom)Process of publishing and subscribing will
+	 * RTC SDK will emit this error code when you call the [leaveRoom](#leaveroom) during the process of publishing or subscribing.
 	 */
-	REPEAT_PUBLISH = "REPEAT_PUBLISH",
+	OPERATION_CANCEL = "OPERATION_CANCEL",
 	
 	/** 
-	 * Publish before joining a room.
+	 * Unknown error
 	 */
-	PUBLISH_BEFORE_JOIN = "PUBLISH_BEFORE_JOIN",
+	UNEXPECTED_ERROR = "UNEXPECTED_ERROR",
+	ALREADY_LOGIN = "ALREADY_LOGIN",
+	LOGIN_FAILED = "LOGIN_FAILED",
+	NOT_LOGIN = "NOT_LOGIN",
+	RTM_DUPLICATE_LOGIN = "RTM_DUPLICATE_LOGIN",
+	RTM_TOKEN_ERROR = "RTM_TOKEN_ERROR",
+	/** RTM p2p消息错误码 */
+	USER_MESSAGE_TIMEOUT = "USER_MESSAGE_TIMEOUT",
+	USER_MESSAGE_BROKEN = "USER_MESSAGE_BROKEN",
+	USER_MESSAGE_NO_RECEIVER = "USER_MESSAGE_NO_RECEIVER",
+	USER_MESSAGE_NO_RELAYPATH = "USER_MESSAGE_NO_RELAYPATH",
+	USER_MESSAGE_SEND_TO_SERVER_ERROR = "USER_MESSAGE_SEND_TO_SERVER_ERROR",
+	USER_MESSAGE_SERVER_RESPONSE_ERROR = "USER_MESSAGE_SERVER_RESPONSE_ERROR",
+	USER_MESSAGE_NOT_JOIN = "USER_MESSAGE_NOT_JOIN",
+	USER_MESSAGE_INIT = "USER_MESSAGE_INIT",
+	USER_MESSAGE_NO_CONNECTION = "USER_MESSAGE_NO_CONNECTION",
+	USER_MESSAGE_EXCEED_MAX_LENGTH = "USER_MESSAGE_EXCEED_MAX_LENGTH",
+	USER_MESSAGE_EMPTY_USER = "USER_MESSAGE_EMPTY_USER",
+	USER_MESSAGE_NOT_LOGIN = "USER_MESSAGE_NOT_LOGIN",
+	USER_MESSAGE_SERVER_PARAMS_NOTSET = "USER_MESSAGE_SERVER_PARAMS_NOTSET",
+	USER_MESSAGE_UNKNOWN = "USER_MESSAGE_UNKNOWN"
+}
+declare enum AudioMixingError {
 	
 	/** 
-	 * Un-publish before joining a room.
+	 * Normal
 	 */
-	UNPUBLISH_BEFORE_JOIN = "UNPUBLISH_BEFORE_JOIN",
+	AUDIO_MIXING_ERROR_OK = 0,
 	
 	/** 
-	 * Subscribe before joining a room.
+	 * Pre-load fails because of missing audio file or the length of the audio file exceeding 20s.
 	 */
-	SUBSCRIBE_BEFORE_JOIN = "SUBSCRIBE_BEFORE_JOIN",
+	AUDIO_MIXING_ERROR_PRELOAD_FAILED = 1,
 	
 	/** 
-	 * Unsubscribe before joining a room.
+	 * Audio mixing starts fails because of missing audio file or failure of reading the audio file.
 	 */
-	UNSUBSCRIBE_BEFORE_JOIN = "UNSUBSCRIBE_BEFORE_JOIN",
+	AUDIO_MIXING_ERROR_START_FAILED = 2,
 	
 	/** 
-	 * Request to publish media stream as an invisible user.
+	 * Invalid audio mixing ID
 	 */
-	NO_PUBLISH_PERMISSION = "NO_PUBLISH_PERMISSION",
+	AUDIO_MIXING_ERROR_ID_NOT_FOUND = 3,
 	
 	/** 
-	 * Request to subscribe or unsubscribe a stream that doesn't exist.
+	 * Invalid start position
 	 */
-	STREAM_NOT_EXIST = "STREAM_NOT_EXIST",
+	AUDIO_MIXING_ERROR_SET_POSITION_FAILED = 4,
 	
 	/** 
-	 * Request to publish an empty stream.
+	 * Invalid volume argument. The volume value ranges [0, 400].
 	 */
-	EMPTY_STREAM = "EMPTY_STREAM",
+	AUDIO_MIXING_ERROR_INVALID_VOLUME = 5,
 	
 	/** 
-	 * Network disconnected. RTC SDk will emit this error code if you call publish, subscribe or the other related methods while the user has not joined a room.
+	 * The audio file to be played does not match to the preload one. Call `unloadAudioMixing` to unload file and proceed.
 	 */
-	NOT_CONNECTED_YET = "NOT_CONNECTED_YET",
+	AUDIO_MIXING_ERROR_LOAD_CONFLICT = 6,
 	
 	/** 
-	 * Request to send message before the user has joined a room.
+	 * Type of the audio file to be played is not supported.
 	 */
-	IM_BEFORE_JOIN = "IM_BEFORE_JOIN",
+	AUDIO_MIXING_ERROR_ID_TYPE_NOT_MATCH = 7,
 	
 	/** 
-	 * The user does not exist.
+	 * Invalid audio pitch
 	 */
-	USER_NOT_EXIST = "USER_NOT_EXIST",
+	AUDIO_MIXING_ERROR_ID_TYPE_INVALID_PITCH = 8,
 	
 	/** 
-	 * The user has joined the room.
+	 * Invalid audio track
 	 */
-	ALREADY_IN_ROOM = "ALREADY_IN_ROOM",
+	AUDIO_MIXING_ERROR_INVALID_AUDIO_TRACK = 9
+}
+/**
+ * @list 104477
+ * @detail 104478
+ */
+/** 
+ * @list 104477
+ * @detail 104478
+ */
+export interface IAudioMixingManager {
 	
 	/** 
-	 * The user is kicked out because a user with the same userId joined the room.
+	 * Start playing audio files and mixes. <br>
+	 *         This method can be called many times by passing in different IDs and filepath to realize simultaneous playback of multiple mixing files and mixing overlay.
+	 * @param id Mix ID. For identifying the mix, please ensure that the mix ID is unique. <br>
+	 *         If this method is repeatedly called with the same ID, the previous mix stops and the next mix starts.
+	 * @param filePath  Specify the file path either the absolute path of a local file or the url of online audio.  Files with the extension of mp3 and aac are supported.
+	 * @param config  Mix Sound configuration <br>
+	 *         You can set the number of times the mix is played, whether the mix is played locally, and whether the mix is sent to the remote end. For details.
+	 * @return
+	 * @notes   <br>
+	 *        + If you have already loaded the sound effect into memory through preloadAudioMixing{@link #preloadAudioMixing}, make sure that the ID here is the same as the ID set by preloadAudioMixing{@link #preloadAudioMixing}.  <br>
+	 *        + After you start playing the audio file and mixing, you can call the stopAudioMixing{@link #stopAudioMixing} method to stop playing the audio file. <br>
+	 *        + The mixing data of this method comes from an external file, while the mixing data of enableAudioMixingFrame{@link #enableAudioMixingFrame} comes from an external cache and the audio format is PCM. These two mixing methods can coexist.
+	 * @region Advanced Feature
 	 */
-	DUPLICATE_LOGIN = "DUPLICATE_LOGIN",
+	startAudioMixing(id: number, filePath: string, options: MixOption): Promise<void>;
 	
 	/** 
-	 * Enable capture repeatedly.
+	 * Stop playing audio files and mixes
+	 * @param id ID of the mixing
+	 * @notes   <br>
+	 *        + After calling startAudioMixing{@link #startAudioMixing} method to start playing audio files and mixes, you can call this method to stop playing audio files and mixes. <br>
+	 *        + After calling this method to stop playing the audio file, the audio file will be automatically uninstalled.
+	 * @region Advanced Feature
 	 */
-	REPEAT_CAPTURE = "REPEAT_CAPTURE",
+	stopAudioMixing(id: number): void;
 	
 	/** 
-	 * Failure of video capture
+	 * Pause playing audio files and mixes
+	 * @param id  ID of the mixing
+	 * @notes   <br>
+	 *        + After calling startAudioMixing{@link #startAudioMixing} method to start playing audio files and mixes, you can call this method to pause playing audio files and mixes. <br>
+	 *        + After calling this method to pause playing audio files and mixing, you can call the resumeAudioMixing{@link #resumeAudioMixing} method to resume playing and mixing. <br>
+	 * @region Advanced Feature
 	 */
-	GET_VIDEO_TRACK_FAILED = "GET_VIDEO_TRACK_FAILED",
+	pauseAudioMixing(id: number): void;
 	
 	/** 
-	 * Failure of getting audio track
+	 * Resume playing audio files and mixing
+	 * @param id  Mixing ID
+	 * @notes After calling the pauseAudioMixing{@link #pauseAudioMixing} method to pause playing audio files and mixing, you can resume playing and mixing by calling this method. <br>
+	 * @region Advanced Feature
 	 */
-	GET_AUDIO_TRACK_FAILED = "GET_AUDIO_TRACK_FAILED",
+	resumeAudioMixing(id: number): void;
 	
 	/** 
-	 * Failure of getting screen track
+	 * Preload the specified audio file into memory
+	 * @param id Mix ID. For identifying the mix, please ensure that the mix ID is unique. <br>
+	 *         If this method is called repeatedly with the same ID, the latter overrides the previous. <br>
+	 *         If you call startAudioMixing{@link #startAudioMixing} and then call this method with the same ID, the previous mix stopped, and then the next mix was loaded. <br>
+	 *         After calling this method with an ID to preload A.mp3, if you need to call startAudioMixing{@link #startAudioMixing} to play B.mp3 with the same ID, please call unloadAudioMixing{@link #unloadAudioMixing} to uninstall A.mp3 first, otherwise you will report an error AUDIO_MIXING_ERROR_LOAD_CONFLICT.
+	 * @param filePath  Used for mixing file paths. It can be the absolute path of the local file or the url of the online audio. <br>
+	 * @return
+	 * @notes   <br>
+	 *        + When you need to play an audio file frequently, call this method to preload the file. When playing, you can only load the file once to reduce CPU usage. <br>
+	 *        + This method pre-loads the specified audio file, and only calling startAudioMixing{@link #startAudioMixing} API can you start playing the specified audio file. <br>
+	 *        + The specified audio file preloaded by calling this method can be unloaded through unloadAudioMixing{@link #unloadAudioMixing}.
+	 * @region Advanced Feature
 	 */
-	GET_SCREEN_TRACK_FAILED = "GET_SCREEN_TRACK_FAILED",
+	preloadAudioMixing(id: number, filePath: string): Promise<void>;
 	
 	/** 
-	 * Stream type mismatched. RTC SDK will emit this error code when you enable the local media device after enabling the custom video module.
+	 * Uninstall the specified audio file
+	 * @param id Mix ID
+	 * @region Advanced Feature
 	 */
-	STREAM_TYPE_NOT_MATCH = "STREAM_TYPE_NOT_MATCH",
+	unloadAudioMixing(id: number): void;
 	
 	/** 
-	 * Cannot find the DOM specified to play the video.
+	 * Adjust the volume of audio mixing, including audio files and PCM data.
+	 * @param id Mixing ID
+	 * @param volume The ratio of the mixing volume to the original volume. The range is `[0, 400]`. The recommended range is `[0, 100]`. <br>
+	 *         + 0: Mute <br>
+	 *         + 100: Original volume <br>
+	 *         + 400: Maximum volume (with overflow protection)
+	 * @region Advanced Feature
 	 */
-	CANT_FIND_DOM = "CANT_FIND_DOM",
+	setAudioMixingVolume(id: number, volume: number): void;
 	
 	/** 
-	 * Invalid device ID
+	 * Get volume of the audio files.
+	 * @param id Audio mix id
+	 * @return <br>
+	 *         + `0`: Failure<br>
+	 *         + `>0`: Successful. Volume<br>
+	 * @region Advanced Feature
 	 */
-	INVALID_DEVICE_ID = "INVALID_DEVICE_ID",
+	getAudioMixingVolume(id: number): number;
 	
 	/** 
-	 * No permission for capture
+	 *   Get audio file duration
+	 * @param id   Mix ID
+	 * @return   <br>
+	 *         + > 0: Success, audio file duration, in milliseconds. <br>
+	 *         + < 0: Failure
+	 * @notes  Before calling this method to obtain the length of the audio file, you need to call preloadAudioMixing{@link #preloadAudioMixing} or startAudioMixing{@link #startAudioMixing}.
+	 * @region Advanced Feature
 	 */
-	NO_PERMISSION = "NO_PERMISSION",
+	getAudioMixingDuration(id: number): number;
 	
 	/** 
-	 * The browser does not support capture.
+	 *   Get audio file playback progress
+	 * @param id   Mix ID
+	 * @return   <br>
+	 *         + > 0: Success, audio file playback progress, in milliseconds. <br>
+	 *         + < 0: Failed
+	 * @notes Before calling this method to get the audio file playback progress, you need to call startAudioMixing{@link #startAudioMixing} to start playing the audio file.
+	 * @region Advanced Feature
 	 */
-	NOT_SUPPORTED = "NOT_SUPPORTED",
+	getAudioMixingCurrentPosition(id: number): number;
 	
 	/** 
-	 * Failure of requesting an ICE node
+	 * Set the starting playback position of the audio file
+	 * @param id Mixing ID
+	 * @param position The starting playback position of the audio file in milliseconds.
+	 * @notes  <br>
+	 *       + This method allows you to play an audio file from a specified position as appropriate, without having to play an audio file in its entirety from the beginning to finish.  <br>
+	 *       + Before calling this method to set the playback position of the audio file, you need to call startAudioMixing{@link #startAudioMixing} to start playing the audio file.
+	 * @region Advanced Feature
 	 */
-	ICE_SERVER_WRONG = "ICE_SERVER_WRONG",
+	setAudioMixingPosition(id: number, position: number): void;
 	
 	/** 
-	 * Failure of establishing a datachannel
+	 *  Start PCM mixing. <br>
+	 *        To mix multiple PCM audio data, call this API multiple times with different ids.
+	 * @param type Mixing type <br>
+	 *        Whether the PCM data is mixed locally and sent to the remotes.
+	 * @notes   <br>
+	 *        + After this API, you must call pushAudioMixingFrame{@link #pushAudioMixingFrame} to start mixing. <br>
+	 *        + To end PCM mixing, use disableAudioMixingFrame{@link #disableAudioMixingFrame}.
+	 * @region Advanced Feature
 	 */
-	ESTABLISH_DATACHANNEL_FAILED = "ESTABLISH_DATACHANNEL_FAILED",
+	enableAudioMixingBuffer(type: AudioMixingType): void;
 	
 	/** 
-	 * Failure of loading network resource
+	 * Disable PCM mixing.
+	 * @region Advanced Feature
 	 */
-	LOAD_RESOURCES_FAILED = "LOAD_RESOURCES_FAILED",
+	disableAudioMixingBuffer(): void;
 	
 	/** 
-	 * Failure of building the signal channel
+	 * Push PCM audio frame data for mixing
+	 * @param buffer Refer to [Browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer)
+	 * @notes Before calling this method, you must start the external audio stream mixing through enableAudioMixingFrame{@link #enableAudioMixingFrame}. <br>
+	 * @region Advanced Feature
 	 */
-	SIGNALING_CHANNEL_NOT_OPEN = "SIGNALING_CHANNEL_NOT_OPEN",
+	pushAudioMixingBuffer(buffer: AudioBuffer): void;
+}
+
+/** 
+ * @type keytype
+ *   Mix playback channel type
+ */
+export declare enum AudioMixingDualMonoMode {
 	
 	/** 
-	 * Request timeout
+	 *  Consistent with audio files
 	 */
-	TIME_OUT = "TIME_OUT",
+	AUTO = 0,
 	
 	/** 
-	 * Request is denied for the reason of network disconnected.
+	 *  Only the left channel audio in the audio file can be heard
 	 */
-	REFUSE_OPERATION_IN_DISCONNECT = "REFUSE_OPERATION_IN_DISCONNECT",
+	MODE_L = 1,
 	
 	/** 
-	 * Failure of building a peer-connection to the signal server for the failure of building transceiver
+	 *  Only the right channel audio in the audio file can be heard
 	 */
-	ADD_TRANSCEIVER_FAILED = "ADD_TRANSCEIVER_FAILED",
+	MODE_R = 2,
 	
 	/** 
-	 * Failure of updating media track
+	 *  Can hear the left and right audio channels in the audio file at the same time
 	 */
-	UPDATE_TRACK_FAILED = "UPDATE_TRACK_FAILED",
+	MODE_MIX = 3
+}
+
+/** 
+ * @type keytype
+ *  Mixing type
+ */
+export declare enum AudioMixingType {
 	
 	/** 
-	 * Failure of publishing a media stream
+	 *  Played at the local device only
 	 */
-	PUBLISH_FAILED = "PUBLISH_FAILED",
+	PLAYOUT = 0,
 	
 	/** 
-	 * Failure of un-publishing a media stream
+	 *  Sent to the remote devices only
 	 */
-	UNPUBLISH_FAILED = "UNPUBLISH_FAILED",
+	PUBLISH = 1,
 	
 	/** 
-	 * Failure of subscribing a media stream
+	 *  Played at the local device and sent to the remote devices.
 	 */
-	SUBSCRIBE_FAILED = "SUBSCRIBE_FAILED",
+	PLAYOUT_AND_PUBLISH = 2
+}
+declare enum AudioMixingState {
 	
-	/** 
-	 * Failure of unsubscribing a media stream
-	 */
-	UNSUBSCRIBE_FAILED = "UNSUBSCRIBE_FAILED",
+	AUDIO_MIXING_STATE_PRELOADED = 0,
 	
-	/** 
-	 * Call [leaveRoom](#leaveroom)Process of publishing and subscribing will
-	 * RTC SDK will emit this error code when you call the [leaveRoom](#leaveroom) during the process of publishing or subscribing.
-	 */
-	OPERATION_CANCEL = "OPERATION_CANCEL",
+	AUDIO_MIXING_STATE_PLAYING = 1,
 	
-	/** 
-	 * Unknown error
-	 */
-	UNEXPECTED_ERROR = "UNEXPECTED_ERROR"
-}
-declare enum AudioMixingError {
+	AUDIO_MIXING_STATE_PAUSED = 2,
 	
-	/** 
-	 * Normal
-	 */
-	AUDIO_MIXING_ERROR_OK = 0,
+	AUDIO_MIXING_STATE_STOPPED = 3,
 	
-	/** 
-	 * Pre-load fails because of missing audio file or the length of the audio file exceeding 20s.
-	 */
-	AUDIO_MIXING_ERROR_PRELOAD_FAILED = 1,
+	AUDIO_MIXING_STATE_FAILED = 4,
 	
-	/** 
-	 * Audio mixing starts fails because of missing audio file or failure of reading the audio file.
-	 */
-	AUDIO_MIXING_ERROR_START_FAILED = 2,
+	AUDIO_MIXING_STATE_FINISHED = 5,
+	
+	AUDIO_MIXING_STATE_PCM_ENABLED = 6,
+	
+	AUDIO_MIXING_STATE_PCM_DISABLED = 7
+}
+
+/** 
+ * @type keytype
+ *   Mixing configuration
+ */
+export interface MixOption {
 	
 	/** 
-	 * Invalid audio mixing ID
+	 *  Mix playback times
+	 * @notes   <br>
+	 *        + Play_count < = 0: Infinite loop <br>
+	 *        + Play_count == 1: Play once (default) <br>
+	 *        + Play_count > 1: Play play_count times
 	 */
-	AUDIO_MIXING_ERROR_ID_NOT_FOUND = 3,
+	playCount: number;
 	
 	/** 
-	 * Invalid start position
+	 *  For mixing playback types. Refer to [AudioMixingType](#audiomixingtype).
 	 */
-	AUDIO_MIXING_ERROR_SET_POSITION_FAILED = 4,
+	type?: AudioMixingType;
+}
+declare class EnhancedEventEmitter<EventTypes extends ValidEventTypes = string | symbol> extends EventEmitter<EventTypes> {
+	constructor();
+	safeEmit<T extends EventNames<EventTypes>>(event: T, ...args: EventArgs<EventTypes, T>): boolean;
+	safeEmitAsPromise(event: string, ...args: any[]): Promise<any>;
+}
+
+/** 
+ * Information of media device
+ */
+export interface RTCDevice {
 	
 	/** 
-	 * Invalid volume argument. The volume value ranges [0, 400].
+	 * Device ID
+	 * Refer to the [browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
 	 */
-	AUDIO_MIXING_ERROR_INVALID_VOLUME = 5,
+	deviceId: MediaDeviceInfo["deviceId"];
 	
 	/** 
-	 * The audio file to be played does not match to the preload one. Call `unloadAudioMixing` to unload file and proceed.
+	 * Device type
+	 * Refer to the [browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
 	 */
-	AUDIO_MIXING_ERROR_LOAD_CONFLICT = 6,
+	deviceType: MediaDeviceInfo["kind"];
 	
 	/** 
-	 * Type of the audio file to be played is not supported.
+	 * Device information
+	 * Refer to the [browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
 	 */
-	AUDIO_MIXING_ERROR_ID_TYPE_NOT_MATCH = 7,
+	deviceInfo: MediaDeviceInfo;
 	
 	/** 
-	 * Invalid audio pitch
+	 * Device label
+	 * Refer to the [browser documentation](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
 	 */
-	AUDIO_MIXING_ERROR_ID_TYPE_INVALID_PITCH = 8,
+	deviceName: MediaDeviceInfo["label"];
 	
 	/** 
-	 * Invalid audio track
+	 * Device state
 	 */
-	AUDIO_MIXING_ERROR_INVALID_AUDIO_TRACK = 9
+	deviceState: "active" | "inactive";
 }
 
 /** 
@@ -1209,7 +1229,9 @@ declare enum EngineEventsTypes {
 	onLiveTranscodingResult = "onLiveTranscodingResult",
 	onSEIMessageReceived = "onSEIMessageReceived",
 	onError = "onError",
-	onAudioMixingStateChanged = "onAudioMixingStateChanged"
+	onAudioMixingStateChanged = "onAudioMixingStateChanged",
+	onUserMessageReceivedOutsideRoom = "onUserMessageReceivedOutsideRoom",
+	onUserBinaryMessageReceivedOutsideRoom = "onUserBinaryMessageReceivedOutsideRoom"
 }
 
 /** 
@@ -1601,7 +1623,7 @@ export interface IEngineEvents {
 	 * @region Room Management Event
 	 */
 	[EngineEventsTypes.onError]: (event: {
-		errorCode: ErrorCode.DUPLICATE_LOGIN;
+		errorCode: ErrorCode.DUPLICATE_LOGIN | ErrorCode.RTM_DUPLICATE_LOGIN | ErrorCode.RTM_TOKEN_ERROR;
 	}) => void;
 	
 	/** 
@@ -1610,6 +1632,8 @@ export interface IEngineEvents {
 	 * @region Advanced Feature
 	 */
 	[EngineEventsTypes.onAudioMixingStateChanged]: (event: AudioMixingStateChangedEvent) => void;
+	[EngineEventsTypes.onUserMessageReceivedOutsideRoom]: (event: UserMessageEvent) => void;
+	[EngineEventsTypes.onUserBinaryMessageReceivedOutsideRoom]: (event: UserBinaryMessageEvent) => void;
 }
 
 /** 
@@ -2125,6 +2149,15 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @region Video Management
 	 */
 	setVideoCaptureConfig(config: TrackCaptureConfig): Promise<void>;
+	login(token: string | null, userId: string): Promise<void>;
+	logout(): Promise<void>;
+	updateLoginToken(token: string | null): Promise<void>;
+	getPeerOnlineStatus(userId: string): Promise<USER_ONLINE_STATUS>;
+	sendUserMessageOutsideRoom(userId: string, message: string): Promise<any>;
+	sendUserBinaryMessageOutsideRoom(userId: string, message: ArrayBuffer): Promise<any>;
+	setServerParams(signature: string, url: string): Promise<any>;
+	sendServerMessage(message: string): Promise<any>;
+	sendServerBinaryMessage(message: ArrayBuffer): Promise<any>;
 }
 
 /** 
@@ -2741,7 +2774,7 @@ export interface LiveTranscodeAudioConfig {
 	/** 
 	 * The AAC profile to be set
 	 */
-	AACProfile?: "LC" | "MAIN" | "HEv1" | "HEv2";
+	AACProfile?: "LC" | "HEv1" | "HEv2";
 }
 
 /** 
@@ -2852,6 +2885,11 @@ export interface RemoteStreamKey {
 	 */
 	streamIndex: StreamIndex;
 }
+export declare enum USER_ONLINE_STATUS {
+	OFFLINE = 0,
+	ONLINE = 1,
+	UNREACHABLE = 2
+}
 
 /** 
  * Point-to-point text message
@@ -3004,7 +3042,7 @@ export interface IVERTC {
 	 *         - `False`: Not Supported
 	 * @region Engine Management
 	 */
-	isSupported: () => boolean;
+	isSupported: () => Promise<boolean>;
 }
 declare class VERTC implements IVERTC {
 	getSdkVersion: () => string;
@@ -3023,7 +3061,7 @@ declare class VERTC implements IVERTC {
 	getAudioPlayback: () => Promise<RTCDevice[]>;
 	getParameter: typeof getParameter;
 	setParameter: typeof setParameter;
-	isSupported: () => boolean;
+	isSupported: () => Promise<boolean>;
 	events: typeof EngineEventsTypes;
 	ErrorCode: typeof ErrorCode;
 	platform: string;