A container class for channel groups. More...

#include <PVRChannelGroups.h>

Public Member Functions
	CPVRChannelGroups (bool bRadio)
	Create a new group container. More...

void	Unload ()
	Remove all groups from this container.

bool	LoadFromDatabase (const std::vector< std::shared_ptr< CPVRClient >> &clients)
	Load all channel groups and all channels from PVR database. More...

std::shared_ptr< CPVRChannelGroup >	CreateChannelGroup (int iType, const CPVRChannelsPath &path)
	Create a channel group matching the given type. More...

size_t	Size () const

bool	Update (const std::shared_ptr< CPVRChannelGroup > &group, bool bUpdateFromClient=false)
	Update a group or add it if it's not in here yet. More...

bool	UpdateFromClient (const std::shared_ptr< CPVRChannelGroup > &group)
	Called by the add-on callback to add a new group. More...

std::shared_ptr< CPVRChannelGroupMember >	GetChannelGroupMemberByPath (const CPVRChannelsPath &path) const
	Get a channel group member given its path. More...

std::shared_ptr< CPVRChannelGroup >	GetById (int iGroupId) const
	Get a pointer to a channel group given its ID. More...

std::vector< std::shared_ptr< CPVRChannelGroup > >	GetGroupsByChannel (const std::shared_ptr< CPVRChannel > &channel, bool bExcludeHidden=false) const
	Get all groups the given channel is a member. More...

std::shared_ptr< CPVRChannelGroup >	GetGroupByPath (const std::string &strPath) const
	Get a channel group given its path. More...

std::shared_ptr< CPVRChannelGroup >	GetByName (const std::string &strName) const
	Get a group given its name. More...

std::shared_ptr< CPVRChannelGroup >	GetGroupAll () const
	Get the group that contains all channels. More...

std::shared_ptr< CPVRChannelGroup >	GetFirstGroup () const

std::shared_ptr< CPVRChannelGroup >	GetLastGroup () const

GroupMemberPair	GetLastAndPreviousToLastPlayedChannelGroupMember () const

std::shared_ptr< CPVRChannelGroup >	GetLastOpenedGroup () const

std::vector< std::shared_ptr< CPVRChannelGroup > >	GetMembers (bool bExcludeHidden=false) const
	Get the list of groups. More...

std::shared_ptr< CPVRChannelGroup >	GetPreviousGroup (const CPVRChannelGroup &group) const
	Get the previous group in this container. More...

std::shared_ptr< CPVRChannelGroup >	GetNextGroup (const CPVRChannelGroup &group) const
	Get the next group in this container. More...

bool	AddGroup (const std::string &strName)
	Add a group to this container. More...

bool	DeleteGroup (const std::shared_ptr< CPVRChannelGroup > &group)
	Remove a group from this container and delete it from the database. More...

bool	HideGroup (const std::shared_ptr< CPVRChannelGroup > &group, bool bHide)
	Hide/unhide a group in this container. More...

bool	CreateChannelEpgs ()
	Create EPG tags for all channels of the internal group. More...

bool	PersistAll ()
	Persist all changes in channel groups. More...

bool	IsRadio () const

bool	UpdateFromClients (const std::vector< std::shared_ptr< CPVRClient >> &clients, bool bChannelsOnly=false)
	Update data with groups and channels from the given clients, sync with local data. More...

bool	UpdateChannelNumbersFromAllChannelsGroup ()
	Update the channel numbers across the channel groups from the all channels group. More...

int	CleanupCachedImages ()
	Erase stale texture db entries and image files. More...

Detailed Description

A container class for channel groups.

Constructor & Destructor Documentation

◆ CPVRChannelGroups()

CPVRChannelGroups::CPVRChannelGroups ( bool bRadio )

explicit

Create a new group container.

Parameters

bRadio True if this is a container for radio channels, false if it is for tv channels.

Member Function Documentation

◆ AddGroup()

