class PVRProvider

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::vecotr<std::string>	SetCountries	GetCountries	optional
Langauges	std::vecotr<std::string>	SetLanguages	GetLanguages	optional

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

Function Documentation

SetUniqueId()

void SetUniqueId ( unsigned int  uniqueId )

inline

required
Unique identifier for this provider.

GetUniqueId()

unsigned int GetUniqueId ( ) const

inline

To get with SetUniqueId changed values.

SetName()

void SetName ( const std::string &  name )

inline

required
Name given to this provider.

GetName()

std::string GetName ( ) const

inline

To get with SetName changed values.

SetType()

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

GetType()

PVR_PROVIDER_TYPE GetType ( ) const

inline

To get with SetType changed values.

SetIconPath()

void SetIconPath ( const std::string &  iconPath )

inline

optional
Path to the provider icon (if present).

GetIconPath()

std::string GetIconPath ( ) const

inline

To get with SetIconPath changed values.