Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches

PVR timer type attributes (kodi::addon::PVRTimerType::SetAttributes() values).
To defines the attributes for a type. These values are bit fields that can be used together. More...

Typedefs

typedef enum PVR_TIMER_TYPES PVR_TIMER_TYPES
 

Enumerations

enum  PVR_TIMER_TYPES {
  PVR_TIMER_TYPE_ATTRIBUTE_NONE = 0 , PVR_TIMER_TYPE_IS_MANUAL = (1 << 0) , PVR_TIMER_TYPE_IS_REPEATING = (1 << 1) , PVR_TIMER_TYPE_IS_READONLY = (1 << 2) ,
  PVR_TIMER_TYPE_FORBIDS_NEW_INSTANCES = (1 << 3) , PVR_TIMER_TYPE_SUPPORTS_ENABLE_DISABLE = (1 << 4) , PVR_TIMER_TYPE_SUPPORTS_CHANNELS = (1 << 5) , PVR_TIMER_TYPE_SUPPORTS_START_TIME = (1 << 6) ,
  PVR_TIMER_TYPE_SUPPORTS_TITLE_EPG_MATCH = (1 << 7) , PVR_TIMER_TYPE_SUPPORTS_FULLTEXT_EPG_MATCH = (1 << 8) , PVR_TIMER_TYPE_SUPPORTS_FIRST_DAY = (1 << 9) , PVR_TIMER_TYPE_SUPPORTS_WEEKDAYS = (1 << 10) ,
  PVR_TIMER_TYPE_SUPPORTS_RECORD_ONLY_NEW_EPISODES = (1 << 11) , PVR_TIMER_TYPE_SUPPORTS_START_END_MARGIN = (1 << 12) , PVR_TIMER_TYPE_SUPPORTS_PRIORITY = (1 << 13) , PVR_TIMER_TYPE_SUPPORTS_LIFETIME = (1 << 14) ,
  PVR_TIMER_TYPE_SUPPORTS_RECORDING_FOLDERS = (1 << 15) , PVR_TIMER_TYPE_SUPPORTS_RECORDING_GROUP = (1 << 16) , PVR_TIMER_TYPE_SUPPORTS_END_TIME = (1 << 17) , PVR_TIMER_TYPE_SUPPORTS_START_ANYTIME = (1 << 18) ,
  PVR_TIMER_TYPE_SUPPORTS_END_ANYTIME = (1 << 19) , PVR_TIMER_TYPE_SUPPORTS_MAX_RECORDINGS = (1 << 20) , PVR_TIMER_TYPE_REQUIRES_EPG_TAG_ON_CREATE = (1 << 21) , PVR_TIMER_TYPE_FORBIDS_EPG_TAG_ON_CREATE = (1 << 22) ,
  PVR_TIMER_TYPE_REQUIRES_EPG_SERIES_ON_CREATE = (1 << 23) , PVR_TIMER_TYPE_SUPPORTS_ANY_CHANNEL = (1 << 24) , PVR_TIMER_TYPE_REQUIRES_EPG_SERIESLINK_ON_CREATE = (1 << 25) , PVR_TIMER_TYPE_SUPPORTS_READONLY_DELETE = (1 << 26) ,
  PVR_TIMER_TYPE_IS_REMINDER = (1 << 27) , PVR_TIMER_TYPE_SUPPORTS_START_MARGIN = (1 << 28) , PVR_TIMER_TYPE_SUPPORTS_END_MARGIN = (1 << 29)
}
 

Detailed Description

PVR timer type attributes (kodi::addon::PVRTimerType::SetAttributes() values).
To defines the attributes for a type. These values are bit fields that can be used together.


Example:

const char struct KODI_ADDON_AUDIODECODER_INFO_TAG * tag
Definition addons/kodi-dev-kit/include/kodi/c-api/addon-instance/AudioDecoder.h:122
Definition Timers.h:530
@ PVR_TIMER_TYPE_IS_REPEATING
0000 0000 0000 0000 0000 0000 0000 0010 : Defines whether this is a type for repeating or one-shot t...
Definition pvr_timers.h:112
@ PVR_TIMER_TYPE_IS_MANUAL
0000 0000 0000 0000 0000 0000 0000 0001 : Defines whether this is a type for manual (time-based) or ...
Definition pvr_timers.h:108

