agora-electron-sdk 4.2.2-dev.4 → 4.2.2-dev.7

package/ts/Private/IAgoraSpatialAudio.ts

@@ -52,7 +52,11 @@ export class SpatialAudioZone {
    */
   upLength?: number;
   /**
-   * The sound attenuation coefficient when users within the sound insulation area communicate with external users. 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 audioAttenuation parameter.(0.5,1]: Strong attenuation mode (default value is 1), that is, the volume and timbre attenuate rapidly during propagation.
+   * The sound attenuation coefficient when users within the sound insulation area communicate with external users. 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 audioAttenuation parameter.
+   *  (0.5,1]: Strong attenuation mode (default value is 1), that is, the volume and timbre attenuate rapidly during propagation.
    */
   audioAttenuation?: number;
 }
@@ -60,13 +64,13 @@ export class SpatialAudioZone {
 /**
  * This class contains some of the APIs in the ILocalSpatialAudioEngine class.
  *
- * The ILocalSpatialAudioEngine class inherits from IBaseSpatialAudioEngine .
+ * The ILocalSpatialAudioEngine class inherits from IBaseSpatialAudioEngine.
  */
 export abstract class IBaseSpatialAudioEngine {
   /**
    * Destroys IBaseSpatialAudioEngine.
    *
-   * This method releases all resources under IBaseSpatialAudioEngine . When the user does not need to use the spatial audio effect, you can call this method to release resources for other operations. After calling this method, you can no longer use any of the APIs under IBaseSpatialAudioEngine . Call this method before the release method under IRtcEngine .
+   * This method releases all resources under IBaseSpatialAudioEngine. When the user does not need to use the spatial audio effect, you can call this method to release resources for other operations. After calling this method, you can no longer use any of the APIs under IBaseSpatialAudioEngine. Call this method before the release method under IRtcEngine.
    */
   abstract release(): void;
 
@@ -78,7 +82,8 @@ export abstract class IBaseSpatialAudioEngine {
    * @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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setMaxAudioRecvCount(maxCount: number): number;
 
@@ -90,7 +95,8 @@ export abstract class IBaseSpatialAudioEngine {
    * @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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setAudioRecvRange(range: number): number;
 
@@ -99,17 +105,18 @@ export abstract class IBaseSpatialAudioEngine {
    *
    * 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. 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.
+   * @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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setDistanceUnit(unit: number): number;
 
   /**
    * Updates the spatial position of the local user.
    *
-   * 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.
+   * 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.
@@ -117,7 +124,8 @@ export abstract class IBaseSpatialAudioEngine {
    * @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
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract updateSelfPosition(
     position: number[],
@@ -146,7 +154,8 @@ export abstract class IBaseSpatialAudioEngine {
    * @param positionInfo The spatial position of the media player. See RemoteVoicePositionInfo.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract updatePlayerPositionInfo(
     playerId: number,
@@ -161,37 +170,49 @@ 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 . 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 . A successful call of this method triggers the onUserMuteAudio and onRemoteAudioStateChanged callbacks on the remote client.
+   * 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.
+   *  A successful call of this method triggers the onUserMuteAudio and onRemoteAudioStateChanged callbacks on the remote client.
    *
-   * @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: true : Stop publishing the local audio stream. false : Publish the local audio stream.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract muteLocalAudioStream(mute: boolean): number;
 
   /**
    * 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.
+   * 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.
+   * @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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract muteAllRemoteAudioStreams(mute: boolean): number;
 
   /**
    * Sets the sound insulation area.
    *
-   * In virtual interactive scenarios, you can use this method to set the sound insulation area and sound attenuation coefficient. When the sound source (which can be the user or the media player) and the listener belong to the inside and outside of the sound insulation area, they can experience the attenuation effect of sound similar to the real environment when it encounters a building partition. When the sound source and the listener belong to the inside and outside of the sound insulation area, the sound attenuation effect is determined by the sound attenuation coefficient in SpatialAudioZone . If the user or media player is in the same sound insulation area, it is not affected by SpatialAudioZone , and the sound attenuation effect is determined by the attenuation parameter in setPlayerAttenuation or setRemoteAudioAttenuation . If you do not call setPlayerAttenuation or setRemoteAudioAttenuation , the default sound attenuation coefficient of the SDK is 0.5, which simulates the attenuation of the sound in the real environment. If the sound source and the receiver belong to two sound insulation areas, the receiver cannot hear the sound source. If this method is called multiple times, the last sound insulation area set takes effect.
+   * In virtual interactive scenarios, you can use this method to set the sound insulation area and sound attenuation coefficient. When the sound source (which can be the user or the media player) and the listener belong to the inside and outside of the sound insulation area, they can experience the attenuation effect of sound similar to the real environment when it encounters a building partition.
+   *  When the sound source and the listener belong to the inside and outside of the sound insulation area, the sound attenuation effect is determined by the sound attenuation coefficient in SpatialAudioZone.
+   *  If the user or media player is in the same sound insulation area, it is not affected by SpatialAudioZone, and the sound attenuation effect is determined by the attenuation parameter in setPlayerAttenuation or setRemoteAudioAttenuation. If you do not call setPlayerAttenuation or setRemoteAudioAttenuation, the default sound attenuation coefficient of the SDK is 0.5, which simulates the attenuation of the sound in the real environment.
+   *  If the sound source and the receiver belong to two sound insulation areas, the receiver cannot hear the sound source. If this method is called multiple times, the last sound insulation area set takes effect.
    *
-   * @param zones Sound insulation area settings. See SpatialAudioZone.
+   * @param zones Sound insulation area settings. See SpatialAudioZone. On the Windows platform, it is necessary to ensure that the number of members in the zones array is equal to the value of zoneCount; otherwise, it may cause a crash.
    * @param zoneCount The number of sound insulation areas.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setZones(zones: SpatialAudioZone[], zoneCount: number): number;
 
@@ -199,11 +220,18 @@ 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 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.
+   * @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 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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setPlayerAttenuation(
     playerId: number,
@@ -214,13 +242,15 @@ export abstract class IBaseSpatialAudioEngine {
   /**
    * Stops or resumes subscribing to the audio stream of a specified user.
    *
-   * 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 .
+   * 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.
+   * @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
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract muteRemoteAudioStream(uid: number, mute: boolean): number;
 }
@@ -228,29 +258,32 @@ export abstract class IBaseSpatialAudioEngine {
 /**
  * This class calculates user positions through the SDK to implement the spatial audio effect.
  *
- * This class inherits from IBaseSpatialAudioEngine . Before calling other APIs in this class, you need to call the initialize method to initialize this class.
+ * This class inherits from IBaseSpatialAudioEngine. Before calling other APIs in this class, you need to call the initialize method to initialize this class.
  */
 export abstract class ILocalSpatialAudioEngine extends IBaseSpatialAudioEngine {
   /**
    * Initializes ILocalSpatialAudioEngine.
    *
-   * Before calling other methods of the ILocalSpatialAudioEngine class, you need to call this method to initialize ILocalSpatialAudioEngine . The SDK supports creating only one ILocalSpatialAudioEngine instance for an app.
+   * Before calling other methods of the ILocalSpatialAudioEngine class, you need to call this method to initialize ILocalSpatialAudioEngine.
+   *  The SDK supports creating only one ILocalSpatialAudioEngine instance for an app.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract initialize(): number;
 
   /**
    * 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 .
+   * 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
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract updateRemotePosition(
     uid: number,
@@ -274,7 +307,8 @@ export abstract class ILocalSpatialAudioEngine extends IBaseSpatialAudioEngine {
    * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract removeRemotePosition(uid: number): number;
 
@@ -292,7 +326,8 @@ export abstract class ILocalSpatialAudioEngine extends IBaseSpatialAudioEngine {
    * After successfully calling this method, the local user no longer hears any remote users. After leaving the channel, to avoid wasting resources, you can also call this method to delete the spatial positions of all remote users.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract clearRemotePositions(): number;
 
@@ -310,13 +345,13 @@ export abstract class ILocalSpatialAudioEngine extends IBaseSpatialAudioEngine {
    *  (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.
+   * @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.
+   *  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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setRemoteAudioAttenuation(
     uid: number,

package/ts/Private/IAudioDeviceManager.ts

@@ -19,7 +19,8 @@ export abstract class IAudioDeviceManager {
    * Enumerates the audio playback devices.
    *
    * @returns
-   * Success: Returns an AudioDeviceInfo array, which includes all the audio playback devices. Failure: An empty array.
+   * Success: Returns an AudioDeviceInfo array, which includes all the audio playback devices.
+   *  Failure: An empty array.
    */
   abstract enumeratePlaybackDevices(): AudioDeviceInfo[];
 
@@ -27,7 +28,8 @@ export abstract class IAudioDeviceManager {
    * Enumerates the audio capture devices.
    *
    * @returns
-   * Success: An AudioDeviceInfo array, which includes all the audio capture devices. Failure: An empty array.
+   * Success: An AudioDeviceInfo array, which includes all the audio capture devices.
+   *  Failure: An empty array.
    */
   abstract enumerateRecordingDevices(): AudioDeviceInfo[];
 
@@ -36,10 +38,11 @@ export abstract class IAudioDeviceManager {
    *
    * 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.
+   * @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.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setPlaybackDevice(deviceId: string): number;
 
@@ -74,10 +77,11 @@ export abstract class IAudioDeviceManager {
    *
    * 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 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.
+   * @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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setRecordingDevice(deviceId: string): number;
 
@@ -105,7 +109,8 @@ export abstract class IAudioDeviceManager {
    * @param volume The volume of the audio recording device. The value range is [0,255]. 0 means no sound, 255 means maximum volume.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setRecordingDeviceVolume(volume: number): number;
 
@@ -117,12 +122,16 @@ 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. 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 is for Windows and macOS 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 is for Windows and macOS 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.
+   * @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.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setLoopbackDevice(deviceId: string): number;
 
@@ -159,86 +168,106 @@ export abstract class IAudioDeviceManager {
   /**
    * Starts the audio playback device test.
    *
-   * This method tests whether the audio playback device works properly. Once a user starts the test, the SDK plays an audio file specified by the user. If the user can hear the audio, the playback device works properly. After calling this method, the SDK triggers the onAudioVolumeIndication callback every 100 ms, reporting uid = 1 and the volume information of the playback device. Ensure that you call this method before joining a channel.
+   * This method tests whether the audio playback device works properly. Once a user starts the test, the SDK plays an audio file specified by the user. If the user can hear the audio, the playback device works properly. After calling this method, the SDK triggers the onAudioVolumeIndication callback every 100 ms, reporting uid = 1 and the volume information of the playback device.
+   *  Ensure that you call this method before joining a channel.
    *
-   * @param testAudioFilePath The path of the audio file. The data format is string in UTF-8.Supported file formats: wav, mp3, m4a, and aac.Supported file sample rates: 8000, 16000, 32000, 44100, and 48000 Hz.
+   * @param testAudioFilePath The path of the audio file. The data format is string in UTF-8.
+   *  Supported file formats: wav, mp3, m4a, and aac.
+   *  Supported file sample rates: 8000, 16000, 32000, 44100, and 48000 Hz.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract startPlaybackDeviceTest(testAudioFilePath: string): number;
 
   /**
    * Stops the audio playback device test.
    *
-   * This method stops the audio playback device test. You must call this method to stop the test after calling the startPlaybackDeviceTest method. Ensure that you call this method before joining a channel.
+   * This method stops the audio playback device test. You must call this method to stop the test after calling the startPlaybackDeviceTest method.
+   *  Ensure that you call this method before joining a channel.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract stopPlaybackDeviceTest(): number;
 
   /**
    * 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.
+   * 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 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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract startRecordingDeviceTest(indicationInterval: number): number;
 
   /**
    * Stops the audio capture device test.
    *
-   * This method stops the audio capture device test. You must call this method to stop the test after calling the startRecordingDeviceTest method. Ensure that you call this method before joining a channel.
+   * This method stops the audio capture device test. You must call this method to stop the test after calling the startRecordingDeviceTest method.
+   *  Ensure that you call this method before joining a channel.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract stopRecordingDeviceTest(): number;
 
   /**
    * Starts an audio device loopback test.
    *
-   * 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. You can call this method either before or after joining a channel. This method only takes effect when called by the host. This method tests local audio devices and does not report the network conditions. When you finished testing, call stopAudioDeviceLoopbackTest to stop the audio device loopback test.
+   * 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.
+   *  You can call this method either before or after joining a channel.
+   *  This method only takes effect when called by the host.
+   *  This method tests local audio devices and does not report the network conditions.
+   *  When you finished testing, call stopAudioDeviceLoopbackTest to stop the audio device loopback test.
    *
    * @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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract startAudioDeviceLoopbackTest(indicationInterval: number): number;
 
   /**
    * Stops the audio device loopback test.
    *
-   * You can call this method either before or after joining a channel. This method only takes effect when called by the host. Ensure that you call this method to stop the loopback test after calling the startAudioDeviceLoopbackTest method.
+   * You can call this method either before or after joining a channel.
+   *  This method only takes effect when called by the host.
+   *  Ensure that you call this method to stop the loopback test after calling the startAudioDeviceLoopbackTest method.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract stopAudioDeviceLoopbackTest(): number;
 
   /**
    * 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 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.
+   * @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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract followSystemPlaybackDevice(enable: boolean): number;
 
   /**
    * 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 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.
+   * @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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract followSystemRecordingDevice(enable: boolean): number;
 
@@ -247,10 +276,11 @@ export abstract class IAudioDeviceManager {
    *
    * This method is for Windows and macOS only.
    *
-   * @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.
+   * @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.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract followSystemLoopbackDevice(enable: boolean): number;
 
@@ -265,7 +295,7 @@ export abstract class IAudioDeviceManager {
    * This method is for Windows and macOS only.
    *
    * @returns
-   * The details about the default audio playback device. See AudioDeviceInfo .
+   * The details about the default audio playback device. See AudioDeviceInfo.
    */
   abstract getPlaybackDefaultDevice(): AudioDeviceInfo;
 
@@ -275,7 +305,7 @@ export abstract class IAudioDeviceManager {
    * This method is for Windows and macOS only.
    *
    * @returns
-   * The details about the default audio capture device. See AudioDeviceInfo .
+   * The details about the default audio capture device. See AudioDeviceInfo.
    */
   abstract getRecordingDefaultDevice(): AudioDeviceInfo;
 }

package/ts/Private/impl/IAgoraMediaEngineImpl.ts

@@ -96,15 +96,21 @@ export class IMediaEngineImpl implements IMediaEngine {
     return 'MediaEngine_pushAudioFrame';
   }
 
-  pullAudioFrame(): AudioFrame {
-    const apiType = this.getApiTypeFromPullAudioFrame();
-    const jsonParams = {};
+  pullAudioFrame(frame: AudioFrame): number {
+    const apiType = this.getApiTypeFromPullAudioFrame(frame);
+    const jsonParams = {
+      frame: frame,
+      toJSON: () => {
+        return {
+          frame: frame,
+        };
+      },
+    };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    const frame = jsonResults.frame;
-    return frame;
+    return jsonResults.result;
   }
 
-  protected getApiTypeFromPullAudioFrame(): string {
+  protected getApiTypeFromPullAudioFrame(frame: AudioFrame): string {
     return 'MediaEngine_pullAudioFrame';
   }
 

package/ts/Private/impl/IAgoraRtcEngineImpl.ts

@@ -26,10 +26,8 @@ import {
   LocalAccessPointConfiguration,
   LocalTranscoderConfiguration,
   LowlightEnhanceOptions,
-  NetworkType,
   RecorderStreamInfo,
   Rectangle,
-  ScreenCaptureFramerateCapability,
   ScreenCaptureParameters,
   ScreenCaptureParameters2,
   ScreenScenarioType,
@@ -264,7 +262,7 @@ export function processIRtcEngineEventHandler(
     case 'onFirstLocalVideoFramePublished':
       if (handler.onFirstLocalVideoFramePublished !== undefined) {
         handler.onFirstLocalVideoFramePublished(
-          jsonParams.connection,
+          jsonParams.source,
           jsonParams.elapsed
         );
       }
@@ -413,7 +411,7 @@ export function processIRtcEngineEventHandler(
 
     case 'onLocalVideoStats':
       if (handler.onLocalVideoStats !== undefined) {
-        handler.onLocalVideoStats(jsonParams.connection, jsonParams.stats);
+        handler.onLocalVideoStats(jsonParams.source, jsonParams.stats);
       }
       break;
 
@@ -4732,13 +4730,13 @@ export class IRtcEngineImpl implements IRtcEngine {
     return 'RtcEngine_isCameraExposureSupported';
   }
 
-  setCameraExposureFactor(value: number): number {
-    const apiType = this.getApiTypeFromSetCameraExposureFactor(value);
+  setCameraExposureFactor(factor: number): number {
+    const apiType = this.getApiTypeFromSetCameraExposureFactor(factor);
     const jsonParams = {
-      value: value,
+      factor: factor,
       toJSON: () => {
         return {
-          value: value,
+          factor: factor,
         };
       },
     };
@@ -4746,7 +4744,7 @@ export class IRtcEngineImpl implements IRtcEngine {
     return jsonResults.result;
   }
 
-  protected getApiTypeFromSetCameraExposureFactor(value: number): string {
+  protected getApiTypeFromSetCameraExposureFactor(factor: number): string {
     return 'RtcEngine_setCameraExposureFactor';
   }
 
@@ -5153,7 +5151,7 @@ export class IRtcEngineImpl implements IRtcEngine {
     return 'RtcEngine_updateScreenCapture';
   }
 
-  queryScreenCaptureCapability(): ScreenCaptureFramerateCapability {
+  queryScreenCaptureCapability(): number {
     const apiType = this.getApiTypeFromQueryScreenCaptureCapability();
     const jsonParams = {};
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
@@ -6647,7 +6645,7 @@ export class IRtcEngineImpl implements IRtcEngine {
     return 'RtcEngine_enableWirelessAccelerate';
   }
 
-  getNetworkType(): NetworkType {
+  getNetworkType(): number {
     const apiType = this.getApiTypeFromGetNetworkType();
     const jsonParams = {};
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);