Representation of a timer event. More...

#include <xbmc_pvr_types.h>

Public Attributes
unsigned int	iClientIndex
	(required) the index of this timer given by the client. PVR_TIMER_NO_CLIENT_INDEX indicates that the index was not yet set by the client, for example for new timers created by Kodi and passed the first time to the client. A valid index must be greater than PVR_TIMER_NO_CLIENT_INDEX. More...

unsigned int	iParentClientIndex
	(optional) for timers scheduled by a repeating timer, the index of the repeating timer that scheduled this timer (it's PVR_TIMER.iClientIndex value). Use PVR_TIMER_NO_PARENT to indicate that this timer was no scheduled by a repeating timer. More...

int	iClientChannelUid
	(optional) unique identifier of the channel to record on. PVR_TIMER_ANY_CHANNEL will denote "any channel", not a specific one. PVR_CHANNEL_INVALID_UID denotes that channel uid is not available. More...

time_t	startTime
	(optional) start time of the recording in UTC. Instant timers that are sent to the add-on by Kodi will have this value set to 0. More...

time_t	endTime
	(optional) end time of the recording in UTC. More...

bool	bStartAnyTime
	(optional) for EPG based (not Manual) timers indicates startTime does not apply. Default = false More...

bool	bEndAnyTime
	(optional) for EPG based (not Manual) timers indicates endTime does not apply. Default = false More...

PVR_TIMER_STATE	state
	(required) the state of this timer More...

unsigned int	iTimerType
	(required) the type of this timer. It is private to the addon and can be freely defined by the addon. The value must be greater than PVR_TIMER_TYPE_NONE. Kodi does not interpret this value (except for checking for PVR_TIMER_TYPE_NONE), but will pass the right id to the addon with every PVR_TIMER instance, thus the addon easily can determine the timer type. More...

char	strTitle [PVR_ADDON_NAME_STRING_LENGTH]
	(required) a title for this timer More...

char	strEpgSearchString [PVR_ADDON_NAME_STRING_LENGTH]
	(optional) a string used to search epg data for repeating epg-based timers. Format is backend-dependent, for example regexp More...

bool	bFullTextEpgSearch
	(optional) indicates, whether strEpgSearchString is to match against the epg episode title only or also against "other" epg data (backend-dependent) More...

char	strDirectory [PVR_ADDON_URL_STRING_LENGTH]
	(optional) the (relative) directory where the recording will be stored in More...

char	strSummary [PVR_ADDON_DESC_STRING_LENGTH]
	(optional) the summary for this timer More...

int	iPriority
	(optional) the priority of this timer More...

int	iLifetime
	(optional) lifetime of recordings created by this timer. > 0 days after which recordings will be deleted by the backend, < 0 addon defined integer list reference, == 0 disabled More...

int	iMaxRecordings
	(optional) maximum number of recordings this timer shall create. > 0 number of recordings, < 0 addon defined integer list reference, == 0 disabled More...

unsigned int	iRecordingGroup
	(optional) integer ref to addon/backend defined list of recording groups More...

time_t	firstDay
	(optional) the first day this timer is active, for repeating timers More...

unsigned int	iWeekdays
	(optional) week days, for repeating timers (see PVR_WEEKDAY_* constant values) More...

unsigned int	iPreventDuplicateEpisodes
	(optional) 1 if backend should only record new episodes in case of a repeating epg-based timer, 0 if all episodes shall be recorded (no duplicate detection). Actual algorithm for duplicate detection is defined by the backend. Addons may define own values for different duplicate detection algorithms, thus this is not just a bool. More...

unsigned int	iEpgUid
	(optional) EPG event id associated with this timer. Event ids must be unique for a channel. Valid ids must be greater than EPG_TAG_INVALID_UID. More...

unsigned int	iMarginStart
	(optional) if set, the backend starts the recording iMarginStart minutes before startTime. More...

unsigned int	iMarginEnd
	(optional) if set, the backend ends the recording iMarginEnd minutes after endTime. More...

int	iGenreType
	(optional) genre type More...

int	iGenreSubType
	(optional) genre sub type More...

char	strSeriesLink [PVR_ADDON_URL_STRING_LENGTH]
	(optional) series link for this timer. If set for an epg-based timer rule, matching events will be found by checking strSeriesLink instead of strTitle (and bFullTextEpgSearch) More...

Detailed Description

Representation of a timer event.

Member Data Documentation

◆ bEndAnyTime

bool PVR_TIMER::bEndAnyTime

(optional) for EPG based (not Manual) timers indicates endTime does not apply. Default = false

◆ bFullTextEpgSearch

bool PVR_TIMER::bFullTextEpgSearch

(optional) indicates, whether strEpgSearchString is to match against the epg episode title only or also against "other" epg data (backend-dependent)

◆ bStartAnyTime

bool PVR_TIMER::bStartAnyTime

(optional) for EPG based (not Manual) timers indicates startTime does not apply. Default = false

◆ endTime

time_t PVR_TIMER::endTime

(optional) end time of the recording in UTC.

◆ firstDay

time_t PVR_TIMER::firstDay

(optional) the first day this timer is active, for repeating timers

◆ iClientChannelUid

int PVR_TIMER::iClientChannelUid

(optional) unique identifier of the channel to record on. PVR_TIMER_ANY_CHANNEL will denote "any channel", not a specific one. PVR_CHANNEL_INVALID_UID denotes that channel uid is not available.

◆ iClientIndex

unsigned int PVR_TIMER::iClientIndex

(required) the index of this timer given by the client. PVR_TIMER_NO_CLIENT_INDEX indicates that the index was not yet set by the client, for example for new timers created by Kodi and passed the first time to the client. A valid index must be greater than PVR_TIMER_NO_CLIENT_INDEX.

◆ iEpgUid

unsigned int PVR_TIMER::iEpgUid

(optional) EPG event id associated with this timer. Event ids must be unique for a channel. Valid ids must be greater than EPG_TAG_INVALID_UID.

◆ iGenreSubType

int PVR_TIMER::iGenreSubType

(optional) genre sub type

◆ iGenreType

int PVR_TIMER::iGenreType

(optional) genre type

◆ iLifetime

int PVR_TIMER::iLifetime

(optional) lifetime of recordings created by this timer. > 0 days after which recordings will be deleted by the backend, < 0 addon defined integer list reference, == 0 disabled

◆ iMarginEnd

unsigned int PVR_TIMER::iMarginEnd

(optional) if set, the backend ends the recording iMarginEnd minutes after endTime.

◆ iMarginStart

unsigned int PVR_TIMER::iMarginStart

(optional) if set, the backend starts the recording iMarginStart minutes before startTime.

◆ iMaxRecordings

int PVR_TIMER::iMaxRecordings

(optional) maximum number of recordings this timer shall create. > 0 number of recordings, < 0 addon defined integer list reference, == 0 disabled

◆ iParentClientIndex

unsigned int PVR_TIMER::iParentClientIndex

(optional) for timers scheduled by a repeating timer, the index of the repeating timer that scheduled this timer (it's PVR_TIMER.iClientIndex value). Use PVR_TIMER_NO_PARENT to indicate that this timer was no scheduled by a repeating timer.

◆ iPreventDuplicateEpisodes

unsigned int PVR_TIMER::iPreventDuplicateEpisodes

(optional) 1 if backend should only record new episodes in case of a repeating epg-based timer, 0 if all episodes shall be recorded (no duplicate detection). Actual algorithm for duplicate detection is defined by the backend. Addons may define own values for different duplicate detection algorithms, thus this is not just a bool.

◆ iPriority

int PVR_TIMER::iPriority

(optional) the priority of this timer

◆ iRecordingGroup

unsigned int PVR_TIMER::iRecordingGroup

(optional) integer ref to addon/backend defined list of recording groups

◆ iTimerType

unsigned int PVR_TIMER::iTimerType

(required) the type of this timer. It is private to the addon and can be freely defined by the addon. The value must be greater than PVR_TIMER_TYPE_NONE. Kodi does not interpret this value (except for checking for PVR_TIMER_TYPE_NONE), but will pass the right id to the addon with every PVR_TIMER instance, thus the addon easily can determine the timer type.

◆ iWeekdays

unsigned int PVR_TIMER::iWeekdays

(optional) week days, for repeating timers (see PVR_WEEKDAY_* constant values)

◆ startTime

time_t PVR_TIMER::startTime

(optional) start time of the recording in UTC. Instant timers that are sent to the add-on by Kodi will have this value set to 0.

◆ state

PVR_TIMER_STATE PVR_TIMER::state

(required) the state of this timer

◆ strDirectory

char PVR_TIMER::strDirectory[PVR_ADDON_URL_STRING_LENGTH]

(optional) the (relative) directory where the recording will be stored in

◆ strEpgSearchString

char PVR_TIMER::strEpgSearchString[PVR_ADDON_NAME_STRING_LENGTH]

(optional) a string used to search epg data for repeating epg-based timers. Format is backend-dependent, for example regexp

◆ strSeriesLink

char PVR_TIMER::strSeriesLink[PVR_ADDON_URL_STRING_LENGTH]

(optional) series link for this timer. If set for an epg-based timer rule, matching events will be found by checking strSeriesLink instead of strTitle (and bFullTextEpgSearch)

◆ strSummary

char PVR_TIMER::strSummary[PVR_ADDON_DESC_STRING_LENGTH]

(optional) the summary for this timer

◆ strTitle

char PVR_TIMER::strTitle[PVR_ADDON_NAME_STRING_LENGTH]

(required) a title for this timer

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

xbmc_pvr_types.h

Public Attributes