Kodi Development  20.0
for Binary and Script based Add-Ons

Inherits CStructHdl< PVRTimer, PVR_TIMER >.

Public Member Functions

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

Friends

class CInstancePVRClient
 

Additional Inherited Members

- Protected Attributes inherited from CStructHdl< PVRTimer, PVR_TIMER >
PVR_TIMERm_cStructure
 

The documentation for this class was generated from the following file: