class PVRChannelGroup

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

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

Function Documentation

SetGroupName()

void SetGroupName ( const std::string &  groupName )

inline

required
Name of this channel group.

GetGroupName()

std::string GetGroupName ( ) const

inline

To get with SetGroupName changed values.

SetIsRadio()

void SetIsRadio ( bool  isRadio )

inline

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

GetIsRadio()

bool GetIsRadio ( ) const

inline

To get with SetIsRadio changed values.

SetPosition()

void SetPosition ( unsigned int  position )

inline

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

GetPosition()

unsigned int GetPosition ( ) const

inline

To get with SetPosition changed values.