PVR add-on timer type
To define the content of kodi::addon::CInstancePVRClient::GetTimerTypes() given groups. More...

Classes
class	kodi::addon::PVRTimerType

Functions
void	kodi::addon::PVRTimerType::SetId (unsigned int id)
	required This type's identifier. Ids must be > PVR_TIMER_TYPE_NONE.

unsigned int	kodi::addon::PVRTimerType::GetId () const
	To get with SetAttributes changed values.

void	kodi::addon::PVRTimerType::SetAttributes (uint64_t attributes)
	required Defines the attributes for this type (PVR_TIMER_TYPE_* constants).

uint64_t	kodi::addon::PVRTimerType::GetAttributes () const
	To get with SetAttributes changed values.

void	kodi::addon::PVRTimerType::SetDescription (const std::string &description)
	optional A short localized string describing the purpose of the type. (e.g. "Any time at this channel if title matches").

std::string	kodi::addon::PVRTimerType::GetDescription () const
	To get with SetDescription changed values.

void	kodi::addon::PVRTimerType::SetPriorities (const std::vector< PVRTypeIntValue > &priorities, int prioritiesDefault=-1)
	optional Priority value definitions.

std::vector< PVRTypeIntValue >	kodi::addon::PVRTimerType::GetPriorities () const
	To get with SetPriorities changed values.

void	kodi::addon::PVRTimerType::SetPrioritiesDefault (int prioritiesDefault)
	optional The default value for PVRTimer::SetPriority().

int	kodi::addon::PVRTimerType::GetPrioritiesDefault () const
	To get with SetPrioritiesDefault changed values.

void	kodi::addon::PVRTimerType::SetLifetimes (const std::vector< PVRTypeIntValue > &lifetimes, int lifetimesDefault=-1)
	optional Lifetime value definitions.

std::vector< PVRTypeIntValue >	kodi::addon::PVRTimerType::GetLifetimes () const
	To get with SetLifetimes changed values.

void	kodi::addon::PVRTimerType::SetLifetimesDefault (int lifetimesDefault)
	optional The default value for SetLifetimes().

int	kodi::addon::PVRTimerType::GetLifetimesDefault () const
	To get with SetLifetimesDefault changed values.

void	kodi::addon::PVRTimerType::SetPreventDuplicateEpisodes (const std::vector< PVRTypeIntValue > &preventDuplicateEpisodes, int preventDuplicateEpisodesDefault=-1)
	optional Prevent duplicate episodes value definitions.

std::vector< PVRTypeIntValue >	kodi::addon::PVRTimerType::GetPreventDuplicateEpisodes () const
	To get with SetPreventDuplicateEpisodes changed values.

void	kodi::addon::PVRTimerType::SetPreventDuplicateEpisodesDefault (int preventDuplicateEpisodesDefault)
	optional The default value for PVRTimer::SetPreventDuplicateEpisodes().

int	kodi::addon::PVRTimerType::GetPreventDuplicateEpisodesDefault () const
	To get with SetPreventDuplicateEpisodesDefault changed values.

void	kodi::addon::PVRTimerType::SetRecordingGroups (const std::vector< PVRTypeIntValue > &recordingGroup, int recordingGroupDefault=-1)
	optional Array containing the possible values of PVRTimer::SetRecordingGroup()

std::vector< PVRTypeIntValue >	kodi::addon::PVRTimerType::GetRecordingGroups () const
	To get with SetRecordingGroups changed values.

void	kodi::addon::PVRTimerType::SetRecordingGroupDefault (int recordingGroupDefault)
	optional The default value for PVRTimer::SetRecordingGroup().

int	kodi::addon::PVRTimerType::GetRecordingGroupDefault () const
	To get with SetRecordingGroupDefault changed values.

void	kodi::addon::PVRTimerType::SetMaxRecordings (const std::vector< PVRTypeIntValue > &maxRecordings, int maxRecordingsDefault=-1)
	optional Array containing the possible values of PVRTimer::SetMaxRecordings().

std::vector< PVRTypeIntValue >	kodi::addon::PVRTimerType::GetMaxRecordings () const
	To get with SetMaxRecordings changed values.

void	kodi::addon::PVRTimerType::SetMaxRecordingsDefault (int maxRecordingsDefault)
	optional The default value for SetMaxRecordings().

int	kodi::addon::PVRTimerType::GetMaxRecordingsDefault () const
	To get with SetMaxRecordingsDefault changed values.

