class PVRTimerType

Detailed Description

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

---

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

Modules
	Value Help

Function Documentation

SetId()

void SetId ( unsigned int  id )

inline

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

GetId()

unsigned int GetId ( ) const

inline

To get with SetAttributes changed values.

SetAttributes()

void 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);

GetAttributes()

uint64_t GetAttributes ( ) const

inline

To get with SetAttributes changed values.

SetDescription()

void 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.")

GetDescription()

std::string GetDescription ( ) const

inline

To get with SetDescription changed values.

SetPriorities()

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

GetPriorities()

std::vector<PVRTypeIntValue> GetPriorities ( ) const

inline

To get with SetPriorities changed values.

SetPrioritiesDefault()

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

GetPrioritiesDefault()

int GetPrioritiesDefault ( ) const

inline

To get with SetPrioritiesDefault changed values.

SetLifetimes()

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

GetLifetimes()

std::vector<PVRTypeIntValue> GetLifetimes ( ) const

inline

To get with SetLifetimes changed values.

SetLifetimesDefault()

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

GetLifetimesDefault()

int GetLifetimesDefault ( ) const

inline

To get with SetLifetimesDefault changed values.

SetPreventDuplicateEpisodes()

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

GetPreventDuplicateEpisodes()

std::vector<PVRTypeIntValue> GetPreventDuplicateEpisodes ( ) const

inline

To get with SetPreventDuplicateEpisodes changed values.

SetPreventDuplicateEpisodesDefault()

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

GetPreventDuplicateEpisodesDefault()

int GetPreventDuplicateEpisodesDefault ( ) const

inline

To get with SetPreventDuplicateEpisodesDefault changed values.

SetRecordingGroups()

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

GetRecordingGroups()

std::vector<PVRTypeIntValue> GetRecordingGroups ( ) const

inline

To get with SetRecordingGroups changed values.

SetRecordingGroupDefault()

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

GetRecordingGroupDefault()

int GetRecordingGroupDefault ( ) const

inline

To get with SetRecordingGroupDefault changed values.

SetMaxRecordings()

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

inline

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

Parameters

[in]	maxRecordings	List of lifetimes 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.

GetMaxRecordings()

std::vector<PVRTypeIntValue> GetMaxRecordings ( ) const

inline

To get with SetMaxRecordings changed values.

SetMaxRecordingsDefault()

void SetMaxRecordingsDefault ( int  maxRecordingsDefault )

inline

optional
The default value for SetMaxRecordings().

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

GetMaxRecordingsDefault()

int GetMaxRecordingsDefault ( ) const

inline

To get with SetMaxRecordingsDefault changed values.