#include <PVRRecording.h>

Inheritance diagram for PVR::CPVRRecording:

Public Member Functions
	CPVRRecording ()

	CPVRRecording (const PVR_RECORDING &recording, unsigned int iClientId)

bool	operator== (const CPVRRecording &right) const

bool	operator!= (const CPVRRecording &right) const

void	FillAddonData (PVR_RECORDING &recording) const
	Copy over data to the given PVR_RECORDING instance.

void	Serialize (CVariant &value) const override

void	ToSortable (SortItem &sortable, Field field) const override

void	Reset ()
	Reset this tag to it's initial state.

bool	Delete ()
	Delete this recording on the client (if supported).

bool	Undelete ()
	Undelete this recording on the client (if supported).

bool	Rename (const std::string &strNewName)
	Rename this recording on the client (if supported).

bool	SetPlayCount (int count) override
	Set this recording's play count. The value will be transferred to the backend if it supports server-side play counts.

bool	IncrementPlayCount () override
	Increment this recording's play count. The value will be transferred to the backend if it supports server-side play counts.

bool	SetLocalPlayCount (int count)
	Set this recording's play count without transferring the value to the backend, even if it supports server-side play counts.

int	GetLocalPlayCount () const
	Get this recording's local play count. The value will not be obtained from the backend, even if it supports server-side play counts.

bool	SetResumePoint (const CBookmark &resumePoint) override
	Set this recording's resume point. The value will be transferred to the backend if it supports server-side resume points.

bool	SetResumePoint (double timeInSeconds, double totalTimeInSeconds, const std::string &playerState="") override
	Set this recording's resume point. The value will be transferred to the backend if it supports server-side resume points.

CBookmark	GetResumePoint () const override
	Get this recording's resume point. The value will be obtained from the backend if it supports server-side resume points.

bool	UpdateRecordingSize ()
	Update this recording's size. The value will be obtained from the backend if it supports server-side size retrieval.

CBookmark	GetLocalResumePoint () const
	Get this recording's local resume point. The value will not be obtained from the backend even if it supports server-side resume points.

std::vector< PVR_EDL_ENTRY >	GetEdl () const
	Retrieve the edit decision list (EDL) of a recording on the backend.

void	UpdateMetadata (CVideoDatabase &db, const CPVRClient &client)
	Get the resume point and play count from the database if the client doesn't handle it itself.

void	Update (const CPVRRecording &tag, const CPVRClient &client)
	Update this tag with the contents of the given tag.

const CDateTime &	RecordingTimeAsUTC () const
	Retrieve the recording start as UTC time.

const CDateTime &	RecordingTimeAsLocalTime () const
	Retrieve the recording start as local time.

CDateTime	EndTimeAsUTC () const
	Retrieve the recording end as UTC time.

CDateTime	EndTimeAsLocalTime () const
	Retrieve the recording end as local time.

bool	HasExpirationTime () const
	Check whether this recording has an expiration time.

CDateTime	ExpirationTimeAsLocalTime () const
	Retrieve the recording expiration time as local time.

bool	WillBeExpiredWithNewLifetime (int iLifetime) const
	Check whether this recording will immediately expire if the given lifetime value would be set.

bool	IsDeleted () const
	If deleted but can be undeleted it is true.

bool	IsRadio () const
	Check whether this is a tv or radio recording.

unsigned int	BroadcastUid () const

std::shared_ptr< CPVRChannel >	Channel () const

int	ChannelUid () const
	Get the uid of the channel on which this recording is/was running.

int	ClientID () const
	the identifier of the client that serves this recording

std::string	ClientRecordingID () const
	Get the recording ID as upplied by the client.

unsigned int	RecordingID () const
	Get the recording ID as upplied by the client.

void	SetRecordingID (unsigned int recordingId)
	Set the recording ID.

std::string	Directory () const
	Get the directory for this recording.

int	Priority () const
	Get the priority for this recording.

int	LifeTime () const
	Get the lifetime for this recording.

