agora-electron-sdk 4.1.1-rc.1 → 4.2.0-dev.13

package/ts/Private/IAgoraSpatialAudio.ts

@@ -1,5 +1,6 @@
 import './extension/IAgoraSpatialAudioExtension';
 import { RtcConnection } from './IAgoraRtcEngineEx';
+
 /**
  * The spatial position of the remote user or the media player.
  */
@@ -69,9 +70,9 @@ export abstract class IBaseSpatialAudioEngine {
 
   /**
    * Sets the maximum number of streams that a user can receive in a specified audio reception range.
-   * If the number of receivable streams exceeds the set value, the local user receives the maxCount streams that are closest to the local user. If there are users who belong to the same team as the local user in the room, the local user receives the audio of the teammates first. For example, when maxCount is set to 3, if there are five remote users in the room, two of whom belong to the same team as the local user, and three of whom belong to different teams but are within the audio reception range of the local user, the local user can hear the two teammates and the one user from a different team closest to the local user.
+   * If the number of receivable streams exceeds the set value, the local user receives the maxCount streams that are closest to the local user.
    *
-   * @param maxCount The maximum number of streams that a user can receive within a specified audio reception range.
+   * @param maxCount The maximum number of streams that a user can receive within a specified audio reception range. The value of this parameter should be ≤ 16, and the default value is 10.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -82,7 +83,7 @@ export abstract class IBaseSpatialAudioEngine {
    * Sets the audio reception range of the local user.
    * After the setting is successful, the local user can only hear the remote users within the setting range or belonging to the same team. You can call this method at any time to update the audio reception range.
    *
-   * @param range The maximum audio reception range. The unit is meters. The value must be greater than 0.
+   * @param range The maximum audio reception range. The unit is meters. The value of this parameter must be greater than 0, and the default value is 20.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -93,7 +94,7 @@ export abstract class IBaseSpatialAudioEngine {
    * Sets the length (in meters) of the game engine distance per unit.
    * In a game engine, the unit of distance is customized, while in the Agora spatial audio algorithm, distance is measured in meters. By default, the SDK converts the game engine distance per unit to one meter. You can call this method to convert the game engine distance per unit to a specified number of meters.
    *
-   * @param unit The number of meters that the game engine distance per unit is equal to. This parameter must be greater than 0.00. For example, setting unit as 2.00 means the game engine distance per unit equals 2 meters.The larger the value is, the faster the sound heard by the local user attenuates when the remote user moves far away from the local user.
+   * @param unit The number of meters that the game engine distance per unit is equal to. The value of this parameter must be greater than 0.00, and the default value is 1.00. For example, setting unit as 2.00 means the game engine distance per unit equals 2 meters.The larger the value is, the faster the sound heard by the local user attenuates when the remote user moves far away from the local user.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -105,11 +106,8 @@ export abstract class IBaseSpatialAudioEngine {
    * Under the ILocalSpatialAudioEngine class, this method needs to be used with updateRemotePosition . The SDK calculates the relative position between the local and remote users according to this method and the parameter settings in updateRemotePosition, and then calculates the user's spatial audio effect parameters.
    *
    * @param position The coordinates in the world coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
-   *
    * @param axisForward The unit vector of the x axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
-   *
    * @param axisRight The unit vector of the y axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
-   *
    * @param axisUp The unit vector of the z axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
    *
    * @returns
@@ -138,7 +136,6 @@ export abstract class IBaseSpatialAudioEngine {
    * After a successful update, the local user can hear the change in the spatial position of the media player.
    *
    * @param playerId The ID of the media player.
-   *
    * @param positionInfo The spatial position of the media player. See RemoteVoicePositionInfo .
    *
    * @returns
@@ -156,9 +153,9 @@ export abstract class IBaseSpatialAudioEngine {
 
   /**
    * Stops or resumes publishing the local audio stream.
-   * This method does not affect any ongoing audio recording, because it does not disable the audio capture device.Call this method after joinChannel [2/2] .When using the spatial audio effect, if you need to set whether to publish the local audio stream, Agora recommends calling this method instead of the muteLocalAudioStream method under IRtcEngine .
+   * This method does not affect any ongoing audio recording, because it does not disable the audio capture device.Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the muteLocalAudioStream method in IRtcEngine .
    *
-   * @param mute Whether to stop publishing the local audio stream.true: Stop publishing the local audio stream.false: Publish the local audio stream.
+   * @param mute Whether to stop publishing the local audio stream:: Stop publishing the local audio stream.true: Publish the local audio stream.false
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -167,9 +164,9 @@ export abstract class IBaseSpatialAudioEngine {
 
   /**
    * Stops or resumes subscribing to the audio streams of all remote users.
-   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joinChannel [2/2] .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the muteAllRemoteAudioStreams method in IRtcEngine .After calling this method, you need to call updateSelfPosition and updateRemotePosition to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
+   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the muteAllRemoteAudioStreams method in IRtcEngine .After calling this method, you need to call updateSelfPosition and updateRemotePosition to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
    *
-   * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stops subscribing to the audio streams of all remote users.false: Subscribe to the audio streams of all remote users.
+   * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stop subscribing to the audio streams of all remote users.false: Subscribe to the audio streams of all remote users.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -191,10 +188,8 @@ export abstract class IBaseSpatialAudioEngine {
    * Sets the sound attenuation properties of the media player.
    *
    * @param playerId The ID of the media player.
-   *
    * @param attenuation The sound attenuation coefficient of the remote user or media player. The value range is [0,1]. The values are as follows:0: Broadcast mode, where the volume and timbre are not attenuated with distance, and the volume and timbre heard by local users do not change regardless of distance.(0,0.5): Weak attenuation mode, that is, the volume and timbre are only weakly attenuated during the propagation process, and the sound can travel farther than the real environment.0.5: (Default) simulates the attenuation of the volume in the real environment; the effect is equivalent to not setting the speaker_attenuation parameter.(0.5,1]: Strong attenuation mode, that is, the volume and timbre attenuate rapidly during the propagation process.
-   *
-   * @param forceSet Whether to force the sound attenuation effect of the media player:true: Force attenuation to set the attenuation of the user. At this time, the attenuation coefficient of the sound insulation area set in the audioAttenuation in the SpatialAudioZone does not take effect for the user.false: Do not force attenuation e to set the user's sound attenuationffect, as shown in the following two cases.If the sound source and listener are inside and outside the sound isolation area, the sound attenuation effect is determined by the audioAttenuation in SpatialAudioZone.If the sound source and the listener are in the same sound insulation area or outside the same sound insulation area, the sound attenuation effect is determined by attenuation in this method.
+   * @param forceSet Whether to force the sound attenuation effect of the media player:true: Force attenuation to set the attenuation of the media player. At this time, the attenuation coefficient of the sound insulation are set in the audioAttenuation in the SpatialAudioZone does not take effect for the media player.false: Do not force attenuation to set the sound attenuation effect of the media player, as shown in the following two cases.If the sound source and listener are inside and outside the sound isolation area, the sound attenuation effect is determined by the audioAttenuation in SpatialAudioZone.If the sound source and the listener are in the same sound insulation area or outside the same sound insulation area, the sound attenuation effect is determined by attenuation in this method.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -207,10 +202,9 @@ export abstract class IBaseSpatialAudioEngine {
 
   /**
    * Stops or resumes subscribing to the audio stream of a specified user.
-   * Call this method after joinChannel [2/2] .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the muteRemoteAudioStream method in IRtcEngine .
+   * Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the muteRemoteAudioStream method in IRtcEngine .
    *
    * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
-   *
    * @param mute Whether to subscribe to the specified remote user's audio stream.true: Stop subscribing to the audio stream of the specified user.false: (Default) Subscribe to the audio stream of the specified user. The SDK decides whether to subscribe according to the distance between the local user and the remote user.
    *
    * @returns
@@ -235,10 +229,9 @@ export abstract class ILocalSpatialAudioEngine extends IBaseSpatialAudioEngine {
 
   /**
    * Updates the spatial position of the specified remote user.
-   * After successfully calling this method, the SDK calculates the spatial audio parameters based on the relative position of the local and remote user.Call this method after joinChannel [2/2] .
+   * After successfully calling this method, the SDK calculates the spatial audio parameters based on the relative position of the local and remote user.Call this method after joinChannel .
    *
    * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
-   *
    * @param posInfo The spatial position of the remote user. See RemoteVoicePositionInfo .
    *
    * @returns
@@ -270,7 +263,11 @@ export abstract class ILocalSpatialAudioEngine extends IBaseSpatialAudioEngine {
   abstract removeRemotePosition(uid: number): number;
 
   /**
-   * @ignore
+   * Occurs when the most active remote speaker is detected.
+   * After a successful call of enableAudioVolumeIndication , the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, who is detected as the loudest for the most times, is the most active user.When the number of users is no less than two and an active remote speaker exists, the SDK triggers this callback and reports the uid of the most active remote speaker.If the most active remote speaker is always the same user, the SDK triggers the onActiveSpeaker callback only once.If the most active remote speaker changes to another user, the SDK triggers this callback again and reports the uid of the new active remote speaker.
+   *
+   * @param uid The user ID of the most active remote speaker.
+   * @param connection The connection information. See RtcConnection .
    */
   abstract removeRemotePositionEx(
     uid: number,
@@ -287,12 +284,33 @@ export abstract class ILocalSpatialAudioEngine extends IBaseSpatialAudioEngine {
   abstract clearRemotePositions(): number;
 
   /**
-   * @ignore
+   * Stops recording the local audio and video.
+   * After calling startRecording , if you want to stop the recording, you must call this method; otherwise, the generated recording files may not be playable.
+   *
+   * @param connection The connection information. See RtcConnection .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.-7: The method is called before IRtcEngine is initialized.
    */
   abstract clearRemotePositionsEx(connection: RtcConnection): number;
 
   /**
-   * @ignore
+   * Sets the sound attenuation effect for the specified user.
+   *
+   * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
+   * @param attenuation For the user's sound attenuation coefficient, the value range is [0,1]. The values are as follows:
+   *  0: Broadcast mode, where the volume and timbre are not attenuated with distance, and the volume and timbre heard by local users do not change regardless of distance.
+   *  (0,0.5): Weak attenuation mode, that is, the volume and timbre are only weakly attenuated during the propagation process, and the sound can travel farther than the real environment.
+   *  0.5: (Default) simulates the attenuation of the volume in the real environment; the effect is equivalent to not setting the speaker_attenuation parameter.
+   *  (0.5,1]: Strong attenuation mode, that is, the volume and timbre attenuate rapidly during the propagation process.
+   *
+   * @param forceSet Whether to force the user's sound attenuation effect:true: Force attenuation to set the sound attenuation of the user. At this time, the attenuation coefficient of the sound insulation area set in the audioAttenuation of the SpatialAudioZone does not take effect for the user.
+   *  If the sound source and listener are inside and outside the sound isolation area, the sound attenuation effect is determined by the audioAttenuation in SpatialAudioZone.
+   *  If the sound source and the listener are in the same sound insulation area or outside the same sound insulation area, the sound attenuation effect is determined by attenuation in this method.
+   *  false: Do not force attenuation to set the user's sound attenuation effect, as shown in the following two cases.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setRemoteAudioAttenuation(
     uid: number,

package/ts/Private/IAudioDeviceManager.ts

@@ -1,5 +1,6 @@
 import './extension/IAudioDeviceManagerExtension';
 import { AudioDeviceInfo } from './IAgoraRtcEngine';
+
 /**
  * The maximum length of the device ID.
  */
@@ -32,6 +33,7 @@ export abstract class IAudioDeviceManager {
 
   /**
    * Sets the audio playback device.
+   * You can call this method to change the audio route currently being used, but this does not change the default audio route. For example, if the default audio route is speaker 1, you call this method to set the audio route as speaker 2 before joinging a channel and then start a device test, the SDK conducts device test on speaker 2. After the device test is completed and you join a channel, the SDK still uses speaker 1, the default audio route.
    *
    * @param deviceId The ID of the specified audio playback device. You can get the device ID by calling enumeratePlaybackDevices . Connecting or disconnecting the audio device does not change the value of deviceId.The maximum length is MaxDeviceIdLengthType .
    *
@@ -57,7 +59,13 @@ export abstract class IAudioDeviceManager {
   abstract getPlaybackDeviceInfo(): AudioDeviceInfo;
 
   /**
-   * @ignore
+   * Sets the volume of the in-ear monitor.
+   * Users must use wired earphones to hear their own voices.You can call this method either before or after joining a channel.
+   *
+   * @param volume The volume of the in-ear monitor. The value ranges between 0 and 100. The default value is 100.
+   *
+   * @returns
+   * < 0: Failure.
    */
   abstract setPlaybackDeviceVolume(volume: number): number;
 
@@ -67,9 +75,10 @@ export abstract class IAudioDeviceManager {
   abstract getPlaybackDeviceVolume(): number;
 
   /**
-   * Sets the audio recording device.
+   * Sets the audio capture device.
+   * You can call this method to change the audio route currently being used, but this does not change the default audio route. For example, if the default audio route is microphone, you call this method to set the audio route as bluetooth earphones before joinging a channel and then start a device test, the SDK conducts device test on the bluetooth earphones. After the device test is completed and you join a channel, the SDK still uses the microphone for audio capturing.
    *
-   * @param deviceId The ID of the audio recording device. You can get the device ID by calling enumerateRecordingDevices . Plugging or unplugging the audio device does not change the value of deviceId.The maximum length is MaxDeviceIdLengthType .
+   * @param deviceId The ID of the audio capture device. You can get the Device ID by calling enumerateRecordingDevices . Connecting or disconnecting the audio device does not change the value of deviceId.The maximum length is MaxDeviceIdLengthType .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -93,9 +102,10 @@ export abstract class IAudioDeviceManager {
   abstract getRecordingDeviceInfo(): AudioDeviceInfo;
 
   /**
-   * Sets the volume of the audio recording device.
+   * Sets the volume of the audio capture device.
+   * This method applies to Windows only.
    *
-   * @param volume  The volume of the audio recording device. The value range is [0,255].
+   * @param volume The volume of the audio recording device. The value ranges between 0 (lowest volume) and 255 (highest volume). 0 means no sound, 255 means maximum volume.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -109,7 +119,7 @@ export abstract class IAudioDeviceManager {
 
   /**
    * Sets the loopback device.
-   * The SDK uses the current playback device as the loopback device by default. If you want to specify another audio device as the loopback device, call this method, and set deviceId to the loopback device you want to specify.This method applies to Windows only.The scenarios where this method is applicable are as follows:Use app A to play music through a Bluetooth headset; when using app B for a video conference, play through the speakers.If the loopback device is set as the Bluetooth headset, the SDK publishes the music in app A to the remote end.If the loopback device is set as the speaker, the SDK does not publish the music in app A to the remote end.If you set the loopback device as the Bluetooth headset, and then use a wired headset to play the music in app A, you need to call this method again, set the loopback device as the wired headset, and the SDK continues to publish the music in app A to remote end.
+   * The SDK uses the current playback device as the loopback device by default. If you want to specify another audio device as the loopback device, call this method, and set deviceId to the loopback device you want to specify.You can call this method to change the audio route currently being used, but this does not change the default audio route. For example, if the default audio route is microphone, you call this method to set the audio route as a sound card before joinging a channel and then start a device test, the SDK conducts device test on the sound card. After the device test is completed and you join a channel, the SDK still uses the microphone for audio capturing.This method applies to Windows only.The scenarios where this method is applicable are as follows:Use app A to play music through a Bluetooth headset; when using app B for a video conference, play through the speakers.If the loopback device is set as the Bluetooth headset, the SDK publishes the music in app A to the remote end.If the loopback device is set as the speaker, the SDK does not publish the music in app A to the remote end.If you set the loopback device as the Bluetooth headset, and then use a wired headset to play the music in app A, you need to call this method again, set the loopback device as the wired headset, and the SDK continues to publish the music in app A to remote end.
    *
    * @param deviceId Specifies the loopback device of the SDK. You can get the device ID by calling enumeratePlaybackDevices . Connecting or disconnecting the audio device does not change the value of deviceId.The maximum length is MaxDeviceIdLengthType .
    *
@@ -128,7 +138,13 @@ export abstract class IAudioDeviceManager {
   abstract getLoopbackDevice(): string;
 
   /**
-   * @ignore
+   * Stops or resumes subscribing to the audio streams of all remote users.
+   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the muteAllRemoteAudioStreams method in IRtcEngine .After calling this method, you need to call updateSelfPosition and updateRemotePosition to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
+   *
+   * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stop subscribing to the audio streams of all remote users.false: Subscribe to the audio streams of all remote users.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setPlaybackDeviceMute(mute: boolean): number;
 
@@ -138,7 +154,13 @@ export abstract class IAudioDeviceManager {
   abstract getPlaybackDeviceMute(): boolean;
 
   /**
-   * @ignore
+   * Stops or resumes subscribing to the audio streams of all remote users.
+   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the muteAllRemoteAudioStreams method in IRtcEngine .After calling this method, you need to call updateSelfPosition and updateRemotePosition to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
+   *
+   * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stop subscribing to the audio streams of all remote users.false: Subscribe to the audio streams of all remote users.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setRecordingDeviceMute(mute: boolean): number;
 
@@ -171,7 +193,7 @@ export abstract class IAudioDeviceManager {
    * Starts the audio capture device test.
    * This method tests whether the audio capture device works properly. After calling this method, the SDK triggers the onAudioVolumeIndication callback at the time interval set in this method, which reports uid = 0 and the volume information of the capturing device.Ensure that you call this method before joining a channel.
    *
-   * @param indicationInterval The time interval (ms) at which the SDK triggers the onAudioVolumeIndication callback. Agora recommends a setting greater than 200 ms. This value must not be less than 10 ms; otherwise, you can not receive the onAudioVolumeIndication callback.
+   * @param indicationInterval The time interval (ms) at which the SDK triggers the onAudioVolumeIndication callback. Agora recommends setting a value greater than 200 ms. This value must not be less than 10 ms; otherwise, you can not receive the onAudioVolumeIndication callback.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -189,7 +211,7 @@ export abstract class IAudioDeviceManager {
 
   /**
    * Starts an audio device loopback test.
-   * This method tests whether the local audio capture device and playback device are working properly. Once the test starts, the audio recording device records the local audio, and the audio playback device plays the captured audio. The SDK triggers two independent onAudioVolumeIndication callbacks at the time interval set in this method, which reports the volume information of the capture device (uid = 0) and the volume information of the playback device (uid = 1) respectively.Ensure that you call this method before joining a channel.This method tests local audio devices and does not report the network conditions.
+   * This method tests whether the local audio capture device and playback device are working properly. After starting the test, the audio capture device records the local audio, and the audio playback device plays the captured audio. The SDK triggers two independent onAudioVolumeIndication callbacks at the time interval set in this method, which reports the volume information of the capture device (uid = 0) and the volume information of the playback device (uid = 1) respectively.Ensure that you call this method before joining a channel.This method tests local audio devices and does not report the network conditions.
    *
    * @param indicationInterval The time interval (ms) at which the SDK triggers the onAudioVolumeIndication callback. Agora recommends setting a value greater than 200 ms. This value must not be less than 10 ms; otherwise, you can not receive the onAudioVolumeIndication callback.
    *
@@ -210,7 +232,7 @@ export abstract class IAudioDeviceManager {
   /**
    * Sets the audio playback device used by the SDK to follow the system default audio playback device.
    *
-   * @param enable Whether to follow the system default audio playback device:true: Follow. The SDK immediately switches the audio playback device when the system default audio playback device changes.false: Do not follow. The SDK switches the audio playback device to the system default audio playback device only when the currently used audio playback device is disconnected.
+   * @param enable Whether to follow the system default audio playback device:true: Follow the system default audio playback device. The SDK immediately switches the audio playback device when the system default audio playback device changes.false: Do not follow the system default audio playback device. The SDK switches the audio playback device to the system default audio playback device only when the currently used audio playback device is disconnected.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -220,7 +242,7 @@ export abstract class IAudioDeviceManager {
   /**
    * Sets the audio recording device used by the SDK to follow the system default audio recording device.
    *
-   * @param enable Whether to follow the system default audio recording device:true: Follow. The SDK immediately switches the audio recording device when the system default audio recording device changes.false: Do not follow. The SDK switches the audio recording device to the system default audio recording device only when the currently used audio recording device is disconnected.
+   * @param enable Whether to follow the system default audio recording device:true: Follow the system default audio playback device. The SDK immediately switches the audio recording device when the system default audio recording device changes.false: Do not follow the system default audio playback device. The SDK switches the audio recording device to the system default audio recording device only when the currently used audio recording device is disconnected.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -231,7 +253,7 @@ export abstract class IAudioDeviceManager {
    * Sets whether the loopback device follows the system default playback device.
    * This method applies to Windows only.
    *
-   * @param enable Whether to follow the system default audio playback device:true: Follow. When the default playback device of the system is changed, the SDK immediately switches to the loopback device.false: Do not follow. The SDK switches the audio loopback device to the system default audio playback device only when the current audio playback device is disconnected.
+   * @param enable Whether to follow the system default audio playback device:true: Follow the system default audio playback device. When the default playback device of the system is changed, the SDK immediately switches to the loopback device.false: Do not follow the system default audio playback device. The SDK switches the audio loopback device to the system default audio playback device only when the current audio playback device is disconnected.
    *
    * @returns
    * 0: Success.< 0: Failure.

package/ts/Private/extension/IAgoraMediaEngineExtension.ts

@@ -3,7 +3,7 @@ import {
   IVideoEncodedFrameObserver,
   IVideoFrameObserver,
 } from '../AgoraMediaBase';
-import { EmitterSubscription } from '../internal/emitter/EventEmitter';
+import type { EmitterSubscription } from '../internal/emitter/EventEmitter';
 
 export type IMediaEngineEvent = IAudioFrameObserver &
   IVideoFrameObserver &

package/ts/Private/extension/IAgoraMediaPlayerExtension.ts

@@ -1,13 +1,10 @@
+import { IAudioPcmFrameSink, IAudioSpectrumObserver } from '../AgoraMediaBase';
+import { IMediaPlayerVideoFrameObserver } from '../IAgoraMediaPlayer';
 import { IMediaPlayerSourceObserver } from '../IAgoraMediaPlayerSource';
-import {
-  IMediaPlayerAudioFrameObserver,
-  IMediaPlayerVideoFrameObserver,
-} from '../IAgoraMediaPlayer';
-import { IAudioSpectrumObserver } from '../AgoraMediaBase';
-import { EmitterSubscription } from '../internal/emitter/EventEmitter';
+import type { EmitterSubscription } from '../internal/emitter/EventEmitter';
 
 export type IMediaPlayerEvent = IMediaPlayerSourceObserver &
-  IMediaPlayerAudioFrameObserver &
+  IAudioPcmFrameSink &
   IMediaPlayerVideoFrameObserver &
   IAudioSpectrumObserver;
 

package/ts/Private/extension/IAgoraMediaRecorderExtension.ts

@@ -1,5 +1,5 @@
 import { IMediaRecorderObserver } from '../AgoraMediaBase';
-import { EmitterSubscription } from '../internal/emitter/EventEmitter';
+import type { EmitterSubscription } from '../internal/emitter/EventEmitter';
 
 export type IMediaRecorderEvent = IMediaRecorderObserver;
 
@@ -51,5 +51,10 @@ declare module '../IAgoraMediaRecorder' {
     removeAllListeners<EventType extends keyof IMediaRecorderEvent>(
       eventType?: EventType
     ): void;
+
+    /**
+     * @ignore
+     */
+    release(): void;
   }
 }

package/ts/Private/extension/IAgoraMusicContentCenterExtension.ts

@@ -1,5 +1,5 @@
 import { IMusicContentCenterEventHandler } from '../IAgoraMusicContentCenter';
-import { EmitterSubscription } from '../internal/emitter/EventEmitter';
+import type { EmitterSubscription } from '../internal/emitter/EventEmitter';
 
 export type IMusicContentCenterEvent = IMusicContentCenterEventHandler;
 

package/ts/Private/extension/IAgoraRtcEngineExtension.ts

@@ -1,11 +1,11 @@
+import { IAudioEncodedFrameObserver } from '../AgoraBase';
+import { IAudioSpectrumObserver } from '../AgoraMediaBase';
 import {
-  IRtcEngineEventHandler,
   IDirectCdnStreamingEventHandler,
   IMetadataObserver,
+  IRtcEngineEventHandler,
 } from '../IAgoraRtcEngine';
-import { IAudioSpectrumObserver } from '../AgoraMediaBase';
-import { IAudioEncodedFrameObserver } from '../AgoraBase';
-import { EmitterSubscription } from '../internal/emitter/EventEmitter';
+import type { EmitterSubscription } from '../internal/emitter/EventEmitter';
 
 export type IRtcEngineEvent = IRtcEngineEventHandler &
   IDirectCdnStreamingEventHandler &

package/ts/Private/impl/AgoraBaseImpl.ts

@@ -6,7 +6,7 @@ export function processIAudioEncodedFrameObserver(
   jsonParams: any
 ) {
   switch (event) {
-    case 'OnRecordAudioEncodedFrame':
+    case 'onRecordAudioEncodedFrame':
       if (handler.onRecordAudioEncodedFrame !== undefined) {
         handler.onRecordAudioEncodedFrame(
           jsonParams.frameBuffer,
@@ -16,7 +16,7 @@ export function processIAudioEncodedFrameObserver(
       }
       break;
 
-    case 'OnPlaybackAudioEncodedFrame':
+    case 'onPlaybackAudioEncodedFrame':
       if (handler.onPlaybackAudioEncodedFrame !== undefined) {
         handler.onPlaybackAudioEncodedFrame(
           jsonParams.frameBuffer,
@@ -26,7 +26,7 @@ export function processIAudioEncodedFrameObserver(
       }
       break;
 
-    case 'OnMixedAudioEncodedFrame':
+    case 'onMixedAudioEncodedFrame':
       if (handler.onMixedAudioEncodedFrame !== undefined) {
         handler.onMixedAudioEncodedFrame(
           jsonParams.frameBuffer,

package/ts/Private/impl/AgoraMediaBaseImpl.ts

@@ -1,12 +1,27 @@
 import {
-  IAudioFrameObserverBase,
   IAudioFrameObserver,
+  IAudioFrameObserverBase,
+  IAudioPcmFrameSink,
   IAudioSpectrumObserver,
+  IMediaRecorderObserver,
   IVideoEncodedFrameObserver,
   IVideoFrameObserver,
-  IMediaRecorderObserver,
 } from '../AgoraMediaBase';
 
+export function processIAudioPcmFrameSink(
+  handler: IAudioPcmFrameSink,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onFrame':
+      if (handler.onFrame !== undefined) {
+        handler.onFrame(jsonParams.frame);
+      }
+      break;
+  }
+}
+
 export function processIAudioFrameObserverBase(
   handler: IAudioFrameObserverBase,
   event: string,
@@ -110,37 +125,19 @@ export function processIVideoFrameObserver(
   switch (event) {
     case 'onCaptureVideoFrame':
       if (handler.onCaptureVideoFrame !== undefined) {
-        handler.onCaptureVideoFrame(jsonParams.videoFrame);
+        handler.onCaptureVideoFrame(
+          jsonParams.sourceType,
+          jsonParams.videoFrame
+        );
       }
       break;
 
     case 'onPreEncodeVideoFrame':
       if (handler.onPreEncodeVideoFrame !== undefined) {
-        handler.onPreEncodeVideoFrame(jsonParams.videoFrame);
-      }
-      break;
-
-    case 'onSecondaryCameraCaptureVideoFrame':
-      if (handler.onSecondaryCameraCaptureVideoFrame !== undefined) {
-        handler.onSecondaryCameraCaptureVideoFrame(jsonParams.videoFrame);
-      }
-      break;
-
-    case 'onSecondaryPreEncodeCameraVideoFrame':
-      if (handler.onSecondaryPreEncodeCameraVideoFrame !== undefined) {
-        handler.onSecondaryPreEncodeCameraVideoFrame(jsonParams.videoFrame);
-      }
-      break;
-
-    case 'onScreenCaptureVideoFrame':
-      if (handler.onScreenCaptureVideoFrame !== undefined) {
-        handler.onScreenCaptureVideoFrame(jsonParams.videoFrame);
-      }
-      break;
-
-    case 'onPreEncodeScreenVideoFrame':
-      if (handler.onPreEncodeScreenVideoFrame !== undefined) {
-        handler.onPreEncodeScreenVideoFrame(jsonParams.videoFrame);
+        handler.onPreEncodeVideoFrame(
+          jsonParams.sourceType,
+          jsonParams.videoFrame
+        );
       }
       break;
 
@@ -153,18 +150,6 @@ export function processIVideoFrameObserver(
       }
       break;
 
-    case 'onSecondaryScreenCaptureVideoFrame':
-      if (handler.onSecondaryScreenCaptureVideoFrame !== undefined) {
-        handler.onSecondaryScreenCaptureVideoFrame(jsonParams.videoFrame);
-      }
-      break;
-
-    case 'onSecondaryPreEncodeScreenVideoFrame':
-      if (handler.onSecondaryPreEncodeScreenVideoFrame !== undefined) {
-        handler.onSecondaryPreEncodeScreenVideoFrame(jsonParams.videoFrame);
-      }
-      break;
-
     case 'onRenderVideoFrame':
       if (handler.onRenderVideoFrame !== undefined) {
         handler.onRenderVideoFrame(
@@ -191,13 +176,22 @@ export function processIMediaRecorderObserver(
   switch (event) {
     case 'onRecorderStateChanged':
       if (handler.onRecorderStateChanged !== undefined) {
-        handler.onRecorderStateChanged(jsonParams.state, jsonParams.error);
+        handler.onRecorderStateChanged(
+          jsonParams.channelId,
+          jsonParams.uid,
+          jsonParams.state,
+          jsonParams.error
+        );
       }
       break;
 
     case 'onRecorderInfoUpdated':
       if (handler.onRecorderInfoUpdated !== undefined) {
-        handler.onRecorderInfoUpdated(jsonParams.info);
+        handler.onRecorderInfoUpdated(
+          jsonParams.channelId,
+          jsonParams.uid,
+          jsonParams.info
+        );
       }
       break;
   }