RDK Documentation (Open Sourced RDK Components)

Description

Files

file  audioOutputPort.cpp
 AudioOutputPort objects are instantiated by the Device Settings module upon initialization. Applications do not need to create any such objects on its own. References to these objects can be retrieved by applications via the VideoOutputPort connected to the AudioOutputPort: VideoOutputPort::getAudioOutputPort()
 
file  audioOutputPortType.cpp
 AudioOutputPortType objects are instantiated by the Device Settings module upon initialization. Applications do not need to create any such objects on its own. References to these objects can be retrieved using a AudioOutputPort object invoking AudioOutputPort::getType()
 
file  host.cpp
 The host module is the central module of the Device Settings module. Each devices establishes one and only one host instance that represents the entire host device.
 
file  audioOutputPort.hpp
 It contain variables,stuctures,class and functions referenced by audiooutputport code.
 
file  audioOutputPortType.hpp
 It contain variables,stuctures,class and functions referenced by audiooutputportType code.
 
file  compositeIn.hpp
 Structures and classes for COMPOSITE Input are defined here.
 
file  frontPanelConfig.hpp
 Structures and classes to manage front panel are defined here.
 
file  frontPanelIndicator.hpp
 Structures and classes for front panel indicator are defined here.
 
file  frontPanelTextDisplay.hpp
 Classes and structures for front panel text display are defined here.
 
file  hdmiIn.hpp
 Structures and classes for HDMI Input are defined here.
 
file  host.hpp
 It contains class,structures referenced by host.cpp file.
 
file  manager.hpp
 It contains class referenced by manager.cpp file.
 
file  videoDevice.hpp
 It contains class referenced by videoDevice.cpp file.
 
file  videoOutputPort.hpp
 It contains class and structure refrenced by the videooutputport.cpp file.
 
file  videoOutputPortType.hpp
 It contains structures and class referenced by the videoOutputportTypes.cpp file.
 
file  videoResolution.hpp
 It contains class and structure refrenced by the videoResolution.cpp file.
 
file  manager.cpp
 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 DFC[zoom] Settings Display (Aspect Ratio, EDID data etc.) General Host configuration (Power managements, event management etc.)
 
file  videoDevice.cpp
 Video Device is also called "Decoder". VideoDevice objects are instantiated by the Device Settings module upon initialization. Applications do not need to create any such objects on its own. References to these objects can be retrieved by applications via Host::getVideoDevices()
 
file  videoOutputPort.cpp
 VideoOutputPort objects are instantiated by the Device Settings module upon initialization. Applications do not need to create any such objects on its own. References to the preallocated objects can be retrieved by applications via Host::getVideoOutputPort(const std::string &name). Each VideoOutputPort is associated with an instance of VideoOutputPortType.
 
file  videoOutputPortType.cpp
 VideoOutputPortType objects are instantiated by the Device Settings module upon initialization. Applications do not need to create any such objects on its own. References to these objects can be retrieved using a VideoOutputPort object invoking VideoOutputPort::getType(). A VideoOutputPortType object represent the shared properties of all output ports of same type. Control over a specific instance of Video Output Port is access over a Video Output Port object.
 
file  videoResolution.cpp
 This file defines the videoResolution objects by the device settings module upon intialization.
 

Data Structures

struct  _dsFPDColorConfig_t
 
struct  _dsFPDIndicatorConfig_t
 
struct  _dsFPDTextDisplayConfig_t
 

Macros

#define MAX_LOG_BUFF   500
 
#define INFO_LEVEL   0
 
#define WARN_LEVEL   1
 
#define ERROR_LEVEL   2
 
#define DEBUG_LEVEL   3
 
#define INT_INFO(FORMAT, ...)   ds_log(INFO_LEVEL ,FORMAT, ##__VA_ARGS__ )
 
#define INT_WARN(FORMAT, ...)   ds_log(WARN_LEVEL ,FORMAT, ##__VA_ARGS__ )
 
#define INT_ERROR(FORMAT, ...)   ds_log(ERROR_LEVEL ,FORMAT, ##__VA_ARGS__ )
 
#define INT_DEBUG(FORMAT, ...)   ds_log(DEBUG_LEVEL ,FORMAT, ##__VA_ARGS__ )
 
#define _MAX_BRIGHTNESS   100
 
#define _MIN_BRIGHTNESS   0
 
#define _DEFAULT_LEVELS   10
 
#define _MAX_CYCLERATE   2
 
#define _MAX_HORZ_COLS   0
 
#define _MAX_VERT_ROWS   0
 
#define _MAX_HORZ_ITER   0
 
#define _MAX_VERT_ITER   0
 
#define _DEFAULT_COLOR_MODE   0
 

Typedefs

typedef void(* DS_LogCb) (int priority, const char *)
 
