Kodi Development  20.0
for Binary and Script based Add-Ons

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().


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()

Modules

 Value Help
 

Function Documentation

◆ SetSupportsEPG()

void SetSupportsEPG ( bool  supportsEPG)
inline

Set true if the add-on provides EPG information.

◆ GetSupportsEPG()

bool GetSupportsEPG ( ) const
inline

To get with SetSupportsEPG changed values.

◆ SetSupportsEPGEdl()

void SetSupportsEPGEdl ( bool  supportsEPGEdl)
inline

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

◆ GetSupportsEPGEdl()

bool GetSupportsEPGEdl ( ) const
inline

To get with SetSupportsEPGEdl changed values.

◆ SetSupportsTV()

void SetSupportsTV ( bool  supportsTV)
inline

Set true if this add-on provides TV channels.

◆ GetSupportsTV()

bool GetSupportsTV ( ) const
inline

To get with SetSupportsTV changed values.

◆ SetSupportsRadio()

void SetSupportsRadio ( bool  supportsRadio)
inline

Set true if this add-on provides TV channels.

◆ GetSupportsRadio()

bool GetSupportsRadio ( ) const
inline

To get with SetSupportsRadio changed values.

◆ SetSupportsRecordings()

void SetSupportsRecordings ( bool  supportsRecordings)
inline

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

◆ GetSupportsRecordings()

bool GetSupportsRecordings ( ) const
inline

To get with SetSupportsRecordings changed values.

◆ SetSupportsRecordingsUndelete()

void SetSupportsRecordingsUndelete ( bool  supportsRecordingsUndelete)
inline

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

◆ GetSupportsRecordingsUndelete()

bool GetSupportsRecordingsUndelete ( ) const
inline

To get with SetSupportsRecordings changed values.

◆ SetSupportsTimers()

void SetSupportsTimers ( bool  supportsTimers)
inline

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

◆ GetSupportsTimers()

bool GetSupportsTimers ( ) const
inline

To get with SetSupportsTimers changed values.

◆ SetSupportsProviders()

void SetSupportsProviders ( bool  supportsProviders)
inline

Set true if this add-on supports providers.

It uses the following functions:

◆ GetSupportsProviders()

bool GetSupportsProviders ( ) const
inline

To get with SetSupportsProviders changed values.

◆ SetSupportsChannelGroups()

void SetSupportsChannelGroups ( bool  supportsChannelGroups)
inline

◆ GetSupportsChannelGroups()

bool GetSupportsChannelGroups ( ) const
inline

To get with SetSupportsChannelGroups changed values.

◆ SetSupportsChannelScan()

void SetSupportsChannelScan ( bool  supportsChannelScan)
inline

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

It use the following function:

◆ GetSupportsChannelScan()

bool GetSupportsChannelScan ( ) const
inline

To get with SetSupportsChannelScan changed values.

◆ SetSupportsChannelSettings()

void SetSupportsChannelSettings ( bool  supportsChannelSettings)
inline

◆ GetSupportsChannelSettings()

bool GetSupportsChannelSettings ( ) const
inline

To get with SetSupportsChannelSettings changed values.

◆ SetHandlesInputStream()

void SetHandlesInputStream ( bool  handlesInputStream)
inline

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

◆ GetHandlesInputStream()

bool GetHandlesInputStream ( ) const
inline

To get with SetHandlesInputStream changed values.

◆ SetHandlesDemuxing()

void SetHandlesDemuxing ( bool  handlesDemuxing)
inline

Set true if this add-on demultiplexes packets.

◆ GetHandlesDemuxing()

bool GetHandlesDemuxing ( ) const
inline

To get with SetHandlesDemuxing changed values.

◆ SetSupportsRecordingPlayCount()

void SetSupportsRecordingPlayCount ( bool  supportsRecordingPlayCount)
inline

Set true if the backend supports play count for recordings.

◆ GetSupportsRecordingPlayCount()

bool GetSupportsRecordingPlayCount ( ) const
inline

To get with SetSupportsRecordingPlayCount changed values.

◆ SetSupportsLastPlayedPosition()

void SetSupportsLastPlayedPosition ( bool  supportsLastPlayedPosition)
inline

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

◆ GetSupportsLastPlayedPosition()

bool GetSupportsLastPlayedPosition ( ) const
inline

To get with SetSupportsLastPlayedPosition changed values.

◆ SetSupportsRecordingEdl()

void SetSupportsRecordingEdl ( bool  supportsRecordingEdl)
inline

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

◆ GetSupportsRecordingEdl()

bool GetSupportsRecordingEdl ( ) const
inline

To get with SetSupportsRecordingEdl changed values.

◆ SetSupportsRecordingsRename()

void SetSupportsRecordingsRename ( bool  supportsRecordingsRename)
inline

Set true if the backend supports renaming recordings.

◆ GetSupportsRecordingsRename()

bool GetSupportsRecordingsRename ( ) const
inline

To get with SetSupportsRecordingsRename changed values.

◆ SetSupportsRecordingsLifetimeChange()

void SetSupportsRecordingsLifetimeChange ( bool  supportsRecordingsLifetimeChange)
inline

Set true if the backend supports changing lifetime for recordings.

◆ GetSupportsRecordingsLifetimeChange()

bool GetSupportsRecordingsLifetimeChange ( ) const
inline

To get with SetSupportsRecordingsLifetimeChange changed values.

◆ SetSupportsDescrambleInfo()

void SetSupportsDescrambleInfo ( bool  supportsDescrambleInfo)
inline

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

◆ GetSupportsDescrambleInfo()

bool GetSupportsDescrambleInfo ( ) const
inline

To get with SetSupportsDescrambleInfo changed values.

◆ SetSupportsAsyncEPGTransfer()

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

◆ GetSupportsAsyncEPGTransfer()

bool GetSupportsAsyncEPGTransfer ( ) const
inline

To get with SetSupportsAsyncEPGTransfer changed values.

◆ SetSupportsRecordingSize()

void SetSupportsRecordingSize ( bool  supportsRecordingSize)
inline

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

◆ GetSupportsRecordingSize()

bool GetSupportsRecordingSize ( ) const
inline

To get with SetSupportsRecordingSize changed values.

◆ SetSupportsRecordingsDelete()

void SetSupportsRecordingsDelete ( bool  supportsRecordingsDelete)
inline

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

◆ GetSupportsRecordingsDelete()

bool GetSupportsRecordingsDelete ( ) const
inline

To get with SetSupportsRecordingsDelete changed values.

◆ SetRecordingsLifetimeValues()

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

◆ GetRecordingsLifetimeValues()

std::vector<PVRTypeIntValue> GetRecordingsLifetimeValues ( ) const
inline

To get with SetRecordingsLifetimeValues changed values.