RDK Documentation (Open Sourced RDK Components)

Description

Describe the details about RDK TR069 capabilities of video output APIs specifications.

Functions

void hostIf_STBServiceVideoOutput::checkForUpdates (updateCallback mUpdateCallback)
 This function checks for the host IF video interface updates such as status, display format, video format, aspect ratio and HDPC (High-Bandwidth Digital Content Protection) in a connected video port. Currently not implemented. More...
 
int hostIf_STBServiceVideoOutput::handleSetMsg (const char *paramName, HOSTIF_MsgData_t *stMsgData)
 This function set the video interface attribute value such as status, display format, video format, aspect ratio and HDPC(High-Bandwidth Digital Content Protection) in the connected video port etc.. Currently not implemented. More...
 
int hostIf_STBServiceVideoOutput::handleGetMsg (const char *paramName, HOSTIF_MsgData_t *stMsgData)
 This function get the video interface attribute value such as status, display format, video format, aspect ratio and HDPC(High-Bandwidth Digital Content Protection) in the connected video port etc.. More...
 
void hostIf_STBServiceVideoOutput::doUpdates (updateCallback mUpdateCallback)
 This function updates the video interface such as status, display format, video format, aspect ratio and HDPC (High-Bandwidth Digital Content Protection) in a connected video port using callback mechanism. More...
 

Function Documentation

◆ checkForUpdates()

void hostIf_STBServiceVideoOutput::checkForUpdates ( updateCallback  mUpdateCallback)

This function checks for the host IF video interface updates such as status, display format, video format, aspect ratio and HDPC (High-Bandwidth Digital Content Protection) in a connected video port. Currently not implemented.

Parameters
[in]mUpdateCallbackCallback function pointer to check for the host IF video interface update.

◆ handleSetMsg()

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

This function set the video interface attribute value such as status, display format, video format, aspect ratio and HDPC(High-Bandwidth Digital Content Protection) in the connected video port etc.. Currently not implemented.

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

Definition at line 204 of file Components_VideoOutput.cpp.

◆ handleGetMsg()

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

This function get the video interface attribute value such as status, display format, video format, aspect ratio and HDPC(High-Bandwidth Digital Content Protection) in the connected video port etc..

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

Definition at line 224 of file Components_VideoOutput.cpp.

◆ doUpdates()

void hostIf_STBServiceVideoOutput::doUpdates ( updateCallback  mUpdateCallback)

This function updates the video interface such as status, display format, video format, aspect ratio and HDPC (High-Bandwidth Digital Content Protection) in a connected video port using callback mechanism.

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

Definition at line 270 of file Components_VideoOutput.cpp.