Typedef Documentation

◆ PVR_TIMER_TYPES

Enumeration Type Documentation

◆ PVR_TIMER_TYPES

Enumerator
PVR_TIMER_TYPE_ATTRIBUTE_NONE 

0000 0000 0000 0000 0000 0000 0000 0000 :
Empty attribute value.

PVR_TIMER_TYPE_IS_MANUAL 

0000 0000 0000 0000 0000 0000 0000 0001 :
Defines whether this is a type for manual (time-based) or epg-based timers.

PVR_TIMER_TYPE_IS_REPEATING 

0000 0000 0000 0000 0000 0000 0000 0010 :
Defines whether this is a type for repeating or one-shot timers.

PVR_TIMER_TYPE_IS_READONLY 

0000 0000 0000 0000 0000 0000 0000 0100 :
Timers of this type must not be edited by Kodi.

PVR_TIMER_TYPE_FORBIDS_NEW_INSTANCES 

0000 0000 0000 0000 0000 0000 0000 1000 :
Timers of this type must not be created by Kodi. All other operations are allowed, though.

PVR_TIMER_TYPE_SUPPORTS_ENABLE_DISABLE 

0000 0000 0000 0000 0000 0000 0001 0000 :
This type supports enabling/disabling of the timer (kodi::addon::PVRTimer::SetState() with PVR_TIMER_STATE_SCHEDULED | PVR_TIMER_STATE_DISABLED).

PVR_TIMER_TYPE_SUPPORTS_CHANNELS 

0000 0000 0000 0000 0000 0000 0010 0000 :
This type supports channels (kodi::addon::PVRTimer::SetClientChannelUid()).

PVR_TIMER_TYPE_SUPPORTS_START_TIME 

0000 0000 0000 0000 0000 0000 0100 0000 :
This type supports a recording start time (kodi::addon::PVRTimer::SetStartTime()).

PVR_TIMER_TYPE_SUPPORTS_TITLE_EPG_MATCH 

0000 0000 0000 0000 0000 0000 1000 0000 :
This type supports matching epg episode title usingkodi::addon::PVRTimer::SetEPGSearchString().

PVR_TIMER_TYPE_SUPPORTS_FULLTEXT_EPG_MATCH 

0000 0000 0000 0000 0000 0001 0000 0000 :
This type supports matching "more" epg data (not just episode title) using kodi::addon::PVRTimer::SetEPGSearchString(). Setting PVR_TIMER_TYPE_SUPPORTS_FULLTEXT_EPG_MATCH implies PVR_TIMER_TYPE_SUPPORTS_TITLE_EPG_MATCH.

PVR_TIMER_TYPE_SUPPORTS_FIRST_DAY 

0000 0000 0000 0000 0000 0010 0000 0000 :
This type supports a first day the timer gets active (kodi::addon::PVRTimer::SetFirstDay()).

PVR_TIMER_TYPE_SUPPORTS_WEEKDAYS 

0000 0000 0000 0000 0000 0100 0000 0000 :
This type supports weekdays for defining the recording schedule (kodi::addon::PVRTimer::SetWeekdays()).

PVR_TIMER_TYPE_SUPPORTS_RECORD_ONLY_NEW_EPISODES 

0000 0000 0000 0000 0000 1000 0000 0000 :
This type supports the "record only new episodes" feature (kodi::addon::PVRTimer::SetPreventDuplicateEpisodes()).

PVR_TIMER_TYPE_SUPPORTS_START_END_MARGIN 

0000 0000 0000 0000 0001 0000 0000 0000 :
This type supports pre and post record time (kodi::addon::PVRTimer::SetMarginStart(), kodi::addon::PVRTimer::SetMarginEnd()).

PVR_TIMER_TYPE_SUPPORTS_PRIORITY 

