Description of an audio gate. 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: false] Enables the audio gate if true

bool	useVad
	[Optional. Default: false] Use voice activity detection rather than audio energy

uint32_t	hangMs
	[Optional. Default: 1500] Hang timer in milliseconds

uint32_t	windowMin
	[Optional. Default: 25] Number of 10ms history samples to gather before calculating the noise floor - ignored if useVad is true

uint32_t	windowMax
	[Optional. Default: 125] Maximum number of 10ms history samples - ignored if useVad is true

double	coefficient
	[Optional. Default: 1.75] Coefficient by which to multiply the current history average to determine the floor - ignored if useVad is true

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

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

Detailed Description

Description of an audio gate.

Helper C++ class to serialize and de-serialize AudioGate JSON.

Example:

Definition at line 2951 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ AudioGate()

AppConfigurationObjects::AudioGate::AudioGate ( )

inline

Definition at line 2976 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::AudioGate::clear ( )

inline

Definition at line 2981 of file ConfigurationObjects.h.

Member Data Documentation

◆ coefficient

double AppConfigurationObjects::AudioGate::coefficient

[Optional. Default: 1.75] Coefficient by which to multiply the current history average to determine the floor - ignored if useVad is true

Definition at line 2973 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::AudioGate::enabled

[Optional. Default: false] Enables the audio gate if true

Definition at line 2958 of file ConfigurationObjects.h.

◆ hangMs

uint32_t AppConfigurationObjects::AudioGate::hangMs

[Optional. Default: 1500] Hang timer in milliseconds

Definition at line 2964 of file ConfigurationObjects.h.

◆ useVad

bool AppConfigurationObjects::AudioGate::useVad

[Optional. Default: false] Use voice activity detection rather than audio energy

Definition at line 2961 of file ConfigurationObjects.h.

◆ windowMax

uint32_t AppConfigurationObjects::AudioGate::windowMax

[Optional. Default: 125] Maximum number of 10ms history samples - ignored if useVad is true

Definition at line 2970 of file ConfigurationObjects.h.

◆ windowMin

uint32_t AppConfigurationObjects::AudioGate::windowMin

[Optional. Default: 25] Number of 10ms history samples to gather before calculating the noise floor - ignored if useVad is true

Definition at line 2967 of file ConfigurationObjects.h.

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

c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members