Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches

Channel data structure
Representation of a TV or radio channel. More...

Topics

 Value Help
 
 class PVRChannelsResultSet
 PVR add-on channel transfer class
To transfer the content of kodi::addon::CInstancePVRClient::GetChannels().
 

Classes

class  kodi::addon::PVRChannel
 

Functions

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

Detailed Description

Channel data structure
Representation of a TV or radio channel.

This is used to store all the necessary TV or radio channel 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 PVRChannel :

Name Type Set call Get call Usage
Unique id unsigned int SetUniqueId GetUniqueId required to set
Is radio bool SetIsRadio GetIsRadio required to set
Channel number unsigned int SetChannelNumber GetChannelNumber optional
Sub channel number unsigned int SetSubChannelNumber GetSubChannelNumber optional
Channel name std::string SetChannelName GetChannelName optional
Mime type std::string SetMimeType GetMimeType optional
Encryption system unsigned int SetEncryptionSystem GetEncryptionSystem optional
Icon path std::string SetIconPath GetIconPath optional
Is hidden bool SetIsHidden GetIsHidden optional
Has archive bool SetHasArchive GetHasArchive optional
Order int SetOrder GetOrder optional
Client provider unique identifier int SetClientProviderUid GetClientProviderUid optional

Function Documentation

◆ GetChannelName()

std::string kodi::addon::PVRChannel::GetChannelName ( ) const
inline

To get with SetChannelName changed values.

◆ GetChannelNumber()

unsigned int kodi::addon::PVRChannel::GetChannelNumber ( ) const
inline

To get with SetChannelNumber changed values.

◆ GetEncryptionSystem()

unsigned int kodi::addon::PVRChannel::GetEncryptionSystem ( ) const
inline

To get with SetEncryptionSystem changed values.

◆ GetHasArchive()

bool kodi::addon::PVRChannel::GetHasArchive ( ) const
inline

To get with GetIsRadio changed values.

◆ GetIconPath()

std::string kodi::addon::PVRChannel::GetIconPath ( ) const
inline

To get with SetIconPath changed values.

◆ GetIsHidden()

bool kodi::addon::PVRChannel::GetIsHidden ( ) const
inline

To get with GetIsRadio changed values.

◆ GetIsRadio()

bool kodi::addon::PVRChannel::GetIsRadio ( ) const
inline

To get with SetIsRadio changed values.

◆ GetMimeType()

std::string kodi::addon::PVRChannel::GetMimeType ( ) const
inline

To get with SetMimeType changed values.

◆ GetOrder()

bool kodi::addon::PVRChannel::GetOrder ( ) const
inline

To get with SetOrder changed values.

◆ GetSubChannelNumber()

unsigned int kodi::addon::PVRChannel::GetSubChannelNumber ( ) const
inline

To get with SetSubChannelNumber changed values.

◆ GetUniqueId()

unsigned int kodi::addon::PVRChannel::GetUniqueId ( ) const
inline

To get with SetUniqueId changed values.

◆ SetChannelName()

void kodi::addon::PVRChannel::SetChannelName ( const std::string & channelName)
inline

optional
Channel name given to this channel.

◆ SetChannelNumber()

void kodi::addon::PVRChannel::SetChannelNumber ( unsigned int channelNumber)
inline

optional
Channel number of this channel on the backend.

◆ SetEncryptionSystem()

void kodi::addon::PVRChannel::SetEncryptionSystem ( unsigned int encryptionSystem)
inline

optional
The encryption ID or CaID of this channel (Conditional access systems).

Lists about available ID's:

◆ SetHasArchive()

void kodi::addon::PVRChannel::SetHasArchive ( bool hasArchive)
inline

optional
true if this channel has a server-side back buffer.

◆ SetIconPath()

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

optional
Path to the channel icon (if present).

◆ SetIsHidden()

void kodi::addon::PVRChannel::SetIsHidden ( bool isHidden)
inline

optional
true if this channel is marked as hidden.

◆ SetIsRadio()

void kodi::addon::PVRChannel::SetIsRadio ( bool isRadio)
inline

required
true if this is a radio channel, false if it's a TV channel.

◆ SetMimeType()

void kodi::addon::PVRChannel::SetMimeType ( const std::string & inputFormat)
inline

optional
Input format mime type.

Available types can be found in https://www.iana.org/assignments/media-types/media-types.xhtml on "application" and "video" or leave empty if unknown.

◆ SetOrder()

void kodi::addon::PVRChannel::SetOrder ( bool order)
inline

optional
The value denoting the order of this channel in the 'All channels' group.

◆ SetSubChannelNumber()

void kodi::addon::PVRChannel::SetSubChannelNumber ( unsigned int subChannelNumber)
inline

optional
Sub channel number of this channel on the backend (ATSC).

◆ SetUniqueId()

void kodi::addon::PVRChannel::SetUniqueId ( unsigned int uniqueId)
inline

required
Unique identifier for this channel.