DVBLink Remote API Library documentation  0.2.0-Master
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
dvblinkremote::Recording Class Reference

Represent a recording. More...

Public Member Functions

 Recording (const std::string &id, const std::string &scheduleId, const std::string &channelId, const Program *program)
 Initializes a new instance of the dvblinkremote::Recording class.
 Recording (Recording &recording)
 Initializes a new instance of the dvblinkremote::Recording class by coping another dvblinkremote::Recording instance.
 ~Recording ()
 Destructor for cleaning up allocated memory.
std::string & GetID ()
 Gets the identifier of the recording.
std::string & GetScheduleID ()
 Gets the schedule identifier of the recording.
std::string & GetChannelID ()
 Gets the channel identifier of the recording.
ProgramGetProgram ()
 Gets the program of the recording.

Public Attributes

bool IsActive
 Represents if the recording is in active state or not.

Detailed Description

Represent a recording.

Constructor & Destructor Documentation

dvblinkremote::Recording::Recording ( const std::string &  id,
const std::string &  scheduleId,
const std::string &  channelId,
const Program program 
)

Initializes a new instance of the dvblinkremote::Recording class.

Parameters
ida constant string reference representing the identifier of the recording.
scheduleIda constant string reference representing the schedule identifier of the recording.
channelIda constant string reference representing the channel identifier of the recording.
programa constant dvblinkremote::Program instance pointer representing the program of the recording.
dvblinkremote::Recording::Recording ( Recording recording)

Initializes a new instance of the dvblinkremote::Recording class by coping another dvblinkremote::Recording instance.

Parameters
recordinga dvblinkremote::Recording reference.
dvblinkremote::Recording::~Recording ( )

Destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremote::Recording::GetChannelID ( )

Gets the channel identifier of the recording.

Returns
Recording channel identifier
std::string& dvblinkremote::Recording::GetID ( )

Gets the identifier of the recording.

Returns
Recording identifier
Program& dvblinkremote::Recording::GetProgram ( )

Gets the program of the recording.

Returns
Recording program
std::string& dvblinkremote::Recording::GetScheduleID ( )

Gets the schedule identifier of the recording.

Returns
Recording schedule identifier

Member Data Documentation

bool dvblinkremote::Recording::IsActive

Represents if the recording is in active state or not.