void	SetLifeTime (int lifeTime)
	Set the lifetime for this recording.

std::string	ChannelName () const
	Get the channel name for this recording.

const std::string &	ClientIconPath () const
	Return the icon path as given by the client.

const std::string &	ClientThumbnailPath () const
	Return the thumbnail path as given by the client.

const std::string &	ClientFanartPath () const
	Return the fanart path as given by the client.

const std::string &	IconPath () const
	Return the icon path used by Kodi.

const std::string &	ThumbnailPath () const
	Return the thumnail path used by Kodi.

const std::string &	FanartPath () const
	Return the fanart path used by Kodi.

std::string	EpisodeName () const
	Retrieve the recording Episode Name.

bool	IsInProgress () const
	check whether this recording is currently in progress

std::shared_ptr< CPVRTimerInfoTag >	GetRecordingTimer () const
	return the timer for an in-progress recording, if any

void	SetGenre (int iGenreType, int iGenreSubType, const std::string &strGenre)
	set the genre for this recording.

int	GenreType () const
	Get the genre type ID of this recording.

int	GenreSubType () const
	Get the genre subtype ID of this recording.

const std::vector< std::string >	Genre () const
	Get the genre as human readable string.

const std::string	GetGenresLabel () const
	Get the genre(s) of this recording as formatted string.

CDateTime	FirstAired () const
	Get the first air date of this recording.

int	GetYear () const override
	Get the premiere year of this recording.

void	SetYear (int year) override
	Set the premiere year of this recording.

bool	HasYear () const override
	Check if the premiere year of this recording is valid.

bool	IsNew () const
	Check whether this recording will be flagged as new.

bool	IsPremiere () const
	Check whether this recording will be flagged as a premiere.

bool	IsFinale () const
	Check whether this recording will be flagged as a finale.

bool	IsLive () const
	Check whether this recording will be flagged as live.

unsigned int	Flags () const
	Return the flags (PVR_RECORDING_FLAG_*) of this recording as a bitfield.

int64_t	GetSizeInBytes () const
	Return the size of this recording in bytes.

void	SetDirty (bool bDirty)
	Mark a recording as dirty/clean.

bool	IsDirty () const
	Return whether the recording is marked dirty.

int	ClientProviderUniqueId () const
	Get the uid of the provider on the client which this recording is from.

std::string	ProviderName () const
	Get the client provider name for this recording.

std::shared_ptr< CPVRProvider >	GetDefaultProvider () const
	Get the default provider of this recording. The default provider represents the PVR add-on itself.

bool	HasClientProvider () const
	Whether or not this recording has a provider set by the client.

std::shared_ptr< CPVRProvider >	GetProvider () const
	Get the provider of this recording. This may be the default provider or a custom provider set by the client. If HasClientProvider() returns true the provider will be custom from the client, otherwise the default provider.

Public Member Functions inherited from CVideoInfoTag
	CVideoInfoTag ()

virtual	~CVideoInfoTag ()=default

void	Reset ()

bool	Load (const TiXmlElement *element, bool append=false, bool prioritise=false)

bool	Save (TiXmlNode node, const std::string &tag, bool savePathInfo=true, const TiXmlElement additionalNode=NULL)

void	Merge (CVideoInfoTag &other)

void	Archive (CArchive &ar) override

void	Serialize (CVariant &value) const override

void	ToSortable (SortItem &sortable, Field field) const override

const CRating	GetRating (std::string type="") const

const std::string &	GetDefaultRating () const

const std::string	GetUniqueID (std::string type="") const

const std::map< std::string, std::string > &	GetUniqueIDs () const

const std::string &	GetDefaultUniqueID () const

bool	HasUniqueID () const

bool	HasPremiered () const

const CDateTime &	GetPremiered () const

const CDateTime &	GetFirstAired () const

const std::string	GetCast (bool bIncludeRole=false) const

bool	HasStreamDetails () const

bool	IsEmpty () const

const std::string &	GetPath () const

void	SetDuration (int duration)
	set the duration in seconds

unsigned int	GetDuration () const
	retrieve the duration in seconds. Prefers the duration from stream details if available.

unsigned int	GetStaticDuration () const
	retrieve the duration in seconds. Ignores the duration from stream details even if available.

void	SetBasePath (std::string basePath)

void	SetDirector (std::vector< std::string > director)

void	SetWritingCredits (std::vector< std::string > writingCredits)

void	SetGenre (std::vector< std::string > genre)

void	SetCountry (std::vector< std::string > country)

void	SetTagLine (std::string tagLine)

void	SetPlotOutline (std::string plotOutline)

void	SetTrailer (std::string trailer)

void	SetPlot (std::string plot)

std::string const &	GetTitle () const

void	SetTitle (std::string title)

void	SetSortTitle (std::string sortTitle)

void	SetPictureURL (CScraperUrl &pictureURL)

void	SetRating (float rating, int votes, const std::string &type="", bool def=false)

void	SetRating (CRating rating, const std::string &type="", bool def=false)

void	SetRating (float rating, const std::string &type="", bool def=false)

void	RemoveRating (const std::string &type)

void	SetRatings (RatingMap ratings, const std::string &defaultRating="")

void	SetVotes (int votes, const std::string &type="")

void	SetUniqueIDs (std::map< std::string, std::string > uniqueIDs)

void	SetPremiered (const CDateTime &premiered)

void	SetPremieredFromDBDate (const std::string &premieredString)

void	SetArtist (std::vector< std::string > artist)

void	SetSet (std::string set)

void	SetSetOverview (std::string setOverview)

void	SetTags (std::vector< std::string > tags)

void	SetFile (std::string file)

void	SetPath (std::string path)

void	SetMPAARating (std::string mpaaRating)

void	SetFileNameAndPath (std::string fileNameAndPath)

void	SetOriginalTitle (std::string originalTitle)

void	SetEpisodeGuide (std::string episodeGuide)

void	SetStatus (std::string status)

void	SetProductionCode (std::string productionCode)

void	SetShowTitle (std::string showTitle)

void	SetStudio (std::vector< std::string > studio)

void	SetAlbum (std::string album)

void	SetShowLink (std::vector< std::string > showLink)

void	SetUniqueID (const std::string &uniqueid, const std::string &type="", bool def=false)

void	RemoveUniqueID (const std::string &type)

void	SetNamedSeasons (std::map< int, std::string > namedSeasons)

void	SetUserrating (int userrating)

virtual int	GetPlayCount () const
	Get this videos's play count.

virtual void	ResetPlayCount ()
	Reset playcount.

virtual bool	IsPlayCountSet () const
	Check if the playcount is set.

const CAssetInfo &	GetAssetInfo () const
	Get the video's asset info.

CAssetInfo &	GetAssetInfo ()

bool	HasVideoVersions () const
	Whether the item has multiple video versions.

void	SetHasVideoVersions (bool hasVersions)
	Set whether this video has video versions.

bool	HasVideoExtras () const
	Whether the item has video extras.

void	SetHasVideoExtras (bool hasExtras)
	Set whether this video has video extras.

bool	IsDefaultVideoVersion () const
	Whether the item is the default video version.

void	SetIsDefaultVideoVersion (bool isDefaultVideoVersion)
	Set whether the item is the default version.

bool	GetUpdateSetOverview () const
	Get whether the Set Overview should be updated. If an NFO contains a <name> but no <overview> then this allows the current Overview to be kept. Otherwise it is overwritten. Default is true - so if updated by a scraper the Overview will be overwritten.

Static Public Member Functions
static std::string	GetTitleFromURL (const std::string &url)
	Retrieve the recording title from the URL path.

Static Public Member Functions inherited from CVideoInfoTag
static unsigned int	GetDurationFromMinuteString (const std::string &runtime)
	get the duration in seconds from a minute string

Static Public Attributes
static const std::string	IMAGE_OWNER_PATTERN = "pvrrecording"