bool CPVRChannelGroups::AddGroup ( const std::string & strName )

Add a group to this container.

Parameters

strName The name of the group.

Returns: True if the group was added, false otherwise.

◆ CleanupCachedImages()

int CPVRChannelGroups::CleanupCachedImages ( )

Erase stale texture db entries and image files.

Returns: number of cleaned up images.

◆ CreateChannelEpgs()

bool CPVRChannelGroups::CreateChannelEpgs ( )

Create EPG tags for all channels of the internal group.

Returns: True if EPG tags where created successfully, false if not.

◆ CreateChannelGroup()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroups::CreateChannelGroup	(	int	iType,
		const CPVRChannelsPath &	path
	)

Create a channel group matching the given type.

Parameters

iType	The type for the group.
path	The path of the group.

Returns: The new group.

◆ DeleteGroup()

bool CPVRChannelGroups::DeleteGroup ( const std::shared_ptr< CPVRChannelGroup > & group )

Remove a group from this container and delete it from the database.

Parameters

group The group to delete.

Returns: True if it was deleted successfully, false if not.

◆ GetById()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroups::GetById ( int iGroupId ) const

Get a pointer to a channel group given its ID.

Parameters

iGroupId The ID of the group.

Returns: The group or NULL if it wasn't found.

◆ GetByName()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroups::GetByName ( const std::string & strName ) const

Get a group given its name.

Parameters

strName The name.

Returns: The group or NULL if it wasn't found.

◆ GetChannelGroupMemberByPath()

std::shared_ptr< CPVRChannelGroupMember > CPVRChannelGroups::GetChannelGroupMemberByPath ( const CPVRChannelsPath & path ) const

Get a channel group member given its path.

Parameters

strPath The path to the channel group member

Returns: The channel group member, or nullptr if not found

◆ GetFirstGroup()

std::shared_ptr<CPVRChannelGroup> PVR::CPVRChannelGroups::GetFirstGroup ( ) const

inline

Returns: The first group in this container, which always is the group with all channels.

◆ GetGroupAll()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroups::GetGroupAll ( ) const

Get the group that contains all channels.

Returns: The group that contains all channels.

◆ GetGroupByPath()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroups::GetGroupByPath ( const std::string & strPath ) const

Get a channel group given its path.

Parameters

strPath The path to the channel group

Returns: The channel group, or nullptr if not found

◆ GetGroupsByChannel()

std::vector< std::shared_ptr< CPVRChannelGroup > > CPVRChannelGroups::GetGroupsByChannel	(	const std::shared_ptr< CPVRChannel > &	channel,
		bool	bExcludeHidden = `false`
	)		const

Get all groups the given channel is a member.

Parameters

channel	The channel.
bExcludeHidden	Whenever to exclude hidden channel groups.

Returns: A list of groups the channel is a member.

◆ GetLastAndPreviousToLastPlayedChannelGroupMember()

GroupMemberPair CPVRChannelGroups::GetLastAndPreviousToLastPlayedChannelGroupMember ( ) const

Returns: The last and previous to last played channel group members. pair.first contains the last, pair.second the previous to last member.

◆ GetLastGroup()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroups::GetLastGroup ( ) const

Returns: The last group in this container.

◆ GetLastOpenedGroup()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroups::GetLastOpenedGroup ( ) const

Returns: The last opened group.

◆ GetMembers()

std::vector< std::shared_ptr< CPVRChannelGroup > > CPVRChannelGroups::GetMembers ( bool bExcludeHidden = false ) const

Get the list of groups.

Parameters

groups	The list to store the results in.
bExcludeHidden	Whenever to exclude hidden channel groups.

Returns: The amount of items that were added.

◆ GetNextGroup()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroups::GetNextGroup ( const CPVRChannelGroup & group ) const

Get the next group in this container.

Parameters

group The current group.

Returns: The next group or the group containing all channels if it wasn't found.

◆ GetPreviousGroup()

