class PVRCapabilities

PVR add-on capabilities
This class is needed to tell Kodi which options are supported on the addon. More...

Classes
class	kodi::addon::PVRCapabilities

Functions
void	kodi::addon::PVRCapabilities::SetSupportsEPG (bool supportsEPG)
	Set true if the add-on provides EPG information.
bool	kodi::addon::PVRCapabilities::GetSupportsEPG () const
	To get with SetSupportsEPG changed values.
void	kodi::addon::PVRCapabilities::SetSupportsEPGEdl (bool supportsEPGEdl)
	Set true if the backend supports retrieving an edit decision list for an EPG tag.
bool	kodi::addon::PVRCapabilities::GetSupportsEPGEdl () const
	To get with SetSupportsEPGEdl changed values.
void	kodi::addon::PVRCapabilities::SetSupportsTV (bool supportsTV)
	Set true if this add-on provides TV channels.
bool	kodi::addon::PVRCapabilities::GetSupportsTV () const
	To get with SetSupportsTV changed values.
void	kodi::addon::PVRCapabilities::SetSupportsRadio (bool supportsRadio)
	Set true if this add-on provides TV channels.
bool	kodi::addon::PVRCapabilities::GetSupportsRadio () const
	To get with SetSupportsRadio changed values.
void	kodi::addon::PVRCapabilities::SetSupportsRecordings (bool supportsRecordings)
	true if this add-on supports playback of recordings stored on the backend.
bool	kodi::addon::PVRCapabilities::GetSupportsRecordings () const
	To get with SetSupportsRecordings changed values.
void	kodi::addon::PVRCapabilities::SetSupportsRecordingsUndelete (bool supportsRecordingsUndelete)
	Set true if this add-on supports undelete of recordings stored on the backend.
bool	kodi::addon::PVRCapabilities::GetSupportsRecordingsUndelete () const
	To get with SetSupportsRecordings changed values.
void	kodi::addon::PVRCapabilities::SetSupportsTimers (bool supportsTimers)
	Set true if this add-on supports the creation and editing of timers.
bool	kodi::addon::PVRCapabilities::GetSupportsTimers () const
	To get with SetSupportsTimers changed values.
void	kodi::addon::PVRCapabilities::SetSupportsProviders (bool supportsProviders)
	Set true if this add-on supports providers.
bool	kodi::addon::PVRCapabilities::GetSupportsProviders () const
	To get with SetSupportsProviders changed values.
void	kodi::addon::PVRCapabilities::SetSupportsChannelGroups (bool supportsChannelGroups)
	Set true if this add-on supports channel groups.
bool	kodi::addon::PVRCapabilities::GetSupportsChannelGroups () const
	To get with SetSupportsChannelGroups changed values.
void	kodi::addon::PVRCapabilities::SetSupportsChannelScan (bool supportsChannelScan)
	Set true if this add-on support scanning for new channels on the backend.
bool	kodi::addon::PVRCapabilities::GetSupportsChannelScan () const
	To get with SetSupportsChannelScan changed values.
void	kodi::addon::PVRCapabilities::SetSupportsChannelSettings (bool supportsChannelSettings)
	Set true if this add-on supports channel edit.
bool	kodi::addon::PVRCapabilities::GetSupportsChannelSettings () const
	To get with SetSupportsChannelSettings changed values.
void	kodi::addon::PVRCapabilities::SetHandlesInputStream (bool handlesInputStream)
	Set true if this add-on provides an input stream. false if Kodi handles the stream.
bool	kodi::addon::PVRCapabilities::GetHandlesInputStream () const
	To get with SetHandlesInputStream changed values.
void	kodi::addon::PVRCapabilities::SetHandlesDemuxing (bool handlesDemuxing)
	Set true if this add-on demultiplexes packets.
bool	kodi::addon::PVRCapabilities::GetHandlesDemuxing () const
	To get with SetHandlesDemuxing changed values.
void	kodi::addon::PVRCapabilities::SetSupportsRecordingPlayCount (bool supportsRecordingPlayCount)
	Set true if the backend supports play count for recordings.