Additional Inherited Members
Public Types inherited from CVideoInfoTag
typedef std::vector< SActorInfo >::const_iterator	iCast

Public Attributes inherited from CVideoInfoTag
std::string	m_basePath

int	m_parentPathID

std::vector< std::string >	m_director

std::vector< std::string >	m_writingCredits

std::vector< std::string >	m_genre

std::vector< std::string >	m_country

std::string	m_strTagLine

std::string	m_strPlotOutline

std::string	m_strTrailer

std::string	m_strPlot

CScraperUrl	m_strPictureURL

std::string	m_strTitle

std::string	m_strSortTitle

std::vector< std::string >	m_artist

std::vector< SActorInfo >	m_cast

SetInfo	m_set
	Assigned movie set.

std::vector< std::string >	m_tags

std::string	m_strFile

std::string	m_strPath

std::string	m_strMPAARating

std::string	m_strFileNameAndPath

std::string	m_strOriginalTitle

std::string	m_strEpisodeGuide

CDateTime	m_premiered

bool	m_bHasPremiered

std::string	m_strStatus

std::string	m_strProductionCode

CDateTime	m_firstAired

std::string	m_strShowTitle

std::vector< std::string >	m_studio

std::string	m_strAlbum

CDateTime	m_lastPlayed

std::vector< std::string >	m_showLink

std::map< int, std::string >	m_namedSeasons

int	m_iTop250

int	m_year

int	m_iSeason

int	m_iEpisode

int	m_iIdUniqueID

int	m_iDbId

int	m_iFileId

int	m_iSpecialSortSeason

int	m_iSpecialSortEpisode

int	m_iTrack

RatingMap	m_ratings

int	m_iIdRating

int	m_iUserRating

CBookmark	m_EpBookmark

int	m_iBookmarkId

int	m_iIdShow

int	m_iIdSeason

CFanart	m_fanart

CStreamDetails	m_streamDetails

CDateTime	m_dateAdded

MediaType	m_type

int	m_relevance

int	m_parsedDetails

std::vector< EmbeddedArtInfo >	m_coverArt
	art information

unsigned int	m_duration
	duration in seconds

Protected Member Functions inherited from IArchivable
virtual	~IArchivable ()=default

Protected Member Functions inherited from ISerializable
	~ISerializable ()=default

Protected Member Functions inherited from ISortable
	~ISortable ()=default

Constructor & Destructor Documentation

◆ CPVRRecording() [1/2]

CPVRRecording::CPVRRecording ( )

◆ CPVRRecording() [2/2]

CPVRRecording::CPVRRecording	(	const PVR_RECORDING &	recording,
		unsigned int	iClientId )

Member Function Documentation

◆ BroadcastUid()

unsigned int PVR::CPVRRecording::BroadcastUid ( ) const

inline

Returns: Broadcast id of the EPG event associated with this recording or EPG_TAG_INVALID_UID

◆ Channel()

std::shared_ptr< CPVRChannel > CPVRRecording::Channel ( ) const

Returns: Get the channel on which this recording is/was running

Note: Only works if the recording has a channel uid provided by the add-on

◆ ChannelName()

std::string PVR::CPVRRecording::ChannelName ( ) const

inline

Get the channel name for this recording.

Returns: the channel name

◆ ChannelUid()

int CPVRRecording::ChannelUid ( ) const

Get the uid of the channel on which this recording is/was running.

Returns: the uid of the channel or PVR_CHANNEL_INVALID_UID

◆ ClientFanartPath()

const std::string & PVR::CPVRRecording::ClientFanartPath ( ) const

inline

Return the fanart path as given by the client.

Returns: The path.

◆ ClientIconPath()

const std::string & PVR::CPVRRecording::ClientIconPath ( ) const

inline

Return the icon path as given by the client.

Returns: The path.

◆ ClientID()

int CPVRRecording::ClientID ( ) const

the identifier of the client that serves this recording

Returns: the client identifier

◆ ClientProviderUniqueId()

int CPVRRecording::ClientProviderUniqueId ( ) const