0000 0000 0000 0000 0010 0000 0000 0000 :
This type supports recording priority (kodi::addon::PVRTimer::SetPriority()).

PVR_TIMER_TYPE_SUPPORTS_LIFETIME 

0000 0000 0000 0000 0100 0000 0000 0000 :
This type supports recording lifetime (kodi::addon::PVRTimer::SetLifetime()).

PVR_TIMER_TYPE_SUPPORTS_RECORDING_FOLDERS 

0000 0000 0000 0000 1000 0000 0000 0000 :
This type supports placing recordings in user defined folders (kodi::addon::PVRTimer::SetDirectory()).

PVR_TIMER_TYPE_SUPPORTS_RECORDING_GROUP 

0000 0000 0000 0001 0000 0000 0000 0000 :
This type supports a list of recording groups (kodi::addon::PVRTimer::SetRecordingGroup()).

PVR_TIMER_TYPE_SUPPORTS_END_TIME 

0000 0000 0000 0010 0000 0000 0000 0000 :
This type supports a recording end time (kodi::addon::PVRTimer::SetEndTime()).

PVR_TIMER_TYPE_SUPPORTS_START_ANYTIME 

0000 0000 0000 0100 0000 0000 0000 0000 :
Enables an 'Any Time' over-ride option for start time (using kodi::addon::PVRTimer::SetStartAnyTime()).

PVR_TIMER_TYPE_SUPPORTS_END_ANYTIME 

0000 0000 0000 1000 0000 0000 0000 0000 :
Enables a separate 'Any Time' over-ride for end time (using kodi::addon::PVRTimer::SetEndAnyTime()).

PVR_TIMER_TYPE_SUPPORTS_MAX_RECORDINGS 

0000 0000 0001 0000 0000 0000 0000 0000 :
This type supports specifying a maximum recordings setting' (kodi::addon::PVRTimer::SetMaxRecordings()).

PVR_TIMER_TYPE_REQUIRES_EPG_TAG_ON_CREATE 

0000 0000 0010 0000 0000 0000 0000 0000 :
This type should not appear on any create menus which don't provide an associated EPG tag.

PVR_TIMER_TYPE_FORBIDS_EPG_TAG_ON_CREATE 

0000 0000 0100 0000 0000 0000 0000 0000 :
This type should not appear on any create menus which provide an associated EPG tag.

PVR_TIMER_TYPE_REQUIRES_EPG_SERIES_ON_CREATE 

0000 0000 1000 0000 0000 0000 0000 0000 :
This type should not appear on any create menus unless associated with an EPG tag with 'series' attributes.

Following conditions allow this:

Implies PVR_TIMER_TYPE_REQUIRES_EPG_TAG_ON_CREATE.

PVR_TIMER_TYPE_SUPPORTS_ANY_CHANNEL 

0000 0001 0000 0000 0000 0000 0000 0000 :
This type supports 'any channel', for example when defining a timer rule that should match any channel instead of a particular channel.

PVR_TIMER_TYPE_REQUIRES_EPG_SERIESLINK_ON_CREATE 

0000 0010 0000 0000 0000 0000 0000 0000 :
This type should not appear on any create menus which don't provide an associated EPG tag with a series link.

PVR_TIMER_TYPE_SUPPORTS_READONLY_DELETE 

0000 0100 0000 0000 0000 0000 0000 0000 :
This type allows deletion of an otherwise read-only timer.

PVR_TIMER_TYPE_IS_REMINDER 

0000 1000 0000 0000 0000 0000 0000 0000 :
Timers of this type do trigger a reminder if time is up.

PVR_TIMER_TYPE_SUPPORTS_START_MARGIN 

0001 0000 0000 0000 0000 0000 0000 0000 :
This type supports pre record time (kodi::addon::PVRTimer::SetMarginStart()).

PVR_TIMER_TYPE_SUPPORTS_END_MARGIN 

0010 0000 0000 0000 0000 0000 0000 0000 :
This type supports post record time (kodi::addon::PVRTimer::SetMarginEnd()).