This class manages HDMI Input. More...

#include <hdmiIn.hpp>

Collaboration diagram for device::HdmiInput:

Public Member Functions
uint8_t	getNumberOfInputs () const
	This API is used to get the number of HDMI Input ports on the set-top. More...

bool	isPresented () const
	This API is used to specify if HDMI Input is being presented via HDMI Out. More...

bool	isActivePort (int8_t Port) const
	This API is used to specify if the provided HDMI 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) HDMI Input port. More...

bool	isPortConnected (int8_t Port) const
	This API is used to specify if the prvided HDMI Input port is connected (i.e. HDMI Input devie is plugged into the set-top). More...

void	selectPort (int8_t Port) const
	This API is used to select the HDMI 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 HDMI In video. More...

void	selectZoomMode (int8_t zoomMode) const
	This API is used to select the HDMI In video zoom mode. More...

void	pauseAudio () const
	This API is used to select the HDMI In video zoom mode. More...

void	resumeAudio () const
	This API is used to select the HDMI In video zoom mode. More...

std::string	getCurrentVideoMode () const
	This API is used to get the current HDMI In video mode (resolution) More...

void	getCurrentVideoModeObj (dsVideoPortResolution_t &resolution)

void	getEDIDBytesInfo (int iHdmiPort, std::vector< uint8_t > &edid) const

void	getHDMISPDInfo (int iHdmiPort, std::vector< uint8_t > &data)

void	setEdidVersion (int iHdmiPort, int iEdidVersion)

void	getEdidVersion (int iHdmiPort, int *iEdidVersion)

void	getHdmiALLMStatus (int iHdmiPort, bool *allmStatus)

void	getSupportedGameFeatures (std::vector< std::string > &featureList)

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

Private Member Functions
	HdmiInput ()
	default constructor More...

virtual	~HdmiInput ()
	destructor More...

yes

This class manages HDMI Input.

Definition at line 71 of file hdmiIn.hpp.

Constructor & Destructor Documentation

◆ HdmiInput()

device::HdmiInput::HdmiInput ( )

private

default constructor

Parameters

None

Returns: None

Definition at line 82 of file hdmiIn.cpp.

◆ ~HdmiInput()

device::HdmiInput::~HdmiInput ( )

privatevirtual

destructor

Parameters

None

Returns: None

Definition at line 96 of file hdmiIn.cpp.

Member Function Documentation

◆ getInstance()

HdmiInput & device::HdmiInput::getInstance ( )

static

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

Parameters

None

Returns: Reference to the instance of HDMI Input class instance

Definition at line 110 of file hdmiIn.cpp.

◆ getNumberOfInputs()

uint8_t device::HdmiInput::getNumberOfInputs ( ) const

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

Parameters

[in] None

Returns: number of HDMI Inputs

Definition at line 125 of file hdmiIn.cpp.

◆ isPresented()

bool device::HdmiInput::isPresented ( ) const

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

Parameters

[in] None

Returns: true if HDMI Input is being presetned.

Definition at line 150 of file hdmiIn.cpp.

◆ isActivePort()

bool device::HdmiInput::isActivePort ( int8_t Port ) const

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

Parameters

[in] HDMI Input port

Returns: true if the provided HDMI Input port is active.

Definition at line 174 of file hdmiIn.cpp.

◆ getActivePort()

int8_t device::HdmiInput::getActivePort ( ) const

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

Parameters

[in] None

Returns: the HDMI Input port which is currently active.

Definition at line 198 of file hdmiIn.cpp.

◆ isPortConnected()

bool device::HdmiInput::isPortConnected ( int8_t Port ) const

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

Parameters

[in] HDMI Input port

Returns: true if the HDMI Input port is connected

Definition at line 222 of file hdmiIn.cpp.

◆ selectPort()

void device::HdmiInput::selectPort ( int8_t Port ) const

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

Parameters

[in] int8_t Port : -1 for No HDMI Input port to be presented 0..n for HDMI Input port (n) to be presented

Returns: None

Definition at line 246 of file hdmiIn.cpp.

◆ scaleVideo()

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

This API is used to scale the HDMI 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 270 of file hdmiIn.cpp.

◆ selectZoomMode()

void device::HdmiInput::selectZoomMode ( int8_t zoomMode ) const

This API is used to select the HDMI In video zoom mode.

Parameters

[in] int8_t zoomMoode : 0 for NONE 1 for FULL

Returns: None

Definition at line 291 of file hdmiIn.cpp.

◆ pauseAudio()

void device::HdmiInput::pauseAudio ( ) const

This API is used to select the HDMI In video zoom mode.

Parameters

[in] None

Returns: None

Definition at line 311 of file hdmiIn.cpp.

◆ resumeAudio()

void device::HdmiInput::resumeAudio ( ) const

This API is used to select the HDMI In video zoom mode.

Parameters

[in] None

Returns: None

Definition at line 331 of file hdmiIn.cpp.

◆ getCurrentVideoMode()

std::string device::HdmiInput::getCurrentVideoMode ( ) const

This API is used to get the current HDMI In video mode (resolution)

Parameters

[in] None

Returns: HDMI Input video resolution string

Definition at line 459 of file hdmiIn.cpp.

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

components/generic/devicesettings/ds/include/hdmiIn.hpp
components/generic/devicesettings/ds/hdmiIn.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

yes

Constructor & Destructor Documentation

◆ HdmiInput()

◆ ~HdmiInput()

Member Function Documentation

◆ getInstance()

◆ getNumberOfInputs()

◆ isPresented()

◆ isActivePort()

◆ getActivePort()

◆ isPortConnected()

◆ selectPort()

◆ scaleVideo()

◆ selectZoomMode()

◆ pauseAudio()

◆ resumeAudio()

◆ getCurrentVideoMode()