Get the uid of the provider on the client which this recording is from.

Returns: the client uid of the provider or PVR_PROVIDER_INVALID_UID

◆ ClientRecordingID()

std::string PVR::CPVRRecording::ClientRecordingID ( ) const

inline

Get the recording ID as upplied by the client.

Returns: the recording identifier

◆ ClientThumbnailPath()

const std::string & PVR::CPVRRecording::ClientThumbnailPath ( ) const

inline

Return the thumbnail path as given by the client.

Returns: The path.

◆ Delete()

bool CPVRRecording::Delete ( )

Delete this recording on the client (if supported).

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

◆ Directory()

std::string PVR::CPVRRecording::Directory ( ) const

inline

Get the directory for this recording.

Returns: the directory

◆ EndTimeAsLocalTime()

CDateTime CPVRRecording::EndTimeAsLocalTime ( ) const

Retrieve the recording end as local time.

Returns: the recording end time

◆ EndTimeAsUTC()

CDateTime CPVRRecording::EndTimeAsUTC ( ) const

Retrieve the recording end as UTC time.

Returns: the recording end time

◆ EpisodeName()

std::string PVR::CPVRRecording::EpisodeName ( ) const

inline

Retrieve the recording Episode Name.

Note: Returns an empty string if no Episode Name was provided by the PVR client

◆ ExpirationTimeAsLocalTime()

CDateTime CPVRRecording::ExpirationTimeAsLocalTime ( ) const

Retrieve the recording expiration time as local time.

Returns: the recording expiration time

◆ FanartPath()

const std::string & PVR::CPVRRecording::FanartPath ( ) const

inline

Return the fanart path used by Kodi.

Returns: The path.

◆ FillAddonData()

void CPVRRecording::FillAddonData ( PVR_RECORDING & recording ) const

Copy over data to the given PVR_RECORDING instance.

Parameters

recording The recording instance to fill.

◆ FirstAired()

CDateTime CPVRRecording::FirstAired ( ) const

Get the first air date of this recording.

Returns: The first air date.

◆ Flags()

unsigned int PVR::CPVRRecording::Flags ( ) const

inline

Return the flags (PVR_RECORDING_FLAG_*) of this recording as a bitfield.

Returns: the flags.

◆ Genre()

const std::vector< std::string > PVR::CPVRRecording::Genre ( ) const

inline

Get the genre as human readable string.

Returns: The genre.

◆ GenreSubType()

int PVR::CPVRRecording::GenreSubType ( ) const

inline

Get the genre subtype ID of this recording.

Returns: The genre subtype ID.

◆ GenreType()

int PVR::CPVRRecording::GenreType ( ) const

inline

Get the genre type ID of this recording.

Returns: The genre type ID.

◆ GetDefaultProvider()

std::shared_ptr< CPVRProvider > CPVRRecording::GetDefaultProvider ( ) const

Get the default provider of this recording. The default provider represents the PVR add-on itself.

Returns: The default provider of this recording

◆ GetEdl()

std::vector< PVR_EDL_ENTRY > CPVRRecording::GetEdl ( ) const

Retrieve the edit decision list (EDL) of a recording on the backend.

Returns: The edit decision list (empty on error)

◆ GetGenresLabel()

const std::string CPVRRecording::GetGenresLabel ( ) const

Get the genre(s) of this recording as formatted string.

Returns: The genres label.

◆ GetLocalPlayCount()

int PVR::CPVRRecording::GetLocalPlayCount ( ) const

inline

Get this recording's local play count. The value will not be obtained from the backend, even if it supports server-side play counts.

Returns: the play count.

◆ GetLocalResumePoint()

CBookmark PVR::CPVRRecording::GetLocalResumePoint ( ) const

inline

Get this recording's local resume point. The value will not be obtained from the backend even if it supports server-side resume points.

Returns: the resume point.

◆ GetProvider()

std::shared_ptr< CPVRProvider > CPVRRecording::GetProvider ( ) const

