Description

Data Structures
class	device::VideoResolution
	Class extending DSConstant to implement the videoResolution interface. More...

class	device::AspectRatio
	This class extends DSConstant to implement AspectRatio. It manages the aspect ratios of the videos. More...

class	device::AudioCompression
	This class extends DSConstant for implementing AudioCompression. It helps to maintain different audio compressions. More...

class	device::AudioEncoding
	This class extends DSConstant to implement AudioEncoding which manages audio encodings. More...

class	device::AudioOutputPort
	Class extending Enumerable to implement the audiooutputport interface. More...

class	device::AudioOutputPortType
	Class extending DSConstant to implement the audiooutputport interface. More...

class	device::AudioStereoMode
	This class extends DSConstant to implement AudioStereoMode. It manages the information related to audio mode types like stereo, mono and so on. More...

class	device::DSConstant
	This class is used to store and manage the names and id's. It is derived by many classes like VideoResolution, VideoOutputPortType, stereoScopicMode and so on. And it is also stores information whether the derived class instances indicating the port or port attributes are enabled or not. More...

class	device::Enumerable
	This class is inherited by many classes in DS for getting the ID. More...

class	device::Exception
	This class handles exceptions occurring in DS module. More...

class	device::FrameRate
	This class extends DSConstant to handle the video frame rate. More...

class	device::FrontPanelConfig

class	device::FrontPanelIndicator
	This class extents DSConstant to manage front panel indicators color, blink sequence and brightness. More...

class	Color
	This class extents DSConstant to manage the color of the front panel indicator. More...

class	Blink
	This class supports to manage front panel indicator blink sequence. More...

class	device::FrontPanelTextDisplay
	This class extents FrontPanelIndicator to manage front panel text display mode, scrolling and its brightness. More...

class	Mode
	This class extents DSConstant to mange the front panel text display mode like time display mode or text display mode etc... More...

class	Scroll
	To manage front panel text display scrolling. More...

class	device::Host
	Class to implement the Host interface. More...

class	device::IllegalArgumentException
	This class extends Exception class to manage the expections caused due to illegal arguments. More...

class	device::List< T >
	This class is implemented using templates and it is used to maintain a container with the list of supported ID's. More...

class	device::Manager
	Class to implement the manager interface. More...

class	device::PixelResolution
	This class extends DSConstant to manages the pixel resolution of the video. More...

class	device::SleepMode
	This class extends DSConstant to implement SleepMode. It is used to manage the sleep modes for device settings. More...

class	device::StereoScopicMode
	This class extentds DSConstant to implement StereoScopicMode. It manages the stereoscopic mode of the video. More...

class	device::UnsupportedOperationException
	This class extends Exception class to manage unsupported operations in devicesettings. More...

class	device::VideoDevice
	class extending DSConstant to implement the videoDevice interface. More...

class	device::VideoDFC
	This class extends DSConstant to manage the video Decoder Format Conversion. More...

class	device::VideoOutputPort
	Class extending enumerable to implement the videoooutputport interface. More...

class	device::VideoOutputPortType
	Class extending DSConstant to implement the VideoOutputporttype interface. More...

Data Structure Documentation

◆ device::VideoResolution

class device::VideoResolution

Class extending DSConstant to implement the videoResolution interface.

@calss VideoResolution

Definition at line 57 of file videoResolution.hpp.

Inheritance diagram for device::VideoResolution:

Collaboration diagram for device::VideoResolution:

Public Member Functions
	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	~VideoResolution ()
	This is a default destructor of class VideoResolution. More...

const PixelResolution &	getPixelResolution () const
	This API is used to get the pixel format of the given video output port. More...

const AspectRatio &	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 StereoScopicMode &	getStereoscopicMode () const
	This API is used to get the stereoscopic mode of the given video output port. More...

const FrameRate &	getFrameRate () const
	This API is used to get the frame rate of the given video output port. More...

bool	isInterlaced () const
	This API is used to check the video is interlaced or not. More...

bool	isEnabled () const
	This API is used to check whether the current resolution is enabled or not. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static const 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 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...

Private Attributes
int	_pixelResolutionId
	Indicates the video resolution.

int	_aspectRatioId
	Indicates aspect ratio type of the video.

int	_stereoScopicModeId
	Indicates the stereoscopic mode of the video.

int	_frameRateId
	Indicates frame rate of the video.

bool	_interlaced
	TRUE indicates interlaced scan and FALSE indicates progressive scan.

bool	_enabled
	TRUE indicates this video resolution is enabled otherwise disabled.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

◆ device::AspectRatio

class device::AspectRatio

This class extends DSConstant to implement AspectRatio. It manages the aspect ratios of the videos.

Definition at line 50 of file aspectRatio.hpp.

Inheritance diagram for device::AspectRatio:

Collaboration diagram for device::AspectRatio:

Public Member Functions
	AspectRatio (int id)
	This function is a parameterised constructor. It initializes the instance with the specified id and also the name which is predefined for the id. It throws an IllegalArgumentException if the id specified is invalid. More...

virtual	~AspectRatio ()
	This function is the default destructor of AspectRatio class. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static const AspectRatio &	getInstance (int id)
	This function gets the instance of the AspectRatio against the id specified, only if the id passed is valid. More...

static const AspectRatio &	getInstance (const std::string &name)
	This function gets the instance of the AspectRatio against the name specified, only if the name passed is valid. More...

Static Public Attributes
static const int	k4x3 = dsVIDEO_ASPECT_RATIO_4x3
	Indicates 4x3 aspect ratio.

static const int	k16x9 = dsVIDEO_ASPECT_RATIO_16x9
	Indicates 16x9 aspect ratio.

static const int	kMax = dsVIDEO_ASPECT_RATIO_MAX
	Indicates maximum number of aspect ratios supported.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Constructor & Destructor Documentation

◆ AspectRatio()

device::AspectRatio::AspectRatio ( int id )

This function is a parameterised constructor. It initializes the instance with the specified id and also the name which is predefined for the id. It throws an IllegalArgumentException if the id specified is invalid.

Parameters

[in] id Indicates the aspect ratio for the instance created. For example: 0 indicates "4x3" aspect ratio and 1 indicates "16x9" aspect ratio .

Returns: None

Definition at line 120 of file aspectRatio.cpp.

◆ ~AspectRatio()

device::AspectRatio::~AspectRatio ( )

virtual

This function is the default destructor of AspectRatio class.

Returns: None

Definition at line 138 of file aspectRatio.cpp.

Member Function Documentation

◆ getInstance() [1/2]

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

static

This function gets the instance of the AspectRatio against the id specified, only if the id passed is valid.

Parameters

[in] id Indicates the id against which the AspectRatio instance is required. The id is used to identify the type of aspect ratio. For example: id of 0 and 1 may correspond to "4x3" and "16x9" aspect ratio respectively.

Returns: Returns an instance of AspectRatio against the id parameter or else throws an IllegalArgumentException indicating that the specified id is invalid.

Definition at line 74 of file aspectRatio.cpp.

◆ getInstance() [2/2]

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

static

This function gets the instance of the AspectRatio against the name specified, only if the name passed is valid.

Parameters

[in] name Indicates the name against which the AspectRatio instance is required. The name is used to identify the type of aspect ratio. For example: id of 0 and 1 may correspond to 4x3 and 16x9 aspect ratio respectively.

Returns: Returns an AspectRatio instance against the name specified or else throws an IllegalArgumentException indicating that the specified name is invalid.

Definition at line 97 of file aspectRatio.cpp.

◆ device::AudioCompression

class device::AudioCompression

This class extends DSConstant for implementing AudioCompression. It helps to maintain different audio compressions.

Definition at line 49 of file audioCompression.hpp.

Inheritance diagram for device::AudioCompression:

Collaboration diagram for device::AudioCompression:

Public Member Functions
	AudioCompression (int id)
	This function is a parameterised constructor. It initializes the AudioCompression instance with the parameters passed as input, only if the id passed is valid. More...

virtual	~AudioCompression ()
	This function is the default destructor for AudioCompression. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static const AudioCompression &	getInstance (int id)
	This function gets an instance of AudioCompression against the specified id, only if the id passed is valid. More...

static const AudioCompression &	getInstance (const std::string &name)
	This function gets an instance of AudioCompression against the specified name, only if the name passed is valid. More...

Static Public Attributes
static const int	kNone = dsAUDIO_CMP_NONE
	Indicates audio compression None.

static const int	kLight = dsAUDIO_CMP_LIGHT
	Indicates light audio compression.

static const int	kMedium = dsAUDIO_CMP_MEDIUM
	Indicates medium audio compression.

static const int	kHeavy = dsAUDIO_CMP_HEAVY
	Indicates heavy audio compression.

static const int	kMax = dsAUDIO_CMP_MAX
	Indicates number of audio compression supported.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Constructor & Destructor Documentation

◆ AudioCompression()

device::AudioCompression::AudioCompression ( int id )

This function is a parameterised constructor. It initializes the AudioCompression instance with the parameters passed as input, only if the id passed is valid.

Parameters

[in]

id

Indicates the id for the instance created. The id is used to identify the audio compression types. For example:

id 0 indicates no audio compression.
id 1 indicates light audio compression.
id 2 indicates medium audio compression.
id 3 indicates heavy audio compression. <ul/"

Returns: None

Definition at line 130 of file audioCompression.cpp.

◆ ~AudioCompression()

device::AudioCompression::~AudioCompression ( )

virtual

This function is the default destructor for AudioCompression.

Returns: None

Definition at line 148 of file audioCompression.cpp.

Member Function Documentation

◆ getInstance() [1/2]

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

static

This function gets an instance of AudioCompression against the specified id, only if the id passed is valid.

Parameters

[in] id Indicates id/index into the list of AudioCompression to get required instance. Id is used to identify the type of compression like light, heavy or medium.

Returns: Returns an instance of AudioCompression against the id specified or else throws an IllegalArgumentException indicating that the instance against specified id was not found.

Definition at line 79 of file audioCompression.cpp.

◆ getInstance() [2/2]

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

static

This function gets an instance of AudioCompression against the specified name, only if the name passed is valid.

Parameters

[in] name Indicates the name against which the AudioCompression instance is required. The name string indicates the audio compression type like "NONE", "LIGHT", "MEDIUM" and "HEAVY"

Returns: Returns an instance of AudioCompression against the name specified or else throws an IllegalArgumentException indicating that the instance against specified name was not found.

Definition at line 102 of file audioCompression.cpp.

◆ device::AudioEncoding

class device::AudioEncoding

This class extends DSConstant to implement AudioEncoding which manages audio encodings.

Definition at line 51 of file audioEncoding.hpp.

Inheritance diagram for device::AudioEncoding:

Collaboration diagram for device::AudioEncoding:

Public Member Functions
	AudioEncoding (int id)
	This function is the default constructor for AudioEncoding. It initializes the instance with the id passed as input. If the id parameter is invalid then it throws an IllegalArgumentException. More...

virtual	~AudioEncoding ()
	This function is the default destructor of AudioEncoding class. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static const AudioEncoding &	getInstance (int id)
	This function gets an AudioEncoding instance against the id parameter, only if the id passed is valid. More...

static const AudioEncoding &	getInstance (const std::string &name)
	This function gets an AudioEncoding instance against the specified name, only if the name passed is valid. More...

Static Public Attributes
static const int	kNone = dsAUDIO_ENC_NONE
	Value indicating encoding type None.

static const int	kDisplay = dsAUDIO_ENC_DISPLAY
	Value indicating digital audio encoding format.

static const int	kPCM = dsAUDIO_ENC_PCM
	Value indicating PCM digital audio encoding format.

static const int	kAC3 = dsAUDIO_ENC_AC3
	Value indicating AC3 digital audio encoding format.

static const int	kMax = dsAUDIO_ENC_MAX
	Indicates the maximum encoding formats supported.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

◆ device::AudioOutputPort

class device::AudioOutputPort

Class extending Enumerable to implement the audiooutputport interface.

Definition at line 60 of file audioOutputPort.hpp.

Inheritance diagram for device::AudioOutputPort:

Collaboration diagram for device::AudioOutputPort:

Public Member Functions
	AudioOutputPort (const int type, const int index, const int id)
	This function is a default constructor for AudioOutputPort. It initialises the data members of AudioOutputPort instance with the parameters passed. It also gets the handle for the type of Audio port requested and updates the audio compression technique, type of encoding, stereo mode, audio gain, audio level, optimal audio level, maximum and minimum DB that is supported and current audio DB. More...

virtual	~AudioOutputPort ()
	This is a default destructor of class AudioOutputPort. More...

const AudioOutputPortType &	getType () const
	This API is used to get the type of the audio output port. The type of audio output port represent the general capabilities of the port. More...

int	getId () const

int	getIndex () const

const std::string &	getName () const
	This API gets the name of the AudioOutputPort. The AudioOutputPort names can be IDLR, HDMI and SPDIF which are created and used by the implementation to uniquely identify them. More...

const List< AudioEncoding >	getSupportedEncodings () const
	This API is used to get the list of audio encodings supported by the port. More...

const List< AudioCompression >	getSupportedCompressions () const
	This API is used to get the list of audio compressions supported by the port. More...

const List< AudioStereoMode >	getSupportedStereoModes () const

const AudioEncoding &	getEncoding () const
	This API is used to get the current encoding of the output port. More...

int	getCompression () const
	This API is used to get the current compression of the output port. More...

int	getDialogEnhancement () const
	This API is used to get the current auto mode. More...

bool	getDolbyVolumeMode () const
	This API is used to get the current auto mode. More...

int	getIntelligentEqualizerMode () const

dsVolumeLeveller_t	getVolumeLeveller () const
	This API is used to get the current volume leveller value. More...

int	getBassEnhancer () const
	This API is used to get the Bass Enhancer boost value. More...

bool	isSurroundDecoderEnabled () const
	This API is used to get status of surround decoder. More...

int	getDRCMode () const
	This API is used to get the Dynamic Range Control mode. More...

dsSurroundVirtualizer_t	getSurroundVirtualizer () const
	This API is used to get the Surround Virtualizer Boost value. More...

bool	getMISteering () const
	This API is used to get status of Media Intelligent Steering. More...

int	getGraphicEqualizerMode () const
	This API is used to get the current Graphical EQ mode. More...

const std::string	getMS12AudioProfile () const
	This API is used to get the current MS12 Audio profile. More...

std::vector< std::string >	getMS12AudioProfileList () const
	This API is used to get the supported MS12 Audio profiles. More...

const AudioStereoMode &	getStereoMode (bool usePersist=false)
	This API is used to get the current stereo mode of the output port. More...

dsError_t	setEnablePort (bool enabled)
	This API is used to enable and disable the Audio output port. More...

dsError_t	reInitializeAudioOutputPort ()
	This API is used to reInitialize AudioOutputPort in case when Constructor miss out the Audio output port. More...

void	enable ()
	This API is used to enable the Audio output port. More...

void	disable ()

bool	getEnablePersist () const

void	setEnablePersist (bool isEnabled)

bool	getStereoAuto ()
	This API is used to get the current auto mode. More...

float	getGain () const
	This API will get the current Gain for the given audio output port. More...

float	getDB () const
	This API will get the current Decibel value for the given Audio port. More...

float	getLevel () const
	This API is used to get the current audio level for the given audio output port. More...

float	getMaxDB () const
	This API is used to get the current Maximum decibel that Audio output port can support. More...

float	getMinDB () const
	This API is used to get the current minimum decibel that Audio output port can support. More...

float	getOptimalLevel () const
	This API is used to get the current optimal level value for audio output port. More...

bool	getAudioDelay (uint32_t &audioDelayMs) const
	This API is used to get the current audio delay in milliseconds for audio output port. More...

bool	getAudioDelayOffset (uint32_t &audioDelayOffsetMs) const
	This API is used to get the current audio delay offset in milliseconds for audio output port. More...

bool	isLoopThru () const
	This API is used to check whether the given audio port is configured for loop thro'. More...

bool	isMuted () const
	This API is used to check whether the audio is muted or not. More...

bool	isConnected () const
	This API is used to check whether the audio output port is connected to a sink device or not. More...

bool	isEnabled () const
	This API is used to check whether the audio is enabled or not. More...

bool	isAudioMSDecode () const
	This API is used to check whether the audio port supports Dolby MS11 Multistream Decode. More...

bool	isAudioMS12Decode () const

void	setEncoding (const int encoding)
	This API is used to set the Encoding method in a given audio port. More...

void	setCompression (const int compression)
	This API is used to set the compression mode in a given audio port. More...

void	setDialogEnhancement (const int level)
	This API is used to set the compression mode in a given audio port. More...

void	setDolbyVolumeMode (const bool mode)
	This API is used to set the compression mode in a given audio port. More...

void	setIntelligentEqualizerMode (const int mode)
	This API is used to set the compression mode in a given audio port. More...

void	setVolumeLeveller (const dsVolumeLeveller_t volLeveller)
	This API is used to set the volume leveller mode & amount for a given audio port. More...

void	setBassEnhancer (const int boost)
	This API is used to adjust the Bass in a given audio port. More...

void	enableSurroundDecoder (const bool enable)
	This API is used to enable/disable surround decoder in a given audio port. More...

void	setDRCMode (const int mode)
	This API is used to set the Dynamic Range control mode in a given audio port. More...

void	setSurroundVirtualizer (const dsSurroundVirtualizer_t virtualizer)
	This API is used to set the surround virtualizer mode and boost value for a given audio port. More...

void	setMISteering (const bool enable)
	This API is used to enable/disable the Media Intelligent Steering in a given audio port. More...

void	setGraphicEqualizerMode (const int mode)
	This API is used to set the compression mode in a given audio port. More...

void	setMS12AudioProfile (std::string profile)
	This API is used to set MS12 Audio Profile. More...

void	setStereoMode (const int mode, const bool toPersist=true)
	This API is used to set the stereo mode to be used in a given audio port.If toPersist is true, the setting will persist after reboots. More...

void	setStereoAuto (const bool autoMode, const bool toPersist=true)
	This API is used to set the stereo mode to be auto;. More...

void	setEncoding (const std::string &encoding)
	This API is used to set the Encoding method in a given audio port. More...

void	setStereoMode (const std::string &mode, const bool toPersist=true)
	This function is used to set the stereo mode for the audio port.If toPersist is true, the setting will persist after reboots. More...

void	getSupportedARCTypes (int *types)
	This API is used to query the supported ARC types of the connected device. More...

void	setSAD (std::vector< int > sad_list)
	This function sets SAD(Short Audio Descriptor) to configure the best available audio format to send to the ARC device from the passed SAD list. More...

void	enableARC (dsAudioARCTypes_t type, bool enable)
	This function enables/disables ARC/EARC and routes audio to connected device. More...

void	enableMS12Config (const dsMS12FEATURE_t feature, const bool enable)
	This API is used to enable MS12 features such as DAPV2 adn DE *. More...

dsError_t	enableLEConfig (const bool enable)
	This API is used to enable Loudness Equivalence *. More...

bool	GetLEConfig ()
	This API is used to check if Loudness Equivalence is enabled or not*. More...

void	setAudioDelay (const uint32_t audioDelayMs)
	This API is used to set audio delay in milliseconds. More...

void	setAudioDelayOffset (const uint32_t audioDelayOffsetMs)
	This API is used to set audio delay offset in milliseconds. More...

void	getSinkDeviceAtmosCapability (dsATMOSCapability_t &atmosCapability)

void	setAudioAtmosOutputMode (bool enable)

void	setAssociatedAudioMixing (const bool mixing)
	This API is used to enable/disable Associated Audio Mixing. More...

void	getAssociatedAudioMixing (bool *mixing)
	This API is used to get status of Associated Audio Mixing. More...

void	setFaderControl (const int mixerBalance)
	This API is used to set the mixerbalance betweeen main and associated audio. More...

void	getFaderControl (int *mixerBalance)
	This API is used to get the mixerbalance betweeen main and associated audio. More...

void	setPrimaryLanguage (const std::string pLang)
	This API is used to set Primary language. More...

void	getPrimaryLanguage (std::string &pLang)
	This API is used to get the current Primary language. More...

void	setSecondaryLanguage (const std::string sLang)
	This API is used to set Secondary language. More...

void	getSecondaryLanguage (std::string &sLang)
	This API is used to get the current AC4 Secondary language. More...

void	setDB (const float db)
	This API is used to set the audio DB value to be used in a given audio port. More...

void	setGain (const float newGain)
	This API is used to set the audio gain to be used in a given audio port. More...

void	setLevel (const float level)
	This API is used to set the audio level to be used in a given audio port. More...

void	setLoopThru (const bool loopThru)
	This API is used to set the audio port to do loop thro. More...

void	setMuted (const bool mute)
	This API is used to mute/unmute the audio. It throws an IllegalArgumentException if audio could not be muted/unmuted. More...

void	setAudioDucking (dsAudioDuckingAction_t action, dsAudioDuckingType_t, const unsigned char level)
	This API is used to set the audio level to be used in a given audio port. If output mode is Passthrough/Expert this mutes the audio. More...

void	getAudioCapabilities (int *capabilities)
	This API is used to query the Audio capabilities of the device. More...

void	getMS12Capabilities (int *capabilities)
	This API is used to query the MS12 capabilities of the device. More...

void	resetDialogEnhancement ()
	This API is used to reset the AudioOutput in a given audio port. More...

void	resetBassEnhancer ()
	This API is used to reset the AudioOutput in a given audio port. More...

void	resetSurroundVirtualizer ()
	This API is used to reset the AudioOutput in a given audio port. More...

void	resetVolumeLeveller ()
	This API is used to reset the AudioOutput in a given audio port. More...

void	setMS12AudioProfileSetttingsOverride (const std::string ProfileState, const std::string ProfileName, const std::string ProfileSettingsName, const std::string ProfileSettingValue)

void	getHdmiArcPortId (int *portId)
	This API is used to query the HDMI ARC Port ID. More...

Static Public Member Functions
static AudioOutputPort &	getInstance (int id)
	This API is used to get the instance of the audio output port based on the port id returned by the getsupported audiooutput port. More...

static AudioOutputPort &	getInstance (const std::string &name)
	This API is used to get the instance of the audio output port based on the port name returned by the getsupported audiooutput port. More...

Private Attributes
int	_type
	Audiooutputporttype.

int	_index
	Index of the audio output port.

int	_id
	Port id.

intptr_t	_handle

std::string	_name

int	_encoding
	Audio Encoding Types.

int	_stereoMode
	Audio stereo mode Types.

uint32_t	_audioDelayMs
	Audio delays.

uint32_t	_audioDelayOffsetMs
	Audio delay offset.

bool	_stereoAuto
	Audio stereo mode Types.

float	_gain
	Audio gain value.

float	_db
	Audio decibel value.

float	_maxDb
	Maximum audio decibel value.

float	_minDb
	Minimum audio decibel value.

float	_optimalLevel
	Optimal audio level.

float	_level
	Audio level.

bool	_loopThru
	Method variable to check whether audio is loop thru or not.

bool	_muted
	Method variable to check whether audio is muted or not.

Member Function Documentation

◆ getName()

device::AudioOutputPort::getName ( ) const

inline

This API gets the name of the AudioOutputPort. The AudioOutputPort names can be IDLR, HDMI and SPDIF which are created and used by the implementation to uniquely identify them.

Returns: _name Indicates the name of the AudioOutputPort

Definition at line 105 of file audioOutputPort.hpp.

◆ device::AudioOutputPortType

class device::AudioOutputPortType

Class extending DSConstant to implement the audiooutputport interface.

Definition at line 56 of file audioOutputPortType.hpp.

Inheritance diagram for device::AudioOutputPortType:

Collaboration diagram for device::AudioOutputPortType:

Public Member Functions
	AudioOutputPortType (int id)
	This is a default constructor of class AudioOutputPortType. It initializes the AudioOutputPortType instance based on the port id. If the id passed is invalid then it throws an IllegalArgumentException. More...

