PVRTimer

Inherits DynamicCStructHdl< PVRTimer, PVR_TIMER >.

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

Static Public Member Functions
static void	AllocResources (const PVR_TIMER *source, PVR_TIMER *target)
static void	FreeResources (PVR_TIMER *target)

Friends
class	CInstancePVRClient

Additional Inherited Members
Protected Attributes inherited from DynamicCStructHdl< PVRTimer, PVR_TIMER >
PVR_TIMER *	m_cStructure

---

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

• /github/workspace/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/pvr/Timers.h