Get the provider of this recording. This may be the default provider or a custom provider set by the client. If HasClientProvider() returns true the provider will be custom from the client, otherwise the default provider.

Returns: The provider of this recording

◆ GetRecordingTimer()

std::shared_ptr< CPVRTimerInfoTag > CPVRRecording::GetRecordingTimer ( ) const

return the timer for an in-progress recording, if any

Returns: the timer if the recording is in progress, nullptr otherwise

◆ GetResumePoint()

CBookmark CPVRRecording::GetResumePoint ( ) const

overridevirtual

Get this recording's resume point. The value will be obtained from the backend if it supports server-side resume points.

Returns: the resume point.

Reimplemented from CVideoInfoTag.

◆ GetSizeInBytes()

int64_t CPVRRecording::GetSizeInBytes ( ) const

Return the size of this recording in bytes.

Returns: the size in bytes.

◆ GetTitleFromURL()

std::string CPVRRecording::GetTitleFromURL ( const std::string & url )

static

Retrieve the recording title from the URL path.

Parameters

url	the URL for the recording

Returns: Title of the recording

◆ GetYear()

int CPVRRecording::GetYear ( ) const

overridevirtual

Get the premiere year of this recording.

Returns: The premiere year

Reimplemented from CVideoInfoTag.

◆ HasClientProvider()

bool CPVRRecording::HasClientProvider ( ) const

Whether or not this recording has a provider set by the client.

Returns: True if a provider was set by the client, false otherwise.

◆ HasExpirationTime()

bool PVR::CPVRRecording::HasExpirationTime ( ) const

inline

Check whether this recording has an expiration time.

Returns: True if the recording has an expiration time, false otherwise

◆ HasYear()

bool CPVRRecording::HasYear ( ) const

overridevirtual

Check if the premiere year of this recording is valid.

Returns: True if the recording has as valid premiere date, false otherwise

Reimplemented from CVideoInfoTag.

◆ IconPath()

const std::string & PVR::CPVRRecording::IconPath ( ) const

inline

Return the icon path used by Kodi.

Returns: The path.

◆ IncrementPlayCount()

bool CPVRRecording::IncrementPlayCount ( )

overridevirtual

Increment this recording's play count. The value will be transferred to the backend if it supports server-side play counts.

Returns: True if play count was increased successfully, false otherwise.

Reimplemented from CVideoInfoTag.

◆ IsDeleted()

bool PVR::CPVRRecording::IsDeleted ( ) const

inline

If deleted but can be undeleted it is true.

◆ IsDirty()

bool PVR::CPVRRecording::IsDirty ( ) const

inline

Return whether the recording is marked dirty.

Returns: true if dirty, false otherwise.

◆ IsFinale()

bool CPVRRecording::IsFinale ( ) const

Check whether this recording will be flagged as a finale.

Returns: True if this recording will be flagged as a finale, false otherwise

◆ IsInProgress()

bool CPVRRecording::IsInProgress ( ) const

check whether this recording is currently in progress

Returns: true if the recording is in progress, false otherwise

◆ IsLive()

bool CPVRRecording::IsLive ( ) const

Check whether this recording will be flagged as live.

Returns: True if this recording will be flagged as live, false otherwise

◆ IsNew()

bool CPVRRecording::IsNew ( ) const

Check whether this recording will be flagged as new.

Returns: True if this recording will be flagged as new, false otherwise

◆ IsPremiere()

bool CPVRRecording::IsPremiere ( ) const

Check whether this recording will be flagged as a premiere.

Returns: True if this recording will be flagged as a premiere, false otherwise

◆ IsRadio()

bool PVR::CPVRRecording::IsRadio ( ) const

inline

Check whether this is a tv or radio recording.

Returns: true if this is a radio recording, false if this is a tv recording

◆ LifeTime()

int PVR::CPVRRecording::LifeTime ( ) const

inline

Get the lifetime for this recording.

Returns: the lifetime

◆ operator!=()

bool CPVRRecording::operator!= ( const CPVRRecording & right ) const

◆ operator==()

