@byteplus/rtc 4.46.6 → 4.46.8

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';
 
@@ -1569,7 +1569,8 @@ declare enum EngineEventsTypes {
 	onRemoteVideoSizeChanged = "onRemoteVideoSizeChanged",
 	onVideoStreamBanned = "onVideoStreamBanned",
 	onAudioStreamBanned = "onAudioStreamBanned",
-	onLocalVideoSizeChanged = "onLocalVideoSizeChanged"
+	onLocalVideoSizeChanged = "onLocalVideoSizeChanged",
+	onServerParamsSetResult = "onServerParamsSetResult"
 }
 
 /** 
@@ -2461,6 +2462,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;
 }
 
 /** 
@@ -3056,7 +3065,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>;
 	
@@ -3094,13 +3104,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.
@@ -4701,7 +4711,10 @@ declare class VERTC implements IVERTC {
 	private _monitor;
 }
 declare const _default: VERTC;
-export default _default;
+
+export {
+	_default as default,
+};
 
 export as namespace RTC;