DVBLink Remote API Library documentation
0.2.0-Master
|
Class for add manual schedule requests. More...
Public Member Functions | |
AddManualScheduleRequest (const std::string &channelId, const long startTime, const long duration, const long dayMask, const std::string &title="") | |
Initializes a new instance of the dvblinkremote::AddManualScheduleRequest class. | |
~AddManualScheduleRequest () | |
Destructor for cleaning up allocated memory. | |
Public Member Functions inherited from dvblinkremote::ManualSchedule | |
ManualSchedule (const std::string &channelId, const long startTime, const long duration, const long dayMask, const std::string &title="") | |
Initializes a new instance of the dvblinkremote::ManualSchedule class. | |
ManualSchedule (const std::string &id, const std::string &channelId, const long startTime, const long duration, const long dayMask, const std::string &title="") | |
Initializes a new instance of the dvblinkremote::ManualSchedule class. | |
virtual | ~ManualSchedule ()=0 |
Pure virtual destructor for cleaning up allocated memory. | |
long | GetStartTime () |
Gets the start time for the manual schedule request. | |
long | GetDuration () |
Gets the duration for the manual schedule request. | |
long | GetDayMask () |
Gets the day bitmask for the manual schedule request. | |
Public Member Functions inherited from dvblinkremote::Schedule | |
Schedule (const DVBLinkScheduleType scheduleType, const std::string &channelId, const int recordingsToKeep=0) | |
Initializes a new instance of the dvblinkremote::Schedule class. | |
Schedule (const DVBLinkScheduleType scheduleType, const std::string &id, const std::string &channelId, const int recordingsToKeep=0) | |
Initializes a new instance of the dvblinkremote::Schedule class. | |
virtual | ~Schedule ()=0 |
Pure virtual destructor for cleaning up allocated memory. | |
std::string & | GetID () |
Gets the identifier of the schedule. | |
std::string & | GetChannelID () |
Gets the channel identifier for the schedule. | |
DVBLinkScheduleType & | GetScheduleType () |
Gets the type for the schedule . |
Additional Inherited Members | |
Public Types inherited from dvblinkremote::ManualSchedule | |
enum | DVBLinkManualScheduleDayMask { MANUAL_SCHEDULE_DAY_MASK_SUNDAY = 1, MANUAL_SCHEDULE_DAY_MASK_MONDAY = 2, MANUAL_SCHEDULE_DAY_MASK_TUESDAY = 4, MANUAL_SCHEDULE_DAY_MASK_WEDNESDAY = 8, MANUAL_SCHEDULE_DAY_MASK_THURSDAY = 16, MANUAL_SCHEDULE_DAY_MASK_FRIDAY = 32, MANUAL_SCHEDULE_DAY_MASK_SATURDAY = 64, MANUAL_SCHEDULE_DAY_MASK_DAILY = 255 } |
An enum to be used for constructing a bitflag to be used for defining repeated recordings for manual schedules. More... | |
Public Attributes inherited from dvblinkremote::ManualSchedule | |
std::string | Title |
The title of the manual schedule request. |
Class for add manual schedule requests.
This is used as input parameter for the IDVBLinkRemoteConnection::AddSchedule method.
dvblinkremote::AddManualScheduleRequest::AddManualScheduleRequest | ( | const std::string & | channelId, |
const long | startTime, | ||
const long | duration, | ||
const long | dayMask, | ||
const std::string & | title = "" |
||
) |
Initializes a new instance of the dvblinkremote::AddManualScheduleRequest class.
channelId | a constant string reference representing the channel identifier. |
startTime | a constant long representing the start time of the schedule. |
duration | a constant long representing the duration of the schedule. |
dayMask | a constant long representing the day bitflag of the schedule. |
dayMask
parameter by using bitwize operations on the DVBLinkManualScheduleDayMask. title | of schedule |
dvblinkremote::AddManualScheduleRequest::~AddManualScheduleRequest | ( | ) |
Destructor for cleaning up allocated memory.