RDK Documentation (Open Sourced RDK Components)
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
SubtecConnector.h File Reference

Interface header for libsubtec_connector. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  gsw_CcColor
 Structure to hold color information for CC. More...
 
struct  gsw_CcAttributes
 

Macros

#define GSW_CC_EMBEDDED_COLOR   (0xff000000)
 
#define GSW_CC_COLOR(r, g, b)   ( (((r) & 0xFF) << 16) | (((g) & 0xFF) << 8) | ((b) & 0xFF) )
 
#define GSW_MAX_CC_COLOR_NAME_LENGTH   32
 
#define GSW_CC_COLOR_MAX   32
 
#define GSW_CC_MAX_FONT_NAME_LENGTH   128
 
#define GSW_CC_FONT_STYLE_EMBEDDED   "embedded"
 
#define GSW_CC_FONT_STYLE_DEFAULT   "Default"
 
#define GSW_CC_FONT_STYLE_MONOSPACED_SERIF   "MonospacedSerif"
 
#define GSW_CC_FONT_STYLE_PROPORTIONAL_SERIF   "ProportionalSerif"
 
#define GSW_CC_FONT_STYLE_MONOSPACED_SANSSERIF   "MonospacedSansSerif"
 
#define GSW_CC_FONT_STYLE_PROPORTIONAL_SANSSERIF   "ProportionalSansSerif"
 
#define GSW_CC_FONT_STYLE_CASUAL   "Casual"
 
#define GSW_CC_FONT_STYLE_CURSIVE   "Cursive"
 
#define GSW_CC_FONT_STYLE_SMALL_CAPITALS   "SmallCapital"
 

Typedefs

typedef struct gsw_CcColor gsw_CcColor
 
typedef enum gsw_CcType gsw_CcType
 
typedef enum gsw_CcOpacity gsw_CcOpacity
 
typedef enum gsw_CcFontSize gsw_CcFontSize
 
typedef char gsw_CcFontStyle[128]
 
typedef enum gsw_CcTextStyle gsw_CcTextStyle
 
typedef enum gsw_CcBorderType gsw_CcBorderType
 
typedef enum gsw_CcEdgeType gsw_CcEdgeType
 
typedef struct gsw_CcAttributes gsw_CcAttributes
 
typedef enum gsw_CcAttribType gsw_CcAttribType
 
typedef enum _CC_VL_OS_API_RESULT CC_VL_OS_API_RESULT
 
typedef enum gsw_CcAnalogServices gsw_CcAnalogServices
 
typedef int mrcc_Error
 

Enumerations

enum  gsw_CcType
 Closed Captioning type.
 
enum  gsw_CcOpacity
 Closed Captioning Opacity.
 
enum  gsw_CcFontSize
 Closed caption Fontsize.
 
enum  gsw_CcTextStyle
 Closed captioning text styles.
 
enum  gsw_CcBorderType
 Window Border type.
 
enum  gsw_CcEdgeType
 Font Edge type.
 
enum  gsw_CcAttribType
 type of attributes
 
enum  _CC_VL_OS_API_RESULT
 CC API result.
 
enum  CCAnalogChannel_t
 Defines closed captioning analog channels. Each of these channels defines a different service. For example, CC1 is the "Primary Synchronous Caption Service", and CC2 is the "Secondary Synchronous Caption Service". More...
 
enum  gsw_CcAnalogServices
 
enum  CCDigitalChannel_t
 Defines closed captioning digital channels. Each of these channels defines a different service. More...
 
enum  CCStatus_t
 Closed Caption Status values as referred to by Applications. More...
 

Functions

void subtecConnector::resetChannel ()
 
void subtecConnector::close ()
 
mrcc_Error subtecConnector::initHal ()
 
mrcc_Error subtecConnector::initPacketSender ()
 
mrcc_Error subtecConnector::ccMgrAPI::ccShow (void)
 
mrcc_Error subtecConnector::ccMgrAPI::ccHide (void)
 
mrcc_Error subtecConnector::ccMgrAPI::ccSetDigitalChannel (unsigned int channel)
 
