class PVRChannel

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

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

Function Documentation

SetUniqueId()

void SetUniqueId ( unsigned int  uniqueId )

inline

required
Unique identifier for this channel.

GetUniqueId()

unsigned int GetUniqueId ( ) const

inline

To get with SetUniqueId changed values.

SetIsRadio()

void SetIsRadio ( bool  isRadio )

inline

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

GetIsRadio()

bool GetIsRadio ( ) const

inline

To get with SetIsRadio changed values.

SetChannelNumber()

void SetChannelNumber ( unsigned int  channelNumber )

inline

optional
Channel number of this channel on the backend.

GetChannelNumber()

unsigned int GetChannelNumber ( ) const

inline

To get with SetChannelNumber changed values.

SetSubChannelNumber()

void SetSubChannelNumber ( unsigned int  subChannelNumber )

inline

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

GetSubChannelNumber()

unsigned int GetSubChannelNumber ( ) const

inline

To get with SetSubChannelNumber changed values.

SetChannelName()

void SetChannelName ( const std::string &  channelName )

inline

optional
Channel name given to this channel.

GetChannelName()

std::string GetChannelName ( ) const

inline

To get with SetChannelName changed values.

SetMimeType()

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

GetMimeType()

std::string GetMimeType ( ) const

inline

To get with SetMimeType changed values.

SetEncryptionSystem()

void SetEncryptionSystem ( unsigned int  encryptionSystem )

inline

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

Lists about available ID's:

• http://www.dvb.org/index.php?id=174
• http://en.wikipedia.org/wiki/Conditional_access_system

GetEncryptionSystem()

unsigned int GetEncryptionSystem ( ) const

inline

To get with SetEncryptionSystem changed values.

SetIconPath()

void SetIconPath ( const std::string &  iconPath )

inline

optional
Path to the channel icon (if present).

GetIconPath()

std::string GetIconPath ( ) const

inline

To get with SetIconPath changed values.

SetIsHidden()

void SetIsHidden ( bool  isHidden )

inline

optional
true if this channel is marked as hidden.

GetIsHidden()

bool GetIsHidden ( ) const

inline

To get with GetIsRadio changed values.

SetHasArchive()

void SetHasArchive ( bool  hasArchive )

inline

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

GetHasArchive()

bool GetHasArchive ( ) const

inline

To get with GetIsRadio changed values.

SetOrder()

void SetOrder ( bool  order )

inline

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

GetOrder()

bool GetOrder ( ) const

inline

To get with SetOrder changed values.