@byteplus/rtc 4.47.1 → 4.47.2

package/index.d.ts

@@ -1,4 +1,4 @@
-// Generated by dts-bundle-generator v6.4.0
+// Generated by dts-bundle-generator v6.13.0
 
 import { EventArgs, EventEmitter, EventNames, ValidEventTypes } from 'eventemitter3';
 
@@ -1292,7 +1292,7 @@ export interface RemoteAudioStats {
 	
 	/** 
 	 * @hidden
-	 * @brief Decoding duration, unit: s
+	 * @brief Cumulative decoding time in seconds of the remote audio stream in this subscription.
 	 */
 	decDuration?: number;
 }
@@ -1486,13 +1486,13 @@ declare enum EngineEventsTypes {
 	
 	/** 
 	 * @brief The first video frame has been rendered successfully.
-	 * @deprecated
+	 * @deprecated  since 4.47, use on onRemoteVideoFirstFrame instead.
 	 */
 	onVideoFirstFrameRendered = "onVideoFirstFrameRendered",
 	
 	/** 
 	 * @brief The first video frame has been decoded successfully.
-	 * @deprecated
+	 * @deprecated since 4.47, use on onRemoteVideoFirstFrame instead.
 	 */
 	onVideoFirstFrameDecoded = "onVideoFirstFrameDecoded",
 	
@@ -1502,7 +1502,7 @@ declare enum EngineEventsTypes {
 	onRemoteVideoFirstFrame = "onRemoteVideoFirstFrame",
 	
 	/** 
-	 * @deprecated
+	 * @deprecated since 4.47, use on onRemoteAudioFirstFrame instead.
 	 * @brief The first audio frame has been decoded successfully.
 	 */
 	onAudioFirstFrameDecoded = "onAudioFirstFrameDecoded",
@@ -1607,7 +1607,8 @@ declare enum EngineEventsTypes {
 	onRemoteVideoSizeChanged = "onRemoteVideoSizeChanged",
 	onVideoStreamBanned = "onVideoStreamBanned",
 	onAudioStreamBanned = "onAudioStreamBanned",
-	onLocalVideoSizeChanged = "onLocalVideoSizeChanged"
+	onLocalVideoSizeChanged = "onLocalVideoSizeChanged",
+	onServerParamsSetResult = "onServerParamsSetResult"
 }
 
 /** 
@@ -2024,6 +2025,8 @@ export interface IEngineEvents {
 	}) => void;
 	
 	/** 
+	 * @hidden
+	 * @deprecated since 4.47, use on onRemoteVideoFirstFrame instead.
 	 * @brief Rendering of the first video frame
 	 * @param event
 	 * @region Video Management Event
@@ -2031,6 +2034,8 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onVideoFirstFrameRendered]: (event: onVideoFirstFrameRenderedEvent) => void;
 	
 	/** 
+	 * @hidden
+	 * @deprecated since 4.47, use on onRemoteVideoFirstFrame instead.
 	 * @brief Rendering of the first video frame
 	 * @param event
 	 * @region Video Management Event
@@ -2045,6 +2050,8 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onRemoteVideoFirstFrame]: (event: onVideoFirstFrameRenderedEvent) => void;
 	
 	/** 
+	 * @hidden
+	 * @deprecated since 4.47, use on onRemoteAudioFirstFrame instead.
 	 * @brief Decoding of the first audio frame
 	 * @param event
 	 * @region Audio Management Event
@@ -2468,8 +2475,7 @@ export interface IEngineEvents {
 	 * @brief The callback is triggered when the openAPI BanUserStream/UnbanUserStream is called to ban/unban the video stream of the specified user from publishing.
 	 * @param event
 	 * @notes + When the specified user in the room is banned/unbanned from sending video streams, all users in the room will receive the callback.
-	 *        + If the banned user leaves and then enters the room, the user is still banned from publishing video stream, and all users in the room will receive the callback again.
-	 *        + If the banned user reconnects due to connection drop, the user remains being banned, and only the banned user receives the callback.
+	 *        + If the banned user leaves or disconnects and then rejoins the room, the user is still banned from publishing audio stream, and all users in the room will be informed via the callback.
 	 *        + If a user is banned, other users receive this callback again when they leave and re-enter the room.
 	 *        + Only banned/unbanned user will receive this callback if the conference mode is enabled in the console.
 	 *        + If the room is dissolved and created again, the status in the room is cleared.
@@ -2480,8 +2486,7 @@ export interface IEngineEvents {
 	 * @brief The callback is triggered when the openAPI BanUserStream/UnbanUserStream is called to ban/unban the audio stream of the specified user from publishing.
 	 * @param event
 	 * @notes + When the specified user in the room is banned/unbanned from sending audio streams, all users in the room will receive the callback.
-	 *        + If the banned user leaves and then enters the room, the user is still banned from publishing audio stream, and all users in the room will receive the callback again.
-	 *        + If the banned user reconnects due to connection drop, the user remains being banned, and only the banned user receives the callback.
+	 *        + If the banned user leaves or disconnects and then rejoins the room, the user is still banned from publishing audio stream, and all users in the room will be informed via the callback.
 	 *        + If a user is banned, other users receive this callback again when they leave and re-enter the room.
 	 *        + Only banned/unbanned user will receive this callback if the conference mode is enabled in the console.
 	 *        + If the room is dissolved and created again, the status in the room is cleared.
@@ -2514,6 +2519,14 @@ export interface IEngineEvents {
 			height: number;
 		};
 	}) => void;
+	
+	/** 
+	 * @brief  Event of whether the setting for the message server successes
+	 * @param error Error code
+	 * @notes + This event notifies you the result after the call of [setServerParams](104478#setServerParams).
+	 * + If the client losts connection after the call of [setServerParams](104478#setServerParams) this event notifies once the client reconnects.
+	 */
+	[EngineEventsTypes.onServerParamsSetResult]: (error?: ErrorCode) => void;
 }
 
 /** 
@@ -2937,8 +2950,8 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Starts pushing media streams to CDN and sets the relevant configurations.
 	 * @param transcode configuration for push media streams to CDN.
 	 * @return
-	 * @notes + After calling this API, you will be informed of the result and errors during the pushing process via [onLiveTransCodingResult](104479#onlivetranscodingresult).
-	 *        + Call [stopLiveTranscoding](#stoplivetranscoding) to stop pushing stream to CDN.
+	 * @notes + After calling this API, you will receive the pushing a mixed stream to CDN events via [onStreamMixingEvent](104479#onstreammixingevent).
+	 *        + Call [stopLiveTranscoding](#stoplivetranscoding) to stop pushing mixed streams to CDN.
 	 * @region Advanced Feature
 	 */
 	startLiveTranscoding: (transcode: LiveTranscodeConfig) => Promise<void>;
@@ -3111,7 +3124,8 @@ 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](#login) before calling this API.
+	 * + [onServerParamsSetResult](104479#onserverparamssetresult) notifies you whether the setting successes.
 	 */
 	setServerParams: (signature: string, url: string) => Promise<any>;
 	
@@ -3149,13 +3163,13 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	
 	/** 
 	 * @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.
+	 * @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.
 	 *        + Call this API with different stream ID to publish multiple public streams.
 	 *        + Call [stopPushPublicStream](#stoppushpublicstream) to stop publishing the public stream.
@@ -4831,7 +4845,10 @@ declare class VERTC implements IVERTC {
 	private _monitor;
 }
 declare const _default: VERTC;
-export default _default;
+
+export {
+	_default as default,
+};
 
 export as namespace RTC;