TR-069 Object (Device.STBServices.{i}.Capabilities.AudioOutput) Public APIs

Description

Describe the details about RDK TR069 capabilities audio output APIs specifications.

Functions
int	hostIf_STBServiceAudioInterface::handleSetMsg (const char *paramName, HOSTIF_MsgData_t *stMsgData)
	This function set the audio interface such as mute status, audio encoding, audio level, Minimum dB(decibel) and Maximum dB(decibel) that can be supported on audio port, Stereo mode used in a given audio port etc.. More...
int	hostIf_STBServiceAudioInterface::handleGetMsg (const char *paramName, HOSTIF_MsgData_t *stMsgData)
	This function get the audio interface attribute values such as mute status, audio encoding, audio level, Minimum dB(decibel) and Maximum dB(decibel) that can be supported on audio port, Stereo mode used in a given audio port etc.. More...
void	hostIf_STBServiceAudioInterface::doUpdates (updateCallback mUpdateCallback)
	This function updates the audio interface such as mute status, audio encoding, audio level, Minimum dB(decibel) and Maximum dB(decibel) that can be supported on audio port, Stereo mode used in a given audio port etc.. using callback mechanism. More...

Function Documentation

handleSetMsg()

int hostIf_STBServiceAudioInterface::handleSetMsg	(	const char *	pSetting,
		HOSTIF_MsgData_t *	stMsgData
	)

This function set the audio interface such as mute status, audio encoding, audio level, Minimum dB(decibel) and Maximum dB(decibel) that can be supported on audio port, Stereo mode used in a given audio port etc..

Parameters

[in]	pSetting	Audio service name string.
[in]	stMsgData	HostIf Message Request param contains the audio attribute value.

Returns

Returns an Integer value.

Return values

0	If successfully set the hostIf audio interface attribute.
-1	If Not able to set the hostIf audio interface attribute.

Definition at line 243 of file Components_AudioOutput.cpp.

handleGetMsg()

int hostIf_STBServiceAudioInterface::handleGetMsg	(	const char *	paramName,
		HOSTIF_MsgData_t *	stMsgData
	)

This function get the audio interface attribute values such as mute status, audio encoding, audio level, Minimum dB(decibel) and Maximum dB(decibel) that can be supported on audio port, Stereo mode used in a given audio port etc..

Parameters

[in]	paramName	Audio service name string.
[in]	stMsgData	Host IF Message Request param contains the audio attribute value.

Returns

Returns an Integer value.

Return values

0	If successfully get the hostIf audio interface attribute.
-1	If Not able to get the hostIf audio interface attribute.
-2	If Not handle the hostIf audio interface attribute.

Definition at line 295 of file Components_AudioOutput.cpp.

doUpdates()

void hostIf_STBServiceAudioInterface::doUpdates

(

updateCallback

mUpdateCallback

)

This function updates the audio interface such as mute status, audio encoding, audio level, Minimum dB(decibel) and Maximum dB(decibel) that can be supported on audio port, Stereo mode used in a given audio port etc.. using callback mechanism.

Parameters

[in]

mUpdateCallback

Callback function which updates the hostIf audio interface.

Definition at line 373 of file Components_AudioOutput.cpp.