Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages

PVR timer various different definitions
This mostly used on kodi::addon::PVRTimer to define default or not available. 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.
 

Detailed Description

PVR timer various different definitions
This mostly used on kodi::addon::PVRTimer to define default or not available.

Macro Definition Documentation

◆ PVR_TIMER_ANY_CHANNEL

#define PVR_TIMER_ANY_CHANNEL   -1

Special kodi::addon::PVRTimer::SetClientChannelUid() value to indicate "any channel". Useful for some repeating timer types.

denotes "any channel", not a specific one.

◆ PVR_TIMER_NO_CLIENT_INDEX

#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.

Timer has not (yet) a valid client index.

◆ PVR_TIMER_NO_EPG_UID

#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.

Timer has no EPG event unique identifier.

◆ PVR_TIMER_NO_PARENT

#define PVR_TIMER_NO_PARENT   PVR_TIMER_NO_CLIENT_INDEX

Special kodi::addon::PVRTimer::SetParentClientIndex() value to indicate that a timer has no parent.

Timer has no parent; it was not scheduled by a repeating timer.

◆ PVR_TIMER_TYPE_NONE

#define PVR_TIMER_TYPE_NONE   0

Numeric PVR timer type definitions (kodi::addon::PVRTimer::SetTimerType() values).

"Null" value for a numeric timer type.

◆ PVR_TIMER_VALUE_NOT_AVAILABLE

#define PVR_TIMER_VALUE_NOT_AVAILABLE   -1

Value where set in background to inform that related part not used.

Normally this related parts need not to set by this as it is default.