PVR::CPVRRecordings Class Reference

#include <PVRRecordings.h>

Public Member Functions
	CPVRRecordings ()
virtual	~CPVRRecordings ()
bool	Update (const std::vector< std::shared_ptr< CPVRClient > > &clients)
	Update all recordings from the given PVR clients.
void	Unload ()
	unload all recordings.
bool	UpdateFromClients (const std::vector< std::shared_ptr< CPVRClient > > &clients)
	Update data with recordings from the given clients, sync with local data.
void	UpdateFromClient (const std::shared_ptr< CPVRRecording > &tag, const CPVRClient &client)
	client has delivered a new/updated recording.
void	UpdateInProgressSize ()
	refresh the size of any in progress recordings from the clients.
int	GetNumTVRecordings () const
bool	HasDeletedTVRecordings () const
int	GetNumRadioRecordings () const
bool	HasDeletedRadioRecordings () const
bool	MarkWatched (const std::shared_ptr< CPVRRecording > &recording, bool bWatched)
	Set a recording's watched state.
bool	ResetResumePoint (const std::shared_ptr< CPVRRecording > &recording)
	Reset a recording's resume point, if any.
bool	DeleteRecording (const std::shared_ptr< CPVRRecording > &recording)
	Delete a recording in the backend, cleanup db enries.
std::vector< std::shared_ptr< CPVRRecording > >	GetAll () const
	Get a list of all recordings.
std::shared_ptr< CPVRRecording >	GetByPath (const std::string &path) const
std::shared_ptr< CPVRRecording >	GetById (int iClientId, const std::string &strRecordingId) const
std::shared_ptr< CPVRRecording >	GetById (unsigned int iId) const
bool	HasRecordingForProvider (bool isRadio, int clientId, int providerId) const
	Check whether at least one recording is offered by the given provider.
unsigned int	GetRecordingCountByProvider (bool isRadio, int clientId, int providerId) const
	Get the total count of recordings offered by the given provider.
std::shared_ptr< CPVRRecording >	GetRecordingForEpgTag (const std::shared_ptr< const CPVREpgInfoTag > &epgTag) const
	Get the recording for the given epg tag, if any.
int	CleanupCachedImages ()
	Erase stale texture db entries and image files.

Constructor & Destructor Documentation

CPVRRecordings()

CPVRRecordings::CPVRRecordings ( )

default

~CPVRRecordings()

CPVRRecordings::~CPVRRecordings ( )

virtual

Member Function Documentation

CleanupCachedImages()

int CPVRRecordings::CleanupCachedImages

(

)

Erase stale texture db entries and image files.

Returns

number of cleaned up images.

DeleteRecording()

bool CPVRRecordings::DeleteRecording

(

const std::shared_ptr< CPVRRecording > &

recording

)

Delete a recording in the backend, cleanup db enries.

Parameters

recording

The recording

Returns

True on success, false otherwise

GetAll()

std::vector< std::shared_ptr< CPVRRecording > > CPVRRecordings::GetAll

(

)

const

Get a list of all recordings.

Returns

the list of all recordings

GetById() [1/2]

std::shared_ptr< CPVRRecording > CPVRRecordings::GetById	(	int	iClientId,
		const std::string &	strRecordingId ) const

GetById() [2/2]

std::shared_ptr< CPVRRecording > CPVRRecordings::GetById

(

unsigned int

iId

)

const

GetByPath()

std::shared_ptr< CPVRRecording > CPVRRecordings::GetByPath

(

const std::string &

path

)

const

GetNumRadioRecordings()

int CPVRRecordings::GetNumRadioRecordings

(

)

const

GetNumTVRecordings()

int CPVRRecordings::GetNumTVRecordings

(

)

const

GetRecordingCountByProvider()

unsigned int CPVRRecordings::GetRecordingCountByProvider	(	bool	isRadio,
		int	clientId,
		int	providerId ) const

Get the total count of recordings offered by the given provider.

Parameters

isRadio	Check radio or TV recordings.
clientId	The clientId of the provider.
providerId	The providerId.

Returns

The total count of matching recordings.

GetRecordingForEpgTag()

std::shared_ptr< CPVRRecording > CPVRRecordings::GetRecordingForEpgTag

(

const std::shared_ptr< const CPVREpgInfoTag > &

epgTag

)

const

Get the recording for the given epg tag, if any.

Parameters

epgTag

The epg tag.

Returns

The requested recording, or an empty recordingptr if none was found.

HasDeletedRadioRecordings()

bool CPVRRecordings::HasDeletedRadioRecordings

(

)

const

HasDeletedTVRecordings()

bool CPVRRecordings::HasDeletedTVRecordings

(

)

const

HasRecordingForProvider()

bool CPVRRecordings::HasRecordingForProvider	(	bool	isRadio,
		int	clientId,
		int	providerId ) const

Check whether at least one recording is offered by the given provider.

Parameters

isRadio	Check radio or TV recordings.
clientId	The clientId to check.
providerId	The providerId to check.

Returns

True, if at least one matching recording is offered by the provider, false otherwise.

MarkWatched()

bool CPVRRecordings::MarkWatched	(	const std::shared_ptr< CPVRRecording > &	recording,
		bool	bWatched )

Set a recording's watched state.

Parameters

recording	The recording
bWatched	True to set watched, false to set unwatched state

Returns

True on success, false otherwise

ResetResumePoint()

bool CPVRRecordings::ResetResumePoint

(

const std::shared_ptr< CPVRRecording > &

recording

)

Reset a recording's resume point, if any.

Parameters

recording

The recording

Returns

True on success, false otherwise

Unload()

void CPVRRecordings::Unload

(

)

unload all recordings.

Update()

bool CPVRRecordings::Update

(

const std::vector< std::shared_ptr< CPVRClient > > &

clients

)

Update all recordings from the given PVR clients.

Parameters

clients

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

Returns

True on success, false otherwise.

UpdateFromClient()

void CPVRRecordings::UpdateFromClient	(	const std::shared_ptr< CPVRRecording > &	tag,
		const CPVRClient &	client )

client has delivered a new/updated recording.

Parameters

tag	The recording
client	The client the recording belongs to.

UpdateFromClients()

bool CPVRRecordings::UpdateFromClients

(

const std::vector< std::shared_ptr< CPVRClient > > &

clients

)

Update data with recordings 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.

Returns

True on success, false otherwise.

UpdateInProgressSize()

void CPVRRecordings::UpdateInProgressSize

(

)

refresh the size of any in progress recordings from the clients.

---

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

• PVRRecordings.h
• PVRRecordings.cpp