RDK Documentation (Open Sourced RDK Components)

Description

Describe the details about RDK TR-069 components SPDIF APIs specifications.

Functions

int hostIf_STBServiceSPDIF::handleSetMsg (const char *paramName, HOSTIF_MsgData_t *stMsgData)
 This function set the SPDIF interface updates such as Enable, Status, Alias, Name, ForcePCM, Pass through, AudioDelay in a connected SPDIF port. Currently ForcePCM is handled. More...
 
int hostIf_STBServiceSPDIF::handleGetMsg (const char *paramName, HOSTIF_MsgData_t *stMsgData)
 This function get the SPDIF interface updates such as Enable, Status, Alias, Name, ForcePCM, Pass through, AudioDelay in a connected SPDIF port. More...
 
void hostIf_STBServiceSPDIF::doUpdates (updateCallback mUpdateCallback)
 This function updates the SPDIF interface updates such as Enable, Status, Alias, Name, ForcePCM, Pass through, AudioDelay in a connected SPDIF port. More...
 

Function Documentation

◆ handleSetMsg()

int hostIf_STBServiceSPDIF::handleSetMsg ( const char *  paramName,
HOSTIF_MsgData_t stMsgData 
)

This function set the SPDIF interface updates such as Enable, Status, Alias, Name, ForcePCM, Pass through, AudioDelay in a connected SPDIF port. Currently ForcePCM is handled.

Parameters
[in]paramNameSPDIF service name string.
[in]stMsgDataHostIf Message Request param contains the SPDIF attribute value.
Returns
Returns an Integer value.
Return values
0If successfully set the hostIf SPDIF interface attribute.
-1If Not able to set the hostIf SPDIF interface attribute.
-2If Not handle the hostIf SPDIF interface attribute.

Definition at line 187 of file Components_SPDIF.cpp.

◆ handleGetMsg()

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

This function get the SPDIF interface updates such as Enable, Status, Alias, Name, ForcePCM, Pass through, AudioDelay in a connected SPDIF port.

Parameters
[in]paramNameSPDIF service name string.
[in]stMsgDataHostIf Message Request param contains the SPDIF attribute value.
Returns
Returns an Integer value.
Return values
0If successfully get the hostIf SPDIF interface attribute.
-1If Not able to get the hostIf SPDIF interface attribute.
-2If Not handle the hostIf SPDIF interface attribute.

Definition at line 210 of file Components_SPDIF.cpp.

◆ doUpdates()

void hostIf_STBServiceSPDIF::doUpdates ( updateCallback  mUpdateCallback)

This function updates the SPDIF interface updates such as Enable, Status, Alias, Name, ForcePCM, Pass through, AudioDelay in a connected SPDIF port.

Parameters
[in]mUpdateCallbackCallback function which updates the hostIf SPDIF interface.

Definition at line 252 of file Components_SPDIF.cpp.