class PVRRecording

Detailed Description

Data structure with available recordings data
With this, recordings related data are transferred between addon and Kodi and can also be used by the addon itself.

The related values here are automatically initiated to defaults and need only be set if supported and used.

---

The following table contains values that can be set with class PVRRecording :

Name	Type	Set call	Get call	Usage
Recording id	std::string	SetRecordingId	GetRecordingId	required to set
Title	std::string	SetTitle	GetTitle	required to set
Episode name	std::string	SetEpisodeName	GetEpisodeName	optional
Series number	int	SetSeriesNumber	GetSeriesNumber	optional
Episode number	int	SetEpisodeNumber	GetEpisodeNumber	optional
Year	int	SetYear	GetYear	optional
Directory	std::string	SetDirectory	GetDirectory	optional
Plot outline	std::string	SetPlotOutline	GetPlotOutline	optional
Plot	std::string	SetPlot	GetPlot	optional
Genre description	std::string	SetGenreDescription	GetGenreDescription	optional
Channel name	std::string	SetChannelName	GetChannelName	optional
Icon path	std::string	SetIconPath	GetIconPath	optional
Thumbnail path	std::string	SetThumbnailPath	GetThumbnailPath	optional
Fanart path	std::string	SetFanartPath	GetFanartPath	optional
Recording time	time_t	SetRecordingTime	GetRecordingTime	optional
Duration	int	SetDuration	GetDuration	optional
Priority	int	SetPriority	GetPriority	optional
Lifetime	int	SetLifetime	GetLifetime	optional
Genre type	int	SetGenreType	GetGenreType	optional
Genre sub type	int	SetGenreSubType	GetGenreSubType	optional
Play count	int	SetPlayCount	GetPlayCount	optional
Last played position	int	SetLastPlayedPosition	GetLastPlayedPosition	optional
Is deleted	bool	SetIsDeleted	GetIsDeleted	optional
EPG event id	unsigned int	SetEPGEventId	GetEPGEventId	optional
Channel unique id	int	SetChannelUid	GetChannelUid	optional
Channel type	PVR_RECORDING_CHANNEL_TYPE	SetChannelType	GetChannelType	optional
First aired	std::string	SetFirstAired	GetFirstAired	optional
Flags	std::string	SetFlags	GetFlags	optional
Size in bytes	std::string	SetSizeInBytes	GetSizeInBytes	optional
Client provider unique identifier	int	SetClientProviderUid	GetClientProviderUid	optional
Provider name	std::string	SetProviderlName	GetProviderName	optional

Topics
	Value Help
	class PVRRecordingsResultSet
	PVR add-on recording transfer class To transfer the content of kodi::addon::CInstancePVRClient::GetRecordings().

Macro Definition Documentation

PVR_RECORDING_INVALID_SERIES_EPISODE

#define PVR_RECORDING_INVALID_SERIES_EPISODE   EPG_TAG_INVALID_SERIES_EPISODE

Special kodi::addon::PVRRecording::SetSeriesNumber() and kodi::addon::PVRRecording::SetEpisodeNumber() value to indicate it is not to be used.

Used if recording has no valid season and/or episode info.

PVR_RECORDING_VALUE_NOT_AVAILABLE

#define PVR_RECORDING_VALUE_NOT_AVAILABLE   -1

Value where set in background to inform that related part not used.

Normally this related parts need not to set by this as it is default.

Function Documentation

SetRecordingId()

void SetRecordingId ( const std::string & recordingId )

inline

required
Unique identifier of the recording on the client.

GetRecordingId()

std::string GetRecordingId ( ) const

inline

To get with SetRecordingId changed values.

SetTitle()

void SetTitle ( const std::string & title )

inline

required
The title of this recording.

GetTitle()

std::string GetTitle ( ) const

inline

To get with SetTitle changed values.

SetEpisodeName()

void SetEpisodeName ( const std::string & episodeName )

inline

optional
Episode name (also known as subtitle).

GetEpisodeName()

std::string GetEpisodeName ( ) const

inline

To get with SetEpisodeName changed values.

SetSeriesNumber()

void SetSeriesNumber ( int seriesNumber )

inline

optional
Series number (usually called season).

Set to "0" for specials/pilot. For 'invalid' see SetEpisodeNumber or set to -1.

GetSeriesNumber()

int GetSeriesNumber ( ) const

inline

To get with SetSeriesNumber changed values.

SetEpisodeNumber()

void SetEpisodeNumber ( int episodeNumber )

inline

optional
Eepisode number within the "iSeriesNumber" season.

For 'invalid' set to -1 or seriesNumber=episodeNumber=0 to show both are invalid.

GetEpisodeNumber()

int GetEpisodeNumber ( ) const

inline

To get with SetEpisodeNumber changed values.

SetYear()

void SetYear ( int year )

inline

optional
Year of first release (use to identify a specific movie re-make) / first airing for TV shows.

Set to '0' for invalid.

GetYear()

int GetYear ( ) const

inline

To get with SetYear changed values.

SetDirectory()

void SetDirectory ( const std::string & directory )

inline

optional

Directory of this recording on the client.

GetDirectory()

std::string GetDirectory ( ) const

inline

To get with SetDirectory changed values.

SetPlotOutline()

void SetPlotOutline ( const std::string & plotOutline )

inline

optional
Plot outline name.

GetPlotOutline()

std::string GetPlotOutline ( ) const

inline

To get with SetPlotOutline changed values.

SetPlot()

void SetPlot ( const std::string & plot )

inline

optional
Plot name.

GetPlot()

std::string GetPlot ( ) const

inline

To get with SetPlot changed values.

SetChannelName()

void SetChannelName ( const std::string & channelName )

inline

optional
Channel name.

GetChannelName()

std::string GetChannelName ( ) const

inline

To get with SetChannelName changed values.

SetIconPath()

void SetIconPath ( const std::string & iconPath )

inline

optional
Channel logo (icon) path.

GetIconPath()

std::string GetIconPath ( ) const

inline

To get with SetIconPath changed values.

SetThumbnailPath()

void SetThumbnailPath ( const std::string & thumbnailPath )

inline

optional
Thumbnail path.

GetThumbnailPath()

std::string GetThumbnailPath ( ) const

inline

To get with SetThumbnailPath changed values.

SetFanartPath()

void SetFanartPath ( const std::string & fanartPath )

inline

optional
Fanart path.

GetFanartPath()

std::string GetFanartPath ( ) const

inline

To get with SetFanartPath changed values.

SetRecordingTime()

void SetRecordingTime ( time_t recordingTime )

inline

optional
Start time of the recording.

GetRecordingTime()

time_t GetRecordingTime ( ) const

inline

To get with SetRecordingTime changed values.

SetDuration()

void SetDuration ( int duration )

inline

optional
Duration of the recording in seconds.

GetDuration()

int GetDuration ( ) const

inline

To get with SetDuration changed values.

SetPriority()

void SetPriority ( int priority )

inline

optional
Priority of this recording (from 0 - 100).

GetPriority()

int GetPriority ( ) const

inline

To get with SetPriority changed values.

SetLifetime()

void SetLifetime ( int lifetime )

inline

optional
Life time in days of this recording.

GetLifetime()

int GetLifetime ( ) const

inline

To get with SetLifetime changed values.

SetGenreType()

void SetGenreType ( int genreType )

inline

optional
Genre type.

Use EPG_GENRE_USE_STRING if type becomes given by SetGenreDescription.

Note

If confirmed that backend brings the types in ETSI EN 300 468 conform values, can be EPG_EVENT_CONTENTMASK ignored and to set here with backend value.

---

Example 1:

kodi::addon::PVRRecording tag;
tag.SetGenreType(EPG_EVENT_CONTENTMASK_MOVIEDRAMA);

---

Example 2 (in case of other, not ETSI EN 300 468 conform genre types):

kodi::addon::PVRRecording tag;
tag.SetGenreType(EPG_GENRE_USE_STRING);
tag.SetGenreDescription("My special genre name"); // Should use (if possible) kodi::GetLocalizedString(...) to have match user language.

GetGenreType()

int GetGenreType ( ) const

inline

To get with SetGenreType changed values.

SetGenreSubType()

void SetGenreSubType ( int genreSubType )

inline

optional
Genre sub type.

Subtypes groups related to set by SetGenreType:

Main genre type	List with available sub genre types
EPG_EVENT_CONTENTMASK_UNDEFINED	Nothing, should be 0
EPG_EVENT_CONTENTMASK_MOVIEDRAMA	EPG_EVENT_CONTENTSUBMASK_MOVIEDRAMA
EPG_EVENT_CONTENTMASK_NEWSCURRENTAFFAIRS	EPG_EVENT_CONTENTSUBMASK_NEWSCURRENTAFFAIRS
EPG_EVENT_CONTENTMASK_SHOW	EPG_EVENT_CONTENTSUBMASK_SHOW
EPG_EVENT_CONTENTMASK_SPORTS	EPG_EVENT_CONTENTSUBMASK_SPORTS
EPG_EVENT_CONTENTMASK_CHILDRENYOUTH	EPG_EVENT_CONTENTSUBMASK_CHILDRENYOUTH
EPG_EVENT_CONTENTMASK_MUSICBALLETDANCE	EPG_EVENT_CONTENTSUBMASK_MUSICBALLETDANCE
EPG_EVENT_CONTENTMASK_ARTSCULTURE	EPG_EVENT_CONTENTSUBMASK_ARTSCULTURE
EPG_EVENT_CONTENTMASK_SOCIALPOLITICALECONOMICS	EPG_EVENT_CONTENTSUBMASK_SOCIALPOLITICALECONOMICS
EPG_EVENT_CONTENTMASK_EDUCATIONALSCIENCE	EPG_EVENT_CONTENTSUBMASK_EDUCATIONALSCIENCE
EPG_EVENT_CONTENTMASK_LEISUREHOBBIES	EPG_EVENT_CONTENTSUBMASK_LEISUREHOBBIES
EPG_EVENT_CONTENTMASK_SPECIAL	EPG_EVENT_CONTENTSUBMASK_SPECIAL
EPG_EVENT_CONTENTMASK_USERDEFINED	Can be defined by you
EPG_GENRE_USE_STRING	Kodi's own value, which declares that the type with SetGenreDescription is given.

