@byteplus/rtc 4.46.0 → 4.46.2

package/index.d.ts

@@ -680,31 +680,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;
@@ -715,6 +728,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;
@@ -2744,7 +2761,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Send point-to-point text messages to a specified user in the room.
 	 * The recipient receives the message via [onUserMessageReceived](104479#onusermessagereceived)  once the message is sent successfully.
 	 * @param userId User ID of the recipient
-	 * @param message Text to be sent within 62KB
+	 * @param message Text to be sent within 64 KB
 	 * @return
 	 * @notes Call [joinRoom](#joinroom) to join the room before calling this API.
 	 * @region Message
@@ -2755,7 +2772,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Send point-to-point binary messages to a specified user in the room.
 	 * The recipient receives the message via [onUserBinaryMessageReceived](104479#onuserbinarymessagereceived) once the message is sent successfully.
 	 * @param userId User ID of the recipient
-	 * @param message Binary to be sent within 62KB
+	 * @param message Binary to be sent within 64 KB
 	 * @return
 	 * @notes Call [joinRoom](#joinroom) to join the room before calling this API.
 	 * @region Message
@@ -2765,7 +2782,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Send text messaging to all other users in the room.
 	 * Users in the room will receive message via [onRoomMessageReceived](104479#onroommessagereceived) once the message is sent successfully.
-	 * @param message Text to be sent within 62KB
+	 * @param message Text to be sent within 64 KB
 	 * @return
 	 * @region Message
 	 */
@@ -2774,7 +2791,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	/** 
 	 * @brief Send binary messaging to all other users in the room.
 	 * Users in the room will receive binary message via [onRoomBinaryMessageReceived](104479#onroombinarymessagereceived) once the message is sent successfully.
-	 * @param message Binary message to be sent within 62KB
+	 * @param message Binary message to be sent within 64 KB
 	 * @return
 	 * @region Message
 	 */