bool	kodi::addon::PVRCapabilities::GetSupportsRecordingPlayCount () const
	To get with SetSupportsRecordingPlayCount changed values.
void	kodi::addon::PVRCapabilities::SetSupportsLastPlayedPosition (bool supportsLastPlayedPosition)
	Set true if the backend supports store/retrieve of last played position for recordings.
bool	kodi::addon::PVRCapabilities::GetSupportsLastPlayedPosition () const
	To get with SetSupportsLastPlayedPosition changed values.
void	kodi::addon::PVRCapabilities::SetSupportsRecordingEdl (bool supportsRecordingEdl)
	Set true if the backend supports retrieving an edit decision list for recordings.
bool	kodi::addon::PVRCapabilities::GetSupportsRecordingEdl () const
	To get with SetSupportsRecordingEdl changed values.
void	kodi::addon::PVRCapabilities::SetSupportsRecordingsRename (bool supportsRecordingsRename)
	Set true if the backend supports renaming recordings.
bool	kodi::addon::PVRCapabilities::GetSupportsRecordingsRename () const
	To get with SetSupportsRecordingsRename changed values.
void	kodi::addon::PVRCapabilities::SetSupportsRecordingsLifetimeChange (bool supportsRecordingsLifetimeChange)
	Set true if the backend supports changing lifetime for recordings.
bool	kodi::addon::PVRCapabilities::GetSupportsRecordingsLifetimeChange () const
	To get with SetSupportsRecordingsLifetimeChange changed values.
void	kodi::addon::PVRCapabilities::SetSupportsDescrambleInfo (bool supportsDescrambleInfo)
	Set true if the backend supports descramble information for playing channels.
bool	kodi::addon::PVRCapabilities::GetSupportsDescrambleInfo () const
	To get with SetSupportsDescrambleInfo changed values.
void	kodi::addon::PVRCapabilities::SetSupportsAsyncEPGTransfer (bool supportsAsyncEPGTransfer)
	Set true if this addon-on supports asynchronous transfer of epg events to Kodi using the callback function kodi::addon::CInstancePVRClient::EpgEventStateChange().
bool	kodi::addon::PVRCapabilities::GetSupportsAsyncEPGTransfer () const
	To get with SetSupportsAsyncEPGTransfer changed values.
void	kodi::addon::PVRCapabilities::SetSupportsRecordingSize (bool supportsRecordingSize)
	Set true if this addon-on supports retrieving size of recordings.
bool	kodi::addon::PVRCapabilities::GetSupportsRecordingSize () const
	To get with SetSupportsRecordingSize changed values.
void	kodi::addon::PVRCapabilities::SetSupportsRecordingsDelete (bool supportsRecordingsDelete)
	Set true if this add-on supports delete of recordings stored on the backend.
bool	kodi::addon::PVRCapabilities::GetSupportsRecordingsDelete () const
	To get with SetSupportsRecordingsDelete changed values.
void	kodi::addon::PVRCapabilities::SetRecordingsLifetimeValues (const std::vector< PVRTypeIntValue > &recordingsLifetimeValues)
	optional Set array containing the possible values for PVRRecording::SetLifetime().
std::vector< PVRTypeIntValue >	kodi::addon::PVRCapabilities::GetRecordingsLifetimeValues () const
	To get with SetRecordingsLifetimeValues changed values.

Detailed Description

PVR add-on capabilities
This class is needed to tell Kodi which options are supported on the addon.

If a capability is set to true, then the corresponding methods from kodi::addon::CInstancePVRClient need to be implemented.

As default them all set to false.

Used on kodi::addon::CInstancePVRClient::GetCapabilities().

---

@ingroup cpp_kodi_addon_pvr_Defs_PVRCapabilities

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