bool CPVRRecording::operator== ( const CPVRRecording & right ) const

◆ Priority()

int PVR::CPVRRecording::Priority ( ) const

inline

Get the priority for this recording.

Returns: the priority

◆ ProviderName()

std::string CPVRRecording::ProviderName ( ) const

Get the client provider name for this recording.

Returns: m_strProviderName The name for this recording provider

◆ RecordingID()

unsigned int PVR::CPVRRecording::RecordingID ( ) const

inline

Get the recording ID as upplied by the client.

Returns: the recording identifier

◆ RecordingTimeAsLocalTime()

const CDateTime & CPVRRecording::RecordingTimeAsLocalTime ( ) const

Retrieve the recording start as local time.

Returns: the recording start time

◆ RecordingTimeAsUTC()

const CDateTime & PVR::CPVRRecording::RecordingTimeAsUTC ( ) const

inline

Retrieve the recording start as UTC time.

Returns: the recording start time

◆ Rename()

bool CPVRRecording::Rename ( const std::string & strNewName )

Rename this recording on the client (if supported).

Parameters

strNewName The new name.

Returns: True if it was renamed successfully, false otherwise.

◆ Reset()

void CPVRRecording::Reset ( )

Reset this tag to it's initial state.

◆ Serialize()

void CPVRRecording::Serialize ( CVariant & value ) const

overridevirtual

Implements ISerializable.

◆ SetDirty()

void PVR::CPVRRecording::SetDirty ( bool bDirty )

inline

Mark a recording as dirty/clean.

Parameters

bDirty true to mark as dirty, false to mark as clean.

◆ SetGenre()

void CPVRRecording::SetGenre	(	int	iGenreType,
		int	iGenreSubType,
		const std::string &	strGenre )

set the genre for this recording.

Parameters

iGenreType	The genre type ID. If set to EPG_GENRE_USE_STRING, set genre to the value provided with strGenre. Otherwise, compile the genre string from the values given by iGenreType and iGenreSubType
iGenreSubType	The genre subtype ID
strGenre	The genre

◆ SetLifeTime()

void PVR::CPVRRecording::SetLifeTime ( int lifeTime )

inline

Set the lifetime for this recording.

Parameters

lifeTime The lifetime

◆ SetLocalPlayCount()

bool PVR::CPVRRecording::SetLocalPlayCount ( int count )

inline

Set this recording's play count without transferring the value to the backend, even if it supports server-side play counts.

Parameters

count play count.

Returns: True if play count was set successfully, false otherwise.

◆ SetPlayCount()

bool CPVRRecording::SetPlayCount ( int count )

overridevirtual

Set this recording's play count. The value will be transferred to the backend if it supports server-side play counts.

Parameters

count play count.

Returns: True if play count was set successfully, false otherwise.

Reimplemented from CVideoInfoTag.

◆ SetRecordingID()

void PVR::CPVRRecording::SetRecordingID ( unsigned int recordingId )

inline

Set the recording ID.

Parameters

recordingId The new identifier

◆ SetResumePoint() [1/2]

bool CPVRRecording::SetResumePoint ( const CBookmark & resumePoint )

overridevirtual

Set this recording's resume point. The value will be transferred to the backend if it supports server-side resume points.

Parameters

resumePoint resume point.

Returns: True if resume point was set successfully, false otherwise.

Reimplemented from CVideoInfoTag.

◆ SetResumePoint() [2/2]

bool CPVRRecording::SetResumePoint	(	double	timeInSeconds,
		double	totalTimeInSeconds,
		const std::string &	playerState = "" )

overridevirtual

Set this recording's resume point. The value will be transferred to the backend if it supports server-side resume points.

Parameters

timeInSeconds	the time of the resume point
totalTimeInSeconds	the total time of the video
playerState	the player state

Returns: True if resume point was set successfully, false otherwise.

Reimplemented from CVideoInfoTag.

◆ SetYear()

void CPVRRecording::SetYear ( int year )

overridevirtual

Set the premiere year of this recording.

Parameters

