RDK Documentation (Open Sourced RDK Components)
Device Settings - Video Resolution APIs

Description

This defines the videoResolution objects by the device settings module upon intialization.

Functions

static const VideoResolutiondevice::VideoResolution::getInstance (int id)
 This API is used to get the instance of the video resolution port based on the port id returned by the getsupported video resolution . More...
 
static const VideoResolutiondevice::VideoResolution::getInstance (const std::string &name, bool isIgnoreEdid=false)
 This API is used to get the instance of the video resolution port with the name as passed parameter and comparing name with the supported resolution . If matched, it returns the supported resolution. More...
 
 device::VideoResolution::VideoResolution (const int id, const std::string &name, int resolutionId, int ratioid, int ssModeId, int frameRateId, bool interlacedId, bool enabled=true)
 This function is a default constructor for videoResolution. It initialises the data members of video Resolution instance with the parameters passed. More...
 
virtual device::VideoResolution::~VideoResolution ()
 This is a default destructor of class VideoResolution. More...
 
const PixelResolutiondevice::VideoResolution::getPixelResolution () const
 This API is used to get the pixel format of the given video output port. More...
 
const AspectRatiodevice::VideoResolution::getAspectRatio () const
 This API is used to get the current Aspect Ratio setting of the Display Device (i.e. TV) that is connected to the port. Its value is independent to the current zoom settings (which includes the Aspect Ratio of the output format) on the Video Output Port. IllegalStateException will be thrown if the display is not connected. UnsupportedOperationException will be thrown if the Display's Aspect Ratio setting is not available. More...
 
const StereoScopicModedevice::VideoResolution::getStereoscopicMode () const
 This API is used to get the stereoscopic mode of the given video output port. More...
 
const FrameRatedevice::VideoResolution::getFrameRate () const
 This API is used to get the frame rate of the given video output port. More...
 
bool device::VideoResolution::isInterlaced () const
 This API is used to check the video is interlaced or not. More...
 
bool device::VideoResolution::isEnabled () const
 This API is used to check whether the current resolution is enabled or not. More...
 

Function Documentation

◆ getInstance() [1/2]

const VideoResolution & device::VideoResolution::getInstance ( int  id)
static

This API is used to get the instance of the video resolution port based on the port id returned by the getsupported video resolution .

Parameters
[in]idport id
Returns
Reference to the instance of the port id.

Definition at line 56 of file videoResolution.cpp.

◆ getInstance() [2/2]

const VideoResolution & device::VideoResolution::getInstance ( const std::string &  name,
bool  isIgnoreEdid = false 
)
static

This API is used to get the instance of the video resolution port with the name as passed parameter and comparing name with the supported resolution . If matched, it returns the supported resolution.

Parameters
[in]nameName of the port
[in]isIgnoreEdidrequest to ignore Edid Check.
Returns
Reference to the instance of the name of the port

Definition at line 71 of file videoResolution.cpp.

◆ VideoResolution()

device::VideoResolution::VideoResolution ( const int  id,
const std::string &  name,
int  pixelResolutionId,
int  ratioId,
int  ssModeId,
int  frameRateId,
bool  interlaced,
bool  enabled = true 
)

This function is a default constructor for videoResolution. It initialises the data members of video Resolution instance with the parameters passed.

Parameters
[in]typeType of video Resolution.
[in]nameName of the video Resolution port.
[in]pixelResolutionIdPixel resolution[720x480,720x480,..] id.
[in]frameRateIdFrame rate[24,25, 59.94,.... frames per second] id.
[in]ratioIdAspect ratio[4:3, 16:9,...] id.
[in]ssModeIdStereoscopic mode[2D, 3D,...] id.
[in]interlacedScan mode type . True if interlaced or False.
[in]enabledTrue if video port is enabled. Else, false.
Returns
None

Definition at line 101 of file videoResolution.cpp.

◆ ~VideoResolution()

device::VideoResolution::~VideoResolution ( )
virtual

This is a default destructor of class VideoResolution.

Returns
None.

Definition at line 123 of file videoResolution.cpp.

◆ getPixelResolution()

const PixelResolution & device::VideoResolution::getPixelResolution ( ) const

This API is used to get the pixel format of the given video output port.

Returns
A list of pixel resolution instance

Definition at line 134 of file videoResolution.cpp.

◆ getAspectRatio()

const AspectRatio & device::VideoResolution::getAspectRatio ( ) const

This API is used to get the current Aspect Ratio setting of the Display Device (i.e. TV) that is connected to the port. Its value is independent to the current zoom settings (which includes the Aspect Ratio of the output format) on the Video Output Port. IllegalStateException will be thrown if the display is not connected. UnsupportedOperationException will be thrown if the Display's Aspect Ratio setting is not available.

Returns
Aspect ratio instance

Definition at line 149 of file videoResolution.cpp.

◆ getStereoscopicMode()

const StereoScopicMode & device::VideoResolution::getStereoscopicMode ( ) const

This API is used to get the stereoscopic mode of the given video output port.

Returns
Reference to the stereoscopicemode instance

Definition at line 161 of file videoResolution.cpp.

◆ getFrameRate()

const FrameRate & device::VideoResolution::getFrameRate ( ) const

This API is used to get the frame rate of the given video output port.

Returns
Reference to the frame rate instance id

Definition at line 172 of file videoResolution.cpp.

◆ isInterlaced()

bool device::VideoResolution::isInterlaced ( ) const

This API is used to check the video is interlaced or not.

Returns
True or False
Return values
TrueIf video is interlaced
FalseIf video is not interlaced

Definition at line 185 of file videoResolution.cpp.

◆ isEnabled()

bool device::VideoResolution::isEnabled ( ) const

This API is used to check whether the current resolution is enabled or not.

Returns
True or False
Return values
TrueIf current resolution is enabled
FalseIf current resolution is disabled

Definition at line 198 of file videoResolution.cpp.