io.agora.spatialaudio.IBaseSpatialAudioEngine Class Reference

Inheritance diagram for io.agora.spatialaudio.IBaseSpatialAudioEngine:

Public Member Functions
abstract int	setMaxAudioRecvCount (int maxCount)
	Sets the maximum number of streams that a user can receive in a specified audio reception range. More...
abstract int	setAudioRecvRange (float range)
	Sets the audio reception range of the local user. More...
abstract int	setDistanceUnit (float unit)
	Sets the length (in meters) of the game engine distance per unit. More...
abstract int	updateSelfPosition (float[] position, float[] axisForward, float[] axisRight, float[] axisUp)
	Updates the spatial position of the local user. More...
abstract int	updatePlayerPositionInfo (int playerId, RemoteVoicePositionInfo positionInfo)
	Updates the spatial position of the media player. More...
abstract int	muteLocalAudioStream (boolean mute)
	Stops or resumes publishing the local audio stream. More...
abstract int	muteAllRemoteAudioStreams (boolean mute)
	Stops or resumes subscribing to the audio streams of all remote users. More...
abstract int	setZones (SpatialAudioZone[] zones)
	Sets the sound insulation area. More...
abstract int	setPlayerAttenuation (int playerId, double attenuation, boolean forceSet)
	Sets the sound attenuation properties of the media player. More...
abstract int	muteRemoteAudioStream (int uid, boolean mute)
abstract int	updateSelfPositionEx (float[] position, float[] axisForward, float[] axisRight, float[] axisUp, RtcConnection connection)
abstract int	clearRemotePositions ()
	Removes the spatial positions of all remote users. More...

Protected Member Functions
abstract int	release ()
	Releases all resources used by the music content center. More...

Member Function Documentation

release()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.release ( )

abstractprotected

Releases all resources used by the music content center.

You must call this method before calling the destroy() method of RtcEngine.

setMaxAudioRecvCount()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.setMaxAudioRecvCount ( int  maxCount )

abstract

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.

Parameters

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.

setAudioRecvRange()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.setAudioRecvRange ( float  range )

abstract

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.

Parameters

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.

setDistanceUnit()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.setDistanceUnit ( float  unit )

abstract

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.

Parameters

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.

updateSelfPosition()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.updateSelfPosition ( float[]  position, float[]  axisForward, float[]  axisRight, float[]  axisUp  )

abstract

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.

Parameters

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.
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.
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.
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.

updatePlayerPositionInfo()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.updatePlayerPositionInfo ( int  playerId, RemoteVoicePositionInfo  positionInfo  )

abstract

Updates the spatial position of the media player.

After a successful update, the local user can hear the change in the spatial position of the media player. Call timing: This method can be called either before or after joining the channel.

Parameters

playerId	The ID of the media player. You can get the Device ID by calling getMediaPlayerId.
positionInfo	The spatial position of the media player. See RemoteVoicePositionInfo.

Returns

• 0: Success.
• < 0: Failure.

muteLocalAudioStream()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.muteLocalAudioStream ( boolean  mute )

abstract

Stops or resumes publishing the local audio stream.

Note

• This method does not affect any ongoing audio recording, because it does not disable the audio capture device.
• Call this method after the joinChannel(String token, String channelId, String optionalInfo, int uid) or joinChannel(String token, String channelId, int uid, ChannelMediaOptions options) method.
• 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 RtcEngine.
• A successful call of this method triggers the onUserMuteAudio and onRemoteAudioStateChanged callbacks on the remote client.

Parameters

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.

muteAllRemoteAudioStreams()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.muteAllRemoteAudioStreams ( boolean  mute )

abstract

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.

Note

• Call this method after the joinChannel(String token, String channelId, String optionalInfo, int uid) or joinChannel(String token, String channelId, int uid, ChannelMediaOptions options) method.
• 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 RtcEngine.
• 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.

Parameters

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.

setZones()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.setZones ( SpatialAudioZone[]  zones )

abstract

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.

Note

If this method is called multiple times, the last sound insulation area set takes effect.

Parameters

zones

Sound insulation area settings. See SpatialAudioZone. When you set this parameter to NULL, it means clearing all sound insulation zones.

Returns

• 0: Success.
• < 0: Failure.

setPlayerAttenuation()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.setPlayerAttenuation ( int  playerId, double  attenuation, boolean  forceSet  )

abstract

Sets the sound attenuation properties of the media player.

Parameters

playerId	The ID of the media player. You can get the Device ID by calling getMediaPlayerId.
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.
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.

clearRemotePositions()

abstract int io.agora.spatialaudio.IBaseSpatialAudioEngine.clearRemotePositions ( )

abstract

Removes the spatial positions of all remote users.

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.