void	kodi::addon::PVRTimerType::SetCustomSettingDefinitions (const std::vector< PVRSettingDefinition > &defs)
	optional Array containing the possible custom integer setting definitions.

std::vector< PVRSettingDefinition >	kodi::addon::PVRTimerType::GetCustomSettingDefinitions () const
	To get with SetCustomSettingDefinitions changed values.

Detailed Description

PVR add-on timer type
To define the content of kodi::addon::CInstancePVRClient::GetTimerTypes() given groups.

@ingroup cpp_kodi_addon_pvr_Defs_Timer_PVRTimerType

The following table contains values that can be set with class PVRTimerType :

Name	Type	Set call	Get call	Usage
Identifier	`unsigned int`	SetId	GetId	required to set
Attributes	`unsigned int`	SetAttributes	GetAttributes	required to set
Description	`std::string`	SetDescription	GetDescription	optional

Priority selection	PVRTypeIntValue	SetPriorities	GetPriorities	optional
Priority default selection	`int`	SetPrioritiesDefault	GetPrioritiesDefault	optional

Lifetime selection	PVRTypeIntValue	SetLifetimes	GetLifetimes	optional
Lifetime default selection	`int`	SetLifetimesDefault	GetLifetimesDefault	optional

Prevent duplicate episodes selection	PVRTypeIntValue	SetPreventDuplicateEpisodes	GetPreventDuplicateEpisodes	optional
Prevent duplicate episodes default	`int`	SetPreventDuplicateEpisodesDefault	GetPreventDuplicateEpisodesDefault	optional

Recording group selection	PVRTypeIntValue	SetRecordingGroups	GetRecordingGroups	optional
Recording group default	`int`	SetRecordingGroupDefault	GetRecordingGroupDefault	optional

Max recordings selection	PVRTypeIntValue	SetMaxRecordings	GetMaxRecordings	optional
Max recordings default	`int`	SetMaxRecordingsDefault	GetMaxRecordingsDefault	optional

Custom setting definitions	PVRSettingDefinition	SetCustomSettingDefinitions	GetCustomSettingDefinitions	optional

Function Documentation

◆ GetAttributes()

uint64_t kodi::addon::PVRTimerType::GetAttributes ( ) const

inline

To get with SetAttributes changed values.

◆ GetCustomSettingDefinitions()

std::vector< PVRSettingDefinition > kodi::addon::PVRTimerType::GetCustomSettingDefinitions ( ) const

inline

To get with SetCustomSettingDefinitions changed values.

◆ GetDescription()

std::string kodi::addon::PVRTimerType::GetDescription ( ) const

inline

To get with SetDescription changed values.

◆ GetId()

unsigned int kodi::addon::PVRTimerType::GetId ( ) const

inline

To get with SetAttributes changed values.

◆ GetLifetimes()

std::vector< PVRTypeIntValue > kodi::addon::PVRTimerType::GetLifetimes ( ) const

inline

To get with SetLifetimes changed values.

◆ GetLifetimesDefault()

int kodi::addon::PVRTimerType::GetLifetimesDefault ( ) const

inline

To get with SetLifetimesDefault changed values.

◆ GetMaxRecordings()

std::vector< PVRTypeIntValue > kodi::addon::PVRTimerType::GetMaxRecordings ( ) const

inline

To get with SetMaxRecordings changed values.

◆ GetMaxRecordingsDefault()

int kodi::addon::PVRTimerType::GetMaxRecordingsDefault ( ) const

inline

To get with SetMaxRecordingsDefault changed values.

◆ GetPreventDuplicateEpisodes()

std::vector< PVRTypeIntValue > kodi::addon::PVRTimerType::GetPreventDuplicateEpisodes ( ) const

inline

To get with SetPreventDuplicateEpisodes changed values.

◆ GetPreventDuplicateEpisodesDefault()

int kodi::addon::PVRTimerType::GetPreventDuplicateEpisodesDefault ( ) const

inline

To get with SetPreventDuplicateEpisodesDefault changed values.

◆ GetPriorities()

std::vector< PVRTypeIntValue > kodi::addon::PVRTimerType::GetPriorities ( ) const

inline

To get with SetPriorities changed values.

◆ GetPrioritiesDefault()

int kodi::addon::PVRTimerType::GetPrioritiesDefault ( ) const

inline

To get with SetPrioritiesDefault changed values.

◆ GetRecordingGroupDefault()

int kodi::addon::PVRTimerType::GetRecordingGroupDefault ( ) const

inline

To get with SetRecordingGroupDefault changed values.

