Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
pvr_timers.h File Reference
#include "pvr_defines.h"
#include <stdbool.h>
#include <stdint.h>
#include <time.h>

Classes

struct  PVR_TIMER
 "C" PVR add-on timer event. More...
 
struct  PVR_TIMER_TYPE
 "C" PVR add-on timer event type. More...
 

Macros

#define PVR_TIMER_TYPE_NONE   0
 Numeric PVR timer type definitions (kodi::addon::PVRTimer::SetTimerType() values).
 
#define PVR_TIMER_NO_CLIENT_INDEX   0
 Special kodi::addon::PVRTimer::SetClientIndex() value to indicate that a timer has not (yet) a valid client index.
 
#define PVR_TIMER_NO_PARENT   PVR_TIMER_NO_CLIENT_INDEX
 Special kodi::addon::PVRTimer::SetParentClientIndex() value to indicate that a timer has no parent.
 
#define PVR_TIMER_NO_EPG_UID   EPG_TAG_INVALID_UID
 Special kodi::addon::PVRTimer::SetEPGUid() value to indicate that a timer has no EPG event uid.
 
#define PVR_TIMER_ANY_CHANNEL   -1
 Special kodi::addon::PVRTimer::SetClientChannelUid() value to indicate "any channel". Useful for some repeating timer types.
 
#define PVR_TIMER_VALUE_NOT_AVAILABLE   -1
 Value where set in background to inform that related part not used.
 

Typedefs

typedef enum PVR_TIMER_TYPES PVR_TIMER_TYPES
 
typedef enum PVR_WEEKDAYS PVR_WEEKDAY
 
typedef enum PVR_TIMER_STATE PVR_TIMER_STATE
 
typedef struct PVR_TIMER PVR_TIMER
 "C" PVR add-on timer event.
 
typedef struct PVR_TIMER_TYPE PVR_TIMER_TYPE
 "C" PVR add-on timer event type.
 

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)
}
 
enum  PVR_WEEKDAYS {
  PVR_WEEKDAY_NONE = 0 , PVR_WEEKDAY_MONDAY = (1 << 0) , PVR_WEEKDAY_TUESDAY = (1 << 1) , PVR_WEEKDAY_WEDNESDAY = (1 << 2) ,
  PVR_WEEKDAY_THURSDAY = (1 << 3) , PVR_WEEKDAY_FRIDAY = (1 << 4) , PVR_WEEKDAY_SATURDAY = (1 << 5) , PVR_WEEKDAY_SUNDAY = (1 << 6) ,
  PVR_WEEKDAY_ALLDAYS
}
 
enum  PVR_TIMER_STATE {
  PVR_TIMER_STATE_NEW = 0 , PVR_TIMER_STATE_SCHEDULED = 1 , PVR_TIMER_STATE_RECORDING = 2 , PVR_TIMER_STATE_COMPLETED = 3 ,
  PVR_TIMER_STATE_ABORTED = 4 , PVR_TIMER_STATE_CANCELLED = 5 , PVR_TIMER_STATE_CONFLICT_OK = 6 , PVR_TIMER_STATE_CONFLICT_NOK = 7 ,
  PVR_TIMER_STATE_ERROR = 8 , PVR_TIMER_STATE_DISABLED = 9
}
 

Typedef Documentation

◆ PVR_TIMER

typedef struct PVR_TIMER PVR_TIMER

"C" PVR add-on timer event.

Structure used to interface in "C" between Kodi and Addon.

See kodi::addon::PVRTimer for description of values.

◆ PVR_TIMER_TYPE

typedef struct PVR_TIMER_TYPE PVR_TIMER_TYPE

"C" PVR add-on timer event type.

Structure used to interface in "C" between Kodi and Addon.

See kodi::addon::PVRTimerType for description of values.