Device Settings HAL COMPOSITE Input Public APIs

Description

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...

Typedef Documentation

dsCompositeInConnectCB_t

typedef void(* dsCompositeInConnectCB_t) (dsCompositeInPort_t Port, bool isPortConnected)

Callback function used to notify applications of COMPOSITE In hot plug status.

HAL Implementation should call this method to deliver COMPOSITE In hot plug status to the application (e.g. Connect/Disconnect for Port 0/1).

Parameters

Port	COMPOSITE Input port.
isPortConnected	Connection state of COMPOSITE In Port.

Returns

None.

Definition at line 183 of file dsCompositeIn.h.

dsCompositeInSignalChangeCB_t

typedef void(* dsCompositeInSignalChangeCB_t) (dsCompositeInPort_t port, dsCompInSignalStatus_t sigStatus)

Callback function used to notify applications of Composite In signal change status.

HAL Implementation should call this method to deliver Composite In signal change status to the application (e.g. NoSignal/UnstableSignal/NotSupportedSignal/StableSignal for Composite In ports).

Parameters

port	Composite Input port.
sigStatus	signal Status of Composite In Port.

Returns

None.

Definition at line 210 of file dsCompositeIn.h.

dsCompositeInStatusChangeCB_t

typedef void(* dsCompositeInStatusChangeCB_t) (dsCompositeInStatus_t inputStatus)

Callback function used to notify applications of Composite Input status.

HAL Implementation should call this method to deliver Composite Input status to the application (e.g. port, isPresented(true/false) etc. for Composite In ports).

Parameters

inputStatus

Composite Input status of a specific Port.

Returns

None.

Definition at line 237 of file dsCompositeIn.h.

Function Documentation

dsCompositeInInit()

dsError_t dsCompositeInInit

(

void

)

Initialize the underlying COMPOSITE Input sub-system.

This function must initialize the COMPOSITE Input module and any associated data structures.

Parameters

None

Returns

Device Settings error code

Return values

dsError_t

Definition at line 58 of file dsCompositeIn.c.

dsCompositeInTerm()

dsError_t dsCompositeInTerm

(

void

)

Terminate the underlying COMPOSITE Input sub-system.

This function must terminate the COMPOSITE Input module and any associated data structures.

Parameters

None

Returns

Device Settings error code

Return values

dsError_t

Definition at line 79 of file dsCompositeIn.c.

dsCompositeInGetNumberOfInputs()

dsError_t dsCompositeInGetNumberOfInputs

(

uint8_t *

pNumberOfInputs

)

Get the number of COMPOSITE Input ports on the set-top.

This function is used to get the number of COMPOSITE Input ports on the set-top.

Parameters

[in]

Definition at line 100 of file dsCompositeIn.c.

dsCompositeInGetStatus()

dsError_t dsCompositeInGetStatus

(

dsCompositeInStatus_t *

pStatus

)

Get the COMPOSITE Input Status.

This function is used to get the current COMPOSITE Input Status.

Parameters

[in]

Definition at line 127 of file dsCompositeIn.c.

dsCompositeInSelectPort()

dsError_t dsCompositeInSelectPort

(

dsCompositeInPort_t

Port

)

Select the COMPOSITE Input port to be presented.

This function is used to select the COMPOSITE Input port for presentation.

Parameters

[in]

Definition at line 154 of file dsCompositeIn.c.

dsCompositeInScaleVideo()

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.

Parameters

[in]	x	: x coordinate for the video
[in]	y	: y coordinate for the video
[in]	width	: width of the video
[in]	height	: height of the video

Returns

Device Settings error code

Return values

dsError_t

Definition at line 178 of file dsCompositeIn.c.

dsCompositeInRegisterConnectCB()

dsError_t dsCompositeInRegisterConnectCB

(

dsCompositeInConnectCB_t

CBFunc

)

Register for the COMPOSITE Input hot plug event.

This function is used to register for the COMPOSITE Input hot plug event.

Parameters

[in]

CBFunc

COMPOSITE Input hot plug callback function.

Returns

Device Settings error code

Return values

dsError_t

dsCompositeInRegisterSignalChangeCB()

dsError_t dsCompositeInRegisterSignalChangeCB

(

dsCompositeInSignalChangeCB_t

CBFunc

)

Register for the Composite Input Signal Change event.

This function is used to register for the Composite Input Signal Change event.

Parameters

[in]

CBFunc

Composite Input Signal change callback function.

Returns

Device Settings error code

Return values

dsError_t

dsCompositeInRegisterStatusChangeCB()

dsError_t dsCompositeInRegisterStatusChangeCB

(

dsCompositeInStatusChangeCB_t

CBFunc

)

Register for the Composite Input Status Change event.

This function is used to register for the Composite Input Status Change event.

Parameters

[in]

CBFunc

Composite Input Status change callback function.

Returns

Device Settings error code

Return values

dsError_t