RDK Documentation (Open Sourced RDK Components)
device::VideoOutputPort::Display Class Reference
Collaboration diagram for device::VideoOutputPort::Display:
Collaboration graph

Public Member Functions

 Display ()
 This function is default constructor and it is used to initialize the display handle and EDID information of the video display with the default values. More...
 
 Display (VideoOutputPort &vPort)
 This function is used to get the display handle of a given video device. More...
 
virtual ~Display ()
 This function is a default destructor of class Display. More...
 
int getProductCode () const
 This function returns the product code of the EDID video display device. More...
 
int getSerialNumber () const
 This function returns the serial number of the EDID video display device. More...
 
int getManufacturerYear () const
 This function returns the year of manufacture of the EDID video display device. More...
 
int getManufacturerWeek () const
 This function returns the week of manufacture of the EDID video display device. More...
 
int getConnectedDeviceType () const
 This function returns the device type of the EDID video display device. More...
 
bool isConnectedDeviceRepeater () const
 
void getEDIDBytes (std::vector< uint8_t > &edid) const
 This function is used to get the EDID information of the connected video display. After it gets the EDID information , it clears the old edid information and inserts it. The EDID bytes are verified before returning them. If invalid EDID bytes are detected, the EDID bytes are read again after READ_EDID_RETRY_MS millis. This repeats for a maximum of READ_EDID_RETRY_TOTAL_MS millis. If ret is not equal to dsERR_NONE, it will throw the ret to exception handler and it will pass message as "dsGetEDIDBytes failed". If invalid EDID is read, even after retries, it throws exception with message "EDID verification failed" If EDID bytes length > 1024 it throws exception with message "EDID length > 1024". More...
 
bool hasSurround () const
 This function returns true if connected display supports surround audio. More...
 
int getSurroundMode () const
 This function returns surround mode supported by connected display. More...
 
const AspectRatiogetAspectRatio () const
 This function returns the instance of the aspect ratio that is used currently in connected display device. More...
 
void getPhysicallAddress (uint8_t &physicalAddressA, uint8_t &physicalAddressB, uint8_t &physicalAddressC, uint8_t &physicalAddressD) const
 This function gets the physical address of the HDMI node of the video display device. More...
 

Private Attributes

intptr_t _handle
 
int _productCode
 Product code of the EDID video display device.
 
int _serialNumber
 Serial number of the EDID video display device.
 
int _manufacturerYear
 Year of manufacture of the EDID video display device.
 
int _manufacturerWeek
 Week of manufacture of the EDID video display device.
 
int _aspectRatio
 
bool _hdmiDeviceType
 
bool _isSurroundCapable
 
bool _isDeviceRepeater
 
uint8_t _physicalAddressA
 Physical Address for HDMI node A.
 
uint8_t _physicalAddressB
 Physical Address for HDMI node B.
 
uint8_t _physicalAddressC
 Physical Address for HDMI node C.
 
uint8_t _physicalAddressD
 Physical Address for HDMI node D.
 

Friends

class VideoOutputPort
 

yes

Definition at line 80 of file videoOutputPort.hpp.

Constructor & Destructor Documentation

◆ Display()

device::VideoOutputPort::Display::Display ( )
inline

This function is default constructor and it is used to initialize the display handle and EDID information of the video display with the default values.

Returns
None.

Definition at line 105 of file videoOutputPort.hpp.

Member Function Documentation

◆ getProductCode()

int device::VideoOutputPort::Display::getProductCode ( ) const
inline

This function returns the product code of the EDID video display device.

Return values
_productCodeProduct code of the display device.

Definition at line 117 of file videoOutputPort.hpp.

◆ getSerialNumber()

int device::VideoOutputPort::Display::getSerialNumber ( ) const
inline

This function returns the serial number of the EDID video display device.

Return values
_serialNumberSerial number of the display device.

Definition at line 126 of file videoOutputPort.hpp.

◆ getManufacturerYear()

int device::VideoOutputPort::Display::getManufacturerYear ( ) const
inline

This function returns the year of manufacture of the EDID video display device.

Return values
_manufacturerYearYear of manufacture of the display device.

Definition at line 135 of file videoOutputPort.hpp.

◆ getManufacturerWeek()

int device::VideoOutputPort::Display::getManufacturerWeek ( ) const
inline

This function returns the week of manufacture of the EDID video display device.

Return values
_manufacturerWeekWeek of manufacture of the display device.

Definition at line 144 of file videoOutputPort.hpp.

◆ getConnectedDeviceType()

int device::VideoOutputPort::Display::getConnectedDeviceType ( ) const
inline

This function returns the device type of the EDID video display device.

Returns
_hdmiDeviceType
Return values
TrueIf device type is HDMI.
FalseIf device type is DVI.

Definition at line 155 of file videoOutputPort.hpp.

◆ getAspectRatio()

const AspectRatio & device::VideoOutputPort::Display::getAspectRatio ( ) const
inline

This function returns the instance of the aspect ratio that is used currently in connected display device.

Returns
_aspectRatio Indicates the aspect ration of the videooutputport.

Definition at line 182 of file videoOutputPort.hpp.

◆ getPhysicallAddress()

void device::VideoOutputPort::Display::getPhysicallAddress ( uint8_t &  physicalAddressA,
uint8_t &  physicalAddressB,
uint8_t &  physicalAddressC,
uint8_t &  physicalAddressD 
) const
inline

This function gets the physical address of the HDMI node of the video display device.

Parameters
[out]physicalAddressAPhysical Address for HDMI node A
[out]physicalAddressBPhysical Address for HDMI node B
[out]physicalAddressCPhysical Address for HDMI node C
[out]physicalAddressDPhysical Address for HDMI node D
Returns
None.

Definition at line 196 of file videoOutputPort.hpp.


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