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 :
◆ PVR_RECORDING_INVALID_SERIES_EPISODE
◆ 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.
◆ SetRecordingId()
void SetRecordingId |
( |
const std::string & |
recordingId | ) |
|
|
inline |
required
Unique identifier of the recording on the client.
◆ GetRecordingId()
std::string GetRecordingId |
( |
| ) |
const |
|
inline |
◆ SetTitle()
void SetTitle |
( |
const std::string & |
title | ) |
|
|
inline |
required
The title of this recording.
◆ GetTitle()
std::string GetTitle |
( |
| ) |
const |
|
inline |
◆ SetEpisodeName()
void SetEpisodeName |
( |
const std::string & |
episodeName | ) |
|
|
inline |
optional
Episode name (also known as subtitle).
◆ GetEpisodeName()
std::string GetEpisodeName |
( |
| ) |
const |
|
inline |
◆ 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 |
◆ 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 |
◆ SetYear()
optional
Year of first release (use to identify a specific movie re-make) / first airing for TV shows.
Set to '0' for invalid.
◆ GetYear()
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 |
◆ SetPlotOutline()
void SetPlotOutline |
( |
const std::string & |
plotOutline | ) |
|
|
inline |
optional
Plot outline name.
◆ GetPlotOutline()
std::string GetPlotOutline |
( |
| ) |
const |
|
inline |
◆ SetPlot()
void SetPlot |
( |
const std::string & |
plot | ) |
|
|
inline |
◆ GetPlot()
std::string GetPlot |
( |
| ) |
const |
|
inline |
To get with SetPlot changed values.
◆ SetChannelName()
void SetChannelName |
( |
const std::string & |
channelName | ) |
|
|
inline |
◆ GetChannelName()
std::string GetChannelName |
( |
| ) |
const |
|
inline |
◆ SetIconPath()
void SetIconPath |
( |
const std::string & |
iconPath | ) |
|
|
inline |
optional
Channel logo (icon) path.
◆ GetIconPath()
std::string GetIconPath |
( |
| ) |
const |
|
inline |
◆ SetThumbnailPath()
void SetThumbnailPath |
( |
const std::string & |
thumbnailPath | ) |
|
|
inline |
◆ GetThumbnailPath()
std::string GetThumbnailPath |
( |
| ) |
const |
|
inline |
◆ SetFanartPath()
void SetFanartPath |
( |
const std::string & |
fanartPath | ) |
|
|
inline |
◆ GetFanartPath()
std::string GetFanartPath |
( |
| ) |
const |
|
inline |
◆ SetRecordingTime()
void SetRecordingTime |
( |
time_t |
recordingTime | ) |
|
|
inline |
optional
Start time of the recording.
◆ GetRecordingTime()
time_t GetRecordingTime |
( |
| ) |
const |
|
inline |
◆ SetDuration()
void SetDuration |
( |
int |
duration | ) |
|
|
inline |
optional
Duration of the recording in seconds.
◆ GetDuration()
int GetDuration |
( |
| ) |
const |
|
inline |
◆ SetPriority()
void SetPriority |
( |
int |
priority | ) |
|
|
inline |
optional
Priority of this recording (from 0 - 100).
◆ GetPriority()
int GetPriority |
( |
| ) |
const |
|
inline |
◆ SetLifetime()
void SetLifetime |
( |
int |
lifetime | ) |
|
|
inline |
optional
Life time in days of this recording.
◆ GetLifetime()
int GetLifetime |
( |
| ) |
const |
|
inline |
◆ 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:
Definition: Recordings.h:39
void SetGenreType(int genreType)
optional Genre type.
Definition: Recordings.h:297
@ EPG_EVENT_CONTENTMASK_MOVIEDRAMA
0x10 : Movie/Drama. See EPG_EVENT_CONTENTSUBMASK_MOVIEDRAMA about related sub types.
Definition: pvr_epg.h:69
Example 2 (in case of other, not ETSI EN 300 468 conform genre types):
void SetGenreDescription(const std::string &genreDescription)
optional To set own genre description name.
Definition: Recordings.h:357
@ EPG_GENRE_USE_STRING
Used to override standard genre types with a own name about. Set to this value EPG_GENRE_USE_STRIN...
Definition: pvr_epg.h:138
◆ GetGenreType()
int GetGenreType |
( |
| ) |
const |
|
inline |
◆ SetGenreSubType()
void SetGenreSubType |
( |
int |
genreSubType | ) |
|
|
inline |
optional
Genre sub type.
Subtypes groups related to set by SetGenreType:
Example:
void SetGenreSubType(int genreSubType)
optional Genre sub type.
Definition: Recordings.h:332
@ EPG_EVENT_CONTENTMASK_MUSICBALLETDANCE
0x60 : Music/Ballet/Dance. See EPG_EVENT_CONTENTSUBMASK_MUSICBALLETDANCE about related sub types.
Definition: pvr_epg.h:94
@ EPG_EVENT_CONTENTSUBMASK_MUSICBALLETDANCE_JAZZ
0x4 : Jazz.
Definition: pvr_epg.h:333
◆ GetGenreSubType()
int GetGenreSubType |
( |
| ) |
const |
|
inline |
◆ 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:
#define EPG_STRING_TOKEN_SEPARATOR
Separator to use in strings containing different tokens, for example writers, directors,...
Definition: pvr_epg.h:527
◆ GetGenreDescription()
std::string GetGenreDescription |
( |
| ) |
const |
|
inline |
◆ SetPlayCount()
void SetPlayCount |
( |
int |
playCount | ) |
|
|
inline |
optional
Play count of this recording on the client.
◆ GetPlayCount()
int GetPlayCount |
( |
| ) |
const |
|
inline |
◆ SetLastPlayedPosition()
void SetLastPlayedPosition |
( |
int |
lastPlayedPosition | ) |
|
|
inline |
optional
Last played position of this recording on the client.
◆ GetLastPlayedPosition()
int GetLastPlayedPosition |
( |
| ) |
const |
|
inline |
◆ SetIsDeleted()
void SetIsDeleted |
( |
int |
isDeleted | ) |
|
|
inline |
optional
Shows this recording is deleted and can be undelete.
◆ GetIsDeleted()
int GetIsDeleted |
( |
| ) |
const |
|
inline |
◆ 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 |
◆ 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 |
◆ SetChannelType()
optional
Channel type.
Set to PVR_RECORDING_CHANNEL_TYPE_UNKNOWN if the type cannot be determined.
Example:
@ PVR_RECORDING_CHANNEL_TYPE_TV
1 : TV channel.
Definition: pvr_recordings.h:94
void SetChannelType(PVR_RECORDING_CHANNEL_TYPE channelType)
optional Channel type.
Definition: Recordings.h:419
◆ GetChannelType()
◆ 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:
void SetFirstAired(const std::string &firstAired)
optional First aired date of this recording.
Definition: Recordings.h:440
◆ GetFirstAired()
std::string GetFirstAired |
( |
| ) |
const |
|
inline |
◆ 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:
@ PVR_RECORDING_FLAG_IS_SERIES
0000 0001 : This recording is part of a series.
Definition: pvr_recordings.h:44
@ PVR_RECORDING_FLAG_IS_PREMIERE
0000 0100 : This recording will be flagged as a premiere.
Definition: pvr_recordings.h:50
void SetFlags(unsigned int flags)
optional Bit field of independent flags associated with the recording.
Definition: Recordings.h:459
◆ GetFlags()
unsigned int GetFlags |
( |
| ) |
const |
|
inline |
◆ SetSizeInBytes()
void SetSizeInBytes |
( |
int64_t |
sizeInBytes | ) |
|
|
inline |
optional
Size of the recording in bytes.
◆ GetSizeInBytes()
int64_t GetSizeInBytes |
( |
| ) |
const |
|
inline |