virtual	~AudioOutputPortType ()
	This is a default destructor of class AudioOutputPortType. More...

const List< AudioEncoding >	getSupportedEncodings () const
	This API is used to get the list of audio encodings supported by the audio port . More...

const List< AudioCompression >	getSupportedCompressions () const
	This API is used to get the list of audio compressions supported by the audio port. More...

const List< AudioStereoMode >	getSupportedStereoModes () const
	This API is used to get the list of audio stereo modes supported by the audio port. More...

const List< AudioOutputPort >	getPorts () const
	This function is used to get the list of platform supported audio output ports. More...

AudioOutputPort &	getPort (int index)
	This function is used to get the AudioOutputPort instance based on the index. More...

void	addEncoding (const AudioEncoding &encoding)
	This function is used to add the specified encoding types to the list of supported encodings for AudioOutputPortType. More...

void	addCompression (const AudioCompression &compression)
	This function is used to add the specified compression types to the list of supported compressions for AudioOutputPortType. More...

void	addStereoMode (const AudioStereoMode &stereoMode)
	This function is used to add the specified stereoMode types to the list of supported stereo modes for AudioOutputPortType. More...

void	addPort (const AudioOutputPort &port)
	This function is used to add the specified audio port to the list of supported audio ports. More...

bool	isModeSupported (int newMode)
	This function is used to find out if requested Audio mode is supported by Platform. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static AudioOutputPortType &	getInstance (int id)
	This function is used to get the instance of the AudioOutputPortType based on the port id, only if the id passed is valid. More...

static AudioOutputPortType &	getInstance (const std::string &name)

Static Public Attributes
static const int	kIDLR = dsAUDIOPORT_TYPE_ID_LR

static const int	kHDMI = dsAUDIOPORT_TYPE_HDMI

static const int	kSPDIF = dsAUDIOPORT_TYPE_SPDIF

static const int	kSPEAKER = dsAUDIOPORT_TYPE_SPEAKER

static const int	kARC = dsAUDIOPORT_TYPE_HDMI_ARC

static const int	kHEADPHONE = dsAUDIOPORT_TYPE_HEADPHONE

Private Attributes
List< AudioEncoding >	_encodings
	List of encoding types.

List< AudioCompression >	_compressions
	List of compression types.

List< AudioStereoMode >	_stereoModes
	List of stereo modes.

List< AudioOutputPort >	_aPorts
	List of audio ports.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

◆ device::AudioStereoMode

class device::AudioStereoMode

This class extends DSConstant to implement AudioStereoMode. It manages the information related to audio mode types like stereo, mono and so on.

Definition at line 52 of file audioStereoMode.hpp.

Inheritance diagram for device::AudioStereoMode:

Collaboration diagram for device::AudioStereoMode:

Public Member Functions
	AudioStereoMode (int id)
	This function is a parameterised constructor of AudioStereoMode class. It initializes the instance with the specified id and the name corresponding to it. More...

virtual	~AudioStereoMode ()
	This function is the default destructor of AudioStereoMode class. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static const AudioStereoMode &	getInstance (int id)
	This function gets an instance of AudioStereoMode against the specified id, only if the id passed is valid. More...

static const AudioStereoMode &	getInstance (const std::string &name)
	This function gets an instance of AudioStereoMode against the specified name, only if the name passed is valid. More...

Static Public Attributes
static const int	kMono = dsAUDIO_STEREO_MONO
	Indicates audio mode of type mono.

static const int	kStereo = dsAUDIO_STEREO_STEREO
	Indicates audio mode of type stereo.

static const int	kSurround = dsAUDIO_STEREO_SURROUND
	Indicates audio mode of type surround.

static const int	kPassThru = dsAUDIO_STEREO_PASSTHRU
	Indicates audio mode of type pass through.

static const int	kDD = dsAUDIO_STEREO_DD
	Indicates audio mode of type dolby digital.

static const int	kDDPlus = dsAUDIO_STEREO_DDPLUS
	Indicates audio mode of type dolby digital plus.

static const int	kMax = dsAUDIO_STEREO_MAX
	Indicates maximum number of audio modes supported.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Constructor & Destructor Documentation

◆ AudioStereoMode()

device::AudioStereoMode::AudioStereoMode ( int id )

This function is a parameterised constructor of AudioStereoMode class. It initializes the instance with the specified id and the name corresponding to it.

Parameters

[in] id Indicates the id for initializing the instance. The id can be used to identify the audio stereo mode. Ex: Id of 0 indicates mono audio whereas id of 1 indicates surround audio.

Returns: None

Definition at line 128 of file audioStereoMode.cpp.

◆ ~AudioStereoMode()

device::AudioStereoMode::~AudioStereoMode ( )

virtual

This function is the default destructor of AudioStereoMode class.

Returns: None

Definition at line 146 of file audioStereoMode.cpp.

Member Function Documentation

◆ getInstance() [1/2]

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

static

This function gets an instance of AudioStereoMode against the specified id, only if the id passed is valid.

Parameters

[in] id Indicates id against which the AudioStereoMode instance is required.

Returns: Returns an instance of AudioStereoMode if the id is valid else throws an IllegalArgumentException.

Definition at line 84 of file audioStereoMode.cpp.

◆ getInstance() [2/2]

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

static

This function gets an instance of AudioStereoMode against the specified name, only if the name passed is valid.

Parameters

[in] name Indicates name string against which the AudioStereoMode instance is required.

Returns: Returns an instance of AudioStereoMode if an instance with the specified name is present else throws an IllegalArgumentException.

Definition at line 105 of file audioStereoMode.cpp.

◆ device::DSConstant

class device::DSConstant

This class is used to store and manage the names and id's. It is derived by many classes like VideoResolution, VideoOutputPortType, stereoScopicMode and so on. And it is also stores information whether the derived class instances indicating the port or port attributes are enabled or not.

Definition at line 52 of file dsConstant.hpp.

Inheritance diagram for device::DSConstant:

Collaboration diagram for device::DSConstant:

Public Member Functions
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Protected Member Functions
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Private Attributes
bool	enabled
	Indicates the port or port attributes inheriting this class is enabled or not.

Constructor & Destructor Documentation

◆ DSConstant() [1/2]

device::DSConstant::DSConstant ( )

inline

This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values.

Returns: None

Definition at line 85 of file dsConstant.hpp.

◆ DSConstant() [2/2]

device::DSConstant::DSConstant	(	const int	id,
		const std::string &	name
	)

inline

This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter.

Parameters

[in]	id	Indicates the id.
[in]	name	Indicates the name string.

Returns: None.

Definition at line 98 of file dsConstant.hpp.

◆ ~DSConstant()

device::DSConstant::~DSConstant ( )

inlinevirtual

This function is the default destructor for DSConstant.

Returns: None

Definition at line 107 of file dsConstant.hpp.

Member Function Documentation

◆ isValid()

device::DSConstant::isValid	(	int	min,
		int	max,
		int	val
	)

inlinestaticprotected

This function checks if the given value lies between min and max values provided.

Parameters

[in]	min	Indicates the minimum value for comparison.
[in]	max	Indicates the maximum value for comparison.
[in]	val	Indicates the value to be compared with minimum and maximum value.

Returns: Returns true(1) if the specified val lies in between min and max values else returns false(0)

Definition at line 72 of file dsConstant.hpp.

◆ operator==()

device::DSConstant::operator== ( int id ) const

inlinevirtual

This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter.

Parameters

[in] id Indicates the value to be compared against the id of the instance.

Returns: Returns true(1) if the values compared are same else returns false(0).

Definition at line 119 of file dsConstant.hpp.

◆ getId()

device::DSConstant::getId ( ) const

inlinevirtual

This function is used to get the id.

Returns: _id Returns the id.

Definition at line 130 of file dsConstant.hpp.

◆ getName()

device::DSConstant::getName ( ) const

inlinevirtual

This function is used to the get the data member name.

Returns: _name Returns the name string.

Definition at line 141 of file dsConstant.hpp.

◆ toString()

device::DSConstant::toString ( ) const

inlinevirtual

This function is used to the get the data member name in string format.

Returns: _name Returns the name string.

Definition at line 152 of file dsConstant.hpp.

◆ enable()

device::DSConstant::enable ( )

inline

This function is used to indicate that the port or port attribute calling this function are enabled.

Returns: None

Definition at line 164 of file dsConstant.hpp.

◆ isEnabled()

device::DSConstant::isEnabled ( ) const

inline

This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes.

Returns: Returns true if data member enabled is set to true else returns false.

Definition at line 176 of file dsConstant.hpp.

◆ device::Enumerable

class device::Enumerable

This class is inherited by many classes in DS for getting the ID.

Definition at line 46 of file enumerable.hpp.

Inheritance diagram for device::Enumerable:

Collaboration diagram for device::Enumerable:

Private Member Functions
int	getId () const
	This function is used to get the id and it is implemented by the classes inheriting it. More...

Member Function Documentation

◆ getId()

device::Enumerable::getId ( ) const

private

This function is used to get the id and it is implemented by the classes inheriting it.

Returns: Returns id value.

◆ device::Exception

class device::Exception

This class handles exceptions occurring in DS module.

Definition at line 52 of file exception.hpp.

Inheritance diagram for device::Exception:

Collaboration diagram for device::Exception:

Public Member Functions
	Exception (const char *msg="No Message for this exception") throw ()
	This function is a parameterised constructor of the class Exception. It initializes the instance with the msg string passed as input parameter. More...

	Exception (int err, const char *msg="No Message for this Exception") throw ()
	This function is a parameterised constructor of the class Exception. It initializes the instance with both message string and the error code passed as input parameter. More...

virtual const std::string &	getMessage () const
	This function is used to get the message string of the exception. More...

virtual int	getCode () const
	This function is used to get the error code of the exception. More...

virtual const char *	what () const throw ()
	This function is overwritten to get the null terminated character sequence of the exception message. More...

virtual	~Exception () throw ()
	This function is the default destructor of Exception class. More...

	Exception (const char *msg="No Message for this exception") throw ()

	Exception (int err, const char *msg="No Message for this Exception") throw ()

virtual const std::string &	getMessage () const

virtual int	getCode () const

virtual const char *	what () const throw ()

Private Attributes
int	_err
	Indicates error code for the exception.

std::string	_msg
	Indicates the error message.

Constructor & Destructor Documentation

◆ Exception() [1/2]

Exception::Exception	(	const char *	msg = `"No Message for this exception"`	)
throw	(
	)

inline

This function is a parameterised constructor of the class Exception. It initializes the instance with the msg string passed as input parameter.

Parameters

[in] msg Message string for the exception.

Returns: None

Definition at line 67 of file exception.hpp.

◆ Exception() [2/2]

Exception::Exception	(	int	err,
		const char *	msg = `"No Message for this Exception"`
	)
throw	(
	)

inline

This function is a parameterised constructor of the class Exception. It initializes the instance with both message string and the error code passed as input parameter.

Parameters

[in]	err	Indicates the error code.
[in]	msg	Message string for the exception.

Returns: None

Definition at line 82 of file exception.hpp.

◆ ~Exception()

Exception::~Exception	(	)
throw	(
	)

inlinevirtual

This function is the default destructor of Exception class.

Returns: None

Definition at line 127 of file exception.hpp.

Member Function Documentation

◆ getMessage()

Exception::getMessage ( ) const

inlinevirtual

This function is used to get the message string of the exception.

Returns: _msg Message string of the exception is returned.

Definition at line 93 of file exception.hpp.

◆ getCode()

Exception::getCode ( ) const

inlinevirtual

This function is used to get the error code of the exception.

Returns: _err Error code of the exception is returned.

Definition at line 104 of file exception.hpp.

◆ what()

Exception::what	(	)	const
throw	(
	)

inlinevirtual

This function is overwritten to get the null terminated character sequence of the exception message.

Returns: Returns a null terminated character sequence of the exception message.

Definition at line 116 of file exception.hpp.

◆ device::FrameRate

class device::FrameRate

This class extends DSConstant to handle the video frame rate.

Definition at line 49 of file frameRate.hpp.

Inheritance diagram for device::FrameRate:

Collaboration diagram for device::FrameRate:

Public Member Functions
	FrameRate (float value)

	FrameRate (int id)

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static const FrameRate &	getInstance (int id)

static const FrameRate &	getInstance (const std::string &name)

Static Public Attributes
static const int	kUnknown = dsVIDEO_FRAMERATE_UNKNOWN
	Indicates video frame rate of unknown type.

static const int	k24 = dsVIDEO_FRAMERATE_24
	Indicates video frame rate of 24 fps.

static const int	k25 = dsVIDEO_FRAMERATE_25
	Indicates video frame rate of 25 fps.

static const int	k30 = dsVIDEO_FRAMERATE_30
	Indicates video frame rate of 30 fps.

static const int	k60 = dsVIDEO_FRAMERATE_60
	Indicates video frame rate of 60 fps.

static const int	k23dot98 = dsVIDEO_FRAMERATE_23dot98
	Indicates video frame rate of 23.98 fps.

static const int	k29dot97 = dsVIDEO_FRAMERATE_29dot97
	Indicates video frame rate of 29.97 fps.

static const int	k50 = dsVIDEO_FRAMERATE_50
	Indicates video frame rate of 50 fps.

static const int	k59dot94 = dsVIDEO_FRAMERATE_59dot94
	Indicates video frame rate of 59.94 fps.

static const int	kMax = dsVIDEO_FRAMERATE_MAX
	Indicates maximum number of frame rates supported.

Private Attributes
float	_value
	Indicates the supported frame rate value in fps.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

◆ device::FrontPanelConfig

class device::FrontPanelConfig

@brieif To manage front panel text display and indicators

Definition at line 55 of file frontPanelConfig.hpp.

Collaboration diagram for device::FrontPanelConfig:

Public Member Functions
FrontPanelIndicator::Color &	getColor (int id)
	This function gets an instance of the front panel indicator Color with the specified id, only if the id passed is valid. More...

FrontPanelIndicator &	getIndicator (int id)
	This function gets an instance of the FrontPanelndicator with the specified id, only if the id passed is valid. More...

FrontPanelTextDisplay &	getTextDisplay (int id)
	This function gets the FrontPanelTextDisplay instance corresponding to the specified id, only if the id passed is valid. More...

FrontPanelIndicator::Color &	getColor (const string &name)
	This function gets an instance of the front panel indicator Color with the specified name, only if the name passed is valid. More...

FrontPanelIndicator &	getIndicator (const string &name)
	This API gets the FrontPanelndicator instance corresponding to the name parameter returned by the get supported frontpanel indicator device. More...

FrontPanelTextDisplay &	getTextDisplay (const string &name)
	This API gets the FrontPanelTextDisplay instance corresponding to the name parameter, only if the name passed is valid. More...

List< FrontPanelIndicator::Color >	getColors ()
	This API gets the list of colors supported by front panel indicators. More...

List< FrontPanelIndicator >	getIndicators ()
	This API gets a list of indicators on the front panel. More...

List< FrontPanelTextDisplay >	getTextDisplays ()
	This API gets a list of text display supported by the front panels. More...

void	fPInit ()
	This API is used to Initialize front panel. More...

void	fPTerm ()
	This API is used to terminate front panel. More...

Static Public Member Functions
static FrontPanelConfig &	getInstance ()
	This API gets the instance of the FrontPanelConfig. When called for the first time, it creates an instance of FrontPanelConfig where the front panel indicators and text display are initialized and loaded with supported colours and text by the default constructor. More...

Private Member Functions
	FrontPanelConfig ()
	This function initializes the underlying front panel sub-system. It loads the platform supported configurations of all the front panel indicator and text display. More...

virtual	~FrontPanelConfig ()
	This function is the default destructor for FrontPanelConfig. More...

void	load ()
	This function creates instances of the front panel indicators and text display. It also loads the platform supported configurations. More...

Private Attributes
std::vector< FrontPanelIndicator >	_indicators
	Container to hold all the FrontPanelIndicator instances.

std::vector< FrontPanelTextDisplay >	_textDisplays
	Container to hold all the FrontPanelTextDisplay instances.

std::vector< FrontPanelIndicator::Color >	_colors
	Container to hold all the Color instances.

Constructor & Destructor Documentation

◆ FrontPanelConfig()

device::FrontPanelConfig::FrontPanelConfig ( )

private

This function initializes the underlying front panel sub-system. It loads the platform supported configurations of all the front panel indicator and text display.

Returns: None

Definition at line 55 of file frontPanelConfig.cpp.

◆ ~FrontPanelConfig()

device::FrontPanelConfig::~FrontPanelConfig ( )

privatevirtual

This function is the default destructor for FrontPanelConfig.

Returns: None

Definition at line 68 of file frontPanelConfig.cpp.

Member Function Documentation

◆ load()

void device::FrontPanelConfig::load ( )

private

This function creates instances of the front panel indicators and text display. It also loads the platform supported configurations.

Returns: None

Definition at line 328 of file frontPanelConfig.cpp.

◆ getInstance()

FrontPanelConfig & device::FrontPanelConfig::getInstance ( )

static

This API gets the instance of the FrontPanelConfig. When called for the first time, it creates an instance of FrontPanelConfig where the front panel indicators and text display are initialized and loaded with supported colours and text by the default constructor.

Returns: _singleton An instance of FrontPanelConfig is returned.

Definition at line 82 of file frontPanelConfig.cpp.

◆ getColor() [1/2]

FrontPanelIndicator::Color & device::FrontPanelConfig::getColor ( int id )

This function gets an instance of the front panel indicator Color with the specified id, only if the id passed is valid.

Parameters

[in] id Indicates the id of the color whose instance is required.

Returns: Returns an instance of Color corresponding to the id parameter else throws an IllegalArgumentException indicating that the instance corresponding to the id parameter was not found.

Definition at line 199 of file frontPanelConfig.cpp.

◆ getIndicator() [1/2]

FrontPanelIndicator & device::FrontPanelConfig::getIndicator ( int id )

This function gets an instance of the FrontPanelndicator with the specified id, only if the id passed is valid.

Parameters

[in] id Indicates the id of front panel indicator whose instance is required.

Returns: Returns an instance of FrontPanelIndicator corresponding to the id parameter else throws an IllegalArgumentException indicating that the instance corresponding to the id parameter was not found.

Definition at line 147 of file frontPanelConfig.cpp.

◆ getTextDisplay() [1/2]

FrontPanelTextDisplay & device::FrontPanelConfig::getTextDisplay ( int id )

This function gets the FrontPanelTextDisplay instance corresponding to the specified id, only if the id passed is valid.

Parameters

[in] id Indicates the id of the front panel display whose instance is required.

Returns: Returns FrontPanelTextDisplay instance corresponding to the id parameter else throws an IllegalArgumentException indicating that the instance corresponding to the id parameter is not found

Definition at line 224 of file frontPanelConfig.cpp.

◆ getColor() [2/2]

FrontPanelIndicator::Color & device::FrontPanelConfig::getColor ( const string & name )

This function gets an instance of the front panel indicator Color with the specified name, only if the name passed is valid.

Parameters

[in] name Indicates the name of the color whose instance is required.

Returns: Returns an instance of Color corresponding to the name parameter else throws an IllegalArgumentException indicating that the instance corresponding to the name parameter was not found.

Definition at line 174 of file frontPanelConfig.cpp.

◆ getIndicator() [2/2]

FrontPanelIndicator & device::FrontPanelConfig::getIndicator ( const string & name )

This API gets the FrontPanelndicator instance corresponding to the name parameter returned by the get supported frontpanel indicator device.

The valid indicator names are Message, Power, Record, Remote and RfByPass.

Parameters

[in] name Indicates the name of the FrontPanelIndicator whose instance should be returned.

Returns: Returns an instance of FrontPanelIndicator corresponding to the name parameter else throws an IllegalArgumentException if the instance corresponding to the name parameter was not found.

Definition at line 101 of file frontPanelConfig.cpp.

◆ getTextDisplay() [2/2]

FrontPanelTextDisplay & device::FrontPanelConfig::getTextDisplay ( const string & name )

This API gets the FrontPanelTextDisplay instance corresponding to the name parameter, only if the name passed is valid.

Valid name parameter is Text.

Parameters

[in] name Indicates the name of FrontPanelTextDisplay whose instance has to be returned.

Returns: Returns FrontPanelTextDisplay instance corresponding to the name else throws an IllegalArgumentException if the instance corresponding to the name parameter is not found.

Definition at line 252 of file frontPanelConfig.cpp.

◆ getColors()

List< FrontPanelIndicator::Color > device::FrontPanelConfig::getColors ( )

This API gets the list of colors supported by front panel indicators.

Returns: rColors List of colors supported by the indicators.

Definition at line 273 of file frontPanelConfig.cpp.

◆ getIndicators()

List< FrontPanelIndicator > device::FrontPanelConfig::getIndicators ( )

This API gets a list of indicators on the front panel.

Returns: rIndicators Contains list indicators on the front panel.

Definition at line 291 of file frontPanelConfig.cpp.

◆ getTextDisplays()

List< FrontPanelTextDisplay > device::FrontPanelConfig::getTextDisplays ( )

This API gets a list of text display supported by the front panels.

Returns: rIndicators Contains the list of text supported by the front panel display.

Definition at line 309 of file frontPanelConfig.cpp.

◆ fPInit()

void device::FrontPanelConfig::fPInit ( )

This API is used to Initialize front panel.

Returns: None

Definition at line 120 of file frontPanelConfig.cpp.

◆ fPTerm()

void device::FrontPanelConfig::fPTerm ( )

This API is used to terminate front panel.

Returns: None

Definition at line 132 of file frontPanelConfig.cpp.

◆ device::FrontPanelIndicator

class device::FrontPanelIndicator

This class extents DSConstant to manage front panel indicators color, blink sequence and brightness.

Definition at line 55 of file frontPanelIndicator.hpp.

Inheritance diagram for device::FrontPanelIndicator:

Collaboration diagram for device::FrontPanelIndicator:

Public Member Functions
int	getBrightness ()
	This API gets the brightness of the specified LED indicators. More...

void	getBrightnessLevels (int &levels, int &min, int &max)
	This function gets the maximum brightness, minimum brightness and the brightness level set for the front panel indicator. More...

int	getColorMode ()
	This function is used to get the color mode of the front panel indicator. The color mode is device specific and can be single or multi color mode (RGB colors). By default the color mode is set to 0 to indicate single color mode. More...

const Blink	getBlink () const
	This API gets the blink parameters of the front panel display like iterations and interval. More...

int	getMaxCycleRate () const
	This API get the rate at which the LED is rotating/glowing during scrolling. More...

void	setBlink (const Blink &blink)
	This API sets the blink iteration and blink interval for the LED. More...

uint32_t	getColor ()
	This API gets the color of the front panel indicator/LED. More...

void	setBrightness (const int &brightness, const bool toPersist=true)
	This API sets the brightness or intensity of the front panel indicators. More...

void	setColor (const Color &newColor, const bool toPersist=true)
	This API sets the color of the front panel indicator. More...

void	setColor (const uint32_t color, const bool toPersist=true)
	This API sets the color of the front panel indicator. More...

void	setState (const bool &enable)
	This API is used to enable or disable the front panel indicator. More...

bool	getState ()
	This API gets the State of the specified LED indicators. More...

const List< Color >	getSupportedColors () const
	This API gets the list of supported colors for front panel indicator. More...

	FrontPanelIndicator (int id, int maxBrightness, int maxCycleRate, int levels, int colorMode)
	This function is a parameterised constructor of FrontPanelIndicator. It creates and initializes the FrontPanelIndicator instance with the configurations/values specified as input parameters. More...

virtual	~FrontPanelIndicator ()
	This function is the default constructor for FrontPanelIndicator. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static FrontPanelIndicator &	getInstance (int id)
	This function gets the FrontPanelIndicator instance corresponding to the id parameter, only if the id passed is valid. More...

static FrontPanelIndicator &	getInstance (const std::string &name)
	This API gets the FrontPanelIndicator instance corresponding to the name parameter. More...

