device::CompositeInput Class Reference

This class manages COMPOSITE Input. More...

#include <compositeIn.hpp>

Collaboration diagram for device::CompositeInput:

Public Member Functions
uint8_t	getNumberOfInputs () const
	This API is used to get the number of COMPOSITE Input ports on the set-top. More...
bool	isPresented () const
	This API is used to specify if COMPOSITE Input is being presented via COMPOSITE Out. More...
bool	isActivePort (int8_t Port) const
	This API is used to specify if the provided COMPOSITE Input port is active (i.e. communicating with the set-top) More...
int8_t	getActivePort () const
	This API is used to specify the active (i.e. communicating with the set-top) COMPOSITE Input port. More...
bool	isPortConnected (int8_t Port) const
	This API is used to specify if the prvided COMPOSITE Input port is connected (i.e. COMPOSITE Input devie is plugged into the set-top). More...
void	selectPort (int8_t Port) const
	This API is used to select the COMPOSITE In port to be presented. More...
void	scaleVideo (int32_t x, int32_t y, int32_t width, int32_t height) const
	This API is used to scale the COMPOSITE In video. More...

Static Public Member Functions
static CompositeInput &	getInstance ()
	This API is used to get the instance of the COMPOSITE Input. More...

Private Member Functions
	CompositeInput ()
	default constructor More...
virtual	~CompositeInput ()
	destructor More...

yes

This class manages COMPOSITE Input.

Definition at line 69 of file compositeIn.hpp.

Constructor & Destructor Documentation

CompositeInput()

device::CompositeInput::CompositeInput ( )

private

default constructor

Parameters

None

Returns

None

Definition at line 80 of file compositeIn.cpp.

~CompositeInput()

device::CompositeInput::~CompositeInput ( )

privatevirtual

destructor

Parameters

None

Returns

None

Definition at line 94 of file compositeIn.cpp.

Member Function Documentation

getInstance()

CompositeInput & device::CompositeInput::getInstance ( )

static

This API is used to get the instance of the COMPOSITE Input.

Parameters

None

Returns

Reference to the instance of COMPOSITE Input class instance

Definition at line 108 of file compositeIn.cpp.

getNumberOfInputs()

uint8_t device::CompositeInput::getNumberOfInputs

(

)

const

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

Parameters

[in]

None

Returns

number of COMPOSITE Inputs

Definition at line 123 of file compositeIn.cpp.

isPresented()

bool device::CompositeInput::isPresented

(

)

const

This API is used to specify if COMPOSITE Input is being presented via COMPOSITE Out.

Parameters

[in]

None

Returns

true if COMPOSITE Input is being presetned.

Definition at line 147 of file compositeIn.cpp.

isActivePort()

bool device::CompositeInput::isActivePort

(

int8_t

Port

)

const

This API is used to specify if the provided COMPOSITE Input port is active (i.e. communicating with the set-top)

Parameters

[in]

COMPOSITE

Input port

Returns

true if the provided COMPOSITE Input port is active.

Definition at line 170 of file compositeIn.cpp.

getActivePort()

int8_t device::CompositeInput::getActivePort

(

)

const

This API is used to specify the active (i.e. communicating with the set-top) COMPOSITE Input port.

Parameters

[in]

None

Returns

the COMPOSITE Input port which is currently active.

Definition at line 193 of file compositeIn.cpp.

isPortConnected()

bool device::CompositeInput::isPortConnected

(

int8_t

Port

)

const

This API is used to specify if the prvided COMPOSITE Input port is connected (i.e. COMPOSITE Input devie is plugged into the set-top).

Parameters

[in]

COMPOSITE

Input port

Returns

true if the COMPOSITE Input port is connected

Definition at line 216 of file compositeIn.cpp.

selectPort()

void device::CompositeInput::selectPort

(

int8_t

Port

)

const

This API is used to select the COMPOSITE In port to be presented.

Parameters

[in]

int8_t

Port : -1 for No COMPOSITE Input port to be presented 0..n for COMPOSITE Input port (n) to be presented

Returns

None

Definition at line 239 of file compositeIn.cpp.

scaleVideo()

void device::CompositeInput::scaleVideo	(	int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height
	)		const

This API is used to scale the COMPOSITE In video.

Parameters

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

Returns

None

Definition at line 262 of file compositeIn.cpp.

---

The documentation for this class was generated from the following files:

• components/generic/devicesettings/ds/include/compositeIn.hpp
• components/generic/devicesettings/ds/compositeIn.cpp