Engage Engine API  1.263.9113
Real-time tactical communications engine API
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
AppConfigurationObjects::Denoiser Class Reference

Noise suppression (RNNoise) tuning settings. 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

float mix
 [Optional, Default: 1.0] Wet/dry mix; 1.0 = fully denoised, 0.0 = original
 
std::string model
 [Optional, Default: ""] Path to RNNoise weights blob; empty = built-in little model
 
float vadGate
 [Optional, Default: 0.0] Min speech probability for full NS; 0 = always apply mix
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Noise suppression (RNNoise) tuning settings.

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

Example:

{
"mix": 1.0,
"model": "",
"vadGate": 0.0
}

Used with EnginePolicyAudio::denoiseInput / denoiseOutput. When those flags are false, this object has no effect.

Definition at line 6472 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Denoiser()

AppConfigurationObjects::Denoiser::Denoiser ( )
inline

Definition at line 6487 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Denoiser::clear ( )
inline

Definition at line 6492 of file ConfigurationObjects.h.

Member Data Documentation

◆ mix

float AppConfigurationObjects::Denoiser::mix

[Optional, Default: 1.0] Wet/dry mix; 1.0 = fully denoised, 0.0 = original

Definition at line 6479 of file ConfigurationObjects.h.

◆ model

std::string AppConfigurationObjects::Denoiser::model

[Optional, Default: ""] Path to RNNoise weights blob; empty = built-in little model

Definition at line 6482 of file ConfigurationObjects.h.

◆ vadGate

float AppConfigurationObjects::Denoiser::vadGate

[Optional, Default: 0.0] Min speech probability for full NS; 0 = always apply mix

Definition at line 6485 of file ConfigurationObjects.h.

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