Kodi Development  20.0
for Binary and Script based Add-Ons

Detailed Description

PVR add-on channel group member
To define the content of kodi::addon::CInstancePVRClient::GetChannelGroups() given groups.

This content becomes then requested with kodi::addon::CInstancePVRClient::GetChannelGroupMembers().


The following table contains values that can be set with class PVRChannelGroupMember :

Name Type Set call Get call Usage
Group name std::string SetGroupName GetGroupName required to set
Channel unique id unsigned int SetChannelUniqueId GetChannelUniqueId required to set
Channel Number unsigned int SetChannelNumber GetChannelNumber optional
Sub channel number unsigned int SetSubChannelNumber GetSubChannelNumber optional
Order int SetOrder GetOrder optional

Modules

 Value Help
 
 class PVRChannelGroupMembersResultSet
 PVR add-on channel group member transfer class
To transfer the content of kodi::addon::CInstancePVRClient::GetChannelGroupMembers().
 

Function Documentation

◆ SetGroupName()

void SetGroupName ( const std::string &  groupName)
inline

required
Name of the channel group to add the channel to.

◆ GetGroupName()

std::string GetGroupName ( ) const
inline

To get with SetGroupName changed values.

◆ SetChannelUniqueId()

void SetChannelUniqueId ( unsigned int  channelUniqueId)
inline

required
Unique id of the member.

◆ GetChannelUniqueId()

unsigned int GetChannelUniqueId ( ) const
inline

To get with SetChannelUniqueId changed values.

◆ SetChannelNumber()

void SetChannelNumber ( unsigned int  channelNumber)
inline

optional
Channel number within the group.

◆ GetChannelNumber()

unsigned int GetChannelNumber ( ) const
inline

To get with SetChannelNumber changed values.

◆ SetSubChannelNumber()

void SetSubChannelNumber ( unsigned int  subChannelNumber)
inline

optional
Sub channel number within the group (ATSC).

◆ GetSubChannelNumber()

unsigned int GetSubChannelNumber ( ) const
inline

To get with SetSubChannelNumber 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.