Device Settings - Video Device APIs

Description

• Video Device is also called "Decoder". VideoDevice 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 by applications via Host::getVideoDevices()

Functions
static VideoDevice &	device::VideoDevice::getInstance (int id)
	This API is used to get the instance of the video device port based on the port id returned by the getsupported videodevice config. More...
	device::VideoDevice::VideoDevice (int id)
	Constructor for videodevice class. This function initializes the the handle for the corresponding video device based on id. IllegalArgumentException will be thrown if the specified id of the device is not recognized. More...
virtual	device::VideoDevice::~VideoDevice ()
	This is a default destructor of the class VideoDevice. More...
void	device::VideoDevice::setDFC (const VideoDFC &dfc)
	This API is used to set the DFC[Decoder format convention used for zoom purpose] setting by its property name. Exception will be thrown if the DFC name is not recognized. More...
void	device::VideoDevice::setDFC (int id)
	This API is used to set the DFC with the passed dfc parameter. This function is used to get the instance of VideoDFC. More...
void	device::VideoDevice::setDFC (const std::string &name)
	This API is used to set the DFC with the passed dfc parameter. This function is used to get the instance of VideoDFC IllegalArgumentException will be thrown if the DFC name is not recognized. UnsupportedOperationException will be thrown if DFC cannot be changed. More...
void	device::VideoDevice::setDFC ()
	This API is used to set the default dfc. More...
void	device::VideoDevice::setPlatformDFC ()
	This API is used to set the DFC setting to the default one supported by the platform. The actual Platform DFC is determined by underlying platform implementation. Applications can use getDFC() API to query the actual DFC set after calling this API. More...
const VideoDFC &	device::VideoDevice::getDFC ()
	This API is used to get the current DFC setting. More...
const List< VideoDFC >	device::VideoDevice::getSupportedDFCs () const
	This API is used to get the list of supported DFC (i.e. Zoom Settings) by the video device. More...
void	device::VideoDevice::addDFC (const VideoDFC &dfc)
	This function is used to push DFC into the list of supported DFC (i.e. Zoom Settings) by the device. More...
void	device::VideoDevice::getHDRCapabilities (int *capabilities)
void	device::VideoDevice::getSettopSupportedResolutions (std::list< std::string > &stbSupportedResoltuions)
unsigned int	device::VideoDevice::getSupportedVideoCodingFormats () const
dsVideoCodecInfo_t	device::VideoDevice::getVideoCodecInfo (dsVideoCodingFormat_t format) const
int	device::VideoDevice::forceDisableHDRSupport (bool disable)
int	device::VideoDevice::setFRFMode (int frfmode) const
int	device::VideoDevice::getFRFMode (int *frfmode) const
int	device::VideoDevice::setDisplayframerate (const char *framerate) const
int	device::VideoDevice::getCurrentDisframerate (char *framerate) const

Function Documentation

getInstance()

VideoDevice & device::VideoDevice::getInstance ( int  id )

static

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

Parameters

[in]

id

port id

Returns

Reference to the instance of the port id

Definition at line 84 of file videoDevice.cpp.

VideoDevice()

device::VideoDevice::VideoDevice

(

int

id

)

Constructor for videodevice class. This function initializes the the handle for the corresponding video device based on id. IllegalArgumentException will be thrown if the specified id of the device is not recognized.

Parameters

[in]

id

Port id.

Returns

None.

Definition at line 104 of file videoDevice.cpp.

~VideoDevice()

device::VideoDevice::~VideoDevice ( )

virtual

This is a default destructor of the class VideoDevice.

Returns

None.

Definition at line 130 of file videoDevice.cpp.

setDFC() [1/4]

void device::VideoDevice::setDFC ( const VideoDFC &  dfc )

private

This API is used to set the DFC[Decoder format convention used for zoom purpose] setting by its property name. Exception will be thrown if the DFC name is not recognized.

Parameters

[in]

dfc

new zoom setting

Returns

None

Definition at line 144 of file videoDevice.cpp.

setDFC() [2/4]

void device::VideoDevice::setDFC

(

int

dfc

)

This API is used to set the DFC with the passed dfc parameter. This function is used to get the instance of VideoDFC.

Parameters

[in]

dfc

new zoom setting

Returns

None

Definition at line 163 of file videoDevice.cpp.

setDFC() [3/4]

void device::VideoDevice::setDFC

(

const std::string &

dfc

)

This API is used to set the DFC with the passed dfc parameter. This function is used to get the instance of VideoDFC IllegalArgumentException will be thrown if the DFC name is not recognized. UnsupportedOperationException will be thrown if DFC cannot be changed.

Parameters

[in]

dfc

Name of the new zoom setting

Returns

None

Definition at line 180 of file videoDevice.cpp.

setDFC() [4/4]

void device::VideoDevice::setDFC ( )

private

This API is used to set the default dfc.

Returns

None

Definition at line 192 of file videoDevice.cpp.

setPlatformDFC()

void device::VideoDevice::setPlatformDFC

(

)

This API is used to set the DFC setting to the default one supported by the platform. The actual Platform DFC is determined by underlying platform implementation. Applications can use getDFC() API to query the actual DFC set after calling this API.

Returns

None

Definition at line 208 of file videoDevice.cpp.

getDFC()

const VideoDFC & device::VideoDevice::getDFC

(

)

This API is used to get the current DFC setting.

Returns

Reference to the current DFC setting

Definition at line 220 of file videoDevice.cpp.

getSupportedDFCs()

const List< VideoDFC > device::VideoDevice::getSupportedDFCs

(

)

const

This API is used to get the list of supported DFC (i.e. Zoom Settings) by the video device.

Returns

A List of supported DFC settings

Definition at line 238 of file videoDevice.cpp.

addDFC()

void device::VideoDevice::addDFC

(

const VideoDFC &

dfc

)

This function is used to push DFC into the list of supported DFC (i.e. Zoom Settings) by the device.

Parameters

[in]

dfc

Supported Zoom setting.

Returns

None.

Definition at line 251 of file videoDevice.cpp.