---

Example:

kodi::addon::PVRRecording tag;
tag.SetGenreType(EPG_EVENT_CONTENTMASK_MUSICBALLETDANCE);
tag.SetGenreSubType(EPG_EVENT_CONTENTSUBMASK_MUSICBALLETDANCE_JAZZ);

GetGenreSubType()

int GetGenreSubType ( ) const

inline

To get with SetGenreSubType changed values.

SetGenreDescription()

void SetGenreDescription ( const std::string & genreDescription )

inline

optional
To set own genre description name.

Will be used only when genreType == EPG_GENRE_USE_STRING or genreSubType == EPG_GENRE_USE_STRING.

Use EPG_STRING_TOKEN_SEPARATOR to separate different genres.

In case of other, not ETSI EN 300 468 conform genre types or something special.

---

Example:

kodi::addon::PVRRecording tag;
tag.SetGenreType(EPG_GENRE_USE_STRING);
tag.SetGenreDescription("Action" + EPG_STRING_TOKEN_SEPARATOR + "Thriller");

GetGenreDescription()

std::string GetGenreDescription ( ) const

inline

To get with SetGenreDescription changed values.

SetPlayCount()

void SetPlayCount ( int playCount )

inline

optional
Play count of this recording on the client.

GetPlayCount()

int GetPlayCount ( ) const

inline

To get with SetPlayCount changed values.

SetLastPlayedPosition()

void SetLastPlayedPosition ( int lastPlayedPosition )

inline

optional
Last played position of this recording on the client.

GetLastPlayedPosition()

int GetLastPlayedPosition ( ) const

inline

To get with SetLastPlayedPosition changed values.

SetIsDeleted()

void SetIsDeleted ( int isDeleted )

inline

optional
Shows this recording is deleted and can be undelete.

GetIsDeleted()

int GetIsDeleted ( ) const

inline

To get with SetIsDeleted changed values.

SetEPGEventId()

void SetEPGEventId ( unsigned int epgEventId )

inline

optional
EPG event id associated with this recording. Valid ids must be greater than EPG_TAG_INVALID_UID.

GetEPGEventId()

unsigned int GetEPGEventId ( ) const

inline

To get with SetEPGEventId changed values.

SetChannelUid()

void SetChannelUid ( int channelUid )

inline

optional
Unique identifier of the channel for this recording. PVR_CHANNEL_INVALID_UID denotes that channel uid is not available.

GetChannelUid()

int GetChannelUid ( ) const

inline

To get with SetChannelUid changed values.

SetChannelType()

void SetChannelType ( PVR_RECORDING_CHANNEL_TYPE channelType )

inline

optional
Channel type.

Set to PVR_RECORDING_CHANNEL_TYPE_UNKNOWN if the type cannot be determined.

---

Example:

kodi::addon::PVRRecording tag;
tag.SetChannelType(PVR_RECORDING_CHANNEL_TYPE_TV);

GetChannelType()

PVR_RECORDING_CHANNEL_TYPE GetChannelType ( ) const

inline

To get with SetChannelType changed values.

SetFirstAired()

void SetFirstAired ( const std::string & firstAired )

inline

optional
First aired date of this recording.

Used only for display purposes. Specify in W3C date format "YYYY-MM-DD".

---

Example:

kodi::addon::PVRRecording tag;
tag.SetFirstAired(1982-10-22);

GetFirstAired()

std::string GetFirstAired ( ) const

inline

To get with SetFirstAired changed values.

SetFlags()

void SetFlags ( unsigned int flags )

inline

optional
Bit field of independent flags associated with the recording.

See enum PVR_RECORDING_FLAG for available bit flags.

---

Here's example about the use of this:

kodi::addon::PVRRecording tag;
tag.SetFlags(PVR_RECORDING_FLAG_IS_SERIES | PVR_RECORDING_FLAG_IS_PREMIERE);

GetFlags()

unsigned int GetFlags ( ) const

inline

To get with SetFlags changed values.

SetSizeInBytes()

void SetSizeInBytes ( int64_t sizeInBytes )

inline

optional
Size of the recording in bytes.

GetSizeInBytes()

int64_t GetSizeInBytes ( ) const

inline

To get with SetSizeInBytes changed values.