Agora C++ API Reference for All Platforms
Public Member Functions | Public Attributes | List of all members
agora::rtc::AudioOptions Struct Reference

Public Member Functions

 AudioOptions ()=default
 
 ~AudioOptions ()=default
 
void SetAll (const AudioOptions &change)
 
bool operator== (const AudioOptions &o) const
 
AudioOptionsFilter ()
 
bool operator!= (const AudioOptions &o) const
 

Public Attributes

Optional< uint32_t > audio_scenario
 
Optional< uint32_t > audio_routing
 
Optional< OPENSL_MODEopensl_mode
 
Optional< bool > has_published_stream
 
Optional< bool > has_subscribed_stream
 
Optional< uint32_t > adm_mix_option_selected
 
Optional< uint32_t > adm_override_lua_input_sample_rate
 
Optional< uint32_t > adm_input_sample_rate
 
Optional< uint32_t > adm_output_sample_rate
 
Optional< bool > adm_stereo_out
 
Optional< bool > adm_stereo_recording
 
Optional< uint32_t > adm_force_use_bluetooth_a2dp
 
Optional< bool > adm_keep_audio_session
 
Optional< bool > adm_use_hw_aec
 
Optional< bool > adm_output_align_input_sample_rate
 
Optional< bool > adm_force_restart
 
Optional< bool > adm_enable_opensl
 
Optional< uint32_t > adm_audio_layer
 
Optional< bool > adm_enable_record_but_not_publish
 
Optional< uint32_t > adm_audio_source
 
Optional< float > adm_playout_bufsize_factor
 
Optional< bool > apm_override_lua_enable_aec
 
Optional< bool > apm_override_lua_enable_ns
 
Optional< bool > apm_override_lua_enable_agc
 
Optional< bool > apm_override_lua_enable_md
 
Optional< bool > apm_enable_aec
 
Optional< bool > apm_enable_ns
 
Optional< bool > apm_enable_agc
 
Optional< bool > apm_enable_md
 
Optional< bool > apm_enable_highpass_filter
 
Optional< bool > apm_enable_tone_remover
 
Optional< bool > apm_enable_pitch_smoother
 
Optional< bool > apm_enable_howling_control
 
Optional< uint32_t > apm_delay_offset_ms
 
Optional< uint32_t > apm_aec_suppression_level
 
Optional< uint32_t > apm_aec_delay_type
 
Optional< uint32_t > apm_aec_nlp_aggressiveness
 
Optional< uint32_t > apm_agc_target_level_dbfs
 
Optional< uint32_t > apm_agc_compression_gain_db
 
Optional< uint32_t > apm_agc_mode
 
Optional< uint32_t > apm_ns_level
 
Optional< bool > apm_enable_dtd
 
Optional< uint32_t > acm_bitrate
 
Optional< uint32_t > acm_codec
 
Optional< bool > acm_dtx
 
Optional< bool > acm_plc
 
Optional< uint32_t > acm_complex_level
 
Optional< uint32_t > acm_ptime
 
Optional< uint32_t > neteq_live_min_delay
 
Optional< uint32_t > neteq_jitter_buffer_max_packets
 
Optional< bool > neteq_jitter_buffer_fast_accelerate
 
Optional< int32_t > neteq_jitter_max_target_delay
 
Optional< bool > neteq_target_level_optimization
 
Optional< uint32_t > neteq_aqm_voice_threshold
 
Optional< uint32_t > playback_volume
 
Optional< bool > webrtc_enable_aec3
 
Optional< bool > derived_headset_black_list_device
 
Optional< int > use_media_volume_in_headset
 
Optional< int > use_media_volume_in_audience
 
Optional< int > use_media_volume_in_solo
 

Constructor & Destructor Documentation

◆ AudioOptions()

agora::rtc::AudioOptions::AudioOptions ( )
default

◆ ~AudioOptions()

agora::rtc::AudioOptions::~AudioOptions ( )
default

Member Function Documentation

◆ SetAll()

void agora::rtc::AudioOptions::SetAll ( const AudioOptions change)
inline

◆ operator==()

bool agora::rtc::AudioOptions::operator== ( const AudioOptions o) const
inline

◆ Filter()

AudioOptions& agora::rtc::AudioOptions::Filter ( )
inline

◆ operator!=()

bool agora::rtc::AudioOptions::operator!= ( const AudioOptions o) const
inline

Member Data Documentation

◆ audio_scenario

Optional<uint32_t> agora::rtc::AudioOptions::audio_scenario

◆ audio_routing

Optional<uint32_t> agora::rtc::AudioOptions::audio_routing

◆ opensl_mode

Optional<OPENSL_MODE> agora::rtc::AudioOptions::opensl_mode

◆ has_published_stream

Optional<bool> agora::rtc::AudioOptions::has_published_stream

◆ has_subscribed_stream

Optional<bool> agora::rtc::AudioOptions::has_subscribed_stream

◆ adm_mix_option_selected

Optional<uint32_t> agora::rtc::AudioOptions::adm_mix_option_selected

◆ adm_override_lua_input_sample_rate

Optional<uint32_t> agora::rtc::AudioOptions::adm_override_lua_input_sample_rate

◆ adm_input_sample_rate

Optional<uint32_t> agora::rtc::AudioOptions::adm_input_sample_rate

◆ adm_output_sample_rate

Optional<uint32_t> agora::rtc::AudioOptions::adm_output_sample_rate

◆ adm_stereo_out

Optional<bool> agora::rtc::AudioOptions::adm_stereo_out

◆ adm_stereo_recording

Optional<bool> agora::rtc::AudioOptions::adm_stereo_recording

◆ adm_force_use_bluetooth_a2dp

Optional<uint32_t> agora::rtc::AudioOptions::adm_force_use_bluetooth_a2dp