Name	Type	Set call	Get call
Supports EPG	boolean	SetSupportsEPG	GetSupportsEPG
Supports EPG EDL	boolean	SetSupportsEPGEdl	GetSupportsEPGEdl
Supports TV	boolean	SetSupportsTV	GetSupportsTV
Supports radio	boolean	SetSupportsRadio	GetSupportsRadio
Supports recordings	boolean	SetSupportsRecordings	GetSupportsRecordings
Supports recordings undelete	boolean	SetSupportsRecordingsUndelete	SetSupportsRecordingsUndelete
Supports timers	boolean	SetSupportsTimers	GetSupportsTimers
Supports providers	boolean	SetSupportsProviders	GetSupportsProviders
Supports channel groups	boolean	SetSupportsChannelGroups	GetSupportsChannelGroups
Supports channel scan	boolean	SetSupportsChannelScan	GetSupportsChannelScan
Supports channel settings	boolean	SetSupportsChannelSettings	GetSupportsChannelSettings
Handles input stream	boolean	SetHandlesInputStream	GetHandlesInputStream
Handles demuxing	boolean	SetHandlesDemuxing	GetHandlesDemuxing
Supports recording play count	boolean	SetSupportsRecordingPlayCount	GetSupportsRecordingPlayCount
Supports last played position	boolean	SetSupportsLastPlayedPosition	GetSupportsLastPlayedPosition
Supports recording EDL	boolean	SetSupportsRecordingEdl	GetSupportsRecordingEdl
Supports recordings rename	boolean	SetSupportsRecordingsRename	GetSupportsRecordingsRename
Supports recordings lifetime change	boolean	SetSupportsRecordingsLifetimeChange	GetSupportsRecordingsLifetimeChange
Supports descramble info	boolean	SetSupportsDescrambleInfo	GetSupportsDescrambleInfo
Supports async EPG transfer	boolean	SetSupportsAsyncEPGTransfer	GetSupportsAsyncEPGTransfer
Supports recording size	boolean	SetSupportsRecordingSize	GetSupportsRecordingSize
Supports recordings delete	boolean	SetSupportsRecordingsDelete	SetSupportsRecordingsDelete
Recordings lifetime values	PVRTypeIntValue	SetRecordingsLifetimeValues	GetRecordingsLifetimeValues

Warning

This class can not be used outside of kodi::addon::CInstancePVRClient::GetCapabilities()

Function Documentation

GetHandlesDemuxing()

bool kodi::addon::PVRCapabilities::GetHandlesDemuxing ( ) const

inline

To get with SetHandlesDemuxing changed values.

GetHandlesInputStream()

bool kodi::addon::PVRCapabilities::GetHandlesInputStream ( ) const

inline

To get with SetHandlesInputStream changed values.

GetRecordingsLifetimeValues()

std::vector< PVRTypeIntValue > kodi::addon::PVRCapabilities::GetRecordingsLifetimeValues ( ) const

inline

To get with SetRecordingsLifetimeValues changed values.

GetSupportsAsyncEPGTransfer()

bool kodi::addon::PVRCapabilities::GetSupportsAsyncEPGTransfer ( ) const

inline

To get with SetSupportsAsyncEPGTransfer changed values.

GetSupportsChannelGroups()

bool kodi::addon::PVRCapabilities::GetSupportsChannelGroups ( ) const

inline

To get with SetSupportsChannelGroups changed values.

GetSupportsChannelScan()

bool kodi::addon::PVRCapabilities::GetSupportsChannelScan ( ) const

inline

To get with SetSupportsChannelScan changed values.

GetSupportsChannelSettings()

bool kodi::addon::PVRCapabilities::GetSupportsChannelSettings ( ) const

inline

To get with SetSupportsChannelSettings changed values.

GetSupportsDescrambleInfo()

bool kodi::addon::PVRCapabilities::GetSupportsDescrambleInfo ( ) const

inline

To get with SetSupportsDescrambleInfo changed values.

GetSupportsEPG()

bool kodi::addon::PVRCapabilities::GetSupportsEPG ( ) const

inline

To get with SetSupportsEPG changed values.

GetSupportsEPGEdl()

bool kodi::addon::PVRCapabilities::GetSupportsEPGEdl ( ) const

inline

To get with SetSupportsEPGEdl changed values.

GetSupportsLastPlayedPosition()

