Agora C++ API Reference for All Platforms
Public Attributes | List of all members
agora::SpatialAudioParams Struct Reference

Public Attributes

Optional< double > speaker_azimuth
 
Optional< double > speaker_elevation
 
Optional< double > speaker_distance
 
Optional< int > speaker_orientation
 
Optional< bool > enable_blur
 
Optional< bool > enable_air_absorb
 
Optional< double > speaker_attenuation
 
Optional< bool > enable_doppler
 

Detailed Description

Spatial audio parameters

Member Data Documentation

◆ speaker_azimuth

Optional<double> agora::SpatialAudioParams::speaker_azimuth

Speaker azimuth in a spherical coordinate system centered on the listener.

◆ speaker_elevation

Optional<double> agora::SpatialAudioParams::speaker_elevation

Speaker elevation in a spherical coordinate system centered on the listener.

◆ speaker_distance

Optional<double> agora::SpatialAudioParams::speaker_distance

Distance between speaker and listener.

◆ speaker_orientation

Optional<int> agora::SpatialAudioParams::speaker_orientation

Speaker orientation [0-180], 0 degree is the same with listener orientation.

◆ enable_blur

Optional<bool> agora::SpatialAudioParams::enable_blur

Enable blur or not for the speaker.

◆ enable_air_absorb

Optional<bool> agora::SpatialAudioParams::enable_air_absorb

Enable air absorb or not for the speaker.

◆ speaker_attenuation

Optional<double> agora::SpatialAudioParams::speaker_attenuation

Speaker attenuation factor.

◆ enable_doppler

Optional<bool> agora::SpatialAudioParams::enable_doppler

Enable doppler factor.