kodi::addon::PVRChannel Class Reference

#include <Channels.h>

Inheritance diagram for kodi::addon::PVRChannel:

Public Member Functions
void	SetUniqueId (unsigned int uniqueId)
	required Unique identifier for this channel.
unsigned int	GetUniqueId () const
	To get with SetUniqueId changed values.
void	SetIsRadio (bool isRadio)
	required true if this is a radio channel, false if it's a TV channel.
bool	GetIsRadio () const
	To get with SetIsRadio changed values.
void	SetChannelNumber (unsigned int channelNumber)
	optional Channel number of this channel on the backend.
unsigned int	GetChannelNumber () const
	To get with SetChannelNumber changed values.
void	SetSubChannelNumber (unsigned int subChannelNumber)
	optional Sub channel number of this channel on the backend (ATSC).
unsigned int	GetSubChannelNumber () const
	To get with SetSubChannelNumber changed values.
void	SetChannelName (const std::string &channelName)
	optional Channel name given to this channel.
std::string	GetChannelName () const
	To get with SetChannelName changed values.
void	SetMimeType (const std::string &inputFormat)
	optional Input format mime type.
std::string	GetMimeType () const
	To get with SetMimeType changed values.
void	SetEncryptionSystem (unsigned int encryptionSystem)
	optional The encryption ID or CaID of this channel (Conditional access systems).
unsigned int	GetEncryptionSystem () const
	To get with SetEncryptionSystem changed values.
void	SetIconPath (const std::string &iconPath)
	optional Path to the channel icon (if present).
std::string	GetIconPath () const
	To get with SetIconPath changed values.
void	SetIsHidden (bool isHidden)
	optional true if this channel is marked as hidden.
bool	GetIsHidden () const
	To get with GetIsRadio changed values.
void	SetHasArchive (bool hasArchive)
	optional true if this channel has a server-side back buffer.
bool	GetHasArchive () const
	To get with GetIsRadio changed values.
void	SetOrder (bool order)
	optional The value denoting the order of this channel in the 'All channels' group.
bool	GetOrder () const
	To get with SetOrder changed values.
void	SetClientProviderUid (int iClientProviderUid)
	optional Unique identifier of the provider this channel belongs to.
int	GetClientProviderUid () const
	To get with SetClientProviderUid changed values.
Public Member Functions inherited from kodi::addon::DynamicCStructHdl< PVRChannel, PVR_CHANNEL >
	DynamicCStructHdl ()
	DynamicCStructHdl (const DynamicCStructHdl &cppClass)
	DynamicCStructHdl (const PVR_CHANNEL *cStructure)
	DynamicCStructHdl (PVR_CHANNEL *cStructure)
const DynamicCStructHdl &	operator= (const DynamicCStructHdl &right)
const DynamicCStructHdl &	operator= (const PVR_CHANNEL &right)
virtual	~DynamicCStructHdl ()
	operator PVR_CHANNEL * ()
	operator const PVR_CHANNEL * () const
const PVR_CHANNEL *	GetCStructure () const
PVR_CHANNEL *	release ()

Static Public Member Functions
static void	AllocResources (const PVR_CHANNEL *source, PVR_CHANNEL *target)
static void	FreeResources (PVR_CHANNEL *target)

Friends
class	CInstancePVRClient

Additional Inherited Members
Protected Attributes inherited from kodi::addon::DynamicCStructHdl< PVRChannel, PVR_CHANNEL >
PVR_CHANNEL *	m_cStructure

Member Function Documentation

AllocResources()

static void kodi::addon::PVRChannel::AllocResources ( const PVR_CHANNEL * source, PVR_CHANNEL * target )

inlinestatic

FreeResources()

static void kodi::addon::PVRChannel::FreeResources ( PVR_CHANNEL * target )

inlinestatic

GetClientProviderUid()

int kodi::addon::PVRChannel::GetClientProviderUid ( ) const

inline

To get with SetClientProviderUid changed values.

SetClientProviderUid()

void kodi::addon::PVRChannel::SetClientProviderUid ( int iClientProviderUid )

inline

optional
Unique identifier of the provider this channel belongs to.

PVR_PROVIDER_INVALID_UID denotes that provider uid is not available.

Friends And Related Symbol Documentation

CInstancePVRClient

friend class CInstancePVRClient

friend

---

The documentation for this class was generated from the following file:

• Channels.h