bool kodi::addon::PVRCapabilities::GetSupportsLastPlayedPosition ( ) const

inline

To get with SetSupportsLastPlayedPosition changed values.

GetSupportsProviders()

bool kodi::addon::PVRCapabilities::GetSupportsProviders ( ) const

inline

To get with SetSupportsProviders changed values.

GetSupportsRadio()

bool kodi::addon::PVRCapabilities::GetSupportsRadio ( ) const

inline

To get with SetSupportsRadio changed values.

GetSupportsRecordingEdl()

bool kodi::addon::PVRCapabilities::GetSupportsRecordingEdl ( ) const

inline

To get with SetSupportsRecordingEdl changed values.

GetSupportsRecordingPlayCount()

bool kodi::addon::PVRCapabilities::GetSupportsRecordingPlayCount ( ) const

inline

To get with SetSupportsRecordingPlayCount changed values.

GetSupportsRecordings()

bool kodi::addon::PVRCapabilities::GetSupportsRecordings ( ) const

inline

To get with SetSupportsRecordings changed values.

GetSupportsRecordingsDelete()

bool kodi::addon::PVRCapabilities::GetSupportsRecordingsDelete ( ) const

inline

To get with SetSupportsRecordingsDelete changed values.

GetSupportsRecordingSize()

bool kodi::addon::PVRCapabilities::GetSupportsRecordingSize ( ) const

inline

To get with SetSupportsRecordingSize changed values.

GetSupportsRecordingsLifetimeChange()

bool kodi::addon::PVRCapabilities::GetSupportsRecordingsLifetimeChange ( ) const

inline

To get with SetSupportsRecordingsLifetimeChange changed values.

GetSupportsRecordingsRename()

bool kodi::addon::PVRCapabilities::GetSupportsRecordingsRename ( ) const

inline

To get with SetSupportsRecordingsRename changed values.

GetSupportsRecordingsUndelete()

bool kodi::addon::PVRCapabilities::GetSupportsRecordingsUndelete ( ) const

inline

To get with SetSupportsRecordings changed values.

GetSupportsTimers()

bool kodi::addon::PVRCapabilities::GetSupportsTimers ( ) const

inline

To get with SetSupportsTimers changed values.

GetSupportsTV()

bool kodi::addon::PVRCapabilities::GetSupportsTV ( ) const

inline

To get with SetSupportsTV changed values.

SetHandlesDemuxing()

void kodi::addon::PVRCapabilities::SetHandlesDemuxing ( bool handlesDemuxing )

inline

Set true if this add-on demultiplexes packets.

SetHandlesInputStream()

void kodi::addon::PVRCapabilities::SetHandlesInputStream ( bool handlesInputStream )

inline

Set true if this add-on provides an input stream. false if Kodi handles the stream.

SetRecordingsLifetimeValues()

void kodi::addon::PVRCapabilities::SetRecordingsLifetimeValues ( const std::vector< PVRTypeIntValue > & recordingsLifetimeValues )

inline

optional
Set array containing the possible values for PVRRecording::SetLifetime().

---

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.

SetSupportsAsyncEPGTransfer()

void kodi::addon::PVRCapabilities::SetSupportsAsyncEPGTransfer ( bool supportsAsyncEPGTransfer )

inline

Set true if this addon-on supports asynchronous transfer of epg events to Kodi using the callback function kodi::addon::CInstancePVRClient::EpgEventStateChange().

SetSupportsChannelGroups()

void kodi::addon::PVRCapabilities::SetSupportsChannelGroups ( bool supportsChannelGroups )

inline

Set true if this add-on supports channel groups.

It use the following functions:

• kodi::addon::CInstancePVRClient::GetChannelGroupsAmount()
• kodi::addon::CInstancePVRClient::GetChannelGroups()
• kodi::addon::CInstancePVRClient::GetChannelGroupMembers()

SetSupportsChannelScan()

void kodi::addon::PVRCapabilities::SetSupportsChannelScan ( bool supportsChannelScan )

inline

Set true if this add-on support scanning for new channels on the backend.

It use the following function:

• kodi::addon::CInstancePVRClient::OpenDialogChannelScan()

SetSupportsChannelSettings()

void kodi::addon::PVRCapabilities::SetSupportsChannelSettings ( bool supportsChannelSettings )

inline

Set true if this add-on supports channel edit.

It use the following functions:

• kodi::addon::CInstancePVRClient::DeleteChannel()
• kodi::addon::CInstancePVRClient::RenameChannel()
• kodi::addon::CInstancePVRClient::OpenDialogChannelSettings()
• kodi::addon::CInstancePVRClient::OpenDialogChannelAdd()

SetSupportsDescrambleInfo()

void kodi::addon::PVRCapabilities::SetSupportsDescrambleInfo ( bool supportsDescrambleInfo )

inline

Set true if the backend supports descramble information for playing channels.

SetSupportsEPG()

void kodi::addon::PVRCapabilities::SetSupportsEPG ( bool supportsEPG )

inline

Set true if the add-on provides EPG information.

SetSupportsEPGEdl()

void kodi::addon::PVRCapabilities::SetSupportsEPGEdl ( bool supportsEPGEdl )

inline

Set true if the backend supports retrieving an edit decision list for an EPG tag.

SetSupportsLastPlayedPosition()

void kodi::addon::PVRCapabilities::SetSupportsLastPlayedPosition ( bool supportsLastPlayedPosition )

inline

Set true if the backend supports store/retrieve of last played position for recordings.

SetSupportsProviders()

void kodi::addon::PVRCapabilities::SetSupportsProviders ( bool supportsProviders )

inline

Set true if this add-on supports providers.

It uses the following functions:

• kodi::addon::CInstancePVRClient::GetProvidersAmount()
• kodi::addon::CInstancePVRClient::GetProviders()

SetSupportsRadio()

void kodi::addon::PVRCapabilities::SetSupportsRadio ( bool supportsRadio )

inline

Set true if this add-on provides TV channels.

SetSupportsRecordingEdl()

void kodi::addon::PVRCapabilities::SetSupportsRecordingEdl ( bool supportsRecordingEdl )

inline

Set true if the backend supports retrieving an edit decision list for recordings.

SetSupportsRecordingPlayCount()

void kodi::addon::PVRCapabilities::SetSupportsRecordingPlayCount ( bool supportsRecordingPlayCount )

inline

Set true if the backend supports play count for recordings.

SetSupportsRecordings()

void kodi::addon::PVRCapabilities::SetSupportsRecordings ( bool supportsRecordings )

inline

true if this add-on supports playback of recordings stored on the backend.

SetSupportsRecordingsDelete()

void kodi::addon::PVRCapabilities::SetSupportsRecordingsDelete ( bool supportsRecordingsDelete )

inline

Set true if this add-on supports delete of recordings stored on the backend.

SetSupportsRecordingSize()

void kodi::addon::PVRCapabilities::SetSupportsRecordingSize ( bool supportsRecordingSize )

inline

Set true if this addon-on supports retrieving size of recordings.

SetSupportsRecordingsLifetimeChange()

void kodi::addon::PVRCapabilities::SetSupportsRecordingsLifetimeChange ( bool supportsRecordingsLifetimeChange )

inline

Set true if the backend supports changing lifetime for recordings.

SetSupportsRecordingsRename()

void kodi::addon::PVRCapabilities::SetSupportsRecordingsRename ( bool supportsRecordingsRename )

inline

Set true if the backend supports renaming recordings.

SetSupportsRecordingsUndelete()

void kodi::addon::PVRCapabilities::SetSupportsRecordingsUndelete ( bool supportsRecordingsUndelete )

inline

Set true if this add-on supports undelete of recordings stored on the backend.

SetSupportsTimers()

void kodi::addon::PVRCapabilities::SetSupportsTimers ( bool supportsTimers )

inline

Set true if this add-on supports the creation and editing of timers.

SetSupportsTV()

void kodi::addon::PVRCapabilities::SetSupportsTV ( bool supportsTV )

inline

Set true if this add-on provides TV channels.