Description

VideoOutputPortType objects are instantiated by the Device Settings module upon initialization.
Applications do not need to create any such objects on its own.
References to these objects can be retrieved using a VideoOutputPort object invoking VideoOutputPort::getType().
A VideoOutputPortType object represent the shared properties of all output ports of same type.
Control over a specific instance of Video Output Port is access over a Video Output Port object

Functions
static VideoOutputPortType &	device::VideoOutputPortType::getInstance (const int id)
	This function is used to get the instance of the video output port type based on the port id. If the 'id' passed is invalid then it throws an IllegalArgumentException. More...

static VideoOutputPortType &	device::VideoOutputPortType::getInstance (const std::string &name)
	This function is used to get the instance of the video output port type based on the port name. If the "name" passed is invalid then it throws an IllegalArgumentException. More...

	device::VideoOutputPortType::VideoOutputPortType (const int id)

virtual	device::VideoOutputPortType::~VideoOutputPortType ()
	This is a default destructor of the class VideoOutputPortType. More...

const List< VideoOutputPort >	device::VideoOutputPortType::getPorts () const
	This function is used to get the list of videooutputporttype. More...

void	device::VideoOutputPortType::enabledDTCP ()
	This function is used to enable the DTCP for videooutputport type. More...

void	device::VideoOutputPortType::enabledHDCP (bool contentProtect=true, char *dhcpKey=0, size_t keySize=0)
	This function is used to enable the HDCP content protection. More...

void	device::VideoOutputPortType::setRestrictedResolution (int resolution)
	This function is used to set the restricted resolution of the videooutput port type. More...

void	device::VideoOutputPortType::addPort (const VideoOutputPort &port)
	This function is used to add video output port type in the videooutputport list. More...

bool	device::VideoOutputPortType::isDTCPSupported () const
	This API is used to query if DTCP is supported by the port type. More...

bool	device::VideoOutputPortType::isHDCPSupported () const
	This API is used to query if HDCP is supported by the port type. More...

bool	device::VideoOutputPortType::isDynamicResolutionsSupported () const
	This function is used to query if dynamic resolutions are supported by the port type. More...

int	device::VideoOutputPortType::getRestrictedResolution () const
	This function is used to get the resolution type which has been restricted from usage. More...

const List< VideoResolution >	device::VideoOutputPortType::getSupportedResolutions () const
	This API is used to get a list of supported Video Resolutions by the port type. More...

Function Documentation

◆ getInstance() [1/2]

VideoOutputPortType & device::VideoOutputPortType::getInstance ( const int id )

static

This function is used to get the instance of the video output port type based on the port id. If the 'id' passed is invalid then it throws an IllegalArgumentException.

Parameters

[in] id port id

Returns: Reference to the instance of the port type id

Definition at line 109 of file videoOutputPortType.cpp.

◆ getInstance() [2/2]

VideoOutputPortType & device::VideoOutputPortType::getInstance ( const std::string & name )

static

This function is used to get the instance of the video output port type based on the port name. If the "name" passed is invalid then it throws an IllegalArgumentException.

Parameters

[in] name port name

Returns: Reference to the instance of the port type name

Definition at line 130 of file videoOutputPortType.cpp.

◆ ~VideoOutputPortType()

device::VideoOutputPortType::~VideoOutputPortType ( )

virtual

This is a default destructor of the class VideoOutputPortType.

Returns: None.

Definition at line 173 of file videoOutputPortType.cpp.

◆ getPorts()

const List< VideoOutputPort > device::VideoOutputPortType::getPorts ( ) const

This function is used to get the list of videooutputporttype.

Returns: List of videooutputport type.

Definition at line 184 of file videoOutputPortType.cpp.

◆ enabledDTCP()

void device::VideoOutputPortType::enabledDTCP ( )

This function is used to enable the DTCP for videooutputport type.

Returns: None.

Definition at line 196 of file videoOutputPortType.cpp.

◆ enabledHDCP()

void device::VideoOutputPortType::enabledHDCP	(	bool	contentProtect = `true`,
		char *	hdcpKey = `0`,
		size_t	keySize = `0`
	)

This function is used to enable the HDCP content protection.

Parameters

[in]	contentProtect	True If Content protection needs to be enabled, false otherwise.
[in]	hdcpKey	HDCP key.
[in]	keySize	HDCP key size.

Returns: None.

Definition at line 212 of file videoOutputPortType.cpp.

◆ setRestrictedResolution()

void device::VideoOutputPortType::setRestrictedResolution ( int resolution )

This function is used to set the restricted resolution of the videooutput port type.

Parameters

[in] resolution Restricted resolution.

Returns: None.

Definition at line 231 of file videoOutputPortType.cpp.

◆ addPort()

void device::VideoOutputPortType::addPort ( const VideoOutputPort & port )

This function is used to add video output port type in the videooutputport list.

Parameters

[in] port Videooutputport type.

Returns: None.

Definition at line 244 of file videoOutputPortType.cpp.

◆ isDTCPSupported()

bool device::VideoOutputPortType::isDTCPSupported ( ) const

This API is used to query if DTCP is supported by the port type.

Returns: True or False

Return values

1	if DTCP is supported
0	if DTCP is not supported

Definition at line 258 of file videoOutputPortType.cpp.

◆ isHDCPSupported()

bool device::VideoOutputPortType::isHDCPSupported ( ) const

This API is used to query if HDCP is supported by the port type.

Returns: True or False

Return values

1	if HDCP is supported
0	if HDCP is not supported

Definition at line 272 of file videoOutputPortType.cpp.

◆ isDynamicResolutionsSupported()

bool device::VideoOutputPortType::isDynamicResolutionsSupported ( ) const

This function is used to query if dynamic resolutions are supported by the port type.

Returns: True or False

Return values

1	If dynamic resolutions is supported.
0	if dynamic resolutions is not supported.

Definition at line 286 of file videoOutputPortType.cpp.

◆ getRestrictedResolution()

int device::VideoOutputPortType::getRestrictedResolution ( ) const

This function is used to get the resolution type which has been restricted from usage.

Returns: _restrictedResolution Any Restricted resolution type.

Definition at line 298 of file videoOutputPortType.cpp.

◆ getSupportedResolutions()

const List< VideoResolution > device::VideoOutputPortType::getSupportedResolutions ( ) const

This API is used to get a list of supported Video Resolutions by the port type.

Returns: A list of video resolutions supported

Definition at line 311 of file videoOutputPortType.cpp.

Description

Functions

Function Documentation

◆ getInstance() [1/2]

◆ getInstance() [2/2]

◆ ~VideoOutputPortType()

◆ getPorts()

◆ enabledDTCP()

◆ enabledHDCP()

◆ setRestrictedResolution()

◆ addPort()

◆ isDTCPSupported()

◆ isHDCPSupported()

◆ isDynamicResolutionsSupported()

◆ getRestrictedResolution()

◆ getSupportedResolutions()