Default audio settings for Engage Engine policy. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

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: true] Enables audio processing

bool	hardwareEnabled
	[Optional, Default: true] Enables local machine hardware audio

int	internalRate
	[Optional, Default: 16000] Internal sampling rate - 8000 or 16000

int	internalChannels
	[Optional, Default: 2] Internal audio channel count rate - 1 or 2

bool	muteTxOnTx
	[Optional, Default: false] Automatically mute TX when TX begins

Aec	aec
	[Optional] Acoustic echo cancellation settings

Vad	vad
	[Optional] Voice activity detection settings

AndroidAudio	android
	[Optional] Android-specific audio settings

Agc	inputAgc
	[Optional] Automatic Gain Control for audio inputs

Agc	outputAgc
	[Optional] Automatic Gain Control for audio outputs

bool	denoiseInput
	[Optional, Default: false] Denoise input

bool	denoiseOutput
	[Optional, Default: false] Denoise output

bool	saveInputPcm
	[Optional, Default: false] If true, input audio is written to a PCM file in the data directory

bool	saveOutputPcm
	[Optional, Default: false] If true, input audio is written to a PCM file in the data directory

AudioRegistry	registry
	[Optional] If specified, this registry will be used to discover the input and output devices

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Default audio settings for Engage Engine policy.

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

Example:

{
   "allowOutputOnTransmit": false,
   "microphoneQueueMs": 60,
   "outputChannels": 2,
   "outputGainPercentage": 0,
   "pcmMaxSamplesInQueue": 1000,
   "pcmMinPlatformSampleCount": 250,
   "pcmSamplingRate": 16000,
   "pcmSpeakerBuffers": 5,
   "speakerQueueMs": 250
}

See also: TODO: ConfigurationObjects::EnginePolicy

Definition at line 6258 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ EnginePolicyAudio()

AppConfigurationObjects::EnginePolicyAudio::EnginePolicyAudio ( )

inline

Definition at line 6310 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::EnginePolicyAudio::clear ( )

inline

Definition at line 6315 of file ConfigurationObjects.h.

Member Data Documentation

◆ aec

Aec AppConfigurationObjects::EnginePolicyAudio::aec

[Optional] Acoustic echo cancellation settings

Definition at line 6280 of file ConfigurationObjects.h.

◆ android

AndroidAudio AppConfigurationObjects::EnginePolicyAudio::android

[Optional] Android-specific audio settings

Definition at line 6286 of file ConfigurationObjects.h.

◆ denoiseInput

bool AppConfigurationObjects::EnginePolicyAudio::denoiseInput

[Optional, Default: false] Denoise input

Definition at line 6295 of file ConfigurationObjects.h.

◆ denoiseOutput

bool AppConfigurationObjects::EnginePolicyAudio::denoiseOutput

[Optional, Default: false] Denoise output

Definition at line 6298 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::EnginePolicyAudio::enabled

[Optional, Default: true] Enables audio processing

Definition at line 6265 of file ConfigurationObjects.h.

◆ hardwareEnabled

bool AppConfigurationObjects::EnginePolicyAudio::hardwareEnabled

[Optional, Default: true] Enables local machine hardware audio

Definition at line 6268 of file ConfigurationObjects.h.

◆ inputAgc

Agc AppConfigurationObjects::EnginePolicyAudio::inputAgc

[Optional] Automatic Gain Control for audio inputs

Definition at line 6289 of file ConfigurationObjects.h.

◆ internalChannels

int AppConfigurationObjects::EnginePolicyAudio::internalChannels

[Optional, Default: 2] Internal audio channel count rate - 1 or 2

Definition at line 6274 of file ConfigurationObjects.h.

◆ internalRate

int AppConfigurationObjects::EnginePolicyAudio::internalRate

[Optional, Default: 16000] Internal sampling rate - 8000 or 16000

Definition at line 6271 of file ConfigurationObjects.h.

◆ muteTxOnTx

bool AppConfigurationObjects::EnginePolicyAudio::muteTxOnTx

[Optional, Default: false] Automatically mute TX when TX begins

Definition at line 6277 of file ConfigurationObjects.h.

◆ outputAgc

Agc AppConfigurationObjects::EnginePolicyAudio::outputAgc

[Optional] Automatic Gain Control for audio outputs

Definition at line 6292 of file ConfigurationObjects.h.

◆ registry

AudioRegistry AppConfigurationObjects::EnginePolicyAudio::registry

[Optional] If specified, this registry will be used to discover the input and output devices

Definition at line 6307 of file ConfigurationObjects.h.

◆ saveInputPcm

bool AppConfigurationObjects::EnginePolicyAudio::saveInputPcm

[Optional, Default: false] If true, input audio is written to a PCM file in the data directory

Definition at line 6301 of file ConfigurationObjects.h.

◆ saveOutputPcm

bool AppConfigurationObjects::EnginePolicyAudio::saveOutputPcm