opentera::AudioSourceConfiguration Class Reference

Represents a configuration of an audio source that can be added to a WebRTC call. More...

#include <AudioSourceConfiguration.h>

Public Member Functions
	AudioSourceConfiguration (const AudioSourceConfiguration &other)=default
	AudioSourceConfiguration (AudioSourceConfiguration &&other)=default
uint32_t	soundCardTotalDelayMs () const
	Returns the sum of the playback and recording delays. More...
absl::optional< bool >	echoCancellation () const
	Indicates if the echo cancellation is enabled. More...
absl::optional< bool >	autoGainControl () const
	Indicates if the auto gain control is enabled. More...
absl::optional< bool >	noiseSuppression () const
	Indicates if the noise suppression is enabled. More...
absl::optional< bool >	highpassFilter () const
	Indicates if the highpass filter is enabled. More...
absl::optional< bool >	stereoSwapping () const
	Indicates if the stereo swapping is enabled. More...
absl::optional< bool >	transientSuppression () const
	Indicates if the transient suppression is enabled. More...
	operator cricket::AudioOptions () const
	operator webrtc::AudioProcessing::Config () const
AudioSourceConfiguration &	operator= (const AudioSourceConfiguration &other)=default
AudioSourceConfiguration &	operator= (AudioSourceConfiguration &&other)=default

Static Public Member Functions
static AudioSourceConfiguration	create (uint32_t soundCardTotalDelayMs)
	Creates an audio source configuration with default values. More...
static AudioSourceConfiguration	create (uint32_t soundCardTotalDelayMs, absl::optional< bool > echoCancellation, absl::optional< bool > autoGainControl, absl::optional< bool > noiseSuppression, absl::optional< bool > highpassFilter, absl::optional< bool > stereoSwapping, absl::optional< bool > transientSuppression)
	Creates an audio source configuration with the specified values. More...

Detailed Description

Represents a configuration of an audio source that can be added to a WebRTC call.

Member Function Documentation

autoGainControl()

absl::optional< bool > opentera::AudioSourceConfiguration::autoGainControl ( ) const

inline

Indicates if the auto gain control is enabled.

Returns

true if the auto gain control is enabled

create() [1/2]

AudioSourceConfiguration opentera::AudioSourceConfiguration::create ( uint32_t  soundCardTotalDelayMs )

inlinestatic

Creates an audio source configuration with default values.

Parameters

soundCardTotalDelayMs

The sum of the playback and recording delays.

Returns

An audio source configuration with default values

create() [2/2]

AudioSourceConfiguration opentera::AudioSourceConfiguration::create ( uint32_t  soundCardTotalDelayMs, absl::optional< bool >  echoCancellation, absl::optional< bool >  autoGainControl, absl::optional< bool >  noiseSuppression, absl::optional< bool >  highpassFilter, absl::optional< bool >  stereoSwapping, absl::optional< bool >  transientSuppression  )

inlinestatic

Creates an audio source configuration with the specified values.

Parameters

soundCardTotalDelayMs	The sum of the playback and recording delays.
echoCancellation	Enable or disable the echo cancellation
autoGainControl	Enable or disable the auto gain control
noiseSuppression	Enable or disable the noise suppression
highpassFilter	Enable or disable the highpass filter
stereoSwapping	Enable or disable the stereo swapping
transientSuppression	Enable or disable the transient suppression

Returns

An audio source configuration with the specified values

echoCancellation()

absl::optional< bool > opentera::AudioSourceConfiguration::echoCancellation ( ) const

inline

Indicates if the echo cancellation is enabled.

Returns

true if the echo cancellation is enabled

highpassFilter()

absl::optional< bool > opentera::AudioSourceConfiguration::highpassFilter ( ) const

inline

Indicates if the highpass filter is enabled.

Returns

true if the highpass filter is enabled

noiseSuppression()

absl::optional< bool > opentera::AudioSourceConfiguration::noiseSuppression ( ) const

inline

Indicates if the noise suppression is enabled.

Returns

true if the noise suppression is enabled

operator cricket::AudioOptions()

AudioSourceConfiguration::operator cricket::AudioOptions ( ) const

explicit

Converts a AudioSourceConfiguration to a cricket::AudioOptions.

Returns

The converted cricket::AudioOptions

operator webrtc::AudioProcessing::Config()

AudioSourceConfiguration::operator webrtc::AudioProcessing::Config ( ) const

explicit

Converts a AudioSourceConfiguration to a webrtc::AudioProcessing::Config.

Returns

The converted webrtc::AudioProcessing::Config

soundCardTotalDelayMs()

uint32_t opentera::AudioSourceConfiguration::soundCardTotalDelayMs ( ) const

inline

Returns the sum of the playback and recording delays.

Returns

The sum of the playback and recording delays

stereoSwapping()

absl::optional< bool > opentera::AudioSourceConfiguration::stereoSwapping ( ) const

inline

Indicates if the stereo swapping is enabled.

Returns

true if the stereo swapping is enabled

transientSuppression()

absl::optional< bool > opentera::AudioSourceConfiguration::transientSuppression ( ) const

inline

Indicates if the transient suppression is enabled.

Returns

true if the transient suppression is enabled

---

The documentation for this class was generated from the following files:

• AudioSourceConfiguration.h
• AudioSourceConfiguration.cpp