Engage Engine API  1.246.9086
Loading...
Searching...
No Matches
AppConfigurationObjects::AudioDeviceDescriptor Class Reference

Custom Audio Device Configuration. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types

enum  Direction_t { dirUnknown = 0 , dirInput , dirOutput , dirBoth }
 Audio Device Direction Enum. More...
 

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

int deviceId
 [Read Only] Unique device identifier assigned by Engage Engine at time of device creation.
 
int samplingRate
 This is the rate that the device will process the PCM audio data at.
 
int channels
 Indicates the number of audio channels to process.
 
Direction_t direction
 Audio direction the device supports.
 
int boostPercentage
 A percentage at which to gain/attenuate the audio.
 
bool isAdad
 True if the device is an Application-Defined Audio Device.
 
std::string name
 Name of the device assigned by the platform.
 
std::string manufacturer
 Device manufacturer (if any)
 
std::string model
 Device mode (if any)
 
std::string hardwareId
 Device hardware ID (if any)
 
std::string serialNumber
 Device serial number (if any)
 
bool isDefault
 True if this is the default device for the direction above.
 
std::string type
 Device type (if any)
 
std::string extra
 Extra data provided by the platform (if any)
 
bool isPresent
 True if the device is currently present on the system.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Custom Audio Device Configuration.

Helper C++ class to serialize and de-serialize AudioDeviceDescriptor JSON used in engageAudioDeviceRegister API.

Example:

{
"boostPercentage": 0,
"channels": 0,
"deviceId": 0,
"direction": 0,
"samplingRate": 0
}
See also
engageAudioDeviceRegister

Definition at line 3462 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ Direction_t

Audio Device Direction Enum.

Enumerator
dirUnknown 

Direction unknown.

dirInput 

This is an input only device.

dirOutput 

This is an output only device.

dirBoth 

This device supports both input and output.

Definition at line 3470 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ AudioDeviceDescriptor()

AppConfigurationObjects::AudioDeviceDescriptor::AudioDeviceDescriptor ( )
inline

Definition at line 3548 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::AudioDeviceDescriptor::clear ( )
inline

Definition at line 3553 of file ConfigurationObjects.h.

◆ toString()

virtual std::string AppConfigurationObjects::AudioDeviceDescriptor::toString ( )
inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 3573 of file ConfigurationObjects.h.

Member Data Documentation

◆ boostPercentage

int AppConfigurationObjects::AudioDeviceDescriptor::boostPercentage

A percentage at which to gain/attenuate the audio.

Values above 100% will gain the level, values below will attenuate.

Definition at line 3516 of file ConfigurationObjects.h.

◆ channels

int AppConfigurationObjects::AudioDeviceDescriptor::channels

Indicates the number of audio channels to process.

Valid values are 1 (mono) and 2 (stereo).

Definition at line 3505 of file ConfigurationObjects.h.

◆ deviceId

int AppConfigurationObjects::AudioDeviceDescriptor::deviceId

[Read Only] Unique device identifier assigned by Engage Engine at time of device creation.

Definition at line 3489 of file ConfigurationObjects.h.

◆ direction

Direction_t AppConfigurationObjects::AudioDeviceDescriptor::direction

Audio direction the device supports.

See also
Direction_t

Definition at line 3508 of file ConfigurationObjects.h.

◆ extra

std::string AppConfigurationObjects::AudioDeviceDescriptor::extra

Extra data provided by the platform (if any)

Definition at line 3543 of file ConfigurationObjects.h.

◆ hardwareId

std::string AppConfigurationObjects::AudioDeviceDescriptor::hardwareId

Device hardware ID (if any)

Definition at line 3531 of file ConfigurationObjects.h.

◆ isAdad

bool AppConfigurationObjects::AudioDeviceDescriptor::isAdad

True if the device is an Application-Defined Audio Device.

Definition at line 3519 of file ConfigurationObjects.h.

◆ isDefault

bool AppConfigurationObjects::AudioDeviceDescriptor::isDefault

True if this is the default device for the direction above.

Definition at line 3537 of file ConfigurationObjects.h.

◆ isPresent

bool AppConfigurationObjects::AudioDeviceDescriptor::isPresent

True if the device is currently present on the system.

Definition at line 3546 of file ConfigurationObjects.h.

◆ manufacturer

std::string AppConfigurationObjects::AudioDeviceDescriptor::manufacturer

Device manufacturer (if any)

Definition at line 3525 of file ConfigurationObjects.h.

◆ model

std::string AppConfigurationObjects::AudioDeviceDescriptor::model

Device mode (if any)

Definition at line 3528 of file ConfigurationObjects.h.

◆ name

std::string AppConfigurationObjects::AudioDeviceDescriptor::name

Name of the device assigned by the platform.

Definition at line 3522 of file ConfigurationObjects.h.

◆ samplingRate

int AppConfigurationObjects::AudioDeviceDescriptor::samplingRate

This is the rate that the device will process the PCM audio data at.

Valid values are 8000 and 16000.

Definition at line 3497 of file ConfigurationObjects.h.

◆ serialNumber

std::string AppConfigurationObjects::AudioDeviceDescriptor::serialNumber

Device serial number (if any)

Definition at line 3534 of file ConfigurationObjects.h.

◆ type

std::string AppConfigurationObjects::AudioDeviceDescriptor::type

Device type (if any)

Definition at line 3540 of file ConfigurationObjects.h.


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