Static Public Attributes
static const int	kMessage = dsFPD_INDICATOR_MESSAGE
	Indicates id of meassage LED.

static const int	kPower = dsFPD_INDICATOR_POWER
	Indicates id of power LED.

static const int	kRecord = dsFPD_INDICATOR_RECORD
	Indicates id of record LED.

static const int	kRemote = dsFPD_INDICATOR_REMOTE
	Indicates id of remote LED.

static const int	kRFBypass = dsFPD_INDICATOR_RFBYPASS
	Indicates id of RF bypass LED.

static const int	kMax = dsFPD_INDICATOR_MAX
	Indicates the maximum number of LEDS supported.

Protected Attributes
int	_maxBrightness
	Indicates maximum brightness value for the FP indicators.

int	_maxCycleRate
	Indicates maximum cycle rate for scrolling of LED.

int	_brightness
	Indicates the brightness of the LED indicator.

int	_levels
	Indicates the brightness level.

int	_colorMode
	Indicates the color mode of the LED indicator (single or multicolor mode).

int	_state
	Indicates the FP indicator is enabled if true.

Blink	_blink
	A Blink instance to control blink iterations and intervals of the LED.

int	_color

uint32_t	_color_rgb32
	Indicates the color id of the LED.

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Static Protected Attributes
static const char *	kPropertyBrightness

static const char *	kPropertyColor

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Member Function Documentation

◆ getBlink()

Blink device::FrontPanelIndicator::getBlink ( ) const

inline

This API gets the blink parameters of the front panel display like iterations and interval.

Parameters

[out] _blink Is filled with the blink parameters set for front panel display

Returns: None

Definition at line 167 of file frontPanelIndicator.hpp.

◆ getMaxCycleRate()

device::FrontPanelIndicator::getMaxCycleRate ( ) const

inline

This API get the rate at which the LED is rotating/glowing during scrolling.

Returns: _maxCycleRate Returns the rate at which LED is rotating/glowing during scrolling

Definition at line 176 of file frontPanelIndicator.hpp.

◆ FrontPanelIndicator::Color

class FrontPanelIndicator::Color

This class extents DSConstant to manage the color of the front panel indicator.

Collaboration diagram for Color:

◆ FrontPanelIndicator::Blink

class FrontPanelIndicator::Blink

This class supports to manage front panel indicator blink sequence.

Collaboration diagram for Blink:

◆ device::FrontPanelTextDisplay

class device::FrontPanelTextDisplay

This class extents FrontPanelIndicator to manage front panel text display mode, scrolling and its brightness.

Definition at line 53 of file frontPanelTextDisplay.hpp.

Inheritance diagram for device::FrontPanelTextDisplay:

Collaboration diagram for device::FrontPanelTextDisplay:

Public Member Functions
int	getTextBrightness ()
	This API gets the text LED brightness value. More...

void	getTextBrightnessLevels (int &levels, int &min, int &max)
	This function is used to get maximum brightness, minimum brightness and brightness level of the front panel LED display. More...

int	getTextColorMode ()
	This function is used to get the color mode of the front panel text display. More...

void	setTextBrightness (const int &brightness)
	This API sets the brightness value for the front panel LED. More...

void	enableDisplay (const int enable)
	This function is used to enable or disable the display of clock on front panel. More...

const Scroll	getScroll () const
	This API gets the scroll parameters for front panel display like vertical & horizontal iterations and hold duration. More...

int	getCurrentTimeFormat ()
	This API Get the time format of the LED display. More...

void	setScroll (const Scroll &scroll)
	This API sets the scroll parameters for text LED display like hold duration, vertical iterations and horizontal iterations. More...

void	setText (const std::string &text)
	This API sets the text LED display, by switching the text display to text mode. More...

void	setTimeFormat (const int iTimeFormat)
	This API sets the time format of the LED display to either 12hr or 24hr format. More...

void	setTime (const int uiHours, const int uiMinutes)
	This API sets the time of the LED display by switching the text display to time mode. More...

void	setMode (int mode)
	This API sets the display mode of the LED display to any, text only or clock only. More...

	FrontPanelTextDisplay (int id, int maxBrightness, int maxCycleRate, int levels, int maxHorizontalIterations, int maxVerticalIterations, const std::string &supportedCharacters, int colorMode)

Public Member Functions inherited from device::FrontPanelIndicator
int	getBrightness ()
	This API gets the brightness of the specified LED indicators. More...

void	getBrightnessLevels (int &levels, int &min, int &max)
	This function gets the maximum brightness, minimum brightness and the brightness level set for the front panel indicator. More...

int	getColorMode ()
	This function is used to get the color mode of the front panel indicator. The color mode is device specific and can be single or multi color mode (RGB colors). By default the color mode is set to 0 to indicate single color mode. More...

const Blink	getBlink () const
	This API gets the blink parameters of the front panel display like iterations and interval. More...

int	getMaxCycleRate () const
	This API get the rate at which the LED is rotating/glowing during scrolling. More...

void	setBlink (const Blink &blink)
	This API sets the blink iteration and blink interval for the LED. More...

uint32_t	getColor ()
	This API gets the color of the front panel indicator/LED. More...

void	setBrightness (const int &brightness, const bool toPersist=true)
	This API sets the brightness or intensity of the front panel indicators. More...

void	setColor (const Color &newColor, const bool toPersist=true)
	This API sets the color of the front panel indicator. More...

void	setColor (const uint32_t color, const bool toPersist=true)
	This API sets the color of the front panel indicator. More...

void	setState (const bool &enable)
	This API is used to enable or disable the front panel indicator. More...

bool	getState ()
	This API gets the State of the specified LED indicators. More...

const List< Color >	getSupportedColors () const
	This API gets the list of supported colors for front panel indicator. More...

	FrontPanelIndicator (int id, int maxBrightness, int maxCycleRate, int levels, int colorMode)
	This function is a parameterised constructor of FrontPanelIndicator. It creates and initializes the FrontPanelIndicator instance with the configurations/values specified as input parameters. More...

virtual	~FrontPanelIndicator ()
	This function is the default constructor for FrontPanelIndicator. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static FrontPanelTextDisplay &	getInstance (int id)
	This API gets the FrontPanelIndicator instance corresponding to the specified id, only if the id passed is valid. More...

static FrontPanelTextDisplay &	getInstance (const string &name)

Static Public Member Functions inherited from device::FrontPanelIndicator
static FrontPanelIndicator &	getInstance (int id)
	This function gets the FrontPanelIndicator instance corresponding to the id parameter, only if the id passed is valid. More...

static FrontPanelIndicator &	getInstance (const std::string &name)
	This API gets the FrontPanelIndicator instance corresponding to the name parameter. More...

Static Public Attributes
static const int	kModeClock12Hr = dsFPD_TIME_12_HOUR
	Indicates 12 hour time format.

static const int	kModeClock24Hr = dsFPD_TIME_24_HOUR
	Indicates 24 hour time format.

static const int	kModeString = dsFPD_TIME_STRING
	Indicates text string.

Static Public Attributes inherited from device::FrontPanelIndicator
static const int	kMessage = dsFPD_INDICATOR_MESSAGE
	Indicates id of meassage LED.

static const int	kPower = dsFPD_INDICATOR_POWER
	Indicates id of power LED.

static const int	kRecord = dsFPD_INDICATOR_RECORD
	Indicates id of record LED.

static const int	kRemote = dsFPD_INDICATOR_REMOTE
	Indicates id of remote LED.

static const int	kRFBypass = dsFPD_INDICATOR_RFBYPASS
	Indicates id of RF bypass LED.

static const int	kMax = dsFPD_INDICATOR_MAX
	Indicates the maximum number of LEDS supported.

Private Attributes
Scroll	_scroll
	Indicates scroll properties.

int	_timeFormat
	Indicates time format for the clock display.

int	_TextBrightness
	Indicates text brightness.

Static Private Attributes
static const char *	kPropertyBrightness = ".brightness"

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::FrontPanelIndicator
int	_maxBrightness
	Indicates maximum brightness value for the FP indicators.

int	_maxCycleRate
	Indicates maximum cycle rate for scrolling of LED.

int	_brightness
	Indicates the brightness of the LED indicator.

int	_levels
	Indicates the brightness level.

int	_colorMode
	Indicates the color mode of the LED indicator (single or multicolor mode).

int	_state
	Indicates the FP indicator is enabled if true.

Blink	_blink
	A Blink instance to control blink iterations and intervals of the LED.

int	_color

uint32_t	_color_rgb32
	Indicates the color id of the LED.

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Static Protected Attributes inherited from device::FrontPanelIndicator
static const char *	kPropertyBrightness

static const char *	kPropertyColor

Member Function Documentation

◆ getScroll()

Scroll device::FrontPanelTextDisplay::getScroll ( ) const

inline

This API gets the scroll parameters for front panel display like vertical & horizontal iterations and hold duration.

Returns: _scroll Returns scroll parameters for front panel display

Definition at line 153 of file frontPanelTextDisplay.hpp.

◆ FrontPanelTextDisplay::Mode

class FrontPanelTextDisplay::Mode

This class extents DSConstant to mange the front panel text display mode like time display mode or text display mode etc...

Collaboration diagram for Mode:

◆ FrontPanelTextDisplay::Scroll

class FrontPanelTextDisplay::Scroll

To manage front panel text display scrolling.

Collaboration diagram for Scroll:

◆ device::Host

class device::Host

Class to implement the Host interface.

Definition at line 60 of file host.hpp.

Collaboration diagram for device::Host:

Public Member Functions
bool	setPowerMode (int mode)
	This API is used to change the power mode of the device. This function will set the power mode to active or standby and turn off all the ouput ports. The accepted modes are defined as constants in host module: Host::kPowerOn, Host::kPowerOff, Host::kPowerStandby. Upon the return of this API, the power mode listeners will be notified of the new power mode. This function is currently not supported. More...

int	getPowerMode ()
	This API is used to get the current power mode of the device. This function is currently not supported. More...

SleepMode	getPreferredSleepMode ()
	This API is used to gets the Preferred sleep Mode and implements the low power mode for RDK platform. dsGetPreferredSleepMode(&mode) function returns preferred sleep mode which is persisted. More...

int	setPreferredSleepMode (const SleepMode)
	This API is used to set the Preferred sleep Mode and implements the low power mode for RDK platform. More...

List< SleepMode >	getAvailableSleepModes ()
	This function is used to get the available sleep modes. More...

void	addPowerModeListener (PowerModeChangeListener *l)
	This API is used to register listeners for Power Mode change event. The listener object is created by application and should be released by the application once the listener is removed. Listeners will be notified with the new mode via the listener's powerModeChanged() callback. More...

void	removePowerModeChangeListener (PowerModeChangeListener *l)
	This API is used to remove a listener from Power Mode change listener list. More...

void	addDisplayConnectionListener (DisplayConnectionChangeListener *l)
	This API is used to register listeners for Display connection change event. The listener will be notified if Display device is connected/disconnected from the video output port. The notification only carries the state change of the connection. It does not carry any other system state change that may have been triggered by the connection. The application is responsible to query the various parts of system to detect any such change. For example, when a TV device is replaced, the application shall query the video output port again upon the connection for the new resolution supported by the TV. The listener object is created by application and should be released by the application once the listener is removed. More...

void	removeDisplayConnectionListener (DisplayConnectionChangeListener *l)
	This API is used to remove listeners from the Display connection change event list. More...

List< VideoOutputPort >	getVideoOutputPorts ()
	This API is used to get the list of the video output ports supported on the device. A complete list of ports that are physically present on the platform will be returned, regardless the state of each port. If no Video Output Port is available on the device, an empty List will be returned. More...

List< AudioOutputPort >	getAudioOutputPorts ()
	This API is used to get the list of the audio output ports supported on the device. A complete list of ports that are physically present on the platform will be returned, regardless the state of each port. If no Audio Output Port is available on the device, an empty List will be returned. More...

List< VideoDevice >	getVideoDevices ()
	This API is used to get the list of the video devices (i.e. Decoders) supported on the device. If no Video Device is available on the device, an empty List will be returned. More...

