RDK Documentation (Open Sourced RDK Components)
Tuner Activity Interface Classes

Description

Data Structures

class  TRM::Activity
 The Activity class represents the request or granted usage of a tuner. The activity field in the class represents the intended use of the tuner. Supported tuner activity names are: More...
 

Data Structure Documentation

◆ TRM::Activity

class TRM::Activity

The Activity class represents the request or granted usage of a tuner. The activity field in the class represents the intended use of the tuner. Supported tuner activity names are:

  • Live: the tuner is used for Live (Live Streaming or Local Live)
  • Record: The tuner is used for Recording.
  • Hybrid: the tuner is reserved for Live and Record activity.
  • EAS: The tuner is used for EAS When tuner sharing is allowed among these activities, a tuner may be reserved for multiple activities at a time. This is indicated by the state of the tuner. However, a single Tuner Reservation message can contain at most one activity. The details filed which contains in the class is optional.

Definition at line 92 of file Activity.h.

Collaboration diagram for TRM::Activity:
Collaboration graph

Public Types

typedef int EnumType
 

Public Member Functions

 Activity (const Enum< Activity > &activity=kNone)
 
 Activity (const char *)
 
const Enum< Activity > & getActivity (void) const
 This function is used to return the request or granted usage of tuner. The Activity field represents the intended use of the tuner. More...
 
bool hasDetails (void) const
 This function is used to return true if the activity has the detailed field describing the activity, otherwise the function will return false. More...
 
const std::string & getDetail (const std::string &key) const
 This function will get the details of the recording. Each activity may be associated with a set of details describing the tuner activity. More...
 
const std::map< KeyT, ValT > & getDetails (void) const
 
void addDetail (const std::string &key, const std::string &value)
 This API is used to add the details describing the activity in to a list. More...
 
bool operator== (const Activity &that) const
 
void print (void) const
 Print the list of recording(s) details which are being scheduled. The defined fields are,. More...
 

Static Public Member Functions

static const char * klassName (void)
 
static const std::vector< const Enum< Activity > * > & getEnums (void)
 

Data Fields

const typedef std::string KeyT
 
const typedef std::string ValT
 

Static Public Attributes

static const Enum< ActivitykNone
 
static const Enum< ActivitykLive
 
static const Enum< ActivitykRecord
 
static const Enum< ActivitykEAS
 

Private Attributes

Enum< Activityactivity
 
std::map< KeyT, ValT > details