@byteplus/rtc 4.66.2 → 4.66.4

package/index.d.ts

@@ -2317,7 +2317,7 @@ export interface AudioPropertiesInfo {
 	
 	/** 
 	 * @brief linear volume. The value is in linear relation to the original volume. The higher the value, the higher the volume. The range is [0,255]. <br>
-	 *        - [0, 25]: Silence <br>
+	 *        - [0, 25]: Nearly silent <br>
 	 *        - [26, 75]: Low volume <br>
 	 *        - [76, 204]: Medium volume <br>
 	 *        - [205, 255]: High volume <br>
@@ -2326,7 +2326,7 @@ export interface AudioPropertiesInfo {
 	
 	/** 
 	 * @brief non-linear volume in dB. The value is in proportion to the log value of the original volume. You can use the value to recognize the Active Speaker in the room. The range is [-127, 0]. <br>
-	 *        - [-127, -60]: Silence <br>
+	 *        - [-127, -60]: Nearly silent
 	 *        - [-59, -40]: Low volume <br>
 	 *        - [-39, -20]: Medium volume <br>
 	 *        - [-19, 0]: High volume <br>
@@ -2461,17 +2461,19 @@ export interface CoreConfigType {
 }
 
 /** 
- * @brief Information and state of a media device.
+ * @brief Information of an audio or video media device (such as camera, microphone, speaker) and its connection state.
  */
 export interface DeviceInfo {
 	
 	/** 
-	 * @brief Information of a media device. See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo).
+	 * @brief Device information, including device ID, type, etc. For details, see [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo).
 	 */
 	mediaDeviceInfo: MediaDeviceInfo;
 	
 	/** 
-	 * @brief Device state.
+	 * @brief Device state:
+	 *        - active: The device is connected.
+	 *        - inactive: The device is disconnected.
 	 */
 	deviceState: "active" | "inactive";
 }
@@ -2912,16 +2914,18 @@ export interface IEngineEvents {
 	[EngineEventsTypes.onRemoteAudioFirstFrame]: (event: onAudioFirstFrameDecodedEvent) => void;
 	
 	/** 
-	 * @brief Event of video device state changing.
-	 * @param event Information and state of a media device.
+	 * @brief Triggered when the connection state of a video device (i.e., camera) changes, such as when a device is disconnected/connected due to plugging or unplugging.<br/>
+	 * > You need to obtain device permissions first (which can be acquired through [enableDevices](104478#enabledevices)) to receive this callback.
+	 * @param event Information (such as device ID and type) and connection state of the device.
 	 * @group Device Management
 	 * @order 60
 	 */
 	[EngineEventsTypes.onVideoDeviceStateChanged]: (event: DeviceInfo) => void;
 	
 	/** 
-	 * @brief Event of audio device state changing.
-	 * @param event Information and state of a media device.
+	 * @brief Triggered when the connection state of an audio media device (i.e., microphone, speaker) changes, such as when a device is disconnected/connected due to plugging or unplugging.<br/>
+	 * > You need to obtain device permissions first (which can be acquired through [enableDevices](104478#enabledevices)) to receive this callback.
+	 * @param event Information (such as device ID and type) and connection state of the device.
 	 * @group Device Management
 	 * @order 50
 	 */
@@ -4024,12 +4028,12 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @param userId The user ID. The empty value indicates the local stream.
 	 * @return If the specified stream does not exist, the volume values are `0`.
 	 * + linear volume. The value is in linear relation to the original volume. The higher the value, the higher the volume. The range is [0,255]. <br>
-	 * &ensp; - \[0, 25]: Silence
+	 * &ensp; - \[0, 25]: Nearly silent
 	 * &ensp; - \[26, 75]: Low volume
 	 * &ensp; - \[76, 204]: Medium volume
 	 * &ensp; - \[205, 255]: High volume
 	 * + non-linear volume in dB. The value is in proportion to the log value of the original volume. You can use the value to recognize the Active Speaker in the room. The range is [-127, 0].
-	 * &ensp; - \[-127, -60]: Silence
+	 * &ensp; - \[-127, -60]: Nearly silent
 	 * &ensp; - \[-59, -40]: Low volume
 	 * &ensp; - \[-39, -20]: Medium volume
 	 * &ensp; - \[-19, 0]: High volume
@@ -4388,7 +4392,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	getWTNStreamManager: () => IWTNStream;
 	
 	/** 
-	 * @brief > Available since v4.66.
+	 * @brief > Available since v4.66.<br>
 	 * Get the call ID. Call this method after joining a room.
 	 * After creating a room, a `callId` is generated to identify the call for this room.
 	 * @return The call ID (`callId`) of the room.
@@ -6718,6 +6722,7 @@ export interface SetParamInterface {
 	PRODUCT: string;
 	FORCE_ENABLED_REPORT_CALLBACKS: string[];
 	SKIP_WEB_AUDIO_IN_TRACK: boolean;
+	ENFORCE_WEB_AUDIO_SUPPORTED: boolean;
 	AUDIO_STALL: boolean;
 	VIDEO_STALL: boolean;
 	VIDEO_STALL_100MS: boolean;
@@ -6751,6 +6756,7 @@ export interface SetParamInterface {
 	AREA_CODE: string;
 	DISABLE_COMPUTE_PRESSURE: boolean;
 	SEND_MESSAGE_SYNC: boolean;
+	H264_HW_ENCODER: boolean;
 }
 
 /**