Inheritance diagram for PVR::CPVRManager:

Collaboration diagram for PVR::CPVRManager:

Public Member Functions
	CPVRManager ()
	Create a new CPVRManager instance, which handles all PVR related operations in XBMC.

	~CPVRManager () override
	Stop the PVRManager and destroy all objects it created.

void	Announce (ANNOUNCEMENT::AnnouncementFlag flag, const std::string &sender, const std::string &message, const CVariant &data) override

template<class T >
T &	Get ()
	Get a PVR component. More...

std::shared_ptr< CPVRProviders >	Providers () const
	Get the providers container. More...

std::shared_ptr< CPVRChannelGroupsContainer >	ChannelGroups () const
	Get the channel groups container. More...

std::shared_ptr< CPVRRecordings >	Recordings () const
	Get the recordings container. More...

std::shared_ptr< CPVRTimers >	Timers () const
	Get the timers container. More...

std::shared_ptr< CPVRClients >	Clients () const
	Get the timers container. More...

std::shared_ptr< CPVRClient >	GetClient (const CFileItem &item) const
	Get the instance of a client that matches the given item. More...

std::shared_ptr< CPVRClient >	GetClient (int iClientId) const
	Get the instance of a client that matches the given id. More...

std::shared_ptr< CPVRPlaybackState >	PlaybackState () const
	Get access to the pvr playback state. More...

CPVREpgContainer &	EpgContainer ()
	Get access to the epg container. More...

void	Init ()
	Init PVRManager.

void	Start ()
	Start the PVRManager, which loads all PVR data and starts some threads to update the PVR data.

void	Stop (bool bRestart=false)
	Stop PVRManager.

void	Unload ()
	Stop PVRManager, unload data.

void	Deinit ()
	Deinit PVRManager, unload data, unload addons.

void	OnSleep ()
	Propagate event on system sleep.

void	OnWake ()
	Propagate event on system wake.

std::shared_ptr< CPVRDatabase >	GetTVDatabase () const
	Get the TV database. More...

bool	IsStarted () const
	Check whether the PVRManager has fully started. More...

bool	EpgsCreated () const
	Check whether EPG tags for channels have been created. More...

void	OnPlaybackStarted (const CFileItem &item)
	Inform PVR manager that playback of an item just started. More...

void	OnPlaybackStopped (const CFileItem &item)
	Inform PVR manager that playback of an item was stopped due to user interaction. More...

void	OnPlaybackEnded (const CFileItem &item)
	Inform PVR manager that playback of an item has stopped without user interaction. More...

void	TriggerEpgsCreate ()
	Let the background thread create epg tags for all channels.

void	TriggerRecordingsUpdate (int clientId)
	Let the background thread update the recordings list. More...

void	TriggerRecordingsUpdate ()

void	TriggerRecordingsSizeInProgressUpdate ()
	Let the background thread update the size for any in progress recordings.

void	TriggerTimersUpdate (int clientId)
	Let the background thread update the timer list. More...

void	TriggerTimersUpdate ()

void	TriggerChannelsUpdate (int clientId)
	Let the background thread update the channel list. More...

void	TriggerChannelsUpdate ()

void	TriggerProvidersUpdate (int clientId)
	Let the background thread update the provider list. More...

void	TriggerProvidersUpdate ()

void	TriggerChannelGroupsUpdate (int clientId)
	Let the background thread update the channel groups list. More...

void	TriggerChannelGroupsUpdate ()

void	TriggerSearchMissingChannelIcons ()
	Let the background thread search for all missing channel icons.

void	TriggerCleanupCachedImages ()
	Let the background thread erase stale texture db entries and image files.

void	TriggerSearchMissingChannelIcons (const std::shared_ptr< CPVRChannelGroup > &group)
	Let the background thread search for missing channel icons for channels contained in the given group. More...

void	LocalizationChanged ()
	Check whether names are still correct after the language settings changed.

bool	IsParentalLocked (const std::shared_ptr< CPVRChannel > &channel) const
	Check if parental lock is overridden at the given moment. More...

bool	IsParentalLocked (const std::shared_ptr< CPVREpgInfoTag > &epgTag) const
	Check if parental lock is overridden at the given moment. More...

void	RestartParentalTimer ()
	Restart the parental timer.

bool	CreateChannelEpgs ()
	Create EPG tags for all channels in internal channel groups. More...

void	ConnectionStateChange (CPVRClient *client, const std::string &connectString, PVR_CONNECTION_STATE state, const std::string &message)
	Signal a connection change of a client.

CEventStream< PVREvent > &	Events ()
	Query the events available for CEventStream.

void	PublishEvent (PVREvent state)
	Publish an event. More...

Protected Member Functions
void	Process () override
	PVR update and control thread.

Member Function Documentation

◆ ChannelGroups()

std::shared_ptr< CPVRChannelGroupsContainer > CPVRManager::ChannelGroups ( ) const

Get the channel groups container.

Returns: The groups container.

◆ Clients()

std::shared_ptr< CPVRClients > CPVRManager::Clients ( ) const

Get the timers container.

Returns: The timers container.

◆ CreateChannelEpgs()

bool CPVRManager::CreateChannelEpgs ( )

Create EPG tags for all channels in internal channel groups.

Returns: True if EPG tags where created successfully, false otherwise

◆ EpgContainer()

CPVREpgContainer & CPVRManager::EpgContainer ( )

Get access to the epg container.

Returns: The epg container.

◆ EpgsCreated()

bool CPVRManager::EpgsCreated ( ) const

