Device Settings - Audio Outport Types APIs

Description

• AudioOutputPortType objects are instantiated by the Device Settings module upon initialization.
• Applications do not need to create any such objects on its own.
• References to these objects can be retrieved using a AudioOutputPort object invoking AudioOutputPort::getType()

Functions
static AudioOutputPortType &	device::AudioOutputPortType::getInstance (int id)
	This function is used to get the instance of the AudioOutputPortType based on the port id, only if the id passed is valid. More...
	device::AudioOutputPortType::AudioOutputPortType (int id)
	This is a default constructor of class AudioOutputPortType. It initializes the AudioOutputPortType instance based on the port id. If the id passed is invalid then it throws an IllegalArgumentException. More...
virtual	device::AudioOutputPortType::~AudioOutputPortType ()
	This is a default destructor of class AudioOutputPortType. More...
const List< AudioCompression >	device::AudioOutputPortType::getSupportedCompressions () const
	This API is used to get the list of audio compressions supported by the audio port. More...
const List< AudioEncoding >	device::AudioOutputPortType::getSupportedEncodings () const
	This API is used to get the list of audio encodings supported by the audio port . More...
const List< AudioStereoMode >	device::AudioOutputPortType::getSupportedStereoModes () const
	This API is used to get the list of audio stereo modes supported by the audio port. More...
const List< AudioOutputPort >	device::AudioOutputPortType::getPorts () const
	This function is used to get the list of platform supported audio output ports. More...
AudioOutputPort &	device::AudioOutputPortType::getPort (int index)
	This function is used to get the AudioOutputPort instance based on the index. More...
void	device::AudioOutputPortType::addEncoding (const AudioEncoding &encoding)
	This function is used to add the specified encoding types to the list of supported encodings for AudioOutputPortType. More...
void	device::AudioOutputPortType::addCompression (const AudioCompression &compression)
	This function is used to add the specified compression types to the list of supported compressions for AudioOutputPortType. More...
void	device::AudioOutputPortType::addStereoMode (const AudioStereoMode &stereoMode)
	This function is used to add the specified stereoMode types to the list of supported stereo modes for AudioOutputPortType. More...
void	device::AudioOutputPortType::addPort (const AudioOutputPort &port)
	This function is used to add the specified audio port to the list of supported audio ports. More...
bool	device::AudioOutputPortType::isModeSupported (int newMode)
	This function is used to find out if requested Audio mode is supported by Platform. More...

Function Documentation

getInstance()

AudioOutputPortType & device::AudioOutputPortType::getInstance ( int  id )

static

This function is used to get the instance of the AudioOutputPortType based on the port id, only if the id passed is valid.

Parameters

[in]

id

Port id

Returns

Returns a reference to the instance of the audioOutputPortType. If the id passed is invalid then it throws an IllegalArgumentException.

Definition at line 90 of file audioOutputPortType.cpp.

AudioOutputPortType()

device::AudioOutputPortType::AudioOutputPortType

(

int

id

)

This is a default constructor of class AudioOutputPortType. It initializes the AudioOutputPortType instance based on the port id. If the id passed is invalid then it throws an IllegalArgumentException.

Parameters

[in]

id

Port id

Returns

None.

Definition at line 109 of file audioOutputPortType.cpp.

~AudioOutputPortType()

device::AudioOutputPortType::~AudioOutputPortType ( )

virtual

This is a default destructor of class AudioOutputPortType.

Returns

None.

Definition at line 127 of file audioOutputPortType.cpp.

getSupportedCompressions()

const List< AudioCompression > device::AudioOutputPortType::getSupportedCompressions

(

)

const

This API is used to get the list of audio compressions supported by the audio port.

Returns

Returns a list of audio compressions supported.

Definition at line 138 of file audioOutputPortType.cpp.

getSupportedEncodings()

const List< AudioEncoding > device::AudioOutputPortType::getSupportedEncodings

(

)

const

This API is used to get the list of audio encodings supported by the audio port .

Returns

A list of audio encodings supported.

Definition at line 150 of file audioOutputPortType.cpp.

getSupportedStereoModes()

const List< AudioStereoMode > device::AudioOutputPortType::getSupportedStereoModes

(

)

const

This API is used to get the list of audio stereo modes supported by the audio port.

Parameters

None

Returns

A list of stereo modes supported

Definition at line 164 of file audioOutputPortType.cpp.

getPorts()

const List< AudioOutputPort > device::AudioOutputPortType::getPorts

(

)

const

This function is used to get the list of platform supported audio output ports.

Returns

_aPorts List of audiooutputports.

Definition at line 176 of file audioOutputPortType.cpp.

getPort()

AudioOutputPort & device::AudioOutputPortType::getPort

(

int

index

)

This function is used to get the AudioOutputPort instance based on the index.

Parameters

[in]

index

Index of the audio output port.

Returns

Reference to the instance of the audiooutputport.

Definition at line 189 of file audioOutputPortType.cpp.

addEncoding()

void device::AudioOutputPortType::addEncoding

(

const AudioEncoding &

encoding

)

This function is used to add the specified encoding types to the list of supported encodings for AudioOutputPortType.

Parameters

[in]

encoding

Type of encoding used in the audio output port type.

Definition at line 208 of file audioOutputPortType.cpp.

addCompression()

void device::AudioOutputPortType::addCompression

(

const AudioCompression &

compression

)

This function is used to add the specified compression types to the list of supported compressions for AudioOutputPortType.

Parameters

[in]

compression

Type of compression used in the audio output port type.

Returns

None.

Definition at line 223 of file audioOutputPortType.cpp.

addStereoMode()

void device::AudioOutputPortType::addStereoMode

(

const AudioStereoMode &

stereoMode

)

This function is used to add the specified stereoMode types to the list of supported stereo modes for AudioOutputPortType.

Parameters

[in]

stereoMode

Type of stereoMode used in the audio output port type.

Returns

None.

Definition at line 238 of file audioOutputPortType.cpp.

addPort()

void device::AudioOutputPortType::addPort

(

const AudioOutputPort &

port

)

This function is used to add the specified audio port to the list of supported audio ports.

Parameters

[in]

port

Indicates the port to be added to the list of supported audio portsi.

Returns

None.

Definition at line 252 of file audioOutputPortType.cpp.

isModeSupported()

bool device::AudioOutputPortType::isModeSupported

(

int

newMode

)

This function is used to find out if requested Audio mode is supported by Platform.

Parameters

[in]

newMode

Indicates the requested Audio mode to be validated against supported Audio modes.

Returns

True means Supported..

Definition at line 265 of file audioOutputPortType.cpp.