◆ GetRecordingGroups()

std::vector< PVRTypeIntValue > kodi::addon::PVRTimerType::GetRecordingGroups ( ) const

inline

To get with SetRecordingGroups changed values.

◆ SetAttributes()

void kodi::addon::PVRTimerType::SetAttributes ( uint64_t attributes )

inline

required
Defines the attributes for this type (PVR_TIMER_TYPE_* constants).

To defines the attributes for a type. These values are bit fields that can be used together.

Example:

kodi::addon::PVRTimerType tag;

tag.SetAttributes(PVR_TIMER_TYPE_IS_MANUAL | PVR_TIMER_TYPE_IS_REPEATING);

tag

const char struct KODI_ADDON_AUDIODECODER_INFO_TAG * tag

Definition addons/kodi-dev-kit/include/kodi/c-api/addon-instance/AudioDecoder.h:122

kodi::addon::PVRTimerType

Definition Timers.h:587

PVR_TIMER_TYPE_IS_REPEATING

@ 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

@ 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

◆ SetCustomSettingDefinitions()

void kodi::addon::PVRTimerType::SetCustomSettingDefinitions ( const std::vector< PVRSettingDefinition > & defs )

inline

optional
Array containing the possible custom integer setting definitions.

Parameters

[in] defs List of integer setting definitions.

@ingroup cpp_kodi_addon_pvr_Defs_General_PVRIntSettingDefinition

The following table contains values that can be set with cpp_kodi_addon_pvr_Defs_General_PVRIntSettingDefinition :

Name	Type	Set call	Get call	Usage
Values	PVRTypeIntValue	SetValues	GetValues	optional
Default value	`int`	SetDefaultValue	GetDefaultValue	optional
Min value	`int`	SetMinValue	GetMinValue	optional
Step	`int`	SetStep	GetStep	optional
Max value	`int`	SetMaxValue	GetMaxValue	optional

◆ SetDescription()

void kodi::addon::PVRTimerType::SetDescription ( const std::string & description )

inline

optional
A short localized string describing the purpose of the type. (e.g. "Any time at this channel if title matches").

If left blank, Kodi will generate a description based on the attributes REPEATING and MANUAL. (e.g. "Repeating EPG-based.")

◆ SetId()

void kodi::addon::PVRTimerType::SetId ( unsigned int id )

inline

required
This type's identifier. Ids must be > PVR_TIMER_TYPE_NONE.

◆ SetLifetimes()

void kodi::addon::PVRTimerType::SetLifetimes	(	const std::vector< PVRTypeIntValue > &	lifetimes,
		int	lifetimesDefault = -1 )

inline

optional
Lifetime value definitions.

Array containing the possible values for PVRTimer::SetLifetime().

Parameters

[in]	lifetimes	List of lifetimes values
[in]	lifetimesDefault	[opt] The default value in list, can also be set by SetLifetimesDefault()

The following table contains values that can be set with class PVRTypeIntValue :

Name	Type	Set call	Get call
Value	`int`	SetValue	GetValue
Description	`std::string`	SetDescription	GetDescription

Remarks: Further can there be used his class constructor to set values.

◆ SetLifetimesDefault()

void kodi::addon::PVRTimerType::SetLifetimesDefault ( int lifetimesDefault )

inline

optional
The default value for SetLifetimes().

Note: Must be filled if SetLifetimes contain values and not defined there on second function value.

◆ SetMaxRecordings()

void kodi::addon::PVRTimerType::SetMaxRecordings	(	const std::vector< PVRTypeIntValue > &	maxRecordings,
		int	maxRecordingsDefault = -1 )

inline

optional
Array containing the possible values of PVRTimer::SetMaxRecordings().

Parameters

[in]	maxRecordings	List of max recordings values
[in]	maxRecordingsDefault	[opt] The default value in list, can also be set by SetMaxRecordingsDefault()

The following table contains values that can be set with class PVRTypeIntValue :

Name	Type	Set call	Get call
Value	`int`	SetValue	GetValue
Description	`std::string`	SetDescription	GetDescription

Remarks: Further can there be used his class constructor to set values.

◆ SetMaxRecordingsDefault()

void kodi::addon::PVRTimerType::SetMaxRecordingsDefault ( int maxRecordingsDefault )

inline

optional
The default value for SetMaxRecordings().

Can be set with here if on SetMaxRecordings not given as second value.

◆ SetPreventDuplicateEpisodes()