typedef struct _dsFPDColorConfig_t dsFPDColorConfig_t
 
typedef struct _dsFPDIndicatorConfig_t dsFPDIndicatorConfig_t
 
typedef struct _dsFPDTextDisplayConfig_t dsFPDTextDisplayConfig_t
 

Functions

dsError_t dsSetStereoMode (intptr_t handle, dsAudioStereoMode_t mode, bool isPersist)
 
dsError_t dsSetStereoAuto (intptr_t handle, int autoMode, bool isPersist)
 
dsError_t dsGetStereoMode (intptr_t handle, dsAudioStereoMode_t *stereoMode, bool isPersist)
 
dsError_t dsEnableAudioPort (intptr_t handle, bool enabled, const char *portName)
 
dsError_t dsGetEnablePersist (intptr_t handle, const char *portName, bool *enabled)
 
dsError_t dsSetEnablePersist (intptr_t handle, const char *portName, bool enabled)
 
void DS_RegisterForLog (DS_LogCb cb)
 
int ds_log (int priority, const char *format,...)
 
std::string numberToString (int number)
 
int stringToNumber (std::string text)
 
std::string numToStr (int number)
 
int strToNum (std::string text)
 
dsError_t dsEnableHDCP (intptr_t handle, bool contentProtect, char *hdcpKey, size_t keySize)
 

Variables

DS_LogCb logCb = NULL
 
static const int8_t COMPOSITE_IN_PORT_NONE = -1
 
static dsFPDColorConfig_t kIndicatorColors [dsFPD_COLOR_MAX]
 
static const dsFPDIndicatorConfig_t kIndicators []
 
static const dsFPDTextDisplayConfig_t kTextDisplays [dsFPD_TEXTDISP_MAX]
 
static const int8_t HDMI_IN_PORT_NONE = -1
 
static unsigned char m_hostEDID []
 
static char cliName [32]
 

Data Structure Documentation

◆ _dsFPDColorConfig_t

struct _dsFPDColorConfig_t

Definition at line 48 of file frontPanelSettings.hpp.

Collaboration diagram for _dsFPDColorConfig_t:
Collaboration graph
Data Fields
int id
dsFPDColor_t color

◆ _dsFPDIndicatorConfig_t

struct _dsFPDIndicatorConfig_t

Definition at line 54 of file frontPanelSettings.hpp.

Collaboration diagram for _dsFPDIndicatorConfig_t:
Collaboration graph
Data Fields
dsFPDIndicator_t id
dsFPDColorConfig_t * supportedColors
int maxBrightness
int maxCycleRate
int minBrightness
int levels
int colorMode

◆ _dsFPDTextDisplayConfig_t

struct _dsFPDTextDisplayConfig_t

Definition at line 64 of file frontPanelSettings.hpp.

Collaboration diagram for _dsFPDTextDisplayConfig_t:
Collaboration graph
Data Fields
dsFPDTextDisplay_t id
const char * name
dsFPDColorConfig_t * supportedColors
int maxBrightness
int maxCycleRate
const char * supportedCharacters
int columns
int rows
int maxHorizontalIterations
int maxVerticalIterations
int levels
int colorMode

Variable Documentation

◆ kIndicatorColors

dsFPDColorConfig_t kIndicatorColors[dsFPD_COLOR_MAX]
static
Initial value:

Definition at line 79 of file frontPanelSettings.hpp.

◆ kTextDisplays

const dsFPDTextDisplayConfig_t kTextDisplays[dsFPD_TEXTDISP_MAX]
static
Initial value:
= {
{
"Text",
kIndicatorColors,
100 ,
2 ,
"ABCDEFG",
0 ,
0 ,
0 ,
0 ,
10 ,
0
},
}

Definition at line 151 of file frontPanelSettings.hpp.

◆ m_hostEDID

unsigned char m_hostEDID[]
static
Initial value:
=
{
}

Definition at line 36 of file hostEDID.hpp.

dsFPD_COLOR_BLUE
#define dsFPD_COLOR_BLUE
Definition: dsTypes.h:765
dsFPD_COLOR_GREEN
#define dsFPD_COLOR_GREEN
Definition: dsTypes.h:766
dsFPD_COLOR_YELLOW
#define dsFPD_COLOR_YELLOW
Definition: dsTypes.h:768
dsFPD_COLOR_ORANGE
#define dsFPD_COLOR_ORANGE
Definition: dsTypes.h:769
dsFPD_COLOR_RED
#define dsFPD_COLOR_RED
Definition: dsTypes.h:767
dsFPD_TEXTDISP_TEXT
@ dsFPD_TEXTDISP_TEXT
Definition: dsTypes.h:805
dsFPD_COLOR_WHITE
#define dsFPD_COLOR_WHITE
Definition: dsTypes.h:770