year	The premiere year

Reimplemented from CVideoInfoTag.

◆ ThumbnailPath()

const std::string & PVR::CPVRRecording::ThumbnailPath ( ) const

inline

Return the thumnail path used by Kodi.

Returns: The path.

◆ ToSortable()

void CPVRRecording::ToSortable	(	SortItem &	sortable,
		Field	field ) const

overridevirtual

Implements ISortable.

◆ Undelete()

bool CPVRRecording::Undelete ( )

Undelete this recording on the client (if supported).

Returns: True if it was undeleted successfully, false otherwise.

◆ Update()

void CPVRRecording::Update	(	const CPVRRecording &	tag,
		const CPVRClient &	client )

Update this tag with the contents of the given tag.

Parameters

tag	The new tag info.
client	The client this recording belongs to.

◆ UpdateMetadata()

void CPVRRecording::UpdateMetadata	(	CVideoDatabase &	db,
		const CPVRClient &	client )

Get the resume point and play count from the database if the client doesn't handle it itself.

Parameters

db	The database to read the data from.
client	The client this recording belongs to.

◆ UpdateRecordingSize()

bool CPVRRecording::UpdateRecordingSize ( )

Update this recording's size. The value will be obtained from the backend if it supports server-side size retrieval.

Returns: true if the the updated value is different, false otherwise.

◆ WillBeExpiredWithNewLifetime()

bool CPVRRecording::WillBeExpiredWithNewLifetime ( int iLifetime ) const

Check whether this recording will immediately expire if the given lifetime value would be set.

Parameters

iLifetime The lifetime value to check

Returns: True if the recording would immediately expire, false otherwiese

Member Data Documentation

◆ IMAGE_OWNER_PATTERN

const std::string CPVRRecording::IMAGE_OWNER_PATTERN = "pvrrecording"

static

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ CPVRRecording() [1/2]

◆ CPVRRecording() [2/2]

Member Function Documentation

◆ BroadcastUid()

◆ Channel()

◆ ChannelName()

◆ ChannelUid()

◆ ClientFanartPath()

◆ ClientIconPath()

◆ ClientID()

◆ ClientProviderUniqueId()

◆ ClientRecordingID()

◆ ClientThumbnailPath()

◆ Delete()

◆ Directory()

◆ EndTimeAsLocalTime()

◆ EndTimeAsUTC()

◆ EpisodeName()

◆ ExpirationTimeAsLocalTime()

◆ FanartPath()

◆ FillAddonData()

◆ FirstAired()

◆ Flags()

◆ Genre()

◆ GenreSubType()

◆ GenreType()

◆ GetDefaultProvider()

◆ GetEdl()

◆ GetGenresLabel()

◆ GetLocalPlayCount()

◆ GetLocalResumePoint()

◆ GetProvider()

◆ GetRecordingTimer()

◆ GetResumePoint()

◆ GetSizeInBytes()

◆ GetTitleFromURL()

◆ GetYear()

◆ HasClientProvider()

◆ HasExpirationTime()

◆ HasYear()

◆ IconPath()

◆ IncrementPlayCount()

◆ IsDeleted()

◆ IsDirty()

◆ IsFinale()

◆ IsInProgress()

◆ IsLive()

◆ IsNew()

◆ IsPremiere()

◆ IsRadio()

◆ LifeTime()

◆ operator!=()

◆ operator==()

◆ Priority()

◆ ProviderName()

◆ RecordingID()

◆ RecordingTimeAsLocalTime()

◆ RecordingTimeAsUTC()

◆ Rename()

◆ Reset()

◆ Serialize()

◆ SetDirty()

◆ SetGenre()

◆ SetLifeTime()

◆ SetLocalPlayCount()

◆ SetPlayCount()

◆ SetRecordingID()

◆ SetResumePoint() [1/2]

◆ SetResumePoint() [2/2]

◆ SetYear()

◆ ThumbnailPath()

◆ ToSortable()

◆ Undelete()

◆ Update()

◆ UpdateMetadata()