VideoOutputPort &	getVideoOutputPort (const std::string &name)
	This API is used to get the reference to the video output port by its name. The name of the port must match one of those returned by Host::getVideoOutputPorts. Application shall not develop code that depends on the actual naming conventions of the video output port. Such code as Host::getVideoOutputPort("HDMI0") is discouraged as the name of the left-most HDMI output port may not necessarily be "HDMI0" from all implementations. IllegalArgumentException will be thrown if the "name" does not match any of the ports. More...

VideoOutputPort &	getVideoOutputPort (int id)
	This API is used to get a reference to the video output port by its id. The name of the port must match one of those returned by Host::getVideoOutputPorts. Application shall not develop code that depends on the actual naming conventions of the video output port. Such code as Host::getVideoOutputPort("HDMI0") is discouraged as the name of the left-most HDMI output port may not necessarily be "HDMI0" from all implementations. IllegalArgumentException will be thrown if the "name" does not match any of the ports. More...

AudioOutputPort &	getAudioOutputPort (const std::string &name)
	This API is used to get the reference to the audio output port by its name. The name of the port must match one of those returned by Host::getAudioOutputPorts. Application shall not develop code that depends on the actual naming conventions of the Audio output port. Such code as Host::getAudioOutputPort("SPDIF0") is discouraged as the name of the left-most SPDIF output port may not necessarily be "SPDIF0" from all implementations. IllegalArgumentException will be thrown if the "name" does not match any of the ports. More...

AudioOutputPort &	getAudioOutputPort (int id)
	This API is used to get a reference to the Audio output port by its id. The name of the port must match one of those returned by Host::getAudioOutputPorts. Application shall not develop code that depends on the actual naming conventions of the Audio output port. Such code as Host::getAudioOutputPort("SPDIF0") is discouraged as the name of the left-most SPDIF output port may not necessarily be "SPDIF0" from all implementations. IllegalArgumentException will be thrown if the "name" does not match any of the ports. More...

void	notifyPowerChange (const int mode)
	This function is used to get the current power state. More...

float	getCPUTemperature ()
	This API gets CPU temperature. More...

uint32_t	getVersion (void)
	Get DS HAL API Version. More...

void	setVersion (uint32_t versionNumber)

void	getHostEDID (std::vector< uint8_t > &edid) const
	This function is used to get the EDID information of the host device. More...

std::string	getSocIDFromSDK ()
	This API to get the SOC ID. dsGetSocIDFromSDK() function returns the SOC ID in string format. More...

void	getSinkDeviceAtmosCapability (dsATMOSCapability_t &atmosCapability)

void	setAudioAtmosOutputMode (bool enable)

void	setAssociatedAudioMixing (const bool mixing)
	This API is used to enable/disable Associated Audio Mixing. More...

void	getAssociatedAudioMixing (bool *mixing)
	This API is used to get status of Associated Audio Mixing. More...

void	setFaderControl (const int mixerbalance)
	This API is used to set the mixerbalance betweeen main and associated audio. More...

void	getFaderControl (int *mixerBalance)
	This API is used to get the mixerbalance betweeen main and associated audio. More...

void	setPrimaryLanguage (const std::string pLang)
	This API is used to set Primary language. More...

void	getPrimaryLanguage (std::string &pLang)
	This API is used to get the current Primary language. More...

void	setSecondaryLanguage (const std::string sLang)
	This API is used to set Secondary language. More...

void	getSecondaryLanguage (std::string &sLang)
	This API is used to get the current AC4 Secondary language. More...

bool	isHDMIOutPortPresent ()

std::string	getDefaultVideoPortName ()

std::string	getDefaultAudioPortName ()

void	getCurrentAudioFormat (dsAudioFormat_t &audioFormat)

Static Public Member Functions
static Host &	getInstance (void)
	This API is used to get a reference to the single instance of the Host object. More...

Static Public Attributes
static const int	kPowerOn = dsPOWER_ON

static const int	kPowerOff = dsPOWER_OFF

static const int	kPowerStandby = dsPOWER_STANDBY

Private Member Functions
	Host (const Host &)=delete

Host &	operator= (const Host &)=delete

void	notifyDisplayConnectionChange (int portHandle, bool newConnectionStatus)

Private Attributes
std::list< PowerModeChangeListener * >	powerEvntListeners

std::list< DisplayConnectionChangeListener * >	dispEvntListeners

◆ device::IllegalArgumentException

class device::IllegalArgumentException

This class extends Exception class to manage the expections caused due to illegal arguments.

Definition at line 51 of file illegalArgumentException.hpp.

Inheritance diagram for device::IllegalArgumentException:

Collaboration diagram for device::IllegalArgumentException:

Public Member Functions
	IllegalArgumentException (const char *msg="Illegal Argument") throw ()
	This function is a parameterised constructor of IllegalArgumentException class. It initializes the instance with the message passed as input parameter. More...

virtual	~IllegalArgumentException () throw ()
	This function is a default destructor of the class IllegalArgumentException. More...

	IllegalArgumentException (const char *msg="Illegal Argument") throw ()

Public Member Functions inherited from device::Exception
	Exception (const char *msg="No Message for this exception") throw ()
	This function is a parameterised constructor of the class Exception. It initializes the instance with the msg string passed as input parameter. More...

	Exception (int err, const char *msg="No Message for this Exception") throw ()
	This function is a parameterised constructor of the class Exception. It initializes the instance with both message string and the error code passed as input parameter. More...

virtual const std::string &	getMessage () const
	This function is used to get the message string of the exception. More...

virtual int	getCode () const
	This function is used to get the error code of the exception. More...

virtual const char *	what () const throw ()
	This function is overwritten to get the null terminated character sequence of the exception message. More...

virtual	~Exception () throw ()
	This function is the default destructor of Exception class. More...

	Exception (const char *msg="No Message for this exception") throw ()

	Exception (int err, const char *msg="No Message for this Exception") throw ()

virtual const std::string &	getMessage () const

virtual int	getCode () const

virtual const char *	what () const throw ()

Constructor & Destructor Documentation

◆ IllegalArgumentException()

device::IllegalArgumentException::IllegalArgumentException	(	const char *	msg = `"Illegal Argument"`	)
throw	(
	)

inline

This function is a parameterised constructor of IllegalArgumentException class. It initializes the instance with the message passed as input parameter.

Parameters

[in] msg Indicates the exception message string to be updated.

Returns: None

Definition at line 64 of file illegalArgumentException.hpp.

◆ ~IllegalArgumentException()

device::IllegalArgumentException::~IllegalArgumentException	(	)
throw	(
	)

inlinevirtual

This function is a default destructor of the class IllegalArgumentException.

Returns: None

Definition at line 74 of file illegalArgumentException.hpp.

◆ device::List

class device::List

template<class T>
class device::List< T >

This class is implemented using templates and it is used to maintain a container with the list of supported ID's.

Definition at line 51 of file list.hpp.

Collaboration diagram for device::List< T >:

Public Member Functions
	List ()
	This function is the default constructor of class List. More...

virtual	~List ()
	This function is the default destructor of class List and is a virtual function.

const T &	at (size_t i) const

T &	at (size_t i)
	This is a template function to get the instance of the calling class against the value at the position i of the container. More...

void	push_back (const T &x)
	This is a template function used to push/store the ID of an instance x into the container. More...

size_t	size ()
	This function gets the size of the container. More...

size_t	size () const

Private Types
typedef std::vector< int >::iterator	iterator
	An iterator for the container.

Private Attributes
std::vector< int >	_container
	Vector container for integers to maintain the id's.

Constructor & Destructor Documentation

◆ List()

template<class T >

device::List< T >::List ( )

inline

This function is the default constructor of class List.

Returns: None

Definition at line 64 of file list.hpp.

Member Function Documentation

◆ at()

template<class T >

device::List< T >::at ( size_t i )

inline

This is a template function to get the instance of the calling class against the value at the position i of the container.

Parameters

[in] i Specifies the container index.

Returns: Returns an instance of the class calling this function. The return value is const and cannot be modified.

Parameters

[in] i Specifies the container index.

Returns: Returns an instance of the class calling this function.

Definition at line 95 of file list.hpp.

◆ push_back()

template<class T >

device::List< T >::push_back ( const T & x )

inline

This is a template function used to push/store the ID of an instance x into the container.

Parameters

[in] x Indicates an instance whose ID needs to be stored.

Returns: None

Definition at line 108 of file list.hpp.

◆ size()

template<class T >

device::List< T >::size ( )

inline

This function gets the size of the container.

Returns: Returns the size of the container.

Definition at line 118 of file list.hpp.

◆ device::Manager

class device::Manager

Class to implement the manager interface.

Definition at line 165 of file manager.hpp.

Collaboration diagram for device::Manager:

Static Public Member Functions
static void	Initialize ()
	This API is used to initialize the Device Setting module. Each API should be called by any client of device settings before it start device settings service. More...

static void	DeInitialize ()
	This API is used to deinitialize the device settings module. DeInitialize() must be called to release all resource used by the Device Setting module. After DeInitialize(), the device will return to a state as if the Initialize() was never called. More...

Static Public Attributes
static int	IsInitialized = 0
	Indicates the application has initialized with devicettings modules.

◆ device::PixelResolution

class device::PixelResolution

This class extends DSConstant to manages the pixel resolution of the video.

Definition at line 51 of file pixelResolution.hpp.

Inheritance diagram for device::PixelResolution:

Collaboration diagram for device::PixelResolution:

Public Member Functions
	PixelResolution (int id)
	This function is a parameterised constructor for PixelResolution. It initializes the instance with the specified id and the name corresponding to it. If the id passed is invalid then it throws an IllegalArgumentException. More...

virtual	~PixelResolution ()
	This function is the default destructor for PixelResolution. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static const PixelResolution &	getInstance (int id)
	This function gets the instance of PixelResolution against the specified id, only if the id passed is valid. More...

static const PixelResolution &	getInstance (const std::string &name)

Static Public Attributes
static const int	k720x480 = dsVIDEO_PIXELRES_720x480
	Indicates 720x480 video resolution.

static const int	k720x576 = dsVIDEO_PIXELRES_720x576
	Indicates 720x576 video resolution.

static const int	k1280x720 = dsVIDEO_PIXELRES_1280x720
	Indicates 1280x720 video resolution.

static const int	k1920x1080 = dsVIDEO_PIXELRES_1920x1080
	Indicates 1920x1080 video resolution.

static const int	k3840x2160 = dsVIDEO_PIXELRES_3840x2160
	Indicates 3840x2160 video resolution.

static const int	k4096x2160 = dsVIDEO_PIXELRES_4096x2160
	Indicates 4096x2160 video resolution.

static const int	kMax = dsVIDEO_PIXELRES_MAX
	Indicates the maximum number of video resolutions supported.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Constructor & Destructor Documentation

◆ PixelResolution()

device::PixelResolution::PixelResolution ( int id )

This function is a parameterised constructor for PixelResolution. It initializes the instance with the specified id and the name corresponding to it. If the id passed is invalid then it throws an IllegalArgumentException.

Parameters

[in] id Indicates the id for the instance with is used to identify the pixel resolution type.

Returns: None

Definition at line 107 of file pixelResolution.cpp.

◆ ~PixelResolution()

device::PixelResolution::~PixelResolution ( )

virtual

This function is the default destructor for PixelResolution.

Returns: None

Definition at line 125 of file pixelResolution.cpp.

Member Function Documentation

◆ getInstance()

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

static

This function gets the instance of PixelResolution against the specified id, only if the id passed is valid.

Parameters

[in] id Indicates the id against which the PixelResolution instance is required.

Returns: Returns an instance of PixelResolution if the specified id is valid else throws an IllegalArgumentException.

Definition at line 85 of file pixelResolution.cpp.

◆ device::SleepMode

class device::SleepMode

This class extends DSConstant to implement SleepMode. It is used to manage the sleep modes for device settings.

Definition at line 51 of file sleepMode.hpp.

Inheritance diagram for device::SleepMode:

Collaboration diagram for device::SleepMode:

Public Member Functions
List< SleepMode >	getSleepModes ()
	This function is used to get all the platform supported types of sleep modes. More...

	SleepMode (int id)
	This function is a parameterised constructor of SleepMode class. It initializes the SleepMode instance with the id specified and the name corresponding to it. If the id passed is invalid then it throws an IllegalArgumentException. More...

virtual	~SleepMode ()
	This function is the default destructor of SleepMode class. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static SleepMode &	getInstance (int id)
	This function is used to get an instance of SleepMode against the specified id, only if the id passed is valid. More...

static SleepMode &	getInstance (const std::string &name)
	This function gets a SleepMode instance of the type specified by 'name' parameter. More...

Static Public Attributes
static const int	kLightSleep = dsHOST_SLEEP_MODE_LIGHT
	Indicates light sleep mode.

static const int	kDeepSleep = dsHOST_SLEEP_MODE_DEEP
	Indicates deep sleep mode.

static const int	kMax = dsHOST_SLEEP_MODE_MAX
	Indicates maximum number of sleep modes supported.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Constructor & Destructor Documentation

◆ SleepMode()

device::SleepMode::SleepMode ( int id )

This function is a parameterised constructor of SleepMode class. It initializes the SleepMode instance with the id specified and the name corresponding to it. If the id passed is invalid then it throws an IllegalArgumentException.

Parameters

[in] id Indicates the id against which the SleepMode instance is required.

Returns: None

Definition at line 147 of file sleepMode.cpp.

◆ ~SleepMode()

device::SleepMode::~SleepMode ( )

virtual

This function is the default destructor of SleepMode class.

Returns: None

Definition at line 165 of file sleepMode.cpp.

Member Function Documentation

◆ getInstance() [1/2]

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

static

This function is used to get an instance of SleepMode against the specified id, only if the id passed is valid.

Parameters

[in] id Indicates the id against which the SleepMode instance is required. The valid id's are 0 and 1 which indicates light and deep sleep mode respectively.

Returns: Returns an instance of SleepMode against the specified id if the id is valid else throws an IllegalArgumentException.

Definition at line 74 of file sleepMode.cpp.

◆ getInstance() [2/2]

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

static

This function gets a SleepMode instance of the type specified by 'name' parameter.

Parameters

[in] name Indicates the name of the sleep mode whose instance is required. The valid names are "LIGHT_SLEEP" and "DEEP_SLEEP".

Returns: Returns the SleepMode instance of specified type only if the name parameter passed is valid else throws an IllegalArgumentException.

Definition at line 125 of file sleepMode.cpp.

◆ getSleepModes()

List< SleepMode > device::SleepMode::getSleepModes ( )

This function is used to get all the platform supported types of sleep modes.

Returns: Returns sleepModes, which is a list containing all the supported sleep mode id's.

Definition at line 100 of file sleepMode.cpp.

◆ device::StereoScopicMode

class device::StereoScopicMode

This class extentds DSConstant to implement StereoScopicMode. It manages the stereoscopic mode of the video.

Definition at line 50 of file stereoScopicMode.hpp.

Inheritance diagram for device::StereoScopicMode:

Collaboration diagram for device::StereoScopicMode:

Public Member Functions
	StereoScopicMode (int id)
	This function is a parameterised constructor of StereoScopicMode class. It initializes the instance with the specified id and the name corressponding to it. If the id passed is invalid then IllegalArgumentException is thrown. More...

virtual	~StereoScopicMode ()
	This function is the default destructor for StereoScopicMode class. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static const StereoScopicMode &	getInstance (int id)
	This function gets an instance of the StereoScopicMode against the specified id, only if the id passed is valid. More...

static const StereoScopicMode &	getInstance (const std::string &name)

Static Public Attributes
static const int	kUnkown = dsVIDEO_SSMODE_UNKNOWN
	Indicates video stereoscopy of unknown type.

static const int	k2D = dsVIDEO_SSMODE_2D
	Indicates video stereoscopy of type 2D.

static const int	k3DSidebySide = dsVIDEO_SSMODE_3D_SIDE_BY_SIDE
	Indicates video stereoscopy of type 3D Side-by-Side.

static const int	k3dTopAndBottom = dsVIDEO_SSMODE_3D_TOP_AND_BOTTOM
	Indicates video stereoscopy of type 3D top and bottom.

static const int	kMax = dsVIDEO_SSMODE_MAX
	Indicates the maximum number of supported stereoscopy types.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Constructor & Destructor Documentation

◆ StereoScopicMode()

device::StereoScopicMode::StereoScopicMode ( int id )

This function is a parameterised constructor of StereoScopicMode class. It initializes the instance with the specified id and the name corressponding to it. If the id passed is invalid then IllegalArgumentException is thrown.

Parameters

[in] id Indicates the id for the instance created which is used to identify the type of video Stereoscopy like 2D, 3D and so on.

Returns: None

Definition at line 100 of file stereoScopicMode.cpp.

◆ ~StereoScopicMode()

device::StereoScopicMode::~StereoScopicMode ( )

virtual

This function is the default destructor for StereoScopicMode class.

Returns: None

Definition at line 118 of file stereoScopicMode.cpp.

Member Function Documentation

◆ getInstance()

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

static

This function gets an instance of the StereoScopicMode against the specified id, only if the id passed is valid.

Parameters

[in] id Indicates the id of the StereoScopicMode instance required.

Returns: Returns an instance of StereoScopicMode against the specified id only if the id is valid else throws an IllegalArgumentException.

Definition at line 78 of file stereoScopicMode.cpp.

◆ device::UnsupportedOperationException

class device::UnsupportedOperationException

This class extends Exception class to manage unsupported operations in devicesettings.

Definition at line 50 of file unsupportedOperationException.hpp.

Inheritance diagram for device::UnsupportedOperationException:

Collaboration diagram for device::UnsupportedOperationException:

Public Member Functions
	UnsupportedOperationException (const char *msg="Unsupported operation") throw ()
	This function is the default constructor of UnsupportedOperationException class. It creates an exception with the message passed as input. More...

virtual	~UnsupportedOperationException () throw ()
	This function is the default destructor of UnsupportedOperationException class. More...

Public Member Functions inherited from device::Exception
	Exception (const char *msg="No Message for this exception") throw ()
	This function is a parameterised constructor of the class Exception. It initializes the instance with the msg string passed as input parameter. More...

	Exception (int err, const char *msg="No Message for this Exception") throw ()
	This function is a parameterised constructor of the class Exception. It initializes the instance with both message string and the error code passed as input parameter. More...

virtual const std::string &	getMessage () const
	This function is used to get the message string of the exception. More...

virtual int	getCode () const
	This function is used to get the error code of the exception. More...

virtual const char *	what () const throw ()
	This function is overwritten to get the null terminated character sequence of the exception message. More...

virtual	~Exception () throw ()
	This function is the default destructor of Exception class. More...

	Exception (const char *msg="No Message for this exception") throw ()

	Exception (int err, const char *msg="No Message for this Exception") throw ()

virtual const std::string &	getMessage () const

virtual int	getCode () const

virtual const char *	what () const throw ()

Constructor & Destructor Documentation

◆ UnsupportedOperationException()

device::UnsupportedOperationException::UnsupportedOperationException	(	const char *	msg = `"Unsupported operation"`	)
throw	(
	)

inline

This function is the default constructor of UnsupportedOperationException class. It creates an exception with the message passed as input.

Parameters

[in] msg Indicates the message string with which exception needs to be thrown.

Returns: None

Definition at line 62 of file unsupportedOperationException.hpp.

◆ ~UnsupportedOperationException()

device::UnsupportedOperationException::~UnsupportedOperationException	(	)
throw	(
	)

inlinevirtual

This function is the default destructor of UnsupportedOperationException class.

Returns: none

Definition at line 71 of file unsupportedOperationException.hpp.

◆ device::VideoDevice

class device::VideoDevice

class extending DSConstant to implement the videoDevice interface.

Definition at line 53 of file videoDevice.hpp.

Inheritance diagram for device::VideoDevice:

Collaboration diagram for device::VideoDevice:

Public Member Functions
	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...

void	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	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	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 &	getDFC ()
	This API is used to get the current DFC setting. More...

const List< VideoDFC >	getSupportedDFCs () const
	This API is used to get the list of supported DFC (i.e. Zoom Settings) by the video device. More...

void	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...

virtual	~VideoDevice ()
	This is a default destructor of the class VideoDevice. More...

void	getHDRCapabilities (int *capabilities)

void	getSettopSupportedResolutions (std::list< std::string > &stbSupportedResoltuions)

unsigned int	getSupportedVideoCodingFormats () const

dsVideoCodecInfo_t	getVideoCodecInfo (dsVideoCodingFormat_t format) const

int	forceDisableHDRSupport (bool disable)

int	getFRFMode (int *frfmode) const

int	setFRFMode (int frfmode) const

int	getCurrentDisframerate (char *framerate) const

int	setDisplayframerate (const char *framerate) const

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static 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...

static VideoDevice &	getInstance (const std::string &name)

Private Member Functions
void	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	setDFC ()
	This API is used to set the default dfc. More...

Private Attributes
intptr_t	_handle

int	_dfc
	Decoder format converter variable.

List< VideoDFC >	_supportedDFCs
	List of supported dfc's.

Static Private Attributes
static const char *	kPropertyDFC = ".DFC"

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

◆ device::VideoDFC

class device::VideoDFC

This class extends DSConstant to manage the video Decoder Format Conversion.

Definition at line 50 of file videoDFC.hpp.

Inheritance diagram for device::VideoDFC:

Collaboration diagram for device::VideoDFC:

Public Member Functions
	VideoDFC (int id)
	This function is a parameterised constructor. It initializes the instance with the id provided and the name corresponding to the id. If the id passed is invalid then it throws an IllegalArgumentException. More...

virtual	~VideoDFC ()
	This function is the default destructor for VideoDFC. More...

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static const VideoDFC &	getInstance (int id)
	This function gets an instance of VideoDFC against the id specified, only if the id passed is valid. More...

static const VideoDFC &	getInstance (const std::string &name)
	This function gets an instance of VideoDFC against the name specified, only if the name passed is valid. More...

Static Public Attributes
static const int	kUnknown = dsVIDEO_ZOOM_UNKNOWN
	Indicates decoder format of type unknown.

static const int	kNone = dsVIDEO_ZOOM_NONE
	Indicates decoder format of type none.

static const int	kFull = dsVIDEO_ZOOM_FULL
	Indicates decoder format of type full.

static const int	kLetterBox_16x9 = dsVIDEO_ZOOM_LB_16_9
	Indicates decoder format of type letter box with 16:9 aspect ratio.

static const int	kLetterBox_14x9 = dsVIDEO_ZOOM_LB_14_9
	Indicates decoder format of type letter box with 14:9 aspect ratio.

static const int	kCCO = dsVIDEO_ZOOM_CCO
	Indicates center cut out decoder format.

static const int	kPanScan = dsVIDEO_ZOOM_PAN_SCAN
	Indicates decoder format of type pan and scan.

static const int	kLetterBox_221x1ON4x3 = dsVIDEO_ZOOM_LB_2_21_1_ON_4_3
	Indicates decoder format of type letter box 2:21:1 in a 4:3 video frame.

static const int	kLetterBox_221x1ON16x9 = dsVIDEO_ZOOM_LB_2_21_1_ON_16_9
	Indicates decoder format of type letter box 2:21:1 in a 16:9 video frame.

static const int	kPlatform = dsVIDEO_ZOOM_PLATFORM
	Indicates decoding format conversion will be managed by the platform.

static const int	kZoom_16x9 = dsVIDEO_ZOOM_16_9_ZOOM
	Indicates decoder format of type 16:9 zoom.

static const int	kPillarBox_4x3 = dsVIDEO_ZOOM_PILLARBOX_4_3
	Indicates decoder format of type pillar box 4:3.

static const int	kWideScreen_4x3 = dsVIDEO_ZOOM_WIDE_4_3
	Indicates decoder format of type 4:3 wide.

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Constructor & Destructor Documentation

◆ VideoDFC()

device::VideoDFC::VideoDFC ( int id )