void kodi::addon::PVRTimerType::SetPreventDuplicateEpisodes	(	const std::vector< PVRTypeIntValue > &	preventDuplicateEpisodes,
		int	preventDuplicateEpisodesDefault = -1 )

inline

optional
Prevent duplicate episodes value definitions.

Array containing the possible values for PVRTimer::SetPreventDuplicateEpisodes().

Note: Must be filled if PVRTimer::SetPreventDuplicateEpisodes() is not empty.

Parameters

[in]	preventDuplicateEpisodes	List of duplicate episodes values
[in]	preventDuplicateEpisodesDefault	[opt] The default value in list, can also be set by SetPreventDuplicateEpisodesDefault()

The following table contains values that can be set with class PVRTypeIntValue :

Name	Type	Set call	Get call
Value	`int`	SetValue	GetValue
Description	`std::string`	SetDescription	GetDescription

Remarks: Further can there be used his class constructor to set values.

◆ SetPreventDuplicateEpisodesDefault()

void kodi::addon::PVRTimerType::SetPreventDuplicateEpisodesDefault ( int preventDuplicateEpisodesDefault )

inline

optional
The default value for PVRTimer::SetPreventDuplicateEpisodes().

Note: Must be filled if SetPreventDuplicateEpisodes contain values and not defined there on second function value.

◆ SetPriorities()

void kodi::addon::PVRTimerType::SetPriorities	(	const std::vector< PVRTypeIntValue > &	priorities,
		int	prioritiesDefault = -1 )

inline

optional
Priority value definitions.

Array containing the possible values for PVRTimer::SetPriority().

Parameters

[in]	priorities	List of priority values
[in]	prioritiesDefault	[opt] The default value in list, can also be set by SetPrioritiesDefault()

The following table contains values that can be set with class PVRTypeIntValue :

Name	Type	Set call	Get call
Value	`int`	SetValue	GetValue
Description	`std::string`	SetDescription	GetDescription

Remarks: Further can there be used his class constructor to set values.

◆ SetPrioritiesDefault()

void kodi::addon::PVRTimerType::SetPrioritiesDefault ( int prioritiesDefault )

inline

optional
The default value for PVRTimer::SetPriority().

Note: Must be filled if SetPriorities contain values and not defined there on second function value.

◆ SetRecordingGroupDefault()

void kodi::addon::PVRTimerType::SetRecordingGroupDefault ( int recordingGroupDefault )

inline

optional
The default value for PVRTimer::SetRecordingGroup().

Note: Must be filled if SetRecordingGroups contain values and not defined there on second function value.

◆ SetRecordingGroups()

void kodi::addon::PVRTimerType::SetRecordingGroups	(	const std::vector< PVRTypeIntValue > &	recordingGroup,
		int	recordingGroupDefault = -1 )

inline

optional
Array containing the possible values of PVRTimer::SetRecordingGroup()

Parameters

[in]	recordingGroup	List of recording group values
[in]	recordingGroupDefault	[opt] The default value in list, can also be set by SetRecordingGroupDefault()

The following table contains values that can be set with class PVRTypeIntValue :

Name	Type	Set call	Get call
Value	`int`	SetValue	GetValue
Description	`std::string`	SetDescription	GetDescription

Remarks: Further can there be used his class constructor to set values.

Classes

Functions

Detailed Description

@ingroup cpp_kodi_addon_pvr_Defs_Timer_PVRTimerType

Function Documentation

◆ GetAttributes()

◆ GetCustomSettingDefinitions()

◆ GetDescription()

◆ GetId()

◆ GetLifetimes()

◆ GetLifetimesDefault()

◆ GetMaxRecordings()

◆ GetMaxRecordingsDefault()

◆ GetPreventDuplicateEpisodes()

◆ GetPreventDuplicateEpisodesDefault()

◆ GetPriorities()

◆ GetPrioritiesDefault()

◆ GetRecordingGroupDefault()

◆ GetRecordingGroups()

◆ SetAttributes()

◆ SetCustomSettingDefinitions()

@ingroup cpp_kodi_addon_pvr_Defs_General_PVRIntSettingDefinition

◆ SetDescription()

◆ SetId()

◆ SetLifetimes()

◆ SetLifetimesDefault()

◆ SetMaxRecordings()

◆ SetMaxRecordingsDefault()

◆ SetPreventDuplicateEpisodes()

◆ SetPreventDuplicateEpisodesDefault()

◆ SetPriorities()

◆ SetPrioritiesDefault()

◆ SetRecordingGroupDefault()

◆ SetRecordingGroups()