class PVRChannelGroupMember

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

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

Classes
class	kodi::addon::PVRChannelGroupMember

Functions
void	kodi::addon::PVRChannelGroupMember::SetGroupName (const std::string &groupName)
	required Name of the channel group to add the channel to.
std::string	kodi::addon::PVRChannelGroupMember::GetGroupName () const
	To get with SetGroupName changed values.
void	kodi::addon::PVRChannelGroupMember::SetChannelUniqueId (unsigned int channelUniqueId)
	required Unique id of the member.
unsigned int	kodi::addon::PVRChannelGroupMember::GetChannelUniqueId () const
	To get with SetChannelUniqueId changed values.
void	kodi::addon::PVRChannelGroupMember::SetChannelNumber (unsigned int channelNumber)
	optional Channel number within the group.
unsigned int	kodi::addon::PVRChannelGroupMember::GetChannelNumber () const
	To get with SetChannelNumber changed values.
void	kodi::addon::PVRChannelGroupMember::SetSubChannelNumber (unsigned int subChannelNumber)
	optional Sub channel number within the group (ATSC).
unsigned int	kodi::addon::PVRChannelGroupMember::GetSubChannelNumber () const
	To get with SetSubChannelNumber changed values.
void	kodi::addon::PVRChannelGroupMember::SetOrder (bool order)
	optional The value denoting the order of this channel in the 'All channels' group.
bool	kodi::addon::PVRChannelGroupMember::GetOrder () const
	To get with SetOrder changed values.

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

Function Documentation

GetChannelNumber()

unsigned int kodi::addon::PVRChannelGroupMember::GetChannelNumber ( ) const

inline

To get with SetChannelNumber changed values.

GetChannelUniqueId()

unsigned int kodi::addon::PVRChannelGroupMember::GetChannelUniqueId ( ) const

inline

To get with SetChannelUniqueId changed values.

GetGroupName()

std::string kodi::addon::PVRChannelGroupMember::GetGroupName ( ) const

inline

To get with SetGroupName changed values.

GetOrder()

bool kodi::addon::PVRChannelGroupMember::GetOrder ( ) const

inline

To get with SetOrder changed values.

GetSubChannelNumber()

unsigned int kodi::addon::PVRChannelGroupMember::GetSubChannelNumber ( ) const

inline

To get with SetSubChannelNumber changed values.

SetChannelNumber()

void kodi::addon::PVRChannelGroupMember::SetChannelNumber ( unsigned int channelNumber )

inline

optional
Channel number within the group.

SetChannelUniqueId()

void kodi::addon::PVRChannelGroupMember::SetChannelUniqueId ( unsigned int channelUniqueId )

inline

required
Unique id of the member.

SetGroupName()

void kodi::addon::PVRChannelGroupMember::SetGroupName ( const std::string & groupName )

inline

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

SetOrder()

void kodi::addon::PVRChannelGroupMember::SetOrder ( bool order )

inline

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

SetSubChannelNumber()

void kodi::addon::PVRChannelGroupMember::SetSubChannelNumber ( unsigned int subChannelNumber )

inline

optional
Sub channel number within the group (ATSC).