@byteplus/rtc 4.52.0 → 4.53.0

package/index.d.ts

@@ -990,7 +990,6 @@ export interface onSEIMessageEvent {
 }
 
 /** 
- * @hidden
  * @brief The SEI carried by the public video stream.
  */
 export interface PublicStreamSEIMessageEvent {
@@ -1204,6 +1203,12 @@ export interface RemoteAudioStats {
 	 */
 	e2eDelay: number;
 	
+	/** 
+	 * @brief The round-trip transmission time delay in ms.
+	 * @notes For FireFox, the value is not accurate.
+	 */
+	totalRtt: number;
+	
 	/** 
 	 * @hidden
 	 * @brief Sample rate of the playback
@@ -1322,6 +1327,12 @@ export interface RemoteVideoStats {
 	 */
 	e2eDelay: number;
 	
+	/** 
+	 * @brief The round-trip transmission time delay in ms.
+	 * @notes For FireFox, the value is not accurate.
+	 */
+	totalRtt: number;
+	
 	/** 
 	 * @brief Whether it is a screen-sharing stream
 	 */
@@ -1507,6 +1518,9 @@ export interface ConnectionStateChangeEvent {
 	 */
 	state: ConnectionState;
 }
+export interface VendorConnectionStateChangeEvent extends ConnectionStateChangeEvent {
+	userId: string;
+}
 
 /** 
  * @brief Event related to the player
@@ -1894,7 +1908,8 @@ declare enum EngineEventsTypes {
 	onLocalVideoSizeChanged = "onLocalVideoSizeChanged",
 	onSubtitleStateChanged = "onSubtitleStateChanged",
 	onSubtitleMessageReceived = "onSubtitleMessageReceived",
-	onServerParamsSetResult = "onServerParamsSetResult"
+	onServerParamsSetResult = "onServerParamsSetResult",
+	onVendorConnectionStateChanged = "onVendorConnectionStateChanged"
 }
 
 /** 
@@ -1932,6 +1947,14 @@ export interface IEngineEvents {
 	 */
 	[EngineEventsTypes.onConnectionStateChanged]: (event: ConnectionStateChangeEvent) => void;
 	
+	/** 
+	 * @hidden
+	 * @brief Vendor ICE connection state changed
+	 * @param event
+	 * @region Network Event
+	 */
+	[EngineEventsTypes.onVendorConnectionStateChanged]: (event: VendorConnectionStateChangeEvent) => void;
+	
 	/** 
 	 * @brief Callback on new media streams captured by camera/microphone in the room.
 	 * @notes You will receive this callback after a remote user successfully publishes media streams captured by camera/microphone in the room with [publishStream](104478#publishstream). Then you can choose whether to call [subscribeStream](104478#subscribestream) to subscribe to the streams or not.
@@ -2087,6 +2110,10 @@ export interface IEngineEvents {
 		 */
 		isScreen: boolean;
 	}) => void;
+	
+	/** 
+	 * @internal
+	 */
 	[EngineEventsTypes.onTrackMute]: (event: {
 		
 		/** 
@@ -2099,6 +2126,10 @@ export interface IEngineEvents {
 		 */
 		isScreen: boolean;
 	}) => void;
