Engage Engine API  1.246.9086
Loading...
Searching...
No Matches
AppConfigurationObjects::Aec Class Reference

Acoustic Echo Cancellation settings. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types

enum  Mode_t {
  aecmDefault = 0 , aecmLow = 1 , aecmMedium = 2 , aecmHigh = 3 ,
  aecmVeryHigh = 4 , aecmHighest = 5
}
 Acoustic echo cancellation mode enum. More...
 

Public Member Functions

void clear ()
 
- Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void initForDocumenting ()
 
virtual std::string toString ()
 
virtual bool isDocumenting () const
 

Public Attributes

bool enabled
 [Optional, Default: false] Enable acoustic echo cancellation
 
Mode_t mode
 [Optional, Default: aecmDefault] Specifies AEC mode. See Mode_t for all modes
 
int speakerTailMs
 [Optional, Default: 60] Milliseconds of speaker tail
 
bool cng
 [Optional, Default: true] Enable comfort noise generation
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Acoustic Echo Cancellation settings.

Helper C++ class to serialize and de-serialize Aec JSON

Example:

See also
TODO: ConfigurationObjects::Aec

Definition at line 5492 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ Mode_t

Acoustic echo cancellation mode enum.

More detailed Mode_t description.

Enumerator
aecmDefault 

Default.

aecmLow 

Low.

aecmMedium 

Medium.

aecmHigh 

High.

aecmVeryHigh 

Very High.

aecmHighest 

Highest.

Definition at line 5503 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Aec()

AppConfigurationObjects::Aec::Aec ( )
inline

Definition at line 5536 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Aec::clear ( )
inline

Definition at line 5541 of file ConfigurationObjects.h.

Member Data Documentation

◆ cng

bool AppConfigurationObjects::Aec::cng

[Optional, Default: true] Enable comfort noise generation

Definition at line 5534 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::Aec::enabled

[Optional, Default: false] Enable acoustic echo cancellation

Definition at line 5525 of file ConfigurationObjects.h.

◆ mode

Mode_t AppConfigurationObjects::Aec::mode

[Optional, Default: aecmDefault] Specifies AEC mode. See Mode_t for all modes

Definition at line 5528 of file ConfigurationObjects.h.

◆ speakerTailMs

int AppConfigurationObjects::Aec::speakerTailMs

[Optional, Default: 60] Milliseconds of speaker tail

Definition at line 5531 of file ConfigurationObjects.h.


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