◆ adm_keep_audio_session

Optional<bool> agora::rtc::AudioOptions::adm_keep_audio_session

◆ adm_use_hw_aec

Optional<bool> agora::rtc::AudioOptions::adm_use_hw_aec

◆ adm_output_align_input_sample_rate

Optional<bool> agora::rtc::AudioOptions::adm_output_align_input_sample_rate

◆ adm_force_restart

Optional<bool> agora::rtc::AudioOptions::adm_force_restart

◆ adm_enable_opensl

Optional<bool> agora::rtc::AudioOptions::adm_enable_opensl

◆ adm_audio_layer

Optional<uint32_t> agora::rtc::AudioOptions::adm_audio_layer

◆ adm_enable_record_but_not_publish

Optional<bool> agora::rtc::AudioOptions::adm_enable_record_but_not_publish

◆ adm_audio_source

Optional<uint32_t> agora::rtc::AudioOptions::adm_audio_source

◆ adm_playout_bufsize_factor

Optional<float> agora::rtc::AudioOptions::adm_playout_bufsize_factor

◆ apm_override_lua_enable_aec

Optional<bool> agora::rtc::AudioOptions::apm_override_lua_enable_aec

◆ apm_override_lua_enable_ns

Optional<bool> agora::rtc::AudioOptions::apm_override_lua_enable_ns

◆ apm_override_lua_enable_agc

Optional<bool> agora::rtc::AudioOptions::apm_override_lua_enable_agc

◆ apm_override_lua_enable_md

Optional<bool> agora::rtc::AudioOptions::apm_override_lua_enable_md

◆ apm_enable_aec

Optional<bool> agora::rtc::AudioOptions::apm_enable_aec

◆ apm_enable_ns

Optional<bool> agora::rtc::AudioOptions::apm_enable_ns

◆ apm_enable_agc

Optional<bool> agora::rtc::AudioOptions::apm_enable_agc

◆ apm_enable_md

Optional<bool> agora::rtc::AudioOptions::apm_enable_md

◆ apm_enable_highpass_filter

Optional<bool> agora::rtc::AudioOptions::apm_enable_highpass_filter

◆ apm_enable_tone_remover

Optional<bool> agora::rtc::AudioOptions::apm_enable_tone_remover

◆ apm_enable_pitch_smoother

Optional<bool> agora::rtc::AudioOptions::apm_enable_pitch_smoother

◆ apm_enable_howling_control

Optional<bool> agora::rtc::AudioOptions::apm_enable_howling_control

◆ apm_delay_offset_ms

Optional<uint32_t> agora::rtc::AudioOptions::apm_delay_offset_ms

◆ apm_aec_suppression_level

Optional<uint32_t> agora::rtc::AudioOptions::apm_aec_suppression_level

◆ apm_aec_delay_type

Optional<uint32_t> agora::rtc::AudioOptions::apm_aec_delay_type

◆ apm_aec_nlp_aggressiveness

Optional<uint32_t> agora::rtc::AudioOptions::apm_aec_nlp_aggressiveness

◆ apm_agc_target_level_dbfs

Optional<uint32_t> agora::rtc::AudioOptions::apm_agc_target_level_dbfs

◆ apm_agc_compression_gain_db

Optional<uint32_t> agora::rtc::AudioOptions::apm_agc_compression_gain_db

◆ apm_agc_mode

Optional<uint32_t> agora::rtc::AudioOptions::apm_agc_mode

◆ apm_ns_level

Optional<uint32_t> agora::rtc::AudioOptions::apm_ns_level

◆ apm_enable_dtd

Optional<bool> agora::rtc::AudioOptions::apm_enable_dtd

◆ acm_bitrate

Optional<uint32_t> agora::rtc::AudioOptions::acm_bitrate

◆ acm_codec

Optional<uint32_t> agora::rtc::AudioOptions::acm_codec

◆ acm_dtx

Optional<bool> agora::rtc::AudioOptions::acm_dtx

◆ acm_plc

Optional<bool> agora::rtc::AudioOptions::acm_plc

◆ acm_complex_level

Optional<uint32_t> agora::rtc::AudioOptions::acm_complex_level

◆ acm_ptime

Optional<uint32_t> agora::rtc::AudioOptions::acm_ptime

◆ neteq_live_min_delay

Optional<uint32_t> agora::rtc::AudioOptions::neteq_live_min_delay

◆ neteq_jitter_buffer_max_packets

Optional<uint32_t> agora::rtc::AudioOptions::neteq_jitter_buffer_max_packets

◆ neteq_jitter_buffer_fast_accelerate

Optional<bool> agora::rtc::AudioOptions::neteq_jitter_buffer_fast_accelerate

◆ neteq_jitter_max_target_delay

Optional<int32_t> agora::rtc::AudioOptions::neteq_jitter_max_target_delay

◆ neteq_target_level_optimization

Optional<bool> agora::rtc::AudioOptions::neteq_target_level_optimization

◆ neteq_aqm_voice_threshold

Optional<uint32_t> agora::rtc::AudioOptions::neteq_aqm_voice_threshold

◆ playback_volume

Optional<uint32_t> agora::rtc::AudioOptions::playback_volume

◆ webrtc_enable_aec3

Optional<bool> agora::rtc::AudioOptions::webrtc_enable_aec3

◆ derived_headset_black_list_device

Optional<bool> agora::rtc::AudioOptions::derived_headset_black_list_device

◆ use_media_volume_in_headset

Optional<int> agora::rtc::AudioOptions::use_media_volume_in_headset

◆ use_media_volume_in_audience

Optional<int> agora::rtc::AudioOptions::use_media_volume_in_audience

◆ use_media_volume_in_solo

Optional<int> agora::rtc::AudioOptions::use_media_volume_in_solo