+	
+	/** 
+	 * @internal
+	 */
 	[EngineEventsTypes.onTrackUnmute]: (event: {
 		
 		/** 
@@ -2896,13 +2927,13 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	
 	/** 
 	 * @brief Send SEI message carried by video frames
-	 * @param streamIndex
-	 * @param message SEI message within 4kb. 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,30].
+	 * @param streamIndex Stream index.
+	 * @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.
+	 *        + 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.
 	 * @region Message
 	 */
 	sendSEIMessage: (streamIndex: StreamIndex, message: Uint8Array | string, repeatCount: number) => void;
@@ -3096,15 +3127,13 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Log in to the RTM server.
 	 * Call this method before users within the same `appID` can communicate with each other via messages.
-	 * @param token Dynamic key. It is used for authentication and verification of users entering the room.
-	 *         You need to bring Token to enter the room. When testing, you can use the console to generate temporary tokens. The official launch requires the use of the key SDK to generate and issue tokens at your server level.
-	 *         Apps with different AppIDs are not interoperable.
-	 * @param userInfo  User information.
+	 * @param token Token for authentication.
+	 *         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
-	 * @notes
-	 *        + Call [logout](#logout) to log out the IM server.
+	 * @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`.
-	 * @region Room Management
 	 */
 	login: (token: string | null, userId: string) => Promise<void>;
 	
@@ -3429,8 +3458,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 +  `0`: Success.
-	 *         + `!0`: Failure.
+	 * @return
 	 * @notes
 	 *        You must call this method after joining the room.
 	 *        You can set your source language by calling `joinRoom`  and importing a json formatted string `"source_language": "zh"` through the paramater of extraInfo. Only chinese, English and Japanese are supported.
@@ -3715,7 +3743,7 @@ export interface VideoPlayerOption {
 	renderDom?: string | HTMLElement;
 	
 	/** 
-	 * @brief Rendering modes: optional  `RENDER_MODE_HIDDEN` and `RENDER_MODE_FIT` .
+	 * @brief Rendering mode.
 	 */
 	renderMode?: VideoRenderMode;
 	
@@ -3735,16 +3763,22 @@ export interface VideoPlayerOption {
 export declare enum VideoRenderMode {
 	
 	/** 
-	 * @brief Windows fill priority.
-	 * Scale the video frame at the original equal ratio until the window is filled with video. If the video frame aspect ratio is different from that of the window, the over-brims of the video frame will not be displayed.
+	 * @brief (Default value for main stream) Fills the entire window with the video frame.
+	 *        The video frame is scaled until the window is filled. If the video frame's aspect ratio is different from that of the window, the extra part of the video frame will be cropped.
 	 */
 	RENDER_MODE_HIDDEN = 0,
 	
 	/** 
-	 * @brief All video frame contents are fit to display in the window.
-	 * Scale the video frame at the original equal ratio until the whole video frame has been displayed in the window. If the video frame aspect ratio is different from that of the window, the area on the window that is not filled by the video frame will be blacked out.
+	 * @brief (Default value for screen-sharing stream) Makes the entire video frame fit within the window while maintaining the video frame's original aspect ratio.
+	 *        There may be empty space at the margins of the window.
+	 */
+	RENDER_MODE_FIT = 1,
+	
+	/** 
+	 * @brief Stretch the video frame until the window is filled.
+	 *        The video frame's aspect ratio can be changed as it is automatically stretched to fill the window.
 	 */
-	RENDER_MODE_FIT = 1
+	RENDER_MODE_FILL = 2
 }
 
 /** 
@@ -4063,10 +4097,10 @@ export declare enum MirrorType {
 export interface AudioPropertiesConfig {
 	
 	/** 
-	 * @brief Prompt interval in ms, the default value is 100.
-	 *        + `<= 0`: Turn off prompt
-	 *        + `(0,100]`: Invalid interval value, and will be automatically reset to 100ms.
-	 *        + `> 100`: The actual value of interval
+	 * @brief Prompt interval in ms, the default value is 100.  </br>
+	 *     &ensp; + `≤0`: Turn off prompt.
+	 *     &ensp; + `(0,100)`: Invalid interval value, and will be automatically reset to 100ms.
+	 *     &ensp; + `≥100`: Enable prompt and set the prompt interval to the set value.
 	 */
 	interval?: number;
 	
@@ -5154,6 +5188,7 @@ declare class VERTC implements IVERTC {
 	events: typeof EngineEventsTypes;
 	ErrorCode: typeof ErrorCode;
 	platform: string;
+	commitInfo: string;
 	downloadLog: (key?: string | undefined) => void;
 	setLogConfig: ({ logLevel, LogfileSize }: {
 		logLevel?: "none" | "error" | "info" | "warning" | "trace" | undefined;