std::shared_ptr< CPVRChannelGroup > CPVRChannelGroups::GetPreviousGroup ( const CPVRChannelGroup & group ) const

Get the previous group in this container.

Parameters

group The current group.

Returns: The previous group or the group containing all channels if it wasn't found.

◆ HideGroup()

bool CPVRChannelGroups::HideGroup	(	const std::shared_ptr< CPVRChannelGroup > &	group,
		bool	bHide
	)

Hide/unhide a group in this container.

Parameters

group	The group to hide/unhide.
bHide	True to hide the group, false to unhide it.

Returns: True on success, false otherwise.

◆ IsRadio()

bool PVR::CPVRChannelGroups::IsRadio ( ) const

inline

Returns: True when this container contains radio groups, false otherwise

◆ LoadFromDatabase()

bool CPVRChannelGroups::LoadFromDatabase ( const std::vector< std::shared_ptr< CPVRClient >> & clients )

Load all channel groups and all channels from PVR database.

Parameters

clients The PVR clients data should be loaded for. Leave empty for all clients.

Returns: True on success, false otherwise.

◆ PersistAll()

bool CPVRChannelGroups::PersistAll ( )

Persist all changes in channel groups.

Returns: True if everything was persisted, false otherwise.

◆ Size()

size_t PVR::CPVRChannelGroups::Size ( ) const

inline

Returns: Amount of groups in this container

◆ Update()

bool CPVRChannelGroups::Update	(	const std::shared_ptr< CPVRChannelGroup > &	group,
		bool	bUpdateFromClient = `false`
	)

Update a group or add it if it's not in here yet.

Parameters

group	The group to update.
bUpdateFromClient	True to save the changes in the db.

Returns: True if the group was added or update successfully, false otherwise.

◆ UpdateChannelNumbersFromAllChannelsGroup()

bool CPVRChannelGroups::UpdateChannelNumbersFromAllChannelsGroup ( )

Update the channel numbers across the channel groups from the all channels group.

Returns: True if any channel number was changed, false otherwise.

◆ UpdateFromClient()

bool PVR::CPVRChannelGroups::UpdateFromClient ( const std::shared_ptr< CPVRChannelGroup > & group )

inline

Called by the add-on callback to add a new group.

Parameters

group The group to add

Returns: True when updated, false otherwise

◆ UpdateFromClients()

bool CPVRChannelGroups::UpdateFromClients	(	const std::vector< std::shared_ptr< CPVRClient >> &	clients,
		bool	bChannelsOnly = `false`
	)

Update data with groups and channels from the given clients, sync with local data.

Parameters

clients	The clients to fetch data from. Leave empty to fetch data from all created clients.
bChannelsOnly	Set to true to only update channels, not the groups themselves.

Returns: True on success, false otherwise.

The documentation for this class was generated from the following files:

xbmc/pvr/channels/PVRChannelGroups.h
xbmc/pvr/channels/PVRChannelGroups.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CPVRChannelGroups()

Member Function Documentation

◆ AddGroup()

◆ CleanupCachedImages()

◆ CreateChannelEpgs()

◆ CreateChannelGroup()

◆ DeleteGroup()

◆ GetById()

◆ GetByName()

◆ GetChannelGroupMemberByPath()

◆ GetFirstGroup()

◆ GetGroupAll()

◆ GetGroupByPath()

◆ GetGroupsByChannel()

◆ GetLastAndPreviousToLastPlayedChannelGroupMember()

◆ GetLastGroup()

◆ GetLastOpenedGroup()

◆ GetMembers()

◆ GetNextGroup()

◆ GetPreviousGroup()

◆ HideGroup()

◆ IsRadio()

◆ LoadFromDatabase()

◆ PersistAll()

◆ Size()

◆ Update()

◆ UpdateChannelNumbersFromAllChannelsGroup()

◆ UpdateFromClient()

◆ UpdateFromClients()