mrcc_Error subtecConnector::ccMgrAPI::ccSetAnalogChannel (unsigned int channel)
 
mrcc_Error subtecConnector::ccMgrAPI::ccSetAttributes (gsw_CcAttributes *attrib, short type, gsw_CcType ccType)
 
mrcc_Error subtecConnector::ccMgrAPI::ccGetAttributes (gsw_CcAttributes *attrib, gsw_CcType ccType)
 
mrcc_Error subtecConnector::ccMgrAPI::ccGetCapability (gsw_CcAttribType attribType, gsw_CcType ccType, void **values, unsigned int *size)
 

Variables

static const char * CCSupportedColors_strings []
 
static unsigned long CCSupportedColors []
 

yes

Interface header for libsubtec_connector.

Definition in file SubtecConnector.h.

Data Structure Documentation

◆ gsw_CcColor

struct gsw_CcColor

Structure to hold color information for CC.

Definition at line 43 of file SubtecConnector.h.

Collaboration diagram for gsw_CcColor:
Collaboration graph
Data Fields
int rgb
char name[32]

◆ gsw_CcAttributes

struct gsw_CcAttributes

Definition at line 176 of file SubtecConnector.h.

Collaboration diagram for gsw_CcAttributes:
Collaboration graph
Data Fields
gsw_CcColor charBgColor

character background color

gsw_CcColor charFgColor

character foreground color

gsw_CcColor winColor

window color

gsw_CcOpacity charBgOpacity

background opacity

gsw_CcOpacity charFgOpacity

foreground opacity

gsw_CcOpacity winOpacity

window opacity

gsw_CcFontSize fontSize

font size

gsw_CcFontStyle fontStyle

font style

gsw_CcTextStyle fontItalic

italicized font

gsw_CcTextStyle fontUnderline

underlined font

gsw_CcBorderType borderType

window border type

gsw_CcColor borderColor

window border color

gsw_CcEdgeType edgeType

font edge type

gsw_CcColor edgeColor

font edge color

Enumeration Type Documentation

◆ CCAnalogChannel_t

enum CCAnalogChannel_t

Defines closed captioning analog channels. Each of these channels defines a different service. For example, CC1 is the "Primary Synchronous Caption Service", and CC2 is the "Secondary Synchronous Caption Service".

Enumerator
CCChannel_INCLUSIVE_MINIMUM 

Not set

CCChannel_CC1 

CC1

CCChannel_CC2 

CC2

CCChannel_CC3 

CC3

CCChannel_CC4 

CC4

CCChannel_TEXT1 

Text 1

CCChannel_TEXT2 

Text 2

CCChannel_TEXT3 

Text 3

CCChannel_TEXT4 

Text 4

CCChannel_NONE 

Used to Set Digital channel to none. (Used to Disable Analog CC )

CCChannel_XDS 

XDS

CCChannel_EXCLUSIVE_MAXIMUM 

Exclusive bounds check

Definition at line 248 of file SubtecConnector.h.

◆ gsw_CcAnalogServices

enum gsw_CcAnalogServices
Enumerator
GSW_CC_ANALOG_SERVICE_CC1 

Primary Caption service

GSW_CC_ANALOG_SERVICE_CC2 

Secondary Caption service

GSW_CC_ANALOG_SERVICE_CC3 

Caption 3

GSW_CC_ANALOG_SERVICE_CC4 

Caption 4

GSW_CC_ANALOG_SERVICE_T1 

Text 1

GSW_CC_ANALOG_SERVICE_T2 

Text 2

GSW_CC_ANALOG_SERVICE_T3 

Text 3

GSW_CC_ANALOG_SERVICE_T4 

Text 4

Definition at line 275 of file SubtecConnector.h.

◆ CCDigitalChannel_t

enum CCDigitalChannel_t

Defines closed captioning digital channels. Each of these channels defines a different service.

Enumerator
CCDigitalChannel_DS1 

DS1

CCDigitalChannel_DS2 

DS2

CCDigitalChannel_DS3 

DS3

CCDigitalChannel_DS4 

DS4

CCDigitalChannel_DS5 

DS5

CCDigitalChannel_DS6 

DS6

CCDigitalChannel_DS7 

DS7

CCDigitalChannel_DS8 

DS8

CCDigitalChannel_DS9 

DS9

CCDigitalChannel_DS10 

DS10

CCDigitalChannel_DS11 

DS11

CCDigitalChannel_DS12 

DS12

CCDigitalChannel_DS13 

DS13

CCDigitalChannel_DS14 

DS14

CCDigitalChannel_DS15 

DS15

CCDigitalChannel_DS16 

DS16

CCDigitalChannel_DS17 

DS17

CCDigitalChannel_DS18 

DS18

CCDigitalChannel_DS19 

DS19

CCDigitalChannel_DS20 

DS20

CCDigitalChannel_DS21 

DS21

CCDigitalChannel_DS22 

DS22

CCDigitalChannel_DS23 

DS23

CCDigitalChannel_DS24 

DS24

CCDigitalChannel_DS25 

DS25

CCDigitalChannel_DS26 

DS26

CCDigitalChannel_DS27 

DS27

CCDigitalChannel_DS28 

DS28

CCDigitalChannel_DS29 

DS29

CCDigitalChannel_DS30 

DS30

CCDigitalChannel_DS31 

DS31

CCDigitalChannel_DS32 

DS32

CCDigitalChannel_DS33 

DS33

CCDigitalChannel_DS34 

DS34

CCDigitalChannel_DS35 

DS35

CCDigitalChannel_DS36 

DS36

CCDigitalChannel_DS37 

DS37

CCDigitalChannel_DS38 

DS38

CCDigitalChannel_DS39 

DS39

CCDigitalChannel_DS40 

DS40

CCDigitalChannel_DS41 

DS41

CCDigitalChannel_DS42 

DS42

CCDigitalChannel_DS43 

DS43

CCDigitalChannel_DS44 

DS44

CCDigitalChannel_DS45 

DS45

CCDigitalChannel_DS46 

DS46

CCDigitalChannel_DS47 

DS47

CCDigitalChannel_DS48 

DS48

CCDigitalChannel_DS49 

DS49

CCDigitalChannel_DS50 

DS50

CCDigitalChannel_DS51 

DS51

CCDigitalChannel_DS52 

DS52

CCDigitalChannel_DS53 

DS53

CCDigitalChannel_DS54 

DS54

CCDigitalChannel_DS55 

DS55

CCDigitalChannel_DS56 

DS56

CCDigitalChannel_DS57 

DS57

CCDigitalChannel_DS58 

DS58

CCDigitalChannel_DS59 

DS59

CCDigitalChannel_DS60 

DS60

CCDigitalChannel_DS61 

DS61

CCDigitalChannel_DS62 

DS62

CCDigitalChannel_DS63 

DS63

CCDigitalChannel_NONE 

Used to Set Digital channel to none. (Used to Disable Digital CC.)

CCDigitalChannel_EXCLUSIVE_MAXIMUM 

Exclusive bounds check

Definition at line 292 of file SubtecConnector.h.

◆ CCStatus_t

enum CCStatus_t

Closed Caption Status values as referred to by Applications.

Enumerator
CCStatus_OFF 

Closed Caption Disabled

CCStatus_ON 

Closed Caption Enabled

CCStatus_ON_MUTE 

Closed Caption ON MUTE

Definition at line 365 of file SubtecConnector.h.

Variable Documentation

◆ CCSupportedColors_strings

const char* CCSupportedColors_strings[]
static
Initial value:
= {
"BLACK",
"WHITE",
"RED",
"GREEN",
"BLUE",
"YELLOW",
"MAGENTA",
"CYAN",
"AUTO",
}

Definition at line 89 of file SubtecConnector.h.

◆ CCSupportedColors

unsigned long CCSupportedColors[]
static
Initial value:
= {
0x00000000,
0x00ffffff,
0x00FF0000,
0x0000FF00,
0x000000FF,
0x00FFFF00,
0x00FF00FF,
0x0000FFFF,
0xFF000000,
}

Definition at line 101 of file SubtecConnector.h.