dsHdmiIn.h File Reference

Device Settings HAL HDMI Input Public API. This API defines the HAL for the Device Settings HDMI Input interface. More...

#include <sys/types.h>
#include "dsError.h"
#include "dsTypes.h"

Include dependency graph for dsHdmiIn.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef void(*	dsHdmiInConnectCB_t) (dsHdmiInPort_t Port, bool isPortConnected)
	Callback function used to notify applications of HDMI In hot plug status. More...
typedef void(*	dsHdmiInSignalChangeCB_t) (dsHdmiInPort_t port, dsHdmiInSignalStatus_t sigStatus)
	Callback function used to notify applications of HDMI In signal change status. More...
typedef void(*	dsHdmiInStatusChangeCB_t) (dsHdmiInStatus_t inputStatus)
	Callback function used to notify applications of HDMI Input status. More...
typedef void(*	dsHdmiInVideoModeUpdateCB_t) (dsHdmiInPort_t port, dsVideoPortResolution_t videoResolution)
	Callback function used to notify applications of HDMI In video mode changes. More...
typedef void(*	dsHdmiInAllmChangeCB_t) (dsHdmiInPort_t port, bool allm_mode)
	Callback function used to notify applications of HDMI Input ALLM Mode. More...

Functions
dsError_t	dsHdmiInInit (void)
	Initialize the underlying HDMI Input sub-system. More...
dsError_t	dsHdmiInTerm (void)
	Terminate the underlying HDMI Input sub-system. More...
dsError_t	dsHdmiInGetNumberOfInputs (uint8_t *pNumberOfInputs)
	Get the number of HDMI Input ports on the set-top. More...
dsError_t	dsHdmiInGetStatus (dsHdmiInStatus_t *pStatus)
	Get the HDMI Inpuut Status. More...
dsError_t	dsHdmiInSelectPort (dsHdmiInPort_t Port)
	Select the HDMI Input port to be presented. More...
dsError_t	dsHdmiInScaleVideo (int32_t x, int32_t y, int32_t width, int32_t height)
	Scale the HDMI In video This function is used to scale the HDMI In video. More...
dsError_t	dsHdmiInSelectZoomMode (dsVideoZoom_t requestedZoomMode)
	Select the HDMI Input zoom mode. More...
dsError_t	dsHdmiInPauseAudio (void)
	Stop the output of HDMI Input audio. More...
dsError_t	dsHdmiInResumeAudio (void)
	Start the output of HDMI Input audio. More...
dsError_t	dsHdmiInGetCurrentVideoMode (dsVideoPortResolution_t *resolution)
	Get the current HDMI Input video mode. More...
dsError_t	dsHdmiInRegisterConnectCB (dsHdmiInConnectCB_t CBFunc)
	Register for the HDMI Input hot plug event. More...
dsError_t	dsHdmiInRegisterSignalChangeCB (dsHdmiInSignalChangeCB_t CBFunc)
	Register for the HDMI Input Signal Change event. More...
dsError_t	dsHdmiInRegisterStatusChangeCB (dsHdmiInStatusChangeCB_t CBFunc)
	Register for the HDMI Input Status Change event. More...
dsError_t	dsHdmiInRegisterVideoModeUpdateCB (dsHdmiInVideoModeUpdateCB_t CBFunc)
	Register for the HDMI Input Video Mode change event. More...
dsError_t	dsHdmiInRegisterAllmChangeCB (dsHdmiInAllmChangeCB_t CBFunc)
	Register for the HDMI Input ALLM Mode Change event. More...
bool	dsIsHdmiARCPort (int iPort)
dsError_t	dsGetEDIDBytesInfo (int iHdmiPort, unsigned char **edid, int *length)
dsError_t	dsGetHDMISPDInfo (int iHdmiPort, unsigned char **data)
dsError_t	dsSetEdidVersion (int iHdmiPort, int iEdidVersion)
dsError_t	dsGetEdidVersion (int iHdmiPort, int *iEdidVersion)
dsError_t	dsGetAllmStatus (int iHdmiPort, bool *allmStatus)
dsError_t	dsGetSupportedGameFeaturesList (dsSupportedGameFeatureList_t *features)

yes

Device Settings HAL HDMI Input Public API. This API defines the HAL for the Device Settings HDMI Input interface.

Document

Document reference.

Open Issues (in no particular order)

1. None

Assumptions

1. None

Abbreviations

• BE: Big-Endian.
• cb: Callback function (suffix).
• DS: Device Settings.
• FPD: Front-Panel Display.
• HAL: Hardware Abstraction Layer.
• LE: Little-Endian.
• LS: Least Significant.
• MBZ: Must be zero.
• MS: Most Significant.
• RDK: Reference Design Kit.
• _t: Type (suffix).

Implementation Notes

1. None

Definition in file dsHdmiIn.h.