Check whether EPG tags for channels have been created.

Returns: True if EPG tags have been created, false otherwise.

◆ Get()

template<class T >

T& PVR::CPVRManager::Get ( )

inline

Get a PVR component.

Returns: The component.

◆ GetClient() [1/2]

std::shared_ptr< CPVRClient > CPVRManager::GetClient ( const CFileItem & item ) const

Get the instance of a client that matches the given item.

Parameters

item	The item containing a PVR recording, a PVR channel, a PVR timer or a PVR EPG event.

Returns: the requested client on success, nullptr otherwise.

◆ GetClient() [2/2]

std::shared_ptr< CPVRClient > CPVRManager::GetClient ( int iClientId ) const

Get the instance of a client that matches the given id.

Parameters

iClientId The id of a PVR client.

Returns: the requested client on success, nullptr otherwise.

◆ GetTVDatabase()

std::shared_ptr< CPVRDatabase > CPVRManager::GetTVDatabase ( ) const

Get the TV database.

Returns: The TV database.

◆ IsParentalLocked() [1/2]

bool CPVRManager::IsParentalLocked ( const std::shared_ptr< CPVRChannel > & channel ) const

Check if parental lock is overridden at the given moment.

Parameters

channel The channel to check.

Returns: True if parental lock is overridden, false otherwise.

◆ IsParentalLocked() [2/2]

bool CPVRManager::IsParentalLocked ( const std::shared_ptr< CPVREpgInfoTag > & epgTag ) const

Check if parental lock is overridden at the given moment.

Parameters

epgTag The epg tag to check.

Returns: True if parental lock is overridden, false otherwise.

◆ IsStarted()

bool PVR::CPVRManager::IsStarted ( ) const

inline

Check whether the PVRManager has fully started.

Returns: True if started, false otherwise.

◆ OnPlaybackEnded()

void CPVRManager::OnPlaybackEnded ( const CFileItem & item )

Inform PVR manager that playback of an item has stopped without user interaction.

Parameters

item	The item that ended to play.

◆ OnPlaybackStarted()

void CPVRManager::OnPlaybackStarted ( const CFileItem & item )

Inform PVR manager that playback of an item just started.

Parameters

item	The item that started to play.

◆ OnPlaybackStopped()

void CPVRManager::OnPlaybackStopped ( const CFileItem & item )

Inform PVR manager that playback of an item was stopped due to user interaction.

Parameters

item	The item that stopped to play.

◆ PlaybackState()

std::shared_ptr< CPVRPlaybackState > CPVRManager::PlaybackState ( ) const

Get access to the pvr playback state.

Returns: The playback state.

◆ Providers()

std::shared_ptr< CPVRProviders > CPVRManager::Providers ( ) const

Get the providers container.

Returns: The providers container.

◆ PublishEvent()

void CPVRManager::PublishEvent ( PVREvent state )

Publish an event.

Parameters

state the event

◆ Recordings()

std::shared_ptr< CPVRRecordings > CPVRManager::Recordings ( ) const

Get the recordings container.

Returns: The recordings container.

◆ Timers()

std::shared_ptr< CPVRTimers > CPVRManager::Timers ( ) const

Get the timers container.

Returns: The timers container.

◆ TriggerChannelGroupsUpdate()

void CPVRManager::TriggerChannelGroupsUpdate ( int clientId )

Let the background thread update the channel groups list.

Parameters

clientId The id of the PVR client to update.

◆ TriggerChannelsUpdate()

void CPVRManager::TriggerChannelsUpdate ( int clientId )

Let the background thread update the channel list.

Parameters

clientId The id of the PVR client to update.

◆ TriggerProvidersUpdate()

void CPVRManager::TriggerProvidersUpdate ( int clientId )

Let the background thread update the provider list.

Parameters

clientId The id of the PVR client to update.

◆ TriggerRecordingsUpdate()

void CPVRManager::TriggerRecordingsUpdate ( int clientId )

Let the background thread update the recordings list.

Parameters

clientId The id of the PVR client to update.

◆ TriggerSearchMissingChannelIcons()

void CPVRManager::TriggerSearchMissingChannelIcons ( const std::shared_ptr< CPVRChannelGroup > & group )

Let the background thread search for missing channel icons for channels contained in the given group.

Parameters

group The channel group.

◆ TriggerTimersUpdate()

void CPVRManager::TriggerTimersUpdate ( int clientId )

Let the background thread update the timer list.

Parameters

clientId The id of the PVR client to update.

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

xbmc/pvr/PVRManager.h
xbmc/pvr/PVRManager.cpp

Public Member Functions

Protected Member Functions

Member Function Documentation

◆ ChannelGroups()

◆ Clients()

◆ CreateChannelEpgs()

◆ EpgContainer()

◆ EpgsCreated()

◆ Get()

◆ GetClient() [1/2]

◆ GetClient() [2/2]

◆ GetTVDatabase()

◆ IsParentalLocked() [1/2]

◆ IsParentalLocked() [2/2]

◆ IsStarted()

◆ OnPlaybackEnded()

◆ OnPlaybackStarted()

◆ OnPlaybackStopped()

◆ PlaybackState()

◆ Providers()

◆ PublishEvent()

◆ Recordings()

◆ Timers()

◆ TriggerChannelGroupsUpdate()

◆ TriggerChannelsUpdate()

◆ TriggerProvidersUpdate()

◆ TriggerRecordingsUpdate()

◆ TriggerSearchMissingChannelIcons()

◆ TriggerTimersUpdate()