Used to configure the Audio properties for a group. 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] Audio is enabled

int	inputId
	[Optional, Default: first audio device] Id for the input audio device to use for this group.

std::string	inputHardwareId
	[Optional] Hardware ID of the input audio device to use for this group. If empty, inputId is used.

int	inputGain
	[Optional, Default: 0] The percentage at which to gain the input audio.

int	outputId
	[Optional, Default: first audio device] Id for the output audio device to use for this group.

std::string	outputHardwareId
	[Optional] Hardware ID of the output audio device to use for this group. If empty, outputId is used.

int	outputGain
	[Optional, Default: 0] The percentage at which to gain the output audio.

int	outputLevelLeft
	[Optional, Default: 100] The percentage at which to set the left audio at.

int	outputLevelRight
	[Optional, Default: 100] The percentage at which to set the right audio at.

bool	outputMuted
	[Optional, Default: false] Mutes output audio.

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

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

Detailed Description

Used to configure the Audio properties for a group.

See also: Group

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

Example:

{
   "inputGain": 0,
   "inputId": 0,
   "outputId": 0,
   "outputLevelLeft": 100,
   "outputLevelRight": 100
}

Definition at line 3977 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Audio()

AppConfigurationObjects::Audio::Audio ( )

inline

Definition at line 4013 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Audio::clear ( )

inline

Definition at line 4018 of file ConfigurationObjects.h.

Member Data Documentation

◆ enabled

bool AppConfigurationObjects::Audio::enabled

[Optional, Default: true] Audio is enabled

Definition at line 3984 of file ConfigurationObjects.h.

◆ inputGain

int AppConfigurationObjects::Audio::inputGain

[Optional, Default: 0] The percentage at which to gain the input audio.

Definition at line 3993 of file ConfigurationObjects.h.

◆ inputHardwareId

std::string AppConfigurationObjects::Audio::inputHardwareId

[Optional] Hardware ID of the input audio device to use for this group. If empty, inputId is used.

Definition at line 3990 of file ConfigurationObjects.h.

◆ inputId

int AppConfigurationObjects::Audio::inputId

[Optional, Default: first audio device] Id for the input audio device to use for this group.

Definition at line 3987 of file ConfigurationObjects.h.

◆ outputGain

int AppConfigurationObjects::Audio::outputGain

[Optional, Default: 0] The percentage at which to gain the output audio.

Definition at line 4002 of file ConfigurationObjects.h.

◆ outputHardwareId

std::string AppConfigurationObjects::Audio::outputHardwareId

[Optional] Hardware ID of the output audio device to use for this group. If empty, outputId is used.

Definition at line 3999 of file ConfigurationObjects.h.

◆ outputId

int AppConfigurationObjects::Audio::outputId

[Optional, Default: first audio device] Id for the output audio device to use for this group.

Definition at line 3996 of file ConfigurationObjects.h.

◆ outputLevelLeft

int AppConfigurationObjects::Audio::outputLevelLeft

[Optional, Default: 100] The percentage at which to set the left audio at.

Definition at line 4005 of file ConfigurationObjects.h.

◆ outputLevelRight

int AppConfigurationObjects::Audio::outputLevelRight

[Optional, Default: 100] The percentage at which to set the right audio at.

Definition at line 4008 of file ConfigurationObjects.h.

◆ outputMuted

bool AppConfigurationObjects::Audio::outputMuted

[Optional, Default: false] Mutes output audio.

Definition at line 4011 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