Device Settings - Manager APIs

Description

RDK Device Settings module is a cross-platform device for controlling the following hardware configurations:

• Audio Output Ports (Volume, Mute, etc.)
• Video Ouptut Ports (Resolutions, Aspect Ratio, etc.)
• Front Panel Indicators such as DFC[zoom] Settings, Display (Aspect Ratio, EDID data etc.), General Host configuration (Power managements, event management etc.)

Functions
static void	device::Manager::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	device::Manager::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...

Function Documentation

Initialize()

void device::Manager::Initialize ( )

static

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.

• dsDisplayInit() function must initialize all underlying the video display modules and associated data structures.
• dsAudioPortInit() function must be used to initialize all the audio output ports. Must return NOT_SUPPORTED when no audio port present in the device (ex., Gateway)
• dsVideoPortInit() function must initialize all the video specific output ports.
• dsVideoDeviceInit() function must initialize all the video devices that exists in the system.
• AudioOutputPortConfig::getInstance().load() function will load constants first and initialize Audio portTypes (encodings, compressions etc.) and its port instances (db, level etc).
• VideoOutputPortConfig::getInstance().load() function will load constants first and initialize a set of supported resolutions. Initialize Video portTypes (Only Enable Ports) and its port instances (current resolution)
• VideoDeviceConfig::getInstance().load() function will load constants first and initialize Video Devices (supported DFCs etc.).

IllegalStateException will be thrown by the APIs if the module is not yet initialized.

Returns

None

Definition at line 97 of file manager.cpp.

DeInitialize()

void device::Manager::DeInitialize ( )

static

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.

• dsVideoDeviceTerm() function will reset the data structures used within this module and release the handles specific to video devices.
• dsVideoPortTerm() function will reset the data structures used within this module and release the video port specific handles.
• dsAudioPortTerm() function will terminate the usage of audio output ports by resetting the data structures used within this module and release the audio port specific handles.
• dsDisplayTerm() function will reset the data structures used within this module and release the video display specific handles.
• VideoDeviceConfig::getInstance().release() function releases the DFCs and video device instance.
• VideoOutputPortConfig::getInstance().release() function clears the instance of video pixel resolution, aspect ratio, stereoscopic mode, frameRate, supported Resolution and video port types.
• AudioOutputPortConfig::getInstance().release() function clears the instance of audio encoding, compression, stereo modes and audio port types.

Returns

None

Definition at line 138 of file manager.cpp.