dsCompositeIn.h File Reference

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

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

Include dependency graph for dsCompositeIn.h:

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

Go to the source code of this file.

Typedefs
typedef void(*	dsCompositeInConnectCB_t) (dsCompositeInPort_t Port, bool isPortConnected)
	Callback function used to notify applications of COMPOSITE In hot plug status. More...
typedef void(*	dsCompositeInSignalChangeCB_t) (dsCompositeInPort_t port, dsCompInSignalStatus_t sigStatus)
	Callback function used to notify applications of Composite In signal change status. More...
typedef void(*	dsCompositeInStatusChangeCB_t) (dsCompositeInStatus_t inputStatus)
	Callback function used to notify applications of Composite Input status. More...

Functions
dsError_t	dsCompositeInInit (void)
	Initialize the underlying COMPOSITE Input sub-system. More...
dsError_t	dsCompositeInTerm (void)
	Terminate the underlying COMPOSITE Input sub-system. More...
dsError_t	dsCompositeInGetNumberOfInputs (uint8_t *pNumberOfInputs)
	Get the number of COMPOSITE Input ports on the set-top. More...
dsError_t	dsCompositeInGetStatus (dsCompositeInStatus_t *pStatus)
	Get the COMPOSITE Input Status. More...
dsError_t	dsCompositeInSelectPort (dsCompositeInPort_t Port)
	Select the COMPOSITE Input port to be presented. More...
dsError_t	dsCompositeInScaleVideo (int32_t x, int32_t y, int32_t width, int32_t height)
	Scale the COMPOSITE In video This function is used to scale the COMPOSITE In video. More...
dsError_t	dsCompositeInRegisterConnectCB (dsCompositeInConnectCB_t CBFunc)
	Register for the COMPOSITE Input hot plug event. More...
dsError_t	dsCompositeInRegisterSignalChangeCB (dsCompositeInSignalChangeCB_t CBFunc)
	Register for the Composite Input Signal Change event. More...
dsError_t	dsCompositeInRegisterStatusChangeCB (dsCompositeInStatusChangeCB_t CBFunc)
	Register for the Composite Input Status Change event. More...

yes

Device Settings HAL COMPOSITE Input Public API. This API defines the HAL for the Device Settings COMPOSITE 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 dsCompositeIn.h.