@byteplus/rtc 4.58.3 → 4.60.0

package/index.d.ts

@@ -60,6 +60,7 @@ declare const Config: {
 	VIDEO_STALL_DATA: number;
 	AUDIO_STALL_DATA: number;
 	IOS_SAFARI_ORIENTATION: boolean;
+	BLACK_FRAME_LIFETIME: number;
 };
 declare const _default: VERTC;
 declare enum AudioMixingError {
@@ -329,6 +330,10 @@ declare enum EngineEventsTypes {
 	onUserMessageReceivedOutsideRoom = "onUserMessageReceivedOutsideRoom",
 	onUserBinaryMessageReceivedOutsideRoom = "onUserBinaryMessageReceivedOutsideRoom",
 	onTokenWillExpire = "onTokenWillExpire",
+	onTokenPublishPrivilegeWillExpire = "onTokenPublishPrivilegeWillExpire",
+	onTokenPublishPrivilegeDidExpired = "onTokenPublishPrivilegeDidExpired",
+	onTokenSubscribePrivilegeWillExpire = "onTokenSubscribePrivilegeWillExpire",
+	onTokenSubscribePrivilegeDidExpired = "onTokenSubscribePrivilegeDidExpired",
 	onCloudProxyConnected = "onCloudProxyConnected",
 	onPushPublicStreamResult = "onPushPublicStreamResult",
 	onPublicStreamSEIMessageReceived = "onPublicStreamSEIMessageReceived",
@@ -349,7 +354,8 @@ declare enum EngineEventsTypes {
 	onPublishRetry = "onPublishRetry",
 	onSubscribeRetry = "onSubscribeRetry",
 	onPublishResult = "onPublishResult",
-	onSubscribeResult = "onSubscribeResult"
+	onSubscribeResult = "onSubscribeResult",
+	onSEIStreamUpdate = "onSEIStreamUpdate"
 }
 declare enum ErrorCode {
 	
@@ -359,7 +365,7 @@ declare enum ErrorCode {
 	INVALID_ENGINE = "INVALID_ENGINE",
 	
 	/** 
-	 * @brief Generally used error code in the majority of features.. Triggered when you call any API with invalid parameters. Please refer to the API documentation and pass in the correct parameters.
+	 * @brief Generally used error code. Triggered when you call any API with invalid parameters. Please refer to the API documentation and pass in the correct parameters.
 	 */
 	INVALID_PARAMS = "INVALID_PARAMS",
 	
@@ -488,6 +494,16 @@ declare enum ErrorCode {
 	 */
 	TOKEN_EXPIRED = "TOKEN_EXPIRED",
 	
+	/** 
+	 * @brief Token expired. Call `updateToken` to update publishing permission with the new token.
+	 */
+	TOKEN_NO_PUBLISH_PERMISSION = "TOKEN_NO_PUBLISH_PERMISSION",
+	
+	/** 
+	 * @brief Token expired. Call `updateToken` to update subscription permission with the new token.
+	 */
+	TOKEN_NO_SUBSCRIBE_PERMISSION = "TOKEN_NO_SUBSCRIBE_PERMISSION",
+	
 	/** 
 	 * @brief The user has been removed from the room because the same user joined the room on the other client. Triggered through the `onError` callback.
 	 */
@@ -543,7 +559,8 @@ declare enum ErrorCode {
 	 * @brief Operation not supported. Triggered when you call `startAudioDeviceRecordTest` or `setAudioPlaybackDevice` if the browser does not support audio device test or audio capture.
 	 */
 	NOT_SUPPORTED = "NOT_SUPPORTED",
-	/**
+	
+	/** 
 	 * @hidden no use
 	 */
 	INTERRUPT = "INTERRUPT",
@@ -804,6 +821,20 @@ declare enum ErrorCode {
 	 */
 	USER_FORBIDDEN = "USER_FORBIDDEN"
 }
+declare enum SEIStreamEventType {
+	
+	/** 
+	 * @brief A black frame video stream is published from the remote user.
+	 *        In the voice call scenario, when a remote user sends SEI data by calling [sendSEIMessage](104478#sendseimessage), the SDK will publish a black frame video stream and trigger this callback.
+	 */
+	BLACK = 0,
+	
+	/** 
+	 * @brief The black frame video stream is removed. The triggers for this callback include:
+	 *        <ul><li> When the remote user starts camera capture, switching from voice call to video call, the black frame video stream stops publishing. </li><li> When the remote user calls [setVideoSourceType](104478#setvideosourcetype) to switch to custom video capture, black frame video stream stops publishing. </li><li> If no SEI data is sent within 1 minute after the remote user calls [sendSEIMessage](104478#sendseimessage), the black frame video stream stops publishing. </li></ul>
+	 */
+	NORMAL = 1
+}
 declare enum StreamMixingEventErrorCode {
 	
 	/** 
@@ -1024,6 +1055,22 @@ export declare enum AudioReportMode {
 	AUDIOMIXING = 1
 }
 
+/** 
+ * @brief User priority in the audio selection
+ */
+export declare enum AudioSelectionPriority {
+	
+	/** 
+	 * @brief Normal whether the stream can be subscribed is determined by the result of audio selection.
+	 */
+	DEFAULT = 0,
+	
+	/** 
+	 * @brief Hight priority with which the stream can skip the audio selection and always be subscribable.
+	 */
+	HIGH = 1
+}
+
 /** 
  * @brief Audio source type
  */
@@ -1111,7 +1158,8 @@ export declare enum FallbackOrRecoverReason {
 }
 
 /** 
- * @brief Forward stream error code.
+ * @detail errorcode
+ * @brief Forward stream error code. Returned through the [onForwardStreamError]({{callback}}#onForwardStreamError) callback.
  */
 export declare enum ForwardStreamError {
 	
@@ -1452,7 +1500,6 @@ export declare enum StreamIndex {
 
 /** 
  * @brief The reason for the removal of the remote stream in the room.
- *
  */
 export declare enum StreamRemoveReason {
 	
@@ -1484,7 +1531,12 @@ export declare enum StreamRemoveReason {
 	/** 
 	 * @brief Other reasons.
 	 */
-	STREAM_REMOVE_REASON_OTHER = 5
+	STREAM_REMOVE_REASON_OTHER = 5,
+	
+	/** 
+	 * @brief token lose publish priviledge.
+	 */
+	STREAM_REMOVE_REASON_TOKEN_PRIVILEGE_EXPIRED = 6
 }
 
 /** 
@@ -1965,7 +2017,7 @@ export interface IAudioMixingManager {
 	 * @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.
 	 *         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
+	 * @return `LOAD_RESOURCES_FAILED`: Loading resource failed. Please pass in the correct resource path.
 	 * @notes + If you have already loaded the sound effect into memory through [preloadAudioMixing](#preloadaudiomixing), make sure that the ID here is the same as the ID set by [preloadAudioMixing](#preloadaudiomixing).
 	 *        + After you start playing the audio file and mixing, you can call the [stopAudioMixing](#stopaudiomixing) method to stop playing the audio file.
 	 *        + The mixing data of this method comes from an external file, while the mixing data of [enableAudioMixingBuffer](#enableaudiomixingbuffer) comes from an external cache and the audio format is PCM. These two mixing methods can coexist.
@@ -2010,7 +2062,7 @@ export interface IAudioMixingManager {
 	 *         If you call [startAudioMixing](#startaudiomixing) and then call this method with the same ID, the previous mix stopped, and then the next mix was loaded.
 	 *         After calling this method with an ID to preload A.mp3, if you need to call [startAudioMixing](#startaudiomixing) to play B.mp3 with the same ID, please call [unloadAudioMixing](#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.
-	 * @return
+	 * @return `LOAD_RESOURCES_FAILED`: Loading resource failed. Please pass in the correct resource path.
 	 * @notes + 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.
 	 *        + This method pre-loads the specified audio file, and only calling [startAudioMixing](#startaudiomixing) API can you start playing the specified audio file.
 	 *        + The specified audio file preloaded by calling this method can be unloaded through [unloadAudioMixing](#unloadaudiomixing).
@@ -2429,7 +2481,6 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onLocalStreamStats]: (stats: LocalStreamStats) => void;
 	
 	/** 
-	 * @hidden
 	 * @brief This 2 s periodical callback notifies information of the public stream after calling [startPlayPublicStream](104478#startplaypublicstream).
 	 * @param stats
 	 * @group Public Stream
@@ -2550,6 +2601,16 @@ export interface IEngineEvents {
 	 */
 	[EngineEventsTypes.onSEIMessageReceived]: (event: onSEIMessageEvent) => void;
 	
+	/** 
+	 * @brief Stream update event of stream that contains SEI information.
+	 *        In a voice call scenario, when a remote user calls [sendSEIMessage](104478#sendseimessage) to send SEI data via the black frame video stream, the stream's sending status will be notified to the local user through this event callback.
+	 *        If the video frame carrying SEI data is a black frame, you do not need to render the video frame.
+	 * @param event Stream containing SEI information update event.
+	 * @group Message
+	 * @order 61
+	 */
+	[EngineEventsTypes.onSEIStreamUpdate]: (event: onSEIStreamUpdateEvent) => void;
+	
 	/** 
 	 * @brief Result of the Auto-Subscription
 	 * @param event
@@ -2655,13 +2716,68 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onUserBinaryMessageReceivedOutsideRoom]: (event: UserBinaryMessageEvent) => void;
 	
 	/** 
-	 * @brief You will receive this callback 30 s before the Token expires.
-	 * Call [updateToken](104478#updatetoken) to submit a new Token。The user will be removed from the room when the Token expires.
+	 * @brief You will receive this callback 30 seconds before the Token expires.
+	 *        Call [updateToken](104478#updatetoken) to submit a new Token. The user will be removed from the room when the Token expires.
 	 * @group Room Management
 	 * @order 45
 	 */
 	[EngineEventsTypes.onTokenWillExpire]: () => void;
 	
+	/** 
+	 * @brief This callback will be triggered 30 seconds before the token publishing permission expires.
+	 *        Upon receiving this callback, call [updateToken](104478#updatetoken) to update the token.
+	 * @notes If the Token is not updated in time, the publishing permission will expire and the stream that is being published will stop. The publisher will receive the [onTokenPublishPrivilegeDidExpired](104479#ontokenpublishprivilegedidexpired) callback, and the remote user will receive the [onUserUnpublishStream](104479#onuserunpublishstream)/[onUserUnpublishScreen](104479#onuserunpublishscreen) callback, with the reason being `STREAM_REMOVE_REASON_TOKEN_PRIVILEGE_EXPIRED`.
+	 * @group Room Management
+	 * @order 50
+	 */
+	[EngineEventsTypes.onTokenPublishPrivilegeWillExpire]: () => void;
+	
+	/** 
+	 * @brief This callback is triggered when the token publishing permission expires. Call [updateToken](104478#updatetoken) to update the Token.
+	 * @group Room Management
+	 * @order 51
+	 */
+	[EngineEventsTypes.onTokenPublishPrivilegeDidExpired]: (e: {
+		
+		/** 
+		 * @brief The `TOKEN_NO_PUBLISH_PERMISSION` error code.
+		 */
+		errorCode?: ErrorCode;
+		
+		/** 
+		 * @brief Error message.
+		 */
+		message?: String;
+	}) => void;
+	
+	/** 
+	 * @brief This callback will be triggered 30 seconds before the token subscription permission expires.
+	 *        Upon receiving this callback, call [updateToken](104478#updatetoken) to update the token.
+	 * @notes If the Token is not updated in time after receiving this callback, the streams that have been subscribed to will be unsubscribed once the token subscription permission expires, and the subscriber will receive the [onTokenSubscribePrivilegeDidExpired](104479#ontokensubscribeprivilegedidexpired) callback.
+	 *        Also, attempts to subscribe to new streams will fail, returning an error code `TOKEN_NO_SUBSCRIBE_PERMISSION`, indicating that the token subscription permission has expired.
+	 * @group Room Management
+	 * @order 55
+	 */
+	[EngineEventsTypes.onTokenSubscribePrivilegeWillExpire]: () => void;
+	
+	/** 
+	 * @brief This callback is triggered when the token subscription permission expires. Call [updateToken](104478#updatetoken) to update the Token.
+	 * @group Room Management
+	 * @order 56
+	 */
+	[EngineEventsTypes.onTokenSubscribePrivilegeDidExpired]: (e: {
+		
+		/** 
+		 * @brief The `TOKEN_NO_SUBSCRIBE_PERMISSION` error code.
+		 */
+		errorCode?: ErrorCode;
+		
+		/** 
+		 * @brief Error message.
+		 */
+		message?: String;
+	}) => void;
+	
 	/** 
 	 * @brief Receives the callback when you call [startCloudProxy](104478#startcloudproxy) to start cloud proxy, and the SDK connects the proxy server successfully.
 	 * @param event
@@ -2669,7 +2785,6 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onCloudProxyConnected]: (event: CloudProxyConnectedEvent) => void;
 	
 	/** 
-	 * @hidden
 	 * @brief Callback of the result of publishing the public stream.
 	 *        After calling [startPushPublicStream](104478#startpushpublicstream), you will be informed of the result through this callback.
 	 * @param event
@@ -2679,7 +2794,6 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onPushPublicStreamResult]: (event: PublicStreamResultEvent) => void;
 	
 	/** 
-	 * @hidden
 	 * @brief Callback of the SEI carried by the public video stream.
 	 *        You will receive SEI by this callback if the public stream you subscribed to by calling [startPlayPublicStream](104478#startplaypublicstream) is carrying SEI.
 	 * @param event
@@ -2692,7 +2806,6 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onPublicStreamSEIMessageReceived]: (event: PublicStreamSEIMessageEvent) => void;
 	
 	/** 
-	 * @hidden
 	 * @brief Callback of the successful decoding of the first video frame of the public stream.
 	 *        Refer to [startPlayPublicStream](104478#startplaypublicstream) for details about subscribing to a public stream.
 	 * @param event
@@ -2702,7 +2815,6 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onFirstPublicStreamVideoFrameDecoded]: (event: PublicStreamVideoFirstFrameDecodedEvent) => void;
 	
 	/** 
-	 * @hidden
 	 * @brief Callback of the successful decoding of the first audio frame of the public stream.
 	 *        Refer to [startPlayPublicStream](104478#startplaypublicstream) for details about subscribing to a public stream.
 	 * @param event
@@ -2712,7 +2824,6 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onFirstPublicStreamAudioFrameDecoded]: (event: PublicStreamAudioFirstFrameDecodedEvent) => void;
 	
 	/** 
-	 * @hidden
 	 * @brief Callback of the successful rendering of the first video frame of the public stream.
 	 *         Refer to [startPlayPublicStream](104478#startplaypublicstream) for details about subscribing to a public stream.
 	 * @param event
@@ -2909,12 +3020,18 @@ export interface IEngineEvents {
 		screen: boolean;
 	}) => void;
 	
+	/** 
+	 * @hidden
+	 */
 	[EngineEventsTypes.onPublishResult]: (e: {
 		isScreen: boolean;
 		isAutoPublish: boolean;
 		errorCode?: ErrorCode;
 	}) => void;
 	
+	/** 
+	 * @hidden
+	 */
 	[EngineEventsTypes.onSubscribeResult]: (e: {
 		userId: string;
 		isScreen: boolean;
@@ -2945,8 +3062,11 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param roomId  The Room ID. The string must conform to the regular expression: `[a-zA-Z0-9_@\-\.]{1,128}`.
 	 * @param userInfo  User information.
 	 * @param roomConfig  Room parameter configuration, set the room mode and whether to automatically publish or subscribe to the flow.
-	 * @return The error code `ErrorCode.ROOM_FORBIDDEN` indicates that the user failed to enter the room because the room has been banned.
-	 *         The error code `ErrorCode.USER_FORBIDDEN` indicates that the user failed to enter the room because the user has been banned.
+	 * @return + `INVALID_TOKEN`: Failed to enter the room due to using an expired or invalid token.
+	 *         + `JOIN_ROOM_FAILED`: Failed to enter the room. Please refer to the corresponding message for specific reasons.
+	 *         + `REPEAT_JOIN`: Join the same room repeatedly.
+	 *         + `ROOM_FORBIDDEN`: Failed to enter the room because the room has been banned.
+	 *         + `USER_FORBIDDEN`: Failed to enter the room because the user has been banned.
 	 * @notes + In the same room with the same App ID, the user ID of each user must be unique. The user will be kicked out of the room when a user with the same userID joins the room because of the error of `DUPLICATE_LOGIN`.
 	 *        + Remote users will receive [onUserJoined](104479#onuserjoined) callback when a visible user joins the room. Call [setUserVisibility](#setuservisibility) to switch the visibility of the user.
 	 *        + By default, the user is visible in an RTC room. Joining fails when the number of users in an RTC room reaches the upper limit. To avoid this, call [setUserVisibility](#setuservisibility) to change the visibility of the audience users to false by considering the capacity for the invisible users is much larger than that for visible users. An RTC room can accommodate a maximum of 50 visible users, and 30 media streams can be published simultaneously. For more information, see [Room Capability](257549).
@@ -2983,6 +3103,9 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        + Call [publishScreen](#publishscreen) to start screen sharing.
 	 *        + After you call this API, the other users in the room will receive [onUserPublishStream](104479#onuserpublishstream).
 	 *        + Call [unpublishStream](#unpublishstream) to stop publishing streams.
+	 * @return + `NO_PUBLISH_PERMISSION`: No permission to publish streams. Please call [setUserVisibility](#setuservisibility) to switch the user to be visible first.
+	 *         + `TOKEN_NO_PUBLISH_PERMISSION`: The Token has no publishing permission or the publishing permission has expired, call [updateToke](#updatetoken) to update the Token's publishing permission.
+	 *         + `PUBLISH_FAILED`: Failed to publish a stream. Please check the returned message for the specific reason.
 	 * @group Audio & Video Transport
 	 * @order 0
 	 */
@@ -3004,6 +3127,9 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @notes + An invisible user cannot publish media streams. Call [setUserVisibility](#setuservisibility) to change your visibility in the room.
 	 *        + After you called this API, the other users in the room will receive [onUserPublishScreen](104479#onuserpublishscreen).
 	 *        + Call [unpublishScreen](#unpublishscreen) to stop publishing screen sharing streams.
+	 * @return + `NO_PUBLISH_PERMISSION`: No permission to publish streams. Please call [setUserVisibility](#setuservisibility) to switch the user to be visible first.
+	 *         + `TOKEN_NO_PUBLISH_PERMISSION`: The Token has no publishing permission or the publishing permission has expired, call [updateToke](#updatetoken) to update the Token's publishing permission.
+	 *         + `PUBLISH_FAILED`: Failed to publish a stream. Please check the returned message for the specific reason.
 	 * @group Screen Sharing
 	 * @order 10
 	 */
@@ -3024,8 +3150,9 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        You can call this API in both automatic subscription mode and manual subscription mode.
 	 * @param userId The ID of the remote user who published the target audio/video stream.
 	 * @param mediaType Media stream type, used for specifying whether to subscribe to the audio stream or the video stream.
-	 * @notes You must first get the remote stream
-	 * information through [onUserPublishStream](104479#onuserpublishstream) before calling this API to subscribe to streams accordingly.
+	 * @notes You must first get the remote stream information through [onUserPublishStream](104479#onuserpublishstream) before calling this API to subscribe to streams accordingly.
+	 * @return + `STREAM_NOT_EXIST`: The target stream does not exist. Please enter the correct ID or make sure that the target stream is in the room.
+	 *         + `TOKEN_NO_SUBSCRIBE_PERMISSION`: The Token has no subscription permission or the subscription permission has expired, call [updateToke](#updatetoken) to update the Token's subscription permission.
 	 * @group Audio & Video Transport
 	 * @order 5
 	 */
@@ -3036,6 +3163,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        You can call this API in both automatic subscription mode and manual subscription mode.
 	 * @param userId The ID of the remote user who published the target audio/video stream.
 	 * @param mediaType Media stream type, used for specifying whether to unsubscribe from the audio stream or the video stream.
+	 * @return `STREAM_NOT_EXIST`: The target stream does not exist. Please enter the correct ID or make sure that the target stream is in the room.
 	 * @group Audio & Video Transport
 	 * @order 6
 	 */
@@ -3047,6 +3175,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param userId The ID of the remote user who published the target screen audio/video stream.
 	 * @param mediaType Media stream type, used for specifying whether to subscribe to the audio stream or the video stream.
 	 * @notes You must first get the remote stream information through [onUserPublishScreen](104479#onuserpublishscreen) before calling this API to subscribe to streams accordingly.
+	 * @return + `STREAM_NOT_EXIST`: The target stream does not exist. Please enter the correct ID or make sure that the target stream is in the room.
+	 *         + `TOKEN_NO_SUBSCRIBE_PERMISSION`: The Token has no subscription permission or the subscription permission has expired, call [updateToke](#updatetoken) to update the Token's subscription permission.
 	 * @group Screen Sharing
 	 * @order 15
 	 */
@@ -3064,15 +3194,17 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	
 	/** 
 	 * @brief Update Token.
-	 * You will receive [onTokenWillExpire](104479#ontokenwillexpire) 30 s before the Token expires. Call this API to submit a new Token.
+	 *        You will receive [onTokenWillExpire](104479#ontokenwillexpire) 30 s before the Token expires. Call this API to submit a new Token.
 	 * @param token A valid token.
 	 * @notes + If you call [joinRoom](#joinroom) with an expired token, the joining will fail with an error code `INVALID_TOKEN`. And you need to obtain a valid token and call this API to update the token.
 	 *      + If joining a room failed because the token expired, call this API with an updated token. And then RTC SDK will automatically rejoin the room without calling [joinRoom](#joinroom) again.
 	 *      + The user will be removed from the room when the Token expires.
+	 * @return + `UPDATE_TOKEN_WITH_INVALID_TOKEN`: Invalid Token.
+	 *         + `UPDATE_TOKEN_BEFORE_JOIN`: The user has not joined a room yet. Please make sure the user is already in the room.
 	 * @group Room Management
 	 * @order 5
 	 */
-	updateToken: (token: string) => void;
+	updateToken: (token: string) => Promise<void>;
 	
 	/** 
 	 * @brief Switch the microphone used for internal audio capturing.
@@ -3102,6 +3234,10 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        The remote clients in the room will be informed of the state change via [onUserStartVideoCapture](104479#onuserstartvideocapture) after the publisher starts video capture by calling this API.
 	 * @param deviceId ID of the capture device which you need to pass in to avoid exceptions such as no screen or a screen that is not the desired one. You can call [enumerateDevices](#enumeratedevices) to obtain the list of devices.
 	 * @return The actual effective video capture parameters. See [MediaTrackSettings](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSettings). Pay attention to the properties: `frameRate`, `height`, and `width`.
+	 *         The following error codes may be returned.
+	 *         + `REPEAT_CAPTURE`: Capture has already started.
+	 *         + `GET_VIDEO_TRACK_FAILED`: Capture failed. Please check if there are available capture devices or if they are being used by other apps.
+	 *         + `STREAM_TYPE_NOT_MATCH`: Wrong stream type. Triggered when you call internal capture APIs after switch to the custom stream source with setVideoSourceType.
 	 * @notes + Call [stopVideoCapture](#stopvideocapture) to stop the internal video capture. Otherwise, the internal video capture will sustain until you destroy the engine instance.
 	 *        + Once you create the engine instance, you can start internal video capture regardless of the video publishing state. The video stream will start publishing only after the video capture starts.
 	 *        + Call [setVideoCaptureDevice](#setvideocapturedevice) to switch the camera used by the internal video capture module.
@@ -3114,7 +3250,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Enable internal video capture immediately. The default setting is off.
 	 *        Internal video capture refers to: capturing video using the built-in module.
 	 *        The remote clients in the room will be informed of the state change via [onUserStopVideoCapture](104479#onuserstopvideocapture) after the publisher stops video capture by calling this API.
-	 * @return
+	 * @return `STREAM_TYPE_NOT_MATCH`: Wrong stream type. Triggered when you call internal capture APIs after switch to the custom stream source with setVideoSourceType.
 	 * @notes + Call [startVideoCapture](#startvideocapture) to enable the internal video capture.
 	 *        + Without calling this API the internal video capture will sustain until you destroy the engine instance.
 	 * @group Video Management
@@ -3128,6 +3264,10 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        The remote clients in the room will be informed of the state change via [onUserStartAudioCapture](104479#onuserstartaudiocapture) after the publisher starts audio capture by calling this API.
 	 * @param deviceId ID of the capture device which you need to pass in to avoid exceptions such as no sound. You can call [enumerateDevices](#enumeratedevices) to obtain the list of devices.
 	 * @return The actual effective audio capture parameters. See [MediaTrackSettings](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSettings).
+	 *         The following error codes may be returned.
+	 *         + `REPEAT_CAPTURE`: Capture has already started.
+	 *         + `GET_AUDIO_TRACK_FAILED`: Capture failed. Please check if there are available capture devices or if they are being used by other apps.
+	 *         + `STREAM_TYPE_NOT_MATCH`: Wrong stream type. Triggered when you call internal capture APIs after switch to the custom stream source with setAudioSourceType.
 	 * @notes + Call [stopAudioCapture](#stopaudiocapture) to stop the internal audio capture. Otherwise, the internal audio capture will sustain until you destroy the engine instance.
 	 *        + Once you create the engine instance, you can start internal audio capture regardless of the audio publishing state. The audio stream will start publishing only after the audio capture starts.
 	 * @group Audio Management
@@ -3139,7 +3279,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Stop internal audio capture. The default is off.
 	 * Internal audio capture refers to: capturing audio using the built-in module.
 	 * The remote clients in the room will be informed of the state change via [onUserStopAudioCapture](104479#onuserstopaudiocapture) after stopping audio capture by calling this API.
-	 * @return
+	 * @return `STREAM_TYPE_NOT_MATCH`: Wrong stream type. Triggered when you call internal capture APIs after switch to the custom stream source with setAudioSourceType.
 	 * @notes + Call [startAudioCapture](#startaudiocapture) to enable the internal audio capture.
 	 *        + Without calling this API the internal audio capture will sustain until you destroy the engine instance.
 	 * @group Audio Management
@@ -3153,6 +3293,11 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param optionsOrAudioDeviceId When using a single parameter, both audio and video device IDs can be set simultaneously. When using two parameters, the audio device's ID can be set.
 	 * @param videoDeviceId Video device's ID.
 	 * @return The actual audio and video capture parameters that take effect. Refer to [MediaTrackSettings](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSettings). Pay attention to the properties: `deviceId`, `channelCount`, `sampleRate`, `frameRate`, `height` and `width`.
+	 *         The following error codes may be returned.
+	 *         + `REPEAT_CAPTURE`: Capture has already started.
+	 *         + `GET_AUDIO_TRACK_FAILED`: Audio capture failed. Please check if there are available capture devices or if they are being used by other apps.
+	 *         + `GET_VIDEO_TRACK_FAILED`: Video capture failed. Please check if there are available capture devices or if they are being used by other apps.
+	 *         + `STREAM_TYPE_NOT_MATCH`: Wrong stream type. Triggered when you call internal capture APIs after switch to the custom stream source with setAudioSourceType or setVideoSourceType.
 	 * @notes + The audio and video capture can be published using [publishStream](#publishstream) and unpublished using [unPublishStream](#unpublishstream).
 	 *        + The method cannot be called simultaneously with [startVideoCapture](#startvideocapture) / [startAudioCapture](#startaudiocapture).
 	 *        + If either the camera or the microphone fails to complete the capture when calling this method, the audio and video capture will fail.
@@ -3196,10 +3341,10 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Use the capture module provided by the RTC SDK to capture the current screen stream for sharing.
 	 * @param screenConfig Specify properties for the sharing screen.
-	 * @return
+	 * @return `GET_SCREEN_TRACK_FAILED`: Capture failed.
 	 * @notes + Call this API will start screen stream video capture but will not publish the captured video. Publishing a screen-sharing stream by calling [publishScreen](#publishscreen).
-	 *     + To turn off screen video source capture, call [stopScreenCapture](#stopscreencapture).
-	 *     + Before calling this API, you can call [setScreenEncoderConfig](#setscreenencoderconfig) to set the capture frame rate and encoding resolution of the screen video stream.
+	 *        + To turn off screen video source capture, call [stopScreenCapture](#stopscreencapture).
+	 *        + Before calling this API, you can call [setScreenEncoderConfig](#setscreenencoderconfig) to set the capture frame rate and encoding resolution of the screen video stream.
 	 * @group Screen Sharing
 	 * @order 0
 	 */
@@ -3227,8 +3372,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	
 	/** 
 	 * @brief Bind a view to the remote media stream and set the rendering mode for the rendering of the remote stream
-	 *     It's recommended to call this API and bind a view once the event of [onUserPublishStream](104479#onuserpublishstream)/[onUserPublishScreen](104479#onuserpublishscreen) is triggered.
-	 *     Call this API again with a blank view to unbind the view from the remote video stream.
+	 *        It is recommended to call this API and bind a view once the event of [onUserPublishStream](104479#onuserpublishstream)/[onUserPublishScreen](104479#onuserpublishscreen) is triggered.
+	 *        Call this API again with a blank view to unbind the view from the remote video stream.
 	 * @param streamIndex Video stream properties
 	 * @param videoPlayerOption View information and rendering mode. Starting from version 4.56, you can set the rotation angle of the remote video rendering using `rotation`.
 	 * @notes You should bind the view after the user joins a room. This setting will sustain when the user leaves the room.
@@ -3248,7 +3393,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Sets the speaker or the earpiece as the audio playback device. The audio playback device defaults to the speaker.
 	 * @param deviceId ID of the audio playback device. Call [enumerateDevices](#enumeratedevices) to get device ID.
-	 * @return
+	 * @return + `INVALID_DEVICE_ID`: Invalid device ID.
+	 *         + `NOT_SUPPORTED`: The browser does not support audio device test or audio capture.
 	 * @notes  You can call this API before or after the user joins a room.
 	 * @group Audio Management
 	 * @order 1
@@ -3298,7 +3444,11 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        The recipient receives the message via [onUserMessageReceived](104479#onusermessagereceived)  once the message is sent successfully.
 	 * @param userId User ID of the recipient
 	 * @param message Text to be sent within 64 KB
-	 * @return
+	 * @return + `USER_MESSAGE_TIMEOUT`: P2P message failed to be sent due to a timeout.
+	 *         + `USER_MESSAGE_BROKEN`: P2P message failed to be sent due to a the broken channel.
+	 *         + `USER_MESSAGE_NO_RECEIVER`: No receiver. Please make sure you pass in the right userId.
+	 *         + `USER_MESSAGE_NOT_JOIN`: The sender has not joined any room.
+	 *         + `USER_MESSAGE_UNKNOWN`: Unknown error.
 	 * @notes Call [joinRoom](#joinroom) to join the room before calling this API.
 	 * @group Message
 	 * @order 0
@@ -3310,7 +3460,11 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * The recipient receives the message via [onUserBinaryMessageReceived](104479#onuserbinarymessagereceived) once the message is sent successfully.
 	 * @param userId User ID of the recipient
 	 * @param message Binary to be sent within 64 KB
-	 * @return
+	 * @return + `USER_MESSAGE_TIMEOUT`: P2P message failed to be sent due to a timeout.
+	 *         + `USER_MESSAGE_BROKEN`: P2P message failed to be sent due to a the broken channel.
+	 *         + `USER_MESSAGE_NO_RECEIVER`: No receiver. Please make sure you pass in the right userId.
+	 *         + `USER_MESSAGE_NOT_JOIN`: The sender has not joined any room.
+	 *         + `USER_MESSAGE_UNKNOWN`: Unknown error.
 	 * @notes Call [joinRoom](#joinroom) to join the room before calling this API.
 	 * @group Message
 	 * @order 1
@@ -3338,14 +3492,21 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	sendRoomBinaryMessage: (message: ArrayBuffer) => Promise<any> | undefined;
 	
 	/** 
-	 * @brief Send SEI message carried by video frames
-	 * @param streamIndex Stream index. You must use video stream for SEI.
+	 * @brief Send supplemental enhancement information (SEI) through video frames.
+	 *        In the video call scenario, the SEI data will be sent with the video frames. In the voice call scenario, the SDK will generate a 16px × 16px black frame video stream to send the data.
+	 * @param streamIndex Specify the type of media stream carrying SEI information. In the voice call scenario, it is recommended to set this value to `STREAM_INDEX_MAIN`.
 	 * @param message SEI message within 4 KB. Empty message or message exceeding this size will not be sent with respective error prompt.
-	 * @param repeatCount Number of message sending repetitions. The value range is [0, max{29, %{video frame rate}-1}]. Recommended range: [2,4].
-	 *                    Calling this API to add SEI data to consecutive `repeatCount` video frames starting from the current one.
-	 * @notes + Call this API to add SEI message to the video frame captured by the internal video capture module.
-	 *        + SDK will abandon the SEI message if no video frame in 2s after you call this API.
-	 *        + Users receiving the stream will receive the SEI message via [onSEIMessageReceived](104479#onseimessagereceived) once the SEI message is sent successfully.
+	 * @param repeatCount Number of times a message is sent repeatedly. The SEI will be added to a consecutive `repeatCount+1` number of video frames starting from the current frame. The value range is `[0, min{30, %{video frame rate}×2}]`, and the recommended range is `[2,4]`.
+	 * @notes + **Compatibility**<br/>
+	 *         &ensp; - SEI messages only support H.264 encoding, and use on browsers with Chromium 86+.
+	 *         &ensp; - Android devices do not support sending SEI data in voice call scenarios.
+	 *         &ensp; - SEI messages cannot be used on iOS devices.
+	 *        + In voice call scenarios, you still need to publish and subscribe to video streams, instead of audio streams.<br/>
+	 *         &ensp; - The publisher can enable automatic publishing when entering the room, or call [publishStream](#publishstream) with the media stream type `AUDIO_AND_VIDEO`.
+	 *         &ensp; - The subsciber can enable automatic subscribing to video streams when entering the room, or call [subscribeStream](#subscribestream) with the media stream type `AUDIO_AND_VIDEO`.
+	 *        + In voice call scenarios, if no SEI data is sent within 1 minute after calling this interface, the SDK will automatically cancel the publication of the black frame video stream.
+	 *        + After the message is sent successfully, the remote end will receive [onSEIMessageReceived](104479#onseimessagereceived).
+	 *        + In voice call scenarios, the sending status of the black frame video stream will be notified to remote users through the [onSEIStreamUpdate](104479#onseistreamupdate) event.
 	 * @group Message
 	 * @order 10
 	 */
@@ -3571,7 +3732,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *         During testing, you can use generate a temporary Token on [Console](https://console.byteplus.com/auth/login), and fill in any value with `roomId`.
 	 *         To officially go live, you need to use the implement token generation at your server. The `roomId` field should be empty. See [Authentication with Token](70121).
 	 * @param userId  User ID.
-	 * @return
+	 * @return + `ALREADY_LOGIN`: The user has already logged in.
+	 *         + `LOGIN_FAILED`: Login failed. Please check the returned message for the specific reason.
 	 * @notes + Call [logout](#logout) to log out the IM server.
 	 *        + In the same App ID, the user ID of each user must be unique. The user will be logged out when a user with the same userID joins the room because of the error of `RTM_DUPLICATE_LOGIN`.
 	 * @group Message
@@ -3612,7 +3774,11 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Send point-to-point (P2P) text message to a user.
 	 * @param userId ID of the recipient
 	 * @param message Text message within 64 KB.
-	 * @return
+	 * @return + `USER_MESSAGE_TIMEOUT`: P2P message failed to be sent due to a timeout.
+	 *         + `USER_MESSAGE_BROKEN`: P2P message failed to be sent due to a the broken channel.
+	 *         + `USER_MESSAGE_NO_RECEIVER`: No receiver. Please make sure you pass in the right userId.
+	 *         + `NOT_LOGIN`: The sender has not logged in yet.
+	 *         + `USER_MESSAGE_UNKNOWN`: Unknown error.
 	 * @notes + Call [login](#login) before calling this API.
 	 *        + The recipient must be logged into the server and will receive the text message via [onUserMessageReceivedOutsideRoom](104479#onusermessagereceivedoutsideroom) if the message has been sent successfully.
 	 * @group Message
@@ -3624,7 +3790,11 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Send point-to-point (P2P) binary message to a user.
 	 * @param userId ID of the recipient
 	 * @param message Binary message within 64 KB
-	 * @return
+	 * @return + `USER_MESSAGE_TIMEOUT`: P2P message failed to be sent due to a timeout.
+	 *         + `USER_MESSAGE_BROKEN`: P2P message failed to be sent due to a the broken channel.
+	 *         + `USER_MESSAGE_NO_RECEIVER`: No receiver. Please make sure you pass in the right userId.
+	 *         + `NOT_LOGIN`: The sender has not logged in yet.
+	 *         + `USER_MESSAGE_UNKNOWN`: Unknown error.
 	 * @notes + Call [login](#login) before calling this API.
 	 *        + The recipient must be logged into the server and will receive the text message via [EngineEventsTypes.onUserBinaryMessageReceivedOutsideRoom](104479#onuserbinarymessagereceivedoutsideroom) if the message has been sent successfully.
 	 * @group Message
@@ -3649,7 +3819,14 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Send point-to-point (P2P) text message to the server.
 	 * @param message Text message within 64 KB.
-	 * @return
+	 * @return + `USER_MESSAGE_TIMEOUT`: P2P message failed to be sent due to a timeout.
+	 *         + `USER_MESSAGE_BROKEN`: P2P message failed to be sent due to a the broken channel.
+	 *         + `USER_MESSAGE_NO_RECEIVER`: No receiver. Please make sure you pass in the right userId.
+	 *         + `USER_MESSAGE_SEND_TO_SERVER_ERROR`: No response from the server.
+	 *         + `USER_MESSAGE_SERVER_RESPONSE_ERROR`: Failed to send message to the server. Response status code is not 200.
+	 *         + `NOT_LOGIN`: The sender has not logged in yet.
+	 *         + `USER_MESSAGE_SERVER_PARAMS_NOTSET`: The server params have not been set yet.
+	 *         + `USER_MESSAGE_UNKNOWN`: Unknown error.
 	 * @notes Before sending a message to the server, you must first call [login](#login) to complete the login process.
 	 * @group Message
 	 * @order 36
@@ -3659,7 +3836,14 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Send point-to-point (P2P) binary message to the server.
 	 * @param message Binary message within 64 KB.
-	 * @return
+	 * @return + `USER_MESSAGE_TIMEOUT`: P2P message failed to be sent due to a timeout.
+	 *         + `USER_MESSAGE_BROKEN`: P2P message failed to be sent due to a the broken channel.
+	 *         + `USER_MESSAGE_NO_RECEIVER`: No receiver. Please make sure you pass in the right userId.
+	 *         + `USER_MESSAGE_SEND_TO_SERVER_ERROR`: No response from the server.
+	 *         + `USER_MESSAGE_SERVER_RESPONSE_ERROR`: Failed to send message to the server. Response status code is not 200.
+	 *         + `NOT_LOGIN`: The sender has not logged in yet.
+	 *         + `USER_MESSAGE_SERVER_PARAMS_NOTSET`: The server params have not been set yet.
+	 *         + `USER_MESSAGE_UNKNOWN`: Unknown error.
 	 * @notes Before sending a message to the server, you must first call [login](#login) to complete the login process.
 	 * @group Message
 	 * @order 37
@@ -3683,13 +3867,12 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	stopCloudProxy: () => void;
 	
 	/** 
-	 * @hidden
 	 * @brief Starts publishing a public media stream.
 	 * @param publicStreamId The public stream's ID. The string must conform to the regular expression: `[a-zA-Z0-9_@\-\.]{1,128}`.
 	 * @param publicStreamParam The public stream's parameters.
 	 *                 A public stream can contain several media streams and will appears as the designated layout.
 	 *                 If the designated media stream is not published yet, the public stream will automatically update once the media stream is published.
-	 * @return
+	 * @return `REPEAT_PUSH`: Publish a public stream repeatedly.
 	 * @notes + Users with the same `appID` can call [startPlayPublicStream](#startplaypublicstream) to subscribe to and play the public stream despite whether he/she has join the room.
 	 *        + You cannot update the parameters of the public stream by repeatedly calling this API with the same stream ID by the same user. Call [updatePublicStreamParam](#updatepublicstreamparam) to update the parameters instead.
 	 *        + Users with different `userID` can call this API with the same stream ID to update the parameters.
@@ -3701,20 +3884,18 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	startPushPublicStream: (publicStreamId: string, publicStreamParam: PublicStreamConfig) => Promise<void>;
 	
 	/** 
-	 * @hidden
 	 * @brief Update the properties of the public stream published by the current user.
 	 *        Call [startPushPublicStream](104478#startpushpublicstream) to start publishing a public stream.
 	 * @param publicStreamId The public stream's ID.
 	 *                       The public stream must be published by the current user.
 	 * @param publicStreamParam The public stream's parameters.
-	 * @return
+	 * @return `REPEAT_PLAY`: Subscribe to a public stream repeatedly.
 	 * @group Public Stream
 	 * @order 1
 	 */
 	updatePublicStreamParam: (publicStreamId: string, publicStreamParam: Partial<PublicStreamConfig>) => Promise<void>;
 	
 	/** 
-	 * @hidden
 	 * @type api
 	 * @brief Stops publishing the public stream.
 	 *        Call [startPushPublicStream](104478#startpushpublicstream) to start publishing a public stream.
@@ -3727,7 +3908,6 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	stopPushPublicStream: (publicStreamId: string) => Promise<void>;
 	
 	/** 
-	 * @hidden
 	 * @brief Subscribes to a designated public stream.
 	 *        You can call this API to subscribe to a public stream whether you joined the room or not.
 	 * @param publicStreamId The public stream's ID.
@@ -3743,7 +3923,6 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	startPlayPublicStream: (publicStreamId: string) => Promise<void>;
 	
 	/** 
-	 * @hidden
 	 * @brief Unsubscribes from a designated public stream.
 	 *        Call [startPlayPublicStream](104478#startplaypublicstream) to subscribe to the public stream.
 	 * @param publicStreamId The public stream's ID.
@@ -3754,7 +3933,6 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	stopPlayPublicStream: (publicStreamId: string) => Promise<void>;
 	
 	/** 
-	 * @hidden
 	 * @brief Sets the player information and rendering mode for the public stream.
 	 * @param publicStreamId The public stream's ID.
 	 * @param videoPlayerOption Player information and rendering mode.
@@ -3770,7 +3948,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *    The format of the image can be: JPG, PNG, or BMP.
 	 *    When the ratio of the image is not the same as the video encoder configuration, the image will be resized with fixed ratio until the width and the height are no more than that of the encoder configuration.
 	 * @notes + Only available to Chrome browser on Mac
-	 * + It's recommended to call this API before stopping video capture to avoid blank frame in video recording.
+	 * + It is recommended to call this API before stopping video capture to avoid blank frame in video recording.
 	 * + You cannot see the image during local preview.
 	 * @group Video Management
 	 * @order 40
@@ -3787,7 +3965,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	
 	/** 
 	 * @brief Set the fallback option for remote media stream
-	 *        Fallback：to enable media stream fallback or to subscribe to only audio stream under poor network conditions to ensure smooth communication.
+	 *        Fallback means to enable media stream fallback or to subscribe to only audio stream under poor network conditions to ensure smooth communication.
 	 * @param option Fallback options for subscribed media stream
 	 * @return + `true` Success
 	 *         + `false` Failure
@@ -3817,6 +3995,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param filePath Specify the path of the audio file for the playback test, including *.wav and *.mp3.
 	 * @param indicationInterval The time interval between each callback in milliseconds. We recommend setting it to 200 ms. The minimal value is 100 ms.
 	 * @return Resolve when the test ends.
+	 *         `REPEAT_DEVICE_TEST`: The test has already started.
 	 * @notes + You can call this API whether the user is in the room.
 	 * + Call [stopAudioPlaybackDeviceTest](#stopaudioplaybackdevicetest) to stop the playback test before moving on to the other device tests.
 	 * @group Device Management
@@ -3838,6 +4017,10 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param indicationInterval The time interval between each callback of [onAudioPlaybackDeviceTestVolume](104479#onaudioplaybackdevicetestvolume) via which you get informed of the playback volume during the test.  We recommend setting it to 200 ms. The minimal value is 100 ms.
 	 * @param onAutoplayFailed Autoplay fails due to the limitation of the browser. We recommend to execute `resume` as soon as the user clicks on the UI element.
 	 * @return Resolve when the test ends.
+	 *         The following error codes may be returned.
+	 *         + `NOT_SUPPORTED`: The browser does not support audio device test or audio capture.
+	 *         + `REPEAT_DEVICE_TEST`: The test has already started.
+	 *         + `AUDIO_DEVICE_RECORD_FAILED`: Failed to start the audio device test.
 	 * @notes + You can call this API whether the user is in a room.
 	 *        + You can call [setCaptureVolume]({{api}}#RTCEngine.setCaptureVolume) to adjust the capture volume during audio route testing. You cannot call [setPlaybackVolume]({{api}}#RTCEngine.setPlaybackVolume) during audio route testing.
 	 *        + The audio capturing will stop and begins to play the recording in 30 seconds after calling this API. Before that, call [stopAudioDeviceRecordAndPlayTest](#stopaudiodevicerecordandplaytest) to stop capturing and start playing the recording.
@@ -3934,6 +4117,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param streamIndex The specified video stream.
 	 * @notes + The snapshot is taken with all video effects on, like rotation, and mirroring.
 	 *        + You can take the snapshot either using SDK internal video capture or customized capture.
+	 * @return `INVOKED_BEFORE_CAPTURE`: No such stream. Please make sure that the specified stream has been published.
 	 * @group Video Snapshot
 	 * @order 0
 	 */
@@ -3943,6 +4127,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Take a snapshot of the remote video.
 	 * @param id The index of the user's stream or the index of the public stream.
 	 * @param streamIndex The specified video stream.
+	 * @return `STREAM_NOT_EXIST`: The target stream does not exist. Please enter the correct ID or make sure that the target stream is in the room.
 	 * @group Video Snapshot
 	 * @order 1
 	 */
@@ -3964,7 +4149,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        After calling this method, you can choose between the recognition and translation modes based on your needs. In the recognition mode, the speech of the speaker in the room will be recognized and converted into captions. In the translation mode, the transcribed text will be translated.You will receive the [onSubtitleMessageReceived](104479#onsubtitlemessagereceived) callback to informs you of related information about subtitles.
 	 *        After calling this method, you will receive the [onSubtitleStateChanged](104479#onsubtitlestatechanged) to inform you of whether subtitles are on.
 	 * @param config Subtitle configrations.
-	 * @return
+	 * @return `SUBTITLE_ALREADY_ON`: Subtitle is already turned on.
 	 * @notes + You must call this method after joining the room.
 	 *        + You can set your source language to Chinese by calling `joinRoom`  and importing a json formatted string `"source_language": "zh"` through the parameter of extraInfo, to English by importing `"source_language": "en"` , and to Japanese by importing `"source_language": "ja"`. The language of your browser will be automatically set as the source language if you don't set it. If the language of your browser is not Chinese, English or Japanese, SDK will set Chinese as the source language.
 	 * @group Live Caption and Translation
@@ -4033,7 +4218,6 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	setPlaybackVolume: (userId: string, streamIndex: StreamIndex, volume: number) => void;
 	
 	/** 
-	 * @hidden
 	 * @brief Adjust audio playback volume of a public stream.
 	 * @param publicStreamId The Id of a specified public stream.
 	 * @param volume The percentage of playback volume to the original volume in range of [0, 400]. The default value is 100%.
@@ -4050,6 +4234,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        After calling [joinRoom]({{api}}#RTCEngine.joinRoom), you can call this API to publish the media stream to multiple rooms. This feature is suitable for scenarios such as co-host PK and online karaoke.
 	 * @param forwardStreamInfos Information of the target rooms where the stream will be forwarded.
 	 * @return Status information for forwarding media stream across rooms.
+	 *         `UNEXPECTED_INVOKE_FORWARD_STREAM`: Unexpected operation. Triggered if the timing of API calls related to forwarding media streams across rooms is incorrect. Please refer to the documentation of each API to confirm the correct order of API calls.
 	 * @notes + Once the forwarding begins, other users in the target room will receive [onUserJoined]({{callback}}#EngineEvents.onUserJoined) and [onUserPublishStream]({{callback}}#EngineEvents.onUserPublishStream)/[onUserPublishScreen]({{callback}}#EngineEvents.onUserPublishScreen).
 	 *        + Call [updateForwardStreamToRooms]({{api}}#RTCEngine.updateForwardStreamToRooms) to add or remove the target room(s).
 	 *        + Call [stopForwardStreamToRooms]({{api}}#RTCEngine.stopForwardStreamToRooms) to stop forwarding media stream to all rooms.
@@ -4063,6 +4248,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Update information of the rooms where the stream will be forwarded after calling [startForwardStreamToRooms]({{api}}#RTCEngine.startForwardStreamToRooms).
 	 * @param forwardStreamInfos Information of the target rooms where the stream will be forwarded.
 	 * @return Status information for forwarding media stream across rooms.
+	 *         `UNEXPECTED_INVOKE_FORWARD_STREAM`: Unexpected operation. Triggered if the timing of API calls related to forwarding media streams across rooms is incorrect. Please refer to the documentation of each API to confirm the correct order of API calls.
 	 * @notes + Users in the added room will receive [onUserJoined]({{callback}}#EngineEvents.onUserJoined) and [onUserPublishStream]({{callback}}#EngineEvents.onUserPublishStream)/[onUserPublishScreen]({{callback}}#EngineEvents.onUserPublishScreen).
 	 *        + Users in the removed room will receive [onUserUnpublishStream]({{callback}}#EngineEvents.onUserUnpublishStream)/[onUserUnpublishScreen]({{callback}}#EngineEvents.onUserUnpublishScreen) and [onUserLeave]({{callback}}#EngineEvents.onUserLeave).
 	 * @group Audio & Video Transport
@@ -4073,6 +4259,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Stop forwarding media stream to all rooms.
 	 * @return Status information for forwarding media stream across rooms.
+	 *         `UNEXPECTED_INVOKE_FORWARD_STREAM`: Unexpected operation. Triggered if the timing of API calls related to forwarding media streams across rooms is incorrect. Please refer to the documentation of each API to confirm the correct order of API calls.
 	 * @notes + Users in the former target rooms will receive [onUserUnpublishStream]({{callback}}#EngineEvents.onUserUnpublishStream)/[onUserUnpublishScreen]({{callback}}#EngineEvents.onUserUnpublishScreen) and [onUserLeave]({{callback}}#EngineEvents.onUserLeave).
 	 *        + Call [updateForwardStreamToRooms]({{api}}#RTCEngine.updateForwardStreamToRooms) to stop forwarding media stream to specific rooms.
 	 *        + Call [pauseForwardStreamToAllRooms]({{api}}#RTCEngine.pauseForwardStreamToAllRooms) and [resumeForwardStreamToAllRooms]({{api}}#RTCEngine.resumeForwardStreamToAllRooms) to pause and resume fowarding media stream to all rooms.
@@ -4085,6 +4272,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Pause forwarding media stream to all rooms.
 	 *        After calling this API, call [resumeForwardStreamToAllRooms]({{api}}#RTCEngine.resumeForwardStreamToAllRooms) to resume.
 	 * @return Status information for forwarding media stream across rooms.
+	 *         `UNEXPECTED_INVOKE_FORWARD_STREAM`: Unexpected operation. Triggered if the timing of API calls related to forwarding media streams across rooms is incorrect. Please refer to the documentation of each API to confirm the correct order of API calls.
 	 * @notes Users in the target rooms will receive [onUserUnpublishStream]({{callback}}#EngineEvents.onUserUnpublishStream)/[onUserUnpublishScreen]({{callback}}#EngineEvents.onUserUnpublishScreen) and [onUserLeave]({{callback}}#EngineEvents.onUserLeave).
 	 * @group Audio & Video Transport
 	 * @order 43
@@ -4094,11 +4282,32 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Resume forwarding media stream to all rooms.
 	 * @return Status information for forwarding media stream across rooms.
+	 *         `UNEXPECTED_INVOKE_FORWARD_STREAM`: Unexpected operation. Triggered if the timing of API calls related to forwarding media streams across rooms is incorrect. Please refer to the documentation of each API to confirm the correct order of API calls.
 	 * @notes Users in the target room will receive [onUserJoined]({{callback}}#EngineEvents.onUserJoined) and [onUserPublishStream]({{callback}}#EngineEvents.onUserPublishStream)/[onUserPublishScreen]({{callback}}#EngineEvents.onUserPublishScreen).
 	 * @group Audio & Video Transport
 	 * @order 44
 	 */
 	resumeForwardStreamToAllRooms: () => Promise<ForwardStreamStateInfo[]>;
+	
+	/** 
+	 * @hidden
+	 */
+	peerConnection: RTCPeerConnection | undefined;
+	
+	/** 
+	 * @hidden
+	 */
+	iceState: RTCIceConnectionState | undefined;
+	
+	/** 
+	 * @brief Set the priority of the local audio stream to be published.
+	 * @param audio_selection_priority The priority of the local audio stream which defaults to be subscribable only up to the result of the Audio Selection.
+	 * @note + You must enable Audio Selection in the RTC console before using this API. You can call this API whether the user has joined a room. Refer to [Audio Selection](https://docs.byteplus.com/byteplus-rtc/docs/113547).<br>
+	 * + The setting is independent in each room that the user joins.
+	 * @group Room Management
+	 * @order 12
+	 */
+	setAudioSelectionConfig: (audioSelectionPriority: AudioSelectionPriority) => Promise<void>;
 }
 
 /** 
@@ -4132,7 +4341,7 @@ export interface IVERTC {
 	 * @brief Call this API to destroy the IRTCEngine instance created by [createEngine](104478#createengine).
 	 * @param engine By calling this API, this `IRTCEngine` instance and resource related will be wiped from memory. And any interaction with the media server will end.
 	 * @notes + Before calling this API， ensure all business scenarios related to this `IRTCEngine` instance have ended.
-	 *       + Calling this API will block the main thread until it completes the exiting process. Therefore, do not include this API in a callback. Nor wait in a callback for the execution of this API in the main thread, thus causing a deadlock.
+	 *        + Calling this API will block the main thread until it completes the exiting process. Therefore, do not include this API in a callback. Nor wait in a callback for the execution of this API in the main thread, thus causing a deadlock.
 	 * @group Engine Management
 	 * @order 1
 	 */
@@ -4158,9 +4367,11 @@ export interface IVERTC {
 	
 	/** 
 	 * @brief Call this API to request for access to video and audio devices.
-	 * @param options The device type you need
-	 * @return + `video: boolean` Video devices
-	 *         + `audio:boolean` Audio devices
+	 * @param options The device type you need.
+	 * @return + `video: boolean` Whether the video device permission is obtained.
+	 *         + `audio: boolean` Whether the audio device permission is obtained.
+	 *         + `videoExceptionError?: DOMException` Error message for obtaining video device permission.
+	 *         + `audioExceptionError?: DOMException` Error message for obtaining audio device permission.
 	 * @group Device Management
 	 * @order 5
 	 */
@@ -4388,7 +4599,7 @@ export interface LiveTranscodeLayoutRegion {
 	 * @brief The render mode to be set. The default value is 1. See the following options:
 	 * • 1: Fill and Crop. The video is enlarged or shrunk with fixed aspect ratio, and completely fills the windows. The region of the video which exceeds the window will be cropped.
 	 * • 2: Fit. The video is enlarged or shrunk with fixed aspect ratio, and is shown completely in the windows. The region of the window, which is not filled with video, is filled with black background.
-	 * • 3: Stretch. The video's aspect ratio is changed as it's automatically stretched to completely fill the bounding box it's contained in, but the whole image is visible.
+	 * • 3: Stretch. The video's aspect ratio is changed as it is automatically stretched to completely fill the bounding box that it is contained in, but the whole image is visible.
 	 */
 	renderMode?: number;
 	
@@ -5297,9 +5508,9 @@ export interface ScreenEncoderConfig {
 	
 	/** 
 	 * @brief The type of content the track contains.
-	 *        `'text'`：The track should be treated as if video details are extra important, and that significant sharp edges and areas of consistent color can occur frequently. For example, presentations or web pages with text content.
-	 *        `'motion'`：The track should be treated as if it contains video where motion is important. For example, webcam video, movies or video games.
-	 *        `'detail'`：The track should be treated as if video details are extra important. For example, presentations or web pages with text content, painting or line art.
+	 *        `'text'`: The track should be treated as if video details are extra important, and that significant sharp edges and areas of consistent color can occur frequently. For example, presentations or web pages with text content.
+	 *        `'motion'`: The track should be treated as if it contains video where motion is important. For example, webcam video, movies or video games.
+	 *        `'detail'`: The track should be treated as if video details are extra important. For example, presentations or web pages with text content, painting or line art.
 	 * @notes This property is not supported on Firefox. See [contentHint browser compatibility](https://caniuse.com/?search=contentHint).
 	 */
 	contentHint?: "text" | "motion" | "detail";
@@ -5327,6 +5538,7 @@ export interface SetParamInterface {
 	SIGNAL_CROP_JOINROOM: boolean;
 	VIDEO_STALL_DATA: number;
 	AUDIO_STALL_DATA: number;
+	BLACK_FRAME_LIFETIME: number;
 }
 
 /** 
@@ -5405,6 +5617,10 @@ export interface SubtitleEvent {
 	
 	/** 
 	 * @brief Error codes of the subtitling task.
+	 *        + `SUBTITLE_ERR_POSTPROCESS`: An internal error occurred in cloud media processing.
+	 *        + `SUBTITLE_ERR_CONNECTION_ERROR`: Connection to the third-party service failed.
+	 *        + `SUBTITLE_ERR_PROCESS_ERROR`: Cloud media processing timed out.
+	 *        + `SUBTITLE_ERR_UNKNOWN`: The client was unable to recognize the error code sent by the cloud media processing.
 	 */
 	errorCode?: ErrorCode;
 	
@@ -5564,9 +5780,9 @@ export interface VideoEncoderConfig {
 	
 	/** 
 	 * @brief The type of content the track contains.
-	 *        `'text'`：The track should be treated as if video details are extra important, and that significant sharp edges and areas of consistent color can occur frequently. For example, presentations or web pages with text content.
-	 *        `'motion'`：The track should be treated as if it contains video where motion is important. For example, webcam video, movies or video games.
-	 *        `'detail'`：The track should be treated as if video details are extra important. For example, presentations or web pages with text content, painting or line art.
+	 *        `'text'`: The track should be treated as if video details are extra important, and that significant sharp edges and areas of consistent color can occur frequently. For example, presentations or web pages with text content.
+	 *        `'motion'`: The track should be treated as if it contains video where motion is important. For example, webcam video, movies or video games.
+	 *        `'detail'`: The track should be treated as if video details are extra important. For example, presentations or web pages with text content, painting or line art.
 	 * @notes This property is not supported on Firefox. See [contentHint browser compatibility](https://caniuse.com/?search=contentHint).
 	 */
 	contentHint?: "text" | "motion" | "detail";
@@ -5722,6 +5938,27 @@ export interface onSEIMessageReceivedEvent {
 	remoteStreamKey: RemoteStreamKey;
 }
 
+/** 
+ * @brief Stream containing SEI information update event.
+ */
+export interface onSEIStreamUpdateEvent {
+	
+	/** 
+	 * @brief User ID.
+	 */
+	userId: string;
+	
+	/** 
+	 * @brief Whether it is a screen-sharing stream.
+	 */
+	isScreen: boolean;
+	
+	/** 
+	 * @brief The stream type containing SEI information.
+	 */
+	type: SEIStreamEventType;
+}
+
 /** 
  * A User in the room publishes a media stream.
  */