Device Settings - Audio Encoding APIs

Description

This contains implementation of AudioEncoding class methods, support functions and variable assignments to manage the audio encoding types.

Functions
static const AudioEncoding &	device::AudioEncoding::getInstance (int id)
	This function gets an AudioEncoding instance against the id parameter, only if the id passed is valid. More...
static const AudioEncoding &	device::AudioEncoding::getInstance (const std::string &name)
	This function gets an AudioEncoding instance against the specified name, only if the name passed is valid. More...
	device::AudioEncoding::AudioEncoding (int id)
	This function is the default constructor for AudioEncoding. It initializes the instance with the id passed as input. If the id parameter is invalid then it throws an IllegalArgumentException. More...
virtual	device::AudioEncoding::~AudioEncoding ()
	This function is the default destructor of AudioEncoding class. More...

Function Documentation

getInstance() [1/2]

const AudioEncoding & device::AudioEncoding::getInstance ( int  id )

static

This function gets an AudioEncoding instance against the id parameter, only if the id passed is valid.

Parameters

[in]

id

Indicates the id against which the AudioEncoding instance is required. The id is used to identify the audio encoding types.

Returns

Returns AudioEncoding instance if the id is valid else throws an IllegalArgumentException.

Definition at line 82 of file audioEncoding.cpp.

getInstance() [2/2]

const AudioEncoding & device::AudioEncoding::getInstance ( const std::string &  name )

static

This function gets an AudioEncoding instance against the specified name, only if the name passed is valid.

Parameters

[in]

name

Indicates the name against which the AudioEncoding instance is required and it is also used to identify the audio encoding types.

Returns

Returns AudioEncoding instance if the name is valid else throws an IllegalArgumentException.

Definition at line 103 of file audioEncoding.cpp.

AudioEncoding()

device::AudioEncoding::AudioEncoding

(

int

id

)

This function is the default constructor for AudioEncoding. It initializes the instance with the id passed as input. If the id parameter is invalid then it throws an IllegalArgumentException.

Parameters

[in]

id

Indicates the audio encoding type. id 0 indicates encoding type None id 1 indicates digital audio encoding format id 2 indicates PCM encoding type id 3 indicates AC3 encoding type

Returns

None

Definition at line 130 of file audioEncoding.cpp.

~AudioEncoding()

device::AudioEncoding::~AudioEncoding ( )

virtual

This function is the default destructor of AudioEncoding class.

Returns

None

Definition at line 150 of file audioEncoding.cpp.