class PVRProvider

Provider data structure
Representation of a provider. More...

Topics
	Value Help
	class PVRProvidersResultSet
	PVR add-on provider transfer class To transfer the content of kodi::addon::CInstancePVRClient::GetProviders().

Classes
class	kodi::addon::PVRProvider

Functions
void	kodi::addon::PVRProvider::SetUniqueId (unsigned int uniqueId)
	required Unique identifier for this provider.
unsigned int	kodi::addon::PVRProvider::GetUniqueId () const
	To get with SetUniqueId changed values.
void	kodi::addon::PVRProvider::SetName (const std::string &name)
	required Name given to this provider.
std::string	kodi::addon::PVRProvider::GetName () const
	To get with SetName changed values.
void	kodi::addon::PVRProvider::SetType (PVR_PROVIDER_TYPE type)
	optional Provider type.
PVR_PROVIDER_TYPE	kodi::addon::PVRProvider::GetType () const
	To get with SetType changed values.
void	kodi::addon::PVRProvider::SetIconPath (const std::string &iconPath)
	optional Path to the provider icon (if present).
std::string	kodi::addon::PVRProvider::GetIconPath () const
	To get with SetIconPath changed values.

Detailed Description

Provider data structure
Representation of a provider.

This is used to store all the necessary provider data and can either provide the necessary data from / to Kodi for the associated functions or can also be used in the addon to store its data.

---

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

Name	Type	Set call	Get call	Usage
Unique id	unsigned int	SetUniqueId	GetUniqueId	required to set
Provider name	std::string	SetName	GetName	required to set
Provider type	PVR_PROVIDER_TYPE	SetType	GetType	optional
Icon path	std::string	SetIconPath	GetIconPath	optional
Countries	std::vector<std::string>	SetCountries	GetCountries	optional
Languages	std::vector<std::string>	SetLanguages	GetLanguages	optional

Function Documentation

GetIconPath()

std::string kodi::addon::PVRProvider::GetIconPath ( ) const

inline

To get with SetIconPath changed values.

GetName()

std::string kodi::addon::PVRProvider::GetName ( ) const

inline

To get with SetName changed values.

GetType()

PVR_PROVIDER_TYPE kodi::addon::PVRProvider::GetType ( ) const

inline

To get with SetType changed values.

GetUniqueId()

unsigned int kodi::addon::PVRProvider::GetUniqueId ( ) const

inline

To get with SetUniqueId changed values.

SetIconPath()

void kodi::addon::PVRProvider::SetIconPath ( const std::string & iconPath )

inline

optional
Path to the provider icon (if present).

SetName()

void kodi::addon::PVRProvider::SetName ( const std::string & name )

inline

required
Name given to this provider.

SetType()

void kodi::addon::PVRProvider::SetType ( PVR_PROVIDER_TYPE type )

inline

optional
Provider type.

Set to PVR_PROVIDER_TYPE_UNKNOWN if the type cannot be determined.

---

Example:

kodi::addon::PVRProvider tag;
tag.SetType(PVR_PROVIDER_TYPE_SATELLITE);

SetUniqueId()

void kodi::addon::PVRProvider::SetUniqueId ( unsigned int uniqueId )

inline

required
Unique identifier for this provider.