@byteplus/rtc 4.40.0 → 4.41.0

package/index.d.ts

@@ -18,11 +18,14 @@ declare enum ErrorCode {
 	 * @brief Token is invalid or has expired.
 	 */
 	INVALID_TOKEN = "INVALID_TOKEN",
+	EXPIRED_TOKEN = "EXPIRED_TOKEN",
 	
 	/** 
 	 * @brief Failure of joining room
 	 */
 	JOIN_ROOM_FAILED = "JOIN_ROOM_FAILED",
+	UPDATE_TOKEN_WITH_INVALID_TOKEN = "UPDATE_TOKEN_WITH_INVALID_TOKEN",
+	UPDATE_TOKEN_BEFORE_JOIN = "UPDATE_TOKEN_BEFORE_JOIN",
 	
 	/** 
 	 * @brief Join the same room repeatedly.
@@ -34,6 +37,16 @@ declare enum ErrorCode {
 	 */
 	REPEAT_PUBLISH = "REPEAT_PUBLISH",
 	
+	/** 
+	 * @brief Publish public stream repeatedly.
+	 */
+	REPEAT_PUSH = "REPEAT_PUSH",
+	
+	/** 
+	 * @brief Subscribe to the public stream repeatedly.
+	 */
+	REPEAT_PLAY = "REPEAT_PLAY",
+	
 	/** 
 	 * @brief Publish before joining a room.
 	 */
@@ -90,13 +103,11 @@ declare enum ErrorCode {
 	ALREADY_IN_ROOM = "ALREADY_IN_ROOM",
 	
 	/** 
-	 * @hidden
 	 * @brief The user has been remove from the room by the administrator via a OpenAPI call.
 	 */
 	KICKED_OUT = "KICKED_OUT",
 	
 	/** 
-	 * @hidden
 	 * @brief Users have been removed from the room because the administrator dismissed the room by calling OpenAPI.
 	 */
 	ROOM_DISMISS = "ROOM_DISMISS",
@@ -223,6 +234,14 @@ declare enum ErrorCode {
 	 */
 	OPERATION_CANCEL = "OPERATION_CANCEL",
 	
+	/** 
+	 */
+	START_CLOUD_PROXY_AFTER_JOIN = "START_CLOUD_PROXY_AFTER_JOIN",
+	
+	/** 
+	 */
+	STOP_CLOUD_PROXY_BEFORE_LEAVE = "STOP_CLOUD_PROXY_BEFORE_LEAVE",
+	
 	/** 
 	 * @brief Unknown error
 	 */
@@ -321,7 +340,12 @@ declare enum ErrorCode {
 	/** 
 	 * @brief Unknown error of messaging
 	 */
-	USER_MESSAGE_UNKNOWN = "USER_MESSAGE_UNKNOWN"
+	USER_MESSAGE_UNKNOWN = "USER_MESSAGE_UNKNOWN",
+	
+	/** 
+	 * @brief The user publishes a public stream before joining room.
+	 */
+	START_PUBLIC_STREAM_BEFORE_JOIN = "START_PUBLIC_STREAM_BEFORE_JOIN"
 }
 declare enum AudioMixingError {
 	
@@ -760,6 +784,17 @@ export interface onVideoFirstFrameDecodedEvent {
 	width: number;
 }
 
+/** 
+ * Event related to decoding the first video frame of the public stream.
+ */
+export declare type PublicStreamVideoFirstFrameDecodedEvent = Omit<onVideoFirstFrameDecodedEvent, "userId"> & {
+	
+	/** 
+	 * @brief  The public stream's ID.
+	 */
+	publicStreamId: string;
+};
+
 /** 
  * Event related to the decoder of the first audio frame
  */
@@ -771,6 +806,17 @@ export interface onAudioFirstFrameDecodedEvent {
 	userId: string;
 }
 
+/** 
+ * @brief Event related to decoding or rendering the first video frame of the public stream.
+ */
+export interface PublicStreamAudioFirstFrameDecodedEvent {
+	
+	/** 
+	 * @brief  The public stream's ID.
+	 */
+	publicStreamId: string;
+}
+
 /** 
  * State of the media devices which including audio capture device. audio playback device, and video capture device.
  */
@@ -808,6 +854,23 @@ export interface onSEIMessageEvent {
 	sei: Uint8Array;
 }
 
+/** 
+ * @hidden
+ * @brief The SEI carried by the public video stream.
+ */
+export interface PublicStreamSEIMessageEvent {
+	
+	/** 
+	 * @brief  The public stream's ID.
+	 */
+	publicStreamId: string;
+	
+	/** 
+	 * @brief SEI message.
+	 */
+	sei: Uint8Array;
+}
+
 /** 
  * State of the local audio stream
  */
@@ -1171,6 +1234,22 @@ export interface RemoteStreamStats {
 	 */
 	rxQuality?: number;
 }
+
+/** 
+ * @brief Subscribed public stream's statistics and network condition, reference period 2s.
+ */
+export declare type PublicStreamStats = Omit<
+
+/** 
+ * @brief Remote stream stats
+ */
+RemoteStreamStats, "userId" | "isScreen"> & {
+	
+	/** 
+	 * @brief The public stream's ID.
+	 */
+	publicStreamId: string;
+};
 declare enum EngineEventsTypes {
 	
 	/** 
@@ -1258,6 +1337,21 @@ declare enum EngineEventsTypes {
 	 */
 	onAudioFirstFrameDecoded = "onAudioFirstFrameDecoded",
 	
+	/** 
+	 * The first video frame has been rendered successfully.
+	 */
+	onFirstPublicStreamVideoFrameRendered = "onFirstPublicStreamVideoFrameRendered",
+	
+	/** 
+	 * The first video frame has been decoded successfully.
+	 */
+	onFirstPublicStreamVideoFrameDecoded = "onFirstPublicStreamVideoFrameDecoded",
+	
+	/** 
+	 * The first audio frame has been decoded successfully.
+	 */
+	onFirstPublicStreamAudioFrameDecoded = "onFirstPublicStreamAudioFrameDecoded",
+	
 	/** 
 	 * @brief The state of the media device changes.
 	 */
@@ -1268,6 +1362,11 @@ declare enum EngineEventsTypes {
 	 */
 	onRemoteStreamStats = "onRemoteStreamStats",
 	
+	/** 
+	 * Callback including the state of the remote public media stream
+	 */
+	onPublicStreamStats = "onPublicStreamStats",
+	
 	/** 
 	 * @brief Callback including the state of the local media stream
 	 */
@@ -1313,7 +1412,11 @@ declare enum EngineEventsTypes {
 	onError = "onError",
 	onAudioMixingStateChanged = "onAudioMixingStateChanged",
 	onUserMessageReceivedOutsideRoom = "onUserMessageReceivedOutsideRoom",
-	onUserBinaryMessageReceivedOutsideRoom = "onUserBinaryMessageReceivedOutsideRoom"
+	onUserBinaryMessageReceivedOutsideRoom = "onUserBinaryMessageReceivedOutsideRoom",
+	onTokenWillExpire = "onTokenWillExpire",
+	onCloudProxyConnected = "onCloudProxyConnected",
+	onPushPublicStreamResult = "onPushPublicStreamResult",
+	onPublicStreamSEIMessageReceived = "onPublicStreamSEIMessageReceived"
 }
 
 /** 
@@ -1405,6 +1508,7 @@ export interface PlayerEvent {
 	 * @brief userId of the user who is joining the room
 	 */
 	userId: string;
+	publicStreamId?: string;
 	
 	/** 
 	 * @brief Readies state of the medias. Refer to the [official documentation](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/readyState)
@@ -1603,6 +1707,12 @@ export interface IEngineEvents {
 	 */
 	[EngineEventsTypes.onLocalStreamStats]: (stats: LocalStreamStats) => void;
 	
+	/** 
+	 * @brief Subscribed public stream's statistics and network condition, reference period 2s.
+	 * @param stats
+	 */
+	[EngineEventsTypes.onPublicStreamStats]: (stats: PublicStreamStats) => void;
+	
 	/** 
 	 * @brief Volume of each of the users in the room
 	 * If the user has not joined a room, the list will only include volume of `local_user`.
@@ -1704,7 +1814,7 @@ export interface IEngineEvents {
 	 * @region Room Management Event
 	 */
 	[EngineEventsTypes.onError]: (event: {
-		errorCode: ErrorCode;
+		errorCode: ErrorCode.DUPLICATE_LOGIN | ErrorCode.RTM_DUPLICATE_LOGIN | ErrorCode.RTM_TOKEN_ERROR | ErrorCode.EXPIRED_TOKEN;
 	}) => void;
 	
 	/** 
@@ -1727,6 +1837,72 @@ export interface IEngineEvents {
 	 * @region Message Event
 	 */
 	[EngineEventsTypes.onUserBinaryMessageReceivedOutsideRoom]: (event: UserBinaryMessageEvent) => void;
+	[EngineEventsTypes.onTokenWillExpire]: () => 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
+	 */
+	[EngineEventsTypes.onCloudProxyConnected]: (event: CloudProxyConnectedEvent) => void;
+	
+	/** 
+	 * @brief Callback of the result of publishing the public stream.
+	 *        After calling [startPushPublicStream](#startpushpublicstream), you will be informed of the result through this callback.
+	 * @param event
+	 */
+	[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](#startplaypublicstream) is carrying SEI.
+	 * @param event
+	 * @notes When multiple streams in the public stream contain SEI:
+	 *        + You will receive SEI from all the video frames if the SEI do not have conflicts.
+	 *        + However, if SEI from video frames have conflicts, you will receive only one of them.
+	 */
+	[EngineEventsTypes.onPublicStreamSEIMessageReceived]: (event: PublicStreamSEIMessageEvent) => void;
+	
+	/** 
+	 * @brief Callback of the successful decoding of the first video frame of the public stream.
+	 *        Refer to [startPlayPublicStream](#startplaypublicstream) for details about subsribing to a public stream.
+	 * @param event
+	 */
+	[EngineEventsTypes.onFirstPublicStreamVideoFrameDecoded]: (event: PublicStreamVideoFirstFrameDecodedEvent) => void;
+	
+	/** 
+	 * @brief Callback of the successful decoding of the first audio frame of the public stream.
+	 *        Refer to [startPlayPublicStream](#startplaypublicstream) for details about subsribing to a public stream.
+	 * @param event
+	 */
+	[EngineEventsTypes.onFirstPublicStreamAudioFrameDecoded]: (event: PublicStreamAudioFirstFrameDecodedEvent) => void;
+	
+	/** 
+	 * @brief Callback of the successful rendering of the first video frame of the public stream.
+	 * @param event
+	 */
+	[EngineEventsTypes.onFirstPublicStreamVideoFrameRendered]: (event: PublicStreamAudioFirstFrameDecodedEvent) => void;
+}
+
+/** 
+ * @brief Cloud proxy informatio
+ */
+export interface CloudProxyInfo {
+	
+	/** 
+	 * @brief The cloud proxy IP of log report
+	 */
+	logProxy: string;
+	
+	/** 
+	 * @brief The cloud proxy IP of the access
+	 */
+	accessProxy: string;
+	
+	/** 
+	 * @brief The cloud proxy IP of RTC admin control
+	 */
+	configProxy: string;
 }
 
 /** 
@@ -1765,7 +1941,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *     + You must call this API to end the call, after calling the [joinRoom](#joinroom) method to join the room. Otherwise you cannot start the next call. Repeatedly call this method have no negative impact. <br>
 	 * @region Room Management
 	 */
-	leaveRoom(): void;
+	leaveRoom(waitAck?: boolean): Promise<void>;
 	
 	/** 
 	 * @brief Destroy engine
@@ -2226,14 +2402,15 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *         Apps with different AppIDs are not interoperable. <br>
 	 * @param userInfo  User information.
 	 * @return
-	 * @notes + Call [logout](#logout) to log out the IM server.
+	 * @notes
+	 *        + Call logout{@link #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`.
 	 * @region Room Management
 	 */
 	login(token: string | null, userId: string): Promise<void>;
 	
 	/** 
-	 * @brief After calling this API to logout you are not able to call APIs to send messages and server messages.
+	 * After calling this API to logout you are not able to call APIs to send messages and server messages.
 	 * @return
 	 */
 	logout(): Promise<void>;
@@ -2242,7 +2419,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Update the Token used to login. Since all tokens have a limited time-to-live, call this API to refresh the token.
 	 * @param token updated token
 	 * @return
-	 * @notes + Call this API to refresh the token after the token has expired with no need for calling [login](#login).
+	 * @notes + Call this API to refresh the token after the token has expired with no need for calling login{@link #login}.
 	 *  + You will be informed of the expiration of the token if you tried to login with an expired token or during a reconnection. If the token expired after the user has logged in, no actions need to be taken.
 	 */
 	updateLoginToken(token: string | null): Promise<void>;
@@ -2251,7 +2428,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Get the status of a user before sending him/her a P2P message. You can also call this API to check the status of the current user.
 	 * @param userId ID of the user whose status intended to know
 	 * @return
-	 * @notes Call [login](#login) before calling this API.
+	 * @notes Call login{@link #login} before calling this API.
 	 */
 	getPeerOnlineStatus(userId: string): Promise<USER_ONLINE_STATUS>;
 	
@@ -2260,8 +2437,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param userId ID of the recipient
 	 * @param message Text message within 62 KB.
 	 * @return
-	 * @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.
+	 * @notes + Call login{@link #login} before calling this API.
+	 * + The recipient must be logged into the server and will receive the text message via [EngineEventsTypes.onUserMessageReceivedOutsideRoom]{@link #[EngineEventsTypes.onUserMessageReceivedOutsideRoom]} if the message has been sent successfully.
 	 */
 	sendUserMessageOutsideRoom(userId: string, message: string): Promise<any>;
 	
@@ -2269,9 +2446,9 @@ 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 46 KB
-	 * @return
-	 * @notes + Call [login](#login) before calling this API.
-	 *  + The recipient must be logged into the server and will receive the text message via [onUserBinaryMessageReceivedOutsideRoom](104479#onuserbinarymessagereceivedoutsideroom) if the message has been sent successfully.
+	 * @return + Call login{@link #login} before calling this API.
+	 *  + The recipient must be logged into the server and will receive the text message via [EngineEventsTypes.onUserBinaryMessageReceivedOutsideRoom]{@link #[EngineEventsTypes.onUserBinaryMessageReceivedOutsideRoom]} if the message has been sent successfully.
+	 * @notes
 	 */
 	sendUserBinaryMessageOutsideRoom(userId: string, message: ArrayBuffer): Promise<any>;
 	
@@ -2280,7 +2457,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param signature Dynamic signature.
 	 * @param url Address of the IM server
 	 * @return
-	 * @notes Call [login](#login) before calling this API.
+	 * @notes Call login{@link #login} before calling this API.
 	 */
 	setServerParams(signature: string, url: string): Promise<any>;
 	
@@ -2288,7 +2465,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Send point-to-point (P2P) text message to the server.
 	 * @param message Text message within 62 KB.
 	 * @return
-	 * @notes Call [login](#login) and [setServerParams](#setserverparams) before calling this API.
+	 * @notes
 	 */
 	sendServerMessage(message: string): Promise<any>;
 	
@@ -2296,10 +2473,89 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Send point-to-point (P2P) binary message to the server.
 	 * @param message Binary message within 46 KB.
 	 * @return
-	 * @notes Call [login](#login) and [setServerParams](#setserverparams) before calling this API.
+	 * @notes
 	 */
 	sendServerBinaryMessage(message: ArrayBuffer): Promise<any>;
 	
+	/** 
+	 * @brief  Start cloud proxy
+	 * @param  cloudProxyInfo cloud proxy informarion list.
+	 * @notes   <br>
+	 *         + Call this API before joining the room.<br>
+	 *         + Start pre-call network detection after starting cloud proxy. <br>
+	 *         + After starting cloud proxy and connects the cloud proxy server successfully, receives [onCloudProxyConnected](104479#onCloudProxyConnected). <br>
+	 *         + To stop cloud proxy, call [stopCloudProxy](#stopCloudProxy).
+	 */
+	startCloudProxy(cloudProxyInfo: CloudProxyInfo): void;
+	
+	/** 
+	 * @brief Stop cloud proxy
+	 * @notes To start cloud proxy, call [startCloudProxy](#startCloudProxy).
+	 */
+	stopCloudProxy(): void;
+	
+	/** 
+	 * @brief Starts publishing a public media stream.
+	 *        A public stream is a media stream that does not belong to any room or any user. Users with the same `appID` can call [startPlayPublicStream](#startplaypublicstream) to subscribe to and play the public stream.
+	 * @param publicStreamId The public stream's ID.
+	 * @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
+	 * @notes + 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.
+	 *        + Call this API with different stream ID to publish multiple public streams.
+	 *        + Call [stopPushPublicStream](#stoppushpublicstream) to stop publishing the public stream.
+	 */
+	startPushPublicStream(publicStreamId: string, publicStreamParam: PublicStreamConfig): Promise<void>;
+	
+	/** 
+	 * @brief Update the properties of the public stream published by the current user.
+	 *        Call [startPushPublicStream](#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
+	 */
+	updatePublicStreamParam(publicStreamId: string, publicStreamParam: Partial<PublicStreamConfig>): Promise<void>;
+	
+	/** 
+	 * @type api
+	 * @brief Stops publishing the public stream.
+	 *        Call [startPushPublicStream](#startpushpublicstream) to start publishing a public stream.
+	 * @param publicStreamId The public stream's ID.
+	 *                       The public stream must be published by the current user.
+	 * @return
+	 */
+	stopPushPublicStream(publicStreamId: string): Promise<void>;
+	
+	/** 
+	 * @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.
+	 *                       If the designated stream is not published when you call this API, you will receive the public stream once it is published.
+	 * @return
+	 * @notes + Before calling this API, we recommend that you call [setPublicStreamVideoPlayer](#setpublicstreamvideoplayer) first to set the player information and rendering mode for the public stream.
+	 *        + After calling this API, you will receive [onFirstPublicStreamVideoFrameDecoded](#onfirstpublicstreamvideoframedecoded) and [onFirstPublicStreamAudioFrameDecoded](#onfirstpublicstreamaudioframedecoded) once the first frame has been decoded.
+	 *        + Call [stopPlayPublicStream](#stopplaypublicstream) to unsubscribing from the public stream.
+	 */
+	startPlayPublicStream(publicStreamId: string): Promise<void>;
+	
+	/** 
+	 * @brief Unsubscribes from a designated public stream.
+	 *        Call [startPlayPublicStream](#startplaypublicstream) to subscribe to the public stream.
+	 * @param publicStreamId The public stream's ID.
+	 * @return
+	 */
+	stopPlayPublicStream(publicStreamId: string): Promise<void>;
+	
+	/** 
+	 * @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.
+	 */
+	setPublicStreamVideoPlayer(publicStreamId: string, videoPlayerOption: Omit<VideoPlayerOption, "userId">): void;
+	
 	/** 
 	 * @brief Get the default parameters of `LiveTranscodeConfig`.
 	 * @return The default parameters of `LiveTranscodeConfig`
@@ -2381,7 +2637,6 @@ export declare enum UserOfflineReason {
 	SWITCH_TO_INVISIBLE = 2,
 	
 	/** 
-	 * @hidden
 	 * @brief The remote user has been removed from the room by the administrator via a OpenAPI call.
 	 */
 	KICKED_BY_ADMIN = 3
@@ -2419,7 +2674,6 @@ export interface RoomConfig {
 }
 
 /** 
- * @hidden
  * @brief Subscription mode
  */
 export declare enum SubscribeMode {
@@ -2855,7 +3109,7 @@ export interface LiveTranscodeConfig {
 	url: string;
 	
 	/** 
-	 * @brief Audio transcoding related configurations.
+	 * Audio transcoding related configurations.
 	 */
 	audio?: Partial<LiveTranscodeAudioConfig>;
 	
@@ -3084,6 +3338,145 @@ export declare enum USER_ONLINE_STATUS {
 	UNREACHABLE = 2
 }
 
+/** 
+ * @brief The media type of the public stream.
+ */
+export declare enum PublicStreamType {
+	
+	/** 
+	 * @brief Audio and video.
+	 */
+	AUDIO_AND_VIDEO = 0,
+	
+	/** 
+	 * @brief Audio only.
+	 */
+	AUDIO_ONLY = 1,
+	
+	/** 
+	 * @brief Video only.
+	 */
+	VIDEO_ONLY = 2
+}
+
+/** 
+ * @brief Interpolation mode.
+ */
+export declare enum PublicInterpolationMode {
+	
+	/** 
+	 * @brief Intermediate with the last frame.
+	 */
+	PREV_FRAME = 0,
+	
+	/** 
+	 * @brief Intermediate with the background image or blank frames.
+	 */
+	OTHER_FRAME = 1
+}
+
+/** 
+ * @brief Layout configuration of a media stream
+ */
+export declare type PublicStreamLayoutRegion = Omit<LiveTranscodeLayoutRegion, "isLocalUser" | "contentControl"> & {
+	
+	/** 
+	 * @brief Room ID of the user that publishes the media stream.
+	 */
+	roomId: string;
+	
+	/** 
+	 * @brief Media type of the public stream.
+	 */
+	mediaType?: PublicStreamType;
+	
+	/** 
+	 * @brief Configurations on how to crop the public stream
+	 */
+	sourceCrop?: {
+		
+		/** 
+		 * @brief The normalized horizontal coordinate value of the top left vertex of the cropped image to width of the original image, ranging within [0.0, 1.0).
+		 */
+		x: number;
+		
+		/** 
+		 * @brief The normalized vertical coordinate value of the top left vertex of the cropped image to height of the original image, ranging within [0.0, 1.0).
+		 */
+		y: number;
+		
+		/** 
+		 * @brief The normalized ratio of the width of the cropped image to that of the original image, ranging within [0.0, 1.0).
+		 */
+		w: number;
+		
+		/** 
+		 * @brief The normalized ratio of the height of the cropped image to that of the original image, ranging within [0.0, 1.0).
+		 */
+		h: number;
+	};
+};
+
+/** 
+ * @brief Configurations of the public stream.
+ */
+export interface PublicStreamConfig {
+	
+	/** 
+	 * @brief Video configurations.
+	 */
+	video?: {
+		
+		/** 
+		 * @brief Width, unit: px.
+		 *        Valid for even numbers only. Assigning an odd number will lead to a failure of publishing a public stream.
+		 */
+		width?: number;
+		
+		/** 
+		 * @brief Height, unit: px.
+		 *        Valid for even numbers only. Assigning an odd number will lead to a failure of publishing a public stream.
+		 */
+		height?: number;
+		
+		/** 
+		 * @brief Frame rate, unit: fps
+		 */
+		fps?: number;
+		
+		/** 
+		 * @brief Bitrate, unit: kbps<br>
+		 */
+		kBitRate: number;
+	};
+	
+	/** 
+	 * @brief The layout mode of the public stream.
+	 */
+	layout?: {
+		
+		/** 
+		 * @brief Interpolation mode.
+		 */
+		interpolationMode?: PublicInterpolationMode;
+		
+		/** 
+		 * @brief Background color in hexadecimal.
+		 */
+		backgroundColor?: string;
+		
+		/** 
+		 * @brief Background image URL up to 1,024 bytes in length. The image format should be JPG, JPEG, or PNG.
+		 */
+		backgroundImage?: string;
+		
+		/** 
+		 * @brief Layout configuration of the public stream
+		 */
+		regions?: PublicStreamLayoutRegion[];
+	};
+}
+
 /** 
  * @brief Point-to-point text message
  */
@@ -3131,12 +3524,32 @@ export interface LiveTranscodingResultEvent {
 	 */
 	message: string;
 }
+
+/** 
+ * @brief The result of publishing the public stream.
+ */
+export interface PublicStreamResultEvent {
+	
+	/** 
+	 * @brief Event number of publishing the public stream.
+	 */
+	code: number;
+	
+	/** 
+	 * @brief Event details of publishing the public stream.
+	 */
+	message: string;
+}
+export interface CloudProxyConnectedEvent {
+	interval: number;
+}
 declare const Config: {
 	VERSION: string;
 	ICE_CONFIG_REQUEST_URLS_INTERNAL: string[];
 	ICE_CONFIG_REQUEST_URLS: never[];
 	EXPECTED_ADDR: string;
 	LOG_SERVER_URL: string;
+	CONFIG_REQUEST_DOMAINS: string[];
 };
 declare function setParameter(key: keyof typeof Config, value: any): void;
 declare function getParameter(key: keyof typeof Config): string | string[] | never[];
@@ -3234,6 +3647,14 @@ export interface IVERTC {
 	 * @region Engine Management
 	 */
 	isSupported: () => Promise<boolean>;
+	
+	/** 
+	 * @brief Gets the codec type supported by current browser.
+	 * If you have enabled vp8 codec, you can call the API to check whether the current browser supports vp8 encoding type before entering the room.
+	 * @return 当前浏览器支持的编解码类型
+	 * @region Engine Management
+	 */
+	getSupportedCodecs: () => Promise<string[]>;
 }
 declare class VERTC implements IVERTC {
 	getSdkVersion: () => string;
@@ -3253,6 +3674,7 @@ declare class VERTC implements IVERTC {
 	getParameter: typeof getParameter;
 	setParameter: typeof setParameter;
 	isSupported: () => Promise<boolean>;
+	getSupportedCodecs: () => Promise<string[]>;
 	events: typeof EngineEventsTypes;
 	ErrorCode: typeof ErrorCode;
 	platform: string;