class PVRChannelGroup

PVR add-on channel group
To define a group for channels, this becomes be asked from kodi::addon::CInstancePVRClient::GetChannelGroups() and used on kodi::addon::CInstancePVRClient::GetChannelGroupMembers() to get his content with PVRChannelGroupMember. More...

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

Classes
class	kodi::addon::PVRChannelGroup
void	kodi::addon::PVRChannelGroup::SetGroupName (const std::string &groupName)
	required Name of this channel group.
std::string	kodi::addon::PVRChannelGroup::GetGroupName () const
	To get with SetGroupName changed values.
void	kodi::addon::PVRChannelGroup::SetIsRadio (bool isRadio)
	required true If this is a radio channel group, false otherwise.
bool	kodi::addon::PVRChannelGroup::GetIsRadio () const
	To get with SetIsRadio changed values.
void	kodi::addon::PVRChannelGroup::SetPosition (unsigned int position)
	optional Sort position of the group (0 indicates that the backend doesn't support sorting of groups).
unsigned int	kodi::addon::PVRChannelGroup::GetPosition () const
	To get with SetPosition changed values.

Detailed Description

PVR add-on channel group
To define a group for channels, this becomes be asked from kodi::addon::CInstancePVRClient::GetChannelGroups() and used on kodi::addon::CInstancePVRClient::GetChannelGroupMembers() to get his content with PVRChannelGroupMember.

---

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

Name	Type	Set call	Get call	Usage
Group name	std::string	SetGroupName	GetGroupName	required to set
Is radio	bool	SetIsRadio	GetIsRadio	required to set
Position	unsigned int	SetPosition	GetPosition	optional

Function Documentation

GetGroupName()

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

inline

To get with SetGroupName changed values.

GetIsRadio()

bool kodi::addon::PVRChannelGroup::GetIsRadio ( ) const

inline

To get with SetIsRadio changed values.

GetPosition()

unsigned int kodi::addon::PVRChannelGroup::GetPosition ( ) const

inline

To get with SetPosition changed values.

SetGroupName()

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

inline

required
Name of this channel group.

SetIsRadio()

void kodi::addon::PVRChannelGroup::SetIsRadio ( bool isRadio )

inline

required
true If this is a radio channel group, false otherwise.

SetPosition()

void kodi::addon::PVRChannelGroup::SetPosition ( unsigned int position )

inline

optional
Sort position of the group (0 indicates that the backend doesn't support sorting of groups).