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:

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.
typedef void(*	dsCompositeInSignalChangeCB_t) (dsCompositeInPort_t port, dsCompInSignalStatus_t sigStatus)
	Callback function used to notify applications of Composite In signal change status.
typedef void(*	dsCompositeInStatusChangeCB_t) (dsCompositeInStatus_t inputStatus)
	Callback function used to notify applications of Composite Input status change event.

Functions
dsError_t	dsCompositeInInit (void)
	Initializes the underlying COMPOSITE Input sub-system.
dsError_t	dsCompositeInTerm (void)
	Terminates the underlying COMPOSITE Input sub-system.
dsError_t	dsCompositeInGetNumberOfInputs (uint8_t *pNumberOfInputs)
	Gets the number of COMPOSITE Input ports on the specific platform.
dsError_t	dsCompositeInGetStatus (dsCompositeInStatus_t *pStatus)
	Gets the COMPOSITE Input Status.
dsError_t	dsCompositeInSelectPort (dsCompositeInPort_t Port)
	Sets the COMPOSITE Input port as active available for presentation.
dsError_t	dsCompositeInScaleVideo (int32_t x, int32_t y, int32_t width, int32_t height)
	Scales the COMPOSITE In video This function scales the COMPOSITE input video. The width and height, based on the x, y coordinates, cannot exceed that of the current resolution of the device. e.g. x(in pixels)+width cannot be greater then the width of the resolution.
dsError_t	dsCompositeInRegisterConnectCB (dsCompositeInConnectCB_t CBFunc)
	Registers the COMPOSITE Input hot plug event.
dsError_t	dsCompositeInRegisterSignalChangeCB (dsCompositeInSignalChangeCB_t CBFunc)
	Registers the Composite Input Signal Change event.
dsError_t	dsCompositeInRegisterStatusChangeCB (dsCompositeInStatusChangeCB_t CBFunc)
	Registers the Composite Input Status Change event.

Detailed Description

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