@byteplus/rtc 4.44.3 → 4.45.1

package/index.d.ts

@@ -661,7 +661,7 @@ export interface MixOption {
 	playCount: number;
 	
 	/** 
-	 * @brief For mixing playback types. Refer to [AudioMixingType](#audiomixingtype).
+	 * @brief For mixing playback types.
 	 */
 	type?: AudioMixingType;
 }
@@ -976,7 +976,7 @@ export interface onMediaDeviceStateChangeEvent {
 export interface onSEIMessageEvent {
 	
 	/** 
-	 * @brief Including userId of the user who sent the message, roomId of the current room, and the media stream carrying this SEI message. Refer to [RemoteStreamKey](#remotestreamkey) for more information.
+	 * @brief Including userId of the user who sent the message, roomId of the current room, and the media stream carrying this SEI message.
 	 */
 	remoteStreamKey: RemoteStreamKey;
 	
@@ -1353,7 +1353,7 @@ export interface RemoteStreamStats {
 	/** 
 	 * @brief userId of the user who is joining the room
 	 */
-	userId?: string;
+	userId: string;
 	
 	/** 
 	 * @brief State of the remote audio stream
@@ -1558,7 +1558,8 @@ declare enum EngineEventsTypes {
 	onPublicStreamSEIMessageReceived = "onPublicStreamSEIMessageReceived",
 	onNetworkQuality = "onNetworkQuality",
 	onSimulcastSubscribeFallback = "onSimulcastSubscribeFallback",
-	onRemoteVideoSizeChanged = "onRemoteVideoSizeChanged"
+	onRemoteVideoSizeChanged = "onRemoteVideoSizeChanged",
+	onLocalVideoSizeChanged = "onLocalVideoSizeChanged"
 }
 
 /** 
@@ -1567,12 +1568,12 @@ declare enum EngineEventsTypes {
 export interface StreamMixingEvent {
 	
 	/** 
-	 * @brief The types. See [StreamMixingEventType](104481#streammixingeventtype).
+	 * @brief The types.
 	 */
 	event: StreamMixingEventType;
 	
 	/** 
-	 * @brief The error codes. See [StreamMixingEventErrorCode](104480#streammixingeventerrorcode).
+	 * @brief The error codes.
 	 */
 	error: StreamMixingEventErrorCode;
 	
@@ -1588,7 +1589,7 @@ export interface StreamMixingEvent {
 export interface UserConnectionEvent {
 	
 	/** 
-	 * @brief User information, refer to [UserInfo](#userinfo) for more details.
+	 * @brief User information.
 	 */
 	userInfo: UserInfo;
 }
@@ -1599,7 +1600,7 @@ export interface UserConnectionEvent {
 export interface UserDisconnectionEvent {
 	
 	/** 
-	 * @brief User information, refer to [UserInfo](#userinfo) for more details.
+	 * @brief User information.
 	 */
 	userInfo: UserInfo;
 	
@@ -1654,7 +1655,11 @@ export interface PlayerEvent {
 	/** 
 	 * @brief userId of the user who is joining the room
 	 */
-	userId: string;
+	userId?: string;
+	
+	/** 
+	 * @brief  The public stream's ID.
+	 */
 	publicStreamId?: string;
 	
 	/** 
@@ -1771,6 +1776,36 @@ export interface StreamKey {
 	 */
 	streamIndex: StreamIndex;
 }
+/**
+ * {zh}
+ * @brief 自动播放失败事件
+ */
+/**
+ * 
+ * @brief Event of Auto-play failure
+ */
+export interface AutoPlayFailedEvent {
+	/**
+	 * {zh}
+	 * @brief 自动播放失败的流所属的用户 ID。不带此参数时表示本地流播放失败。
+	 */
+	/**
+	 * 
+	 * @brief ID of the user whose stream failed to playback automatically. Without this parameter, the notification is about the local stream.
+	 */
+	userId?: string;
+	/**
+	 * {zh}
+	 * @brief 自动播放失败的媒体类型
+	 *        例如，当同一用户的视频流和音频流自动播放都失败时，将触发两次 `onAutoPlayFailed` 回调，分别包含 `audio` 和 `video` 参数。
+	 */
+	/**
+	 * 
+	 * @brief Type of the media which is failed to play automatically
+	 *        For example, when both audio and video streams from the same user failed to playback automatically, you would get notified by `onAutoPlayFailed` twice with the argument of `audio` and `video` respectively.
+	 */
+	kind?: "audio" | "video";
+}
 declare enum StreamMixingEventErrorCode {
 	
 	/** 
@@ -1954,7 +1989,7 @@ export interface IEngineEvents {
 	 * @param event
 	 * @region Video Management Event
 	 */
-	[EngineEventsTypes.onAutoplayFailed]: (event: PlayerEvent) => void;
+	[EngineEventsTypes.onAutoplayFailed]: (event: AutoPlayFailedEvent) => void;
 	
 	/** 
 	 * @brief Event of media track ending
@@ -2187,7 +2222,7 @@ export interface IEngineEvents {
 	 * @param event Event related to the player
 	 * @region Room Management Event
 	 */
-	[EngineEventsTypes.onAutoplayFailed]: (event: PlayerEvent) => void;
+	[EngineEventsTypes.onAutoplayFailed]: (event: AutoPlayFailedEvent) => void;
 	
 	/** 
 	 * @hidden
@@ -2291,19 +2326,11 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onAudioPlaybackDeviceTestVolume]: (volume: number) => void;
 	
 	/** 
-	 * @brief The callback reports the network quality of the local user every 2s after the user enters the room.
-	 */
-	[EngineEventsTypes.onNetworkQuality]: (
-	
-	/** 
-	 * @brief Upstream network quality
-	 */
-	uplinkNetworkQuality: NetworkQuality, 
-	
-	/** 
-	 * @brief Downstream network quality
+	 * @brief The callback reports the upstream and downstream network quality of the local user every 2s after the user enters the room.
+	 * @param uplinkNetworkQuality Upstream network quality.
+	 * @param downlinkNetworkQuality Downstream network quality.
 	 */
-	downlinkNetworkQuality: NetworkQuality) => void;
+	[EngineEventsTypes.onNetworkQuality]: (uplinkNetworkQuality: NetworkQuality, downlinkNetworkQuality: NetworkQuality) => void;
 	
 	/** 
 	 * @brief Receives this callback when fallback happens or the stream recovers from fallback.
@@ -2343,6 +2370,33 @@ export interface IEngineEvents {
 	 * @region Push to CDN
 	 */
 	[EngineEventsTypes.onStreamMixingEvent]: (event: StreamMixingEvent) => void;
+	
+	/** 
+	 * @brief The callback of the actual video capturing configuration.
+	 */
+	[EngineEventsTypes.onLocalVideoSizeChanged]: (e: {
+		
+		/** 
+		 * @brief The attributes of the screen-sharing stream.
+		 */
+		streamIndex: StreamIndex;
+		
+		/** 
+		 * @brief The actual capturing configuration.
+		 */
+		info: {
+			
+			/** 
+			 * @brief The width of the shared video (px).
+			 */
+			width: number;
+			
+			/** 
+			 * @brief The height of the shared video (px).
+			 */
+			height: number;
+		};
+	}) => void;
 }
 
 /** 
@@ -2384,6 +2438,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	leaveRoom(waitAck?: boolean): Promise<void>;
 	
 	/** 
+	 * @hidden
 	 * @brief Destroy engine
 	 * Destroy the engine instances created by calling [createEngine](#createengine) and release all related resources.
 	 * @notes + Make sure that the business scenarios related to the `RTCEngine` instances that need to be destroyed are all finished before calling this API.
@@ -2396,10 +2451,10 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Publishes media streams captured by camera/microphone in the current room.
 	 * @param mediaType Media stream type, used for specifying whether to publish audio stream or video stream.
-	 * @notes + Streams are not published automatically in multi-room mode by default, you need to call this API to publish streams manually.  <br>
-	 *        + An invisible user cannot publish media streams. Call [setUserVisibility](#setuservisibility) to change your visibility in the room.  <br>
-	 *        + Call [publishScreen](#publishscreen) to start screen sharing.  <br>
-	 *        + After you call this API, the other users in the room will receive [onUserPublishStream](104479#onuserpublishstream). Those who successfully received your streams will receive [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) at the same time.  <br>
+	 * @notes + Streams are not published automatically in multi-room mode by default, you need to call this API to publish streams manually.
+	 *        + An invisible user cannot publish media streams. Call [setUserVisibility](#setuservisibility) to change your visibility in the room.
+	 *        + Call [publishScreen](#publishscreen) to start screen sharing.
+	 *        + After you call this API, the other users in the room will receive [onUserPublishStream](104479#onuserpublishstream). Those who successfully received your streams will receive [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) at the same time.
 	 *        + Call [unpublishStream](#unpublishstream) to stop publishing streams.
 	 * @region Room Management
 	 */
@@ -2408,7 +2463,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Stops publishing media streams captured by camera/microphone in the current room.
 	 * @param mediaType Media stream type, used for specifying whether to stop publishing audio stream or video stream.
-	 * @notes + After calling [publishStream](#publishstream), call this API to stop publishing streams. <br>
+	 * @notes + After calling [publishStream](#publishstream), call this API to stop publishing streams.
 	 *        + After calling this API, the other users in the room will receive [onUserUnpublishStream](104479#onuserunpublishstream).
 	 * @region Room Management
 	 */
@@ -2417,8 +2472,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Publishes local screen sharing streams in the current room.
 	 * @param mediaType Media stream type, used for specifying whether to publish audio stream or video stream.
-	 * @notes + An invisible user cannot publish media streams. Call [setUserVisibility](#setuservisibility) to change your visibility in the room. <br>
-	 *        + After you called this API, the other users in the room will receive [onUserPublishScreen](104479#onuserpublishscreen). Those who successfully received your streams will receive [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) at the same time.  <br>
+	 * @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). Those who successfully received your streams will receive [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) at the same time.
 	 *        + Call [unpublishScreen](#unpublishscreen) to stop publishing screen sharing streams.
 	 * @region Screen Sharing
 	 */
@@ -2427,25 +2482,24 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Stops publishing local screen sharing streams in the current room.
 	 * @param mediaType Media stream type, used for specifying whether to stop publishing audio stream or video stream.
-	 * @notes  + After calling [publishScreen](#publishscreen), call this API to stop publishing streams. <br>
+	 * @notes  + After calling [publishScreen](#publishscreen), call this API to stop publishing streams.
 	 *         + After calling this API, the other users in the room will receive [onUserUnpublishScreen](104479#onuserunpublishscreen).
 	 * @region Screen Sharing
 	 */
 	unpublishScreen(mediaType: MediaType): Promise<void>;
 	
 	/** 
-	 * @brief Subscribes to specific remote media streams captured by camera/microphone.  <br>
+	 * @brief Subscribes to specific remote media streams captured by camera/microphone.
 	 *        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{@link #IRTCRoomEventHandler#onUserPublishStream} before calling this API to subscribe to streams accordingly.  <br>
-	 *        + The [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) callback will be triggered after calling this API to indicate that the audio/video stream was successfully received.  <br>
+	 * @notes You must first get the remote stream information through onUserPublishStream{@link #IRTCRoomEventHandler#onUserPublishStream} before calling this API to subscribe to streams accordingly.
 	 * @region Room Management
 	 */
 	subscribeStream(userId: string, mediaType: MediaType): Promise<void>;
 	
 	/** 
-	 * @brief Unsubscribes from specific remote media streams captured by camera/microphone.  <br>
+	 * @brief Unsubscribes from specific remote media streams captured by camera/microphone.
 	 *        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.
@@ -2454,18 +2508,18 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	unsubscribeStream(userId: string, mediaType: MediaType): Promise<void>;
 	
 	/** 
-	 * @brief Subscribes to specific screen sharing media stream.  <br>
+	 * @brief Subscribes to specific screen sharing media stream.
 	 *        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 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.  <br>
-	 *        + The [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) callback will be triggered after calling this API to indicate that the audio/video stream was successfully received.  <br>
+	 * @notes + You must first get the remote stream information through [onUserPublishScreen](104479#onuserpublishscreen) before calling this API to subscribe to streams accordingly.
+	 *        + The [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) callback will be triggered after calling this API to indicate that the audio/video stream was successfully received.
 	 * @region Room Management
 	 */
 	subscribeScreen(userId: string, mediaType: MediaType): Promise<void>;
 	
 	/** 
-	 * @brief Unsubscribes from specific screen sharing media stream.  <br>
+	 * @brief Unsubscribes from specific screen sharing media stream.
 	 *        You can call this API in both automatic subscription mode and manual subscription mode.
 	 * @param uid The ID of the remote user who published the target screen audio/video stream.
 	 * @param type Media stream type, used for specifying whether to unsubscribe from the audio stream or the video stream.
@@ -2544,7 +2598,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * 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
 	 * @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.
+	 *        + Without calling this API the internal audio capture will sustain until you destroy the engine instance.
 	 * @region Audio Management
 	 */
 	stopAudioCapture(): Promise<void>;
@@ -2577,7 +2631,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @notes You should bind the view after the user joins a room. This setting will sustain when the user leaves the room.
 	 * @region Video Management
 	 */
-	setLocalVideoPlayer(streamIndex: StreamIndex, videoPlayerOption?: VideoPlayerOption): HTMLVideoElement | undefined;
+	setLocalVideoPlayer(streamIndex: StreamIndex, videoPlayerOption?: Partial<VideoPlayerOption>): HTMLVideoElement | undefined;
 	
 	/** 
 	 * @brief Bind a view to the remote media stream and set the rendering mode for the rendering of the remote stream
@@ -2608,12 +2662,15 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	
 	/** 
 	 * @brief Play audio and video stream manually.
-	 * Call this API when user need to take part in the audio and video reaction after calling [joinRoom](#joinroom) and set to autoPlay to False.
-	 * @param userId
-	 * @return
+	 * Call this API when user need to take part in the audio and video reaction after calling [createEngine](#createengine) and set to autoPlay to False.
+	 * @param userId ID of the user whose stream is intended to play
+	 *               Call this API without a parameter to start playing the local medias.
+	 * @return Calling this API when the audio and video are playing will also return a Promise.
 	 * @region Room Management
+	 * @note + Call this API to start playback if the audio and/or video is not playing.
+	 * + Call this API once to start both audio and video playbacks when they do not start.
 	 */
-	play(userId: string): Promise<void>;
+	play(userId?: string): Promise<void>;
 	
 	/** 
 	 * @brief Pause receiving remote media streams.
@@ -2695,19 +2752,21 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        You can set parameters for up to 3 streams, SDK will always take the value of the first 3 streams when parameters for more streams are set.
 	 *        The code rate of the parameters must be in descending order.
 	 *        When the resolution of the max stream is in [540P, 1080P], you can simulcast 3 streams; when in [270P, 450P], you can simulcast 2 streams; when in [0, 180P], you can not enable simulcast.
-	 * @notes  <br>
-	 *        + For the video stream captured by the camera, the default value is 360P, 15FPS; for the screen-sharing stream, the default value is 1080P, 15FPS.
-	 *        + Before calling this API to set parameters for multiple video streams, the largest resolution of published streams is 640px × 360px with a frame rate of 15fps by default.  <br>
+	 * @notes + For the video stream captured by the camera, the default value is 360P, 15FPS; for the screen-sharing stream, the default value is 1080P, 15FPS.
+	 *        + Before calling this API to set parameters for multiple video streams, the largest resolution of published streams is 640px × 360px with a frame rate of 15fps by default.
 	 *        + This API is applicable to the video stream captured by the camera, see [setScreenEncoderConfig](#setscreenencoderconfig) for setting parameters for screen sharing video stream.
 	 * @region Video Management
 	 */
 	setVideoEncoderConfig(descriptions: VideoEncoderConfig | VideoEncoderConfig[]): Promise<void>;
 	
 	/** 
-	 * @brief Video publisher call this API to set the expected configurations for the screen sharing video stream, including resolution, frame rate, bitrate, scale mode, and fallback strategy in poor network conditions.
-	 * @param description You expected configurations for screen sharing video stream.
-	 * @notes Before calling this API, a screen video stream with a default resolution of 1920px × 1080px and a frame rate of 15fps will be published.
-	 * @region Screen Shareing Management
+	 * @type api
+	 * @author changzhenan
+	 * @region Video Management
+	 * @brief Set the encoding configuration of the screen-sharing stream，which is also applied in video capture.
+	 *        If the configuration is not supported by your browser, the video will be captured based on the supported configuration. You will also receive the callback [onLocalVideoSizeChanged](104479#onlocalvideosizechanged).
+	 * @param VideoEncoderConfig The encoding configuration of the screen-sharing stream.
+	 * @notes + We recommend that you set the encoding configuration before video capture. Otherwise, the video will be captured based on the default configuration(1080p@15fps).
 	 */
 	setScreenEncoderConfig(description: VideoEncoderConfig): Promise<void>;
 	
@@ -2715,10 +2774,9 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Sets your expected configuration of the remote video stream that you want to subscribe to or have subscribed to.
 	 * @param userId The ID of the target stream publisher
 	 * @param remoteVideoConfig Your expected configuration, see RemoteVideoConfig{@link #RemoteVideoConfig}.
-	 * @notes <br>
-	 *        + This API only works after the publisher calls [enableSimulcastMode](#enablesimulcastmode) to enable publishing multiple video streams, in which case the subscriber will receive a stream that is closest to the set configuration.  <br>
-	 *        + If you don't call this API after the publisher enables the function of publishing multiple streams, you will receive by default the video stream with the largest resolution set by the publisher.  <br>
-	 *        + You should call this API in the room. If you want to call it before entering the room, you should set the `remoteVideoConfig` in the roomConfig` when calling [joinRoom](#joinroom).  <br>
+	 * @notes + This API only works after the publisher calls [enableSimulcastMode](#enablesimulcastmode) to enable publishing multiple video streams, in which case the subscriber will receive a stream that is closest to the set configuration.
+	 *        + If you don't call this API after the publisher enables the function of publishing multiple streams, you will receive by default the video stream with the largest resolution set by the publisher.
+	 *        + You should call this API in the room. If you want to call it before entering the room, you should set the `remoteVideoConfig` in the roomConfig` when calling [joinRoom](#joinroom).
 	 * @region Video Management
 	 */
 	setRemoteVideoConfig(userId: string, remoteVideoConfig: RemoteVideoConfig): Promise<void>;
@@ -2807,18 +2865,20 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	setUserVisibility(enable: boolean): Promise<void>;
 	
 	/** 
-	 * @brief Bind a custom videoTrack object.
-	 * @param index specify a stream index
-	 * @param track specify a video track. Refer to [MediaStreamTrack](https://developer.mozilla.org/zh-CN/docs/Web/API/MediaStreamTrack) for more details.
+	 * @brief Set a custom videoTrack as the video source.
+	 *        Before calling this API, you must call [setVideoSourceType](#setvideosourcetype) to enable custom video capture.
+	 * @param index specify a stream index.
+	 * @param track specify a video track. See [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack).
 	 * @return
 	 * @region Video Management
 	 */
 	setExternalVideoTrack(index: StreamIndex, track: MediaStreamTrack): Promise<void>;
 	
 	/** 
-	 * @brief Bind a custom audioTrack object.
-	 * @param index specify a stream index
-	 * @param track specify a audio track
+	 * @brief Set a custom audioTrack as the audio source.
+	 *        Before calling this API, you must call [setAudioSourceType](#setaudiosourcetype) to enable custom video capture.
+	 * @param index specify a stream index.
+	 * @param track specify an audio track. See [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack).
 	 * @return
 	 * @region Audio Management
 	 */
@@ -3214,18 +3274,21 @@ export interface RoomConfig {
 	
 	/** 
 	 * @brief Enable/disable auto-subscribe audio. Enable by default.
+	 *        This does not include the screen stream.
 	 *        Call publish[104481#publish] to publish media streams if you disable `isAutoPublish`.
 	 */
 	isAutoPublish?: boolean;
 	
 	/** 
 	 * @brief Enable/disable auto-subscribe audio. Enable by default.
+	 *        This does not include the screen stream.
 	 * Call subscribeUserStream, unsubscribe to revise the subscription.
 	 */
 	isAutoSubscribeAudio?: boolean;
 	
 	/** 
 	 * @brief Enable/disable auto-subscribe video. Enable by default.
+	 *        This does not include the screen stream.
 	 * Call subscribeUserStream, unsubscribe to revise the subscription.
 	 */
 	isAutoSubscribeVideo?: boolean;
@@ -3530,7 +3593,12 @@ export declare enum ConnectionState {
 	/** 
 	 * @brief Completion of the reconnecting
 	 */
-	CONNECTION_STATE_RECONNECTED = 5
+	CONNECTION_STATE_RECONNECTED = 5,
+	
+	/** 
+	 * @brief The `CONNECTION_STATE_DISCONNECTED` status lasted for more than 10 seconds, during which SDK failed to reconnect. SDK will continue to try to reconnect.
+	 */
+	CONNECTION_STATE_LOST = 6
 }
 
 /** 
@@ -3589,27 +3657,27 @@ export interface ScreenConfig {
 }
 
 /** 
- * @brief Video encoding configuration
+ * @brief The video encoding configuration.
  */
 export interface VideoEncoderConfig {
 	
 	/** 
-	 * @brief width in px
+	 * @brief The width of the shared video (px).
 	 */
 	width: number;
 	
 	/** 
-	 * @brief height in px
+	 * @brief The height of the shared video (px).
 	 */
 	height: number;
 	
 	/** 
-	 * @brief frame rate
+	 * @brief The framerate of the shared video (fps).
 	 */
 	frameRate: number;
 	
 	/** 
-	 * @brief The max bitrate, unit: kbps
+	 * @brief The maximum bitrate(>0/kbps). The default value is 3000kbps.
 	 */
 	maxKbps: number;
 }
@@ -3677,7 +3745,7 @@ export interface LiveTranscodeConfig {
 	video?: Partial<LiveTranscodeVideoConfig>;
 	
 	/** 
-	 * @brief User layout information. Refer to [LiveTranscodeLayoutConfig](#LiveTranscodeLayoutConfig) for more details.
+	 * @brief User layout information.
 	 */
 	layout?: Partial<LiveTranscodeLayoutConfig>;
 }
@@ -4284,6 +4352,38 @@ export declare enum AudioProfileType {
 	hdMono = 5
 }
 
+/** 
+ * @brief Auto-play policy
+ */
+export declare enum RTCAutoPlayPolicy {
+	
+	/** 
+	 * @brief By default, play audios and videos automatically.
+	 */
+	AUTO_PLAY = 0,
+	
+	/** 
+	 * @brief Play videos only automatically.
+	 */
+	VIDEO_ONLY = 1,
+	
+	/** 
+	 * @brief Disable Auto-play. Guide user to act with the App to play the media streams.
+	 */
+	PLAY_MANUALLY = 2
+}
+
+/** 
+ * @brief Configuration for the engine instance to be created
+ */
+export interface EngineConfig {
+	
+	/** 
+	 * @brief Auto-play policy
+	 */
+	autoPlayPolicy: RTCAutoPlayPolicy;
+}
+
 /** 
  * @brief Point-to-point text message
  */
@@ -4297,7 +4397,7 @@ export interface UserMessageEvent {
 	/** 
 	 * @brief Point-to-point text message
 	 */
-	message: Object | string;
+	message: string;
 }
 
 /** 
@@ -4359,9 +4459,10 @@ declare const Config: {
 	LOG_SERVER_URL: string;
 	CONFIG_REQUEST_DOMAINS: string[];
 	DEVICE_ID: string;
+	OVERSEA: boolean;
 };
 declare function setParameter(key: keyof typeof Config, value: any): void;
-declare function getParameter(key: keyof typeof Config): string | string[];
+declare function getParameter(key: keyof typeof Config): string | boolean | string[];
 /**
  * @list 104477
  * @detail 104478
@@ -4378,12 +4479,13 @@ export interface IVERTC {
 	 *        Calling this API repeatedly will create multiple IRTCEngine instances.
 	 * @param appId A unique identifier for each application. You can apply appIDs on the RTC console.
 	 *              Instances generated by different AppIDs are independent in RTC service. Users served by one AppID cannot communicate with users served by another AppID.
+	 * @param config Configuration of the engine instance, such as Auto-play policy
 	 * @return Return an `IRTCEngine` instance if you call this API successfully.
 	 * @notes + Call [destroyEngine](#destroyengine) respectively to destroy each IRTCEngine instance.
 	 *         + As each IRTCEngine instance is resource consuming, we recommend creating no more than 2 engine instances on each device at the same time.
 	 * @region Engine Management
 	 */
-	createEngine(appId: string): IRTCEngine;
+	createEngine(appId: string, config?: EngineConfig): IRTCEngine;
 	
 	/** 
 	 * @brief Call this API to destroy the IRTCEngine instance created by [createEngine](#createengine).
@@ -4474,7 +4576,7 @@ export interface IVERTC {
 }
 declare class VERTC implements IVERTC {
 	getSdkVersion: () => string;
-	createEngine: (appId: string) => IRTCEngine;
+	createEngine: (appId: string, config?: EngineConfig | undefined) => IRTCEngine;
 	destroyEngine: (engine: IRTCEngine) => void;
 	enumerateDevices: () => Promise<MediaDeviceInfo[]>;
 	enableDevices: (options?: {