Kodi Development 22.0
for Binary and Script based Add-Ons
 
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Friends | List of all members
PVRChannel
C++ » Interface - kodi::addon » Addon type instances » PVR » Definitions, structures and enumerators » 2. Channel » class PVRChannel

Inherits DynamicCStructHdl< PVRChannel, PVR_CHANNEL >.

Public Member Functions

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

Member Function Documentation

◆ SetClientProviderUid()

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

◆ GetClientProviderUid()

int GetClientProviderUid ( ) const
inline

To get with SetClientProviderUid changed values.

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