@byteplus/rtc 4.45.1 → 4.45.3

package/index.d.ts

@@ -690,31 +690,44 @@ export interface AudioCodecProfile {
 	chn: number;
 	sr: number;
 }
+/**
+ * 音频采集参数下发，定义参考文档：https://bytedance.feishu.cn/sheets/shtcnu2nj9ghFLWiANQb6A1snxh?sheet=7d720e
+ */
 export interface IEngineBAC {
-	codec?: any;
-	play?: AudioCodecProfile;
-	record?: AudioCodecProfile;
+	codec?: {
+		enc_fs?: number;
+	};
+	adm?: {
+		play?: AudioCodecProfile;
+		record?: AudioCodecProfile;
+	};
 	agc?: any;
 	aec?: any;
 	ans?: any;
 }
+/**
+ * 音频编码参数下发，定义参考文档：https://bytedance.feishu.cn/sheets/shtcnu2nj9ghFLWiANQb6A1snxh?sheet=7d720e
+ */
 export interface IEngineANM {
-	enc_param: {
+	enc_param?: {
 		bitrate: number;
 		chn: number;
+		sr: number;
 	};
 }
 export interface IAudioConfig {
-	bitrate: number;
-	channel: number;
-	sampleRate: number;
-	agc: boolean;
-	aec: boolean;
-	ans: boolean;
+	bitrate?: number;
+	channel?: number;
+	playChannel?: number;
+	sampleRate?: number;
+	playbackRate?: number;
+	agc?: boolean;
+	aec?: boolean;
+	ans?: boolean;
 }
 declare class AudioProfileManager {
-	engineBAC: any;
-	engineANM: any;
+	engineBAC: Partial<IEngineBAC>;
+	engineANM: IEngineANM;
 	bitrate?: number;
 	sampleRate?: number;
 	channel?: number;
@@ -725,6 +738,10 @@ declare class AudioProfileManager {
 	private _init;
 	updateEngineBAC(newProfile?: IEngineBAC): void;
 	updateEngineANM(newProfile?: IEngineANM): void;
+	/**
+	 * 通过setAudioProfile设置进来的预设编码参数
+	 * @param profile AudioProfile
+	 */
 	setAudioProfile(profile: AudioProfileType): void;
 	setBitrate(bitrate: number): void;
 	setAEC(enable: boolean): void;
@@ -1559,7 +1576,8 @@ declare enum EngineEventsTypes {
 	onNetworkQuality = "onNetworkQuality",
 	onSimulcastSubscribeFallback = "onSimulcastSubscribeFallback",
 	onRemoteVideoSizeChanged = "onRemoteVideoSizeChanged",
-	onLocalVideoSizeChanged = "onLocalVideoSizeChanged"
+	onLocalVideoSizeChanged = "onLocalVideoSizeChanged",
+	onServerParamsSetResult = "onServerParamsSetResult"
 }
 
 /** 
@@ -2397,6 +2415,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;
 }
 
 /** 
@@ -2992,7 +3018,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>;
 	
@@ -3030,13 +3057,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.