This function is a parameterised constructor. It initializes the instance with the id provided and the name corresponding to the id. If the id passed is invalid then it throws an IllegalArgumentException.

Parameters

[in] id Indicates the id for the instance which is used to identify the video zoom type. For instance id indicates letterbox_16x9 and so on.

Returns: None.

Definition at line 139 of file videoDFC.cpp.

◆ ~VideoDFC()

device::VideoDFC::~VideoDFC ( )

virtual

This function is the default destructor for VideoDFC.

Returns: None

Definition at line 157 of file videoDFC.cpp.

Member Function Documentation

◆ getInstance() [1/2]

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

static

This function gets an instance of VideoDFC against the id specified, only if the id passed is valid.

Parameters

[in] id Indicates the id for which the corresponding VideoDFC instance is required.

Returns: Returns an instance of VideoDFC only if the specified id is valid else throws an IllegalArgumentException.

Definition at line 95 of file videoDFC.cpp.

◆ getInstance() [2/2]

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

static

This function gets an instance of VideoDFC against the name specified, only if the name passed is valid.

Parameters

[in] name Indicates the name of the instance required.

Returns: Returns an instance of VideoDFC only if the specified id is valid else throws an IllegalArgumentException.

Definition at line 116 of file videoDFC.cpp.

◆ device::VideoOutputPort

class device::VideoOutputPort

Class extending enumerable to implement the videoooutputport interface.

Definition at line 59 of file videoOutputPort.hpp.

Inheritance diagram for device::VideoOutputPort:

Collaboration diagram for device::VideoOutputPort:

Public Member Functions
	VideoOutputPort (const int type, const int index, const int id, int audioPortId, const std::string &resolution)
	This function is a parameterised constructor for videooutputport. It initialises the data members of VideoOutputPort instance with the parameters passed. It also updates the details about the video port to indicate if the video port is enabled or not and also if its connected to the display or not. An IllegalArgumentException is thrown if any error occurs while accessing the information about the video port. More...

virtual	~VideoOutputPort ()
	This is a default destructor of class VideoOutputPort. More...

const VideoOutputPortType &	getType () const
	This API is used to get the type of the video output port. A type of the video output port represent the general capabilities of the port. More...

int	getId () const
	This function returns the video output port id. More...

const std::string &	getName () const
	This API gets the name of the VideoOutputPort. The VideoOutputPort names can be HDMI, RF, Component etc... which are created and used by the implementation to uniquely identify them. More...

int	getIndex () const
	This function returns the index of the video output port. More...

AudioOutputPort &	getAudioOutputPort ()
	This API is used to get the audio output port connected to the video output port. This connection is established during library initialization and cannot be modified. An Video port is connected to at most one Audio port. An Audio port however can be connected to multiple Video ports. UnsupportedOperationException will be thrown if the this Video Output Port is not connected to any Audio Output Port (i.e. on a Video-only device) More...

const VideoResolution &	getResolution ()
	This API is used to get the current video resolution output from the video output port. Upon library initialization, the resolution from the persistence storage will be loaded as the initial Resolution for the video output port. More...

const VideoResolution &	getDefaultResolution () const
	This API is used to get the default resolution supported by the video output port. More...

const VideoOutputPort::Display &	getDisplay ()
	This API is used to get the display device information currently connected to the output port. Application can use isDisplayConnected() to query the display connection status before trying to get an instance of the display. More...

bool	isDisplayConnected () const
	This API is used to Check if the port is currently connected to any display device. More...

bool	isContentProtected () const
	This API is used to Check if the port or the content output on the port has DTCP or HDCP in use. More...

bool	isEnabled () const
	This API is used to check whether this Video output port is enabled or not. More...

bool	isActive () const
	This API is used to check if Port is connected to active port of Sink device. More...

bool	isDynamicResolutionSupported () const
	This API is used to check whether the video output port supports the dynamic super resolution or not. More...

void	setAudioPort (int id)
	This function set the audio output port id. More...

void	setResolution (const std::string &resolution, bool persist=true, bool isIgnoreEdid=false)
	This API is used to set the output resolution of the port by ID or its Name. The specified resolution must be one of the resolutions supported by the port. The list of supported resolutions can be retrieved via VideoOutputPortType:: getSupportedResolutions(); IllegalArgumentException will be thrown if the specified name or ID of the resolution is not recognized. More...

void	setDisplayConnected (const bool connected)
	This API is used to set the video output port display to be connected. More...

void	enable ()
	This API is used to enable the video output port. More...

void	disable ()
	This API is used to disable the Audio output port. More...

int	getHDCPStatus ()

int	getHDCPProtocol ()

int	getHDCPReceiverProtocol ()

int	getHDCPCurrentProtocol ()

void	getTVHDRCapabilities (int *capabilities) const
	This API is used to get HDR format supported by TV. More...

void	getSupportedTvResolutions (int *resolutions) const
	This API is used to get TV supported Video Resolutions. More...

int	forceDisable4KSupport (bool disable)

bool	setForceHDRMode (dsHDRStandard_t status)
	This API is used to set/reset force HDR mode. More...

bool	IsOutputHDR ()
	This API is used to check if Video output is HDR or not. More...

void	ResetOutputToSDR ()
	This API is used to reset the video output to SDR if it is HDR. More...

bool	SetHdmiPreference (dsHdcpProtocolVersion_t hdcpProtocol)
	This API is used to set the Preferred HDMI Protocol. More...

int	GetHdmiPreference ()
	This API is used to get the HDMI Preference. More...

bool	setScartParameter (const std::string parameter, const std::string value)

int	getVideoEOTF () const

int	getMatrixCoefficients () const

int	getColorSpace () const

int	getColorDepth () const

int	getQuantizationRange () const

void	getCurrentOutputSettings (int &videoEOTF, int &matrixCoefficients, int &colorSpace, int &colorDepth, int &quantizationRange) const

const unsigned int	getPreferredColorDepth (bool persist=true)

void	setPreferredColorDepth (const unsigned int colordepth, bool persist=true)

void	getColorDepthCapabilities (unsigned int *capabilities) const

Static Public Member Functions
static VideoOutputPort &	getInstance (int id)
	This API is used to get the instance of the video output port based on the port id returned by the getsupported videooutput port. More...

static VideoOutputPort &	getInstance (const std::string &name)
	This API is used to get the instance of the video output port based on the port name returned by the getsupported videooutput port. More...

Private Attributes
int	_type
	VideooOtputPortType.

int	_index
	Index of the video.

int	_id
	Port id.

intptr_t	_handle

std::string	_name

bool	_enabled
	Method variable to check whether VideoPort is enabled or not.

bool	_contentProtected
	Method variable tO check whether videoport is content protected or not.

bool	_displayConnected
	Method variable to check whether the video display is connected or not.

int	_aPortId

std::string	_defaultResolution

std::string	_resolution

Display	_display

Static Private Attributes
static const char *	kPropertyResolution = ".resolution"

Member Function Documentation

◆ getId()

int device::VideoOutputPort::getId ( ) const

inline

This function returns the video output port id.

Returns: id Video Output port id.

Definition at line 215 of file videoOutputPort.hpp.

◆ getName()

device::VideoOutputPort::getName ( ) const

inline

This API gets the name of the VideoOutputPort. The VideoOutputPort names can be HDMI, RF, Component etc... which are created and used by the implementation to uniquely identify them.

Returns: _name Indicates the name of the VideoOutputPort

Definition at line 225 of file videoOutputPort.hpp.

◆ getIndex()

int device::VideoOutputPort::getIndex ( ) const

inline

This function returns the index of the video output port.

Returns: index Index of the video output port.

Definition at line 234 of file videoOutputPort.hpp.

◆ setAudioPort()

void device::VideoOutputPort::setAudioPort ( int id )

inline

This function set the audio output port id.

Parameters

[in] id Audio Output port id.

Returns: None.

Definition at line 255 of file videoOutputPort.hpp.

◆ device::VideoOutputPortType

class device::VideoOutputPortType

Class extending DSConstant to implement the VideoOutputporttype interface.

Definition at line 59 of file videoOutputPortType.hpp.

Inheritance diagram for device::VideoOutputPortType:

Collaboration diagram for device::VideoOutputPortType:

Public Member Functions
	VideoOutputPortType (const int id)

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

int	getTypeId () const

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

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

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

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

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

const VideoResolution &	getOutputResolution (const VideoResolution &inputResolution) const

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

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

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

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

void	addResolution (const VideoResolution &resolution)

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

Public Member Functions inherited from device::DSConstant
	DSConstant ()
	This function is the default constructor for DSConstant. It initializes the DSConstant instance with default values. More...

	DSConstant (const int id, const std::string &name)
	This function is a parameterised constructor for DSConstant. It initializes the DSConstant instance with the values passed as input parameter. More...

virtual	~DSConstant ()
	This function is the default destructor for DSConstant. More...

virtual bool	operator== (int id) const
	This function is an operator overloading for == operator. It checks if the id of DSConstant instance is equal to the id passed as input parameter. More...

virtual int	getId () const
	This function is used to get the id. More...

virtual const std::string &	getName () const
	This function is used to the get the data member name. More...

virtual const std::string &	toString () const
	This function is used to the get the data member name in string format. More...

void	enable ()
	This function is used to indicate that the port or port attribute calling this function are enabled. More...

bool	isEnabled () const
	This function is used to check if the calling object is enabled or not. The calling object can be an instance of video output port or audio output port or their attributes. More...

Static Public Member Functions
static 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 &	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...

Static Public Attributes
static const int	kRF = dsVIDEOPORT_TYPE_RF

static const int	kBaseband = dsVIDEOPORT_TYPE_BB

static const int	kSVideo = dsVIDEOPORT_TYPE_SVIDEO

static const int	k1394 = dsVIDEOPORT_TYPE_1394

static const int	kDVI = dsVIDEOPORT_TYPE_DVI

static const int	kComponent = dsVIDEOPORT_TYPE_COMPONENT

static const int	kHDMI = dsVIDEOPORT_TYPE_HDMI

static const int	kInternal = dsVIDEOPORT_TYPE_INTERNAL

static const int	kScart = dsVIDEOPORT_TYPE_SCART

static const int	kMax = dsVIDEOPORT_TYPE_MAX

Private Attributes
bool	_dtcpSupported
	Method variable to check whether dtcp is supported or not.

bool	_hdcpSupported
	Method variable to check whether hdcp is supported o rnot.

bool	_dynamic
	Method variable to check whether dynamic resolution is supported or not.

int	_restrictedResolution

List< VideoResolution >	_supportedResolutions

List< VideoOutputPort >	_vPorts

Additional Inherited Members
Static Protected Member Functions inherited from device::DSConstant
static bool	isValid (int min, int max, int val)
	This function checks if the given value lies between min and max values provided. More...

Protected Attributes inherited from device::DSConstant
int	_id
	Indicates the id of the instance inheriting this class.

std::string	_name
	Indicates the name string of the instance inheriting this class.

Description

Data Structures

Data Structure Documentation

◆ device::VideoResolution

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

◆ device::AspectRatio

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ AspectRatio()

◆ ~AspectRatio()

Member Function Documentation

◆ getInstance() [1/2]

◆ getInstance() [2/2]

◆ device::AudioCompression

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ AudioCompression()

◆ ~AudioCompression()

Member Function Documentation

◆ getInstance() [1/2]

◆ getInstance() [2/2]

◆ device::AudioEncoding

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

◆ device::AudioOutputPort

Public Member Functions

Static Public Member Functions

Private Attributes

Member Function Documentation

◆ getName()

◆ device::AudioOutputPortType

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

◆ device::AudioStereoMode

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ AudioStereoMode()

◆ ~AudioStereoMode()

Member Function Documentation

◆ getInstance() [1/2]

◆ getInstance() [2/2]

◆ device::DSConstant

Public Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ DSConstant() [1/2]

◆ DSConstant() [2/2]

◆ ~DSConstant()

Member Function Documentation

◆ isValid()

◆ operator==()

◆ getId()

◆ getName()

◆ toString()

◆ enable()

◆ isEnabled()

◆ device::Enumerable

Private Member Functions

Member Function Documentation

◆ getId()

◆ device::Exception