 |
Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
|
|
Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
|
#include <Timers.h>
Public Member Functions | |
| void | SetClientIndex (unsigned int clientIndex) |
| required The index of this timer given by the client. More... | |
| unsigned int | GetClientIndex () const |
| To get with SetClientIndex changed values. More... | |
| void | SetState (PVR_TIMER_STATE state) |
| required The state of this timer. More... | |
| PVR_TIMER_STATE | GetState () const |
| To get with SetState changed values. More... | |
| void | SetTimerType (unsigned int timerType) |
| required The type of this timer. More... | |
| unsigned int | GetTimerType () const |
| To get with SetTimerType changed values. More... | |
| void | SetTitle (const std::string &title) |
| required A title for this timer. More... | |
| std::string | GetTitle () const |
| To get with SetTitle changed values. More... | |
| void | SetParentClientIndex (unsigned int parentClientIndex) |
| optional For timers scheduled by a repeating timer. More... | |
| unsigned int | GetParentClientIndex () const |
| To get with SetParentClientIndex changed values. More... | |
| void | SetClientChannelUid (int clientChannelUid) |
| optional Unique identifier of the channel to record on. More... | |
| int | GetClientChannelUid () const |
| To get with SetClientChannelUid changed values. More... | |
| void | SetStartTime (time_t startTime) |
| optional Start time of the recording in UTC. More... | |
| time_t | GetStartTime () const |
| To get with SetStartTime changed values. More... | |
| void | SetEndTime (time_t endTime) |
| optional End time of the recording in UTC. More... | |
| time_t | GetEndTime () const |
| To get with SetEndTime changed values. More... | |
| void | SetStartAnyTime (bool startAnyTime) |
| optional For EPG based (not Manual) timers indicates startTime does not apply. More... | |
| bool | GetStartAnyTime () const |
| To get with SetStartAnyTime changed values. More... | |
| void | SetEndAnyTime (bool endAnyTime) |
| optional For EPG based (not Manual) timers indicates endTime does not apply. More... | |
| bool | GetEndAnyTime () const |
| To get with SetEndAnyTime changed values. More... | |
| void | SetEPGSearchString (const std::string &epgSearchString) |
| optional A string used to search epg data for repeating epg-based timers. More... | |
| std::string | GetEPGSearchString () const |
| To get with SetEPGSearchString changed values. More... | |
| void | SetFullTextEpgSearch (bool fullTextEpgSearch) |
| optional Indicates, whether SetEPGSearchString() is to match against the epg episode title only or also against "other" epg data (backend-dependent). More... | |
| bool | GetFullTextEpgSearch () const |
| To get with SetFullTextEpgSearch changed values. More... | |
| void | SetDirectory (const std::string &directory) |
| optional The (relative) directory where the recording will be stored in. More... | |
| std::string | GetDirectory () const |
| To get with SetDirectory changed values. More... | |
| void | SetSummary (const std::string &summary) |
| optional The summary for this timer. More... | |
| std::string | GetSummary () const |
| To get with SetDirectory changed values. More... | |
| void | SetPriority (int priority) |
| optional The priority of this timer. More... | |
| int | GetPriority () const |
| To get with SetPriority changed values. More... | |
| void | SetLifetime (int priority) |
| optional Lifetime of recordings created by this timer. More... | |
| int | GetLifetime () const |
| To get with SetLifetime changed values. More... | |
| void | SetMaxRecordings (int maxRecordings) |
| optional Maximum number of recordings this timer shall create. More... | |
| int | GetMaxRecordings () const |
| To get with SetMaxRecordings changed values. More... | |
| void | SetRecordingGroup (unsigned int recordingGroup) |
| optional Integer ref to addon/backend defined list of recording groups. More... | |
| unsigned int | GetRecordingGroup () const |
| To get with SetRecordingGroup changed values. More... | |
| void | SetFirstDay (time_t firstDay) |
| optional The first day this timer is active, for repeating timers. More... | |
| time_t | GetFirstDay () const |
| To get with SetFirstDay changed values. More... | |
| void | SetWeekdays (unsigned int weekdays) |
| optional Week days, for repeating timers (see PVR_WEEKDAY_* constant values) More... | |
| unsigned int | GetWeekdays () const |
| To get with SetFirstDay changed values. More... | |
| void | SetPreventDuplicateEpisodes (unsigned int preventDuplicateEpisodes) |
| optional Prevent duplicate episodes. More... | |
| unsigned int | GetPreventDuplicateEpisodes () const |
| To get with SetPreventDuplicateEpisodes changed values. More... | |
| void | SetEPGUid (unsigned int epgUid) |
| optional EPG event id associated with this timer. Event ids must be unique for a channel. More... | |
| unsigned int | GetEPGUid () const |
| To get with SetEPGUid changed values. More... | |
| void | SetMarginStart (unsigned int marginStart) |
| optional If set, the backend starts the recording selected minutes before SetStartTime. More... | |
| unsigned int | GetMarginStart () const |
| To get with SetMarginStart changed values. More... | |
| void | SetMarginEnd (unsigned int marginEnd) |
| optional If set, the backend ends the recording selected minutes after SetEndTime. More... | |
| unsigned int | GetMarginEnd () const |
| To get with SetMarginEnd changed values. More... | |
| void | SetGenreType (int genreType) |
| optional Genre type. More... | |
| int | GetGenreType () const |
| To get with SetGenreType changed values. More... | |
| void | SetGenreSubType (int genreSubType) |
| optional Genre sub type. More... | |
| int | GetGenreSubType () const |
| To get with SetGenreType changed values. More... | |
| void | SetSeriesLink (const std::string &seriesLink) |
| optional Series link for this timer. More... | |
| std::string | GetSeriesLink () const |
| To get with SetSeriesLink changed values. More... | |
 Public Member Functions inherited from kodi::addon::CStructHdl< PVRTimer, PVR_TIMER > | |
| CStructHdl () | |
| CStructHdl (const PVRTimer &cppClass) | |
| CStructHdl (const PVR_TIMER *cStructure) | |
| CStructHdl (PVR_TIMER *cStructure) | |
| const CStructHdl & | operator= (const CStructHdl &right) |
| const CStructHdl & | operator= (const PVR_TIMER &right) |
| virtual | ~CStructHdl () |
| operator PVR_TIMER * () | |
| operator const PVR_TIMER * () const | |
| const PVR_TIMER * | GetCStructure () const |
Friends | |
| class | CInstancePVRClient |
Additional Inherited Members | |
| Protected Attributes inherited from kodi::addon::CStructHdl< PVRTimer, PVR_TIMER > | |
| PVR_TIMER * | m_cStructure |
|
friend |
1.9.2