Describes an audio device that is available on the system. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions
void	clear ()

virtual std::string	toString ()

Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void	initForDocumenting ()

virtual bool	isDocumenting () const

Public Attributes
std::string	hardwareId
	The string identifier used to identify the hardware.

bool	isDefault
	True if this is the default device.

std::string	name
	Name of the device.

std::string	manufacturer
	[Optional] Manufacturer

std::string	model
	[Optional] Model

std::string	serialNumber
	[Optional] Serial number

std::string	type
	[Optional] Type

std::string	extra
	[Optional] Extra

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

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

Detailed Description

Describes an audio device that is available on the system.

Helper C++ class to serialize and de-serialize AudioRegistryDevice

Example:

See also: AudioRegistryDevice

Definition at line 3603 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ AudioRegistryDevice()

AppConfigurationObjects::AudioRegistryDevice::AudioRegistryDevice ( )

inline

Definition at line 3634 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::AudioRegistryDevice::clear ( )

inline

Definition at line 3639 of file ConfigurationObjects.h.

◆ toString()

virtual std::string AppConfigurationObjects::AudioRegistryDevice::toString ( )

inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 3651 of file ConfigurationObjects.h.

Member Data Documentation

◆ extra

std::string AppConfigurationObjects::AudioRegistryDevice::extra

[Optional] Extra

Definition at line 3632 of file ConfigurationObjects.h.

◆ hardwareId

std::string AppConfigurationObjects::AudioRegistryDevice::hardwareId

The string identifier used to identify the hardware.

Definition at line 3610 of file ConfigurationObjects.h.

◆ isDefault

bool AppConfigurationObjects::AudioRegistryDevice::isDefault

True if this is the default device.

Definition at line 3613 of file ConfigurationObjects.h.

◆ manufacturer

std::string AppConfigurationObjects::AudioRegistryDevice::manufacturer

[Optional] Manufacturer

Definition at line 3619 of file ConfigurationObjects.h.

◆ model

std::string AppConfigurationObjects::AudioRegistryDevice::model

[Optional] Model

Definition at line 3622 of file ConfigurationObjects.h.

◆ name

std::string AppConfigurationObjects::AudioRegistryDevice::name

Name of the device.

Definition at line 3616 of file ConfigurationObjects.h.

◆ serialNumber

std::string AppConfigurationObjects::AudioRegistryDevice::serialNumber

[Optional] Serial number

Definition at line 3625 of file ConfigurationObjects.h.

◆ type

std::string AppConfigurationObjects::AudioRegistryDevice::type

[Optional] Type

Definition at line 3629 of file ConfigurationObjects.h.

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

engage/src/api/c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members