PVR add-on EPG data tag
Representation of an EPG event.
Herewith all EPG related data are saved in one class whereby the data can be exchanged with Kodi, or can also be used on the addon to save there.
See EPG methods about usage.
The following table contains values that can be set with class PVREPGTag :
◆ SetUniqueBroadcastId()
void SetUniqueBroadcastId |
( |
unsigned int |
uniqueBroadcastId | ) |
|
|
inline |
required
Identifier for this event. Event uids must be unique for a channel. Valid uids must be greater than EPG_TAG_INVALID_UID.
◆ GetUniqueBroadcastId()
unsigned int GetUniqueBroadcastId |
( |
| ) |
const |
|
inline |
◆ SetUniqueChannelId()
void SetUniqueChannelId |
( |
unsigned int |
uniqueChannelId | ) |
|
|
inline |
required
Unique identifier of the channel this event belongs to.
◆ GetUniqueChannelId()
unsigned int GetUniqueChannelId |
( |
| ) |
const |
|
inline |
◆ SetTitle()
void SetTitle |
( |
const std::string & |
title | ) |
|
|
inline |
required
This event's title.
◆ GetTitle()
std::string GetTitle |
( |
| ) |
const |
|
inline |
◆ SetStartTime()
void SetStartTime |
( |
time_t |
startTime | ) |
|
|
inline |
required
Start time in UTC.
Seconds elapsed since 00:00 hours, Jan 1, 1970 UTC.
◆ GetStartTime()
time_t GetStartTime |
( |
| ) |
const |
|
inline |
◆ SetEndTime()
void SetEndTime |
( |
time_t |
endTime | ) |
|
|
inline |
required
End time in UTC.
Seconds elapsed since 00:00 hours, Jan 1, 1970 UTC.
◆ GetEndTime()
time_t GetEndTime |
( |
| ) |
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 GetPlot changed values.
◆ SetOriginalTitle()
void SetOriginalTitle |
( |
const std::string & |
originalTitle | ) |
|
|
inline |
◆ GetOriginalTitle()
std::string GetOriginalTitle |
( |
| ) |
const |
|
inline |
◆ SetCast()
void SetCast |
( |
const std::string & |
cast | ) |
|
|
inline |
◆ GetCast()
std::string GetCast |
( |
| ) |
const |
|
inline |
To get with SetCast changed values.
◆ SetDirector()
void SetDirector |
( |
const std::string & |
director | ) |
|
|
inline |
◆ GetDirector()
std::string GetDirector |
( |
| ) |
const |
|
inline |
◆ SetWriter()
void SetWriter |
( |
const std::string & |
writer | ) |
|
|
inline |
◆ GetWriter()
std::string GetWriter |
( |
| ) |
const |
|
inline |
◆ SetYear()
◆ GetYear()
To get with SetYear changed values.
◆ SetIMDBNumber()
void SetIMDBNumber |
( |
const std::string & |
IMDBNumber | ) |
|
|
inline |
optional
IMDB identification number.
◆ GetIMDBNumber()
std::string GetIMDBNumber |
( |
| ) |
const |
|
inline |
◆ SetIconPath()
void SetIconPath |
( |
const std::string & |
iconPath | ) |
|
|
inline |
◆ GetIconPath()
std::string GetIconPath |
( |
| ) |
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:
@ EPG_EVENT_CONTENTMASK_MOVIEDRAMA
0x10 : Movie/Drama. See EPG_EVENT_CONTENTSUBMASK_MOVIEDRAMA about related sub types.
Definition: pvr_epg.h:69
void SetGenreType(int genreType)
optional Genre type.
Definition: EPG.h:255
Example 2 (in case of other, not ETSI EN 300 468 conform genre types):
@ 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
void SetGenreDescription(const std::string &genreDescription)
optional genre. Will be used only when genreType == EPG_GENRE_USE_STRING or genreSubType == EPG_GENR...
Definition: EPG.h:314
◆ GetGenreType()
int GetGenreType |
( |
| ) |
const |
|
inline |
◆ SetGenreSubType()
void SetGenreSubType |
( |
int |
genreSubType | ) |
|
|
inline |
optional
Genre sub type.
Subtypes groups related to set by SetGenreType:
Example:
@ 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
void SetGenreSubType(int genreSubType)
optional Genre sub type.
Definition: EPG.h:292
◆ GetGenreSubType()
int GetGenreSubType |
( |
| ) |
const |
|
inline |
◆ SetGenreDescription()
void SetGenreDescription |
( |
const std::string & |
genreDescription | ) |
|
|
inline |
optional
genre. 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 |
◆ SetFirstAired()
void SetFirstAired |
( |
const std::string & |
firstAired | ) |
|
|
inline |
optional
First aired in UTC.
◆ GetFirstAired()
std::string GetFirstAired |
( |
| ) |
const |
|
inline |
◆ SetParentalRating()
void SetParentalRating |
( |
int |
parentalRating | ) |
|
|
inline |
optional
Parental rating.
◆ GetParentalRating()
int GetParentalRating |
( |
| ) |
const |
|
inline |
To get with SetParentalRatinge changed values.
◆ SetParentalRatingCode()
void SetParentalRatingCode |
( |
const std::string & |
parentalRatingCode | ) |
|
|
inline |
required
This event's parental rating code.
◆ GetParentalRatingCode()
std::string GetParentalRatingCode |
( |
| ) |
const |
|
inline |
◆ SetStarRating()
void SetStarRating |
( |
int |
starRating | ) |
|
|
inline |
◆ GetStarRating()
int GetStarRating |
( |
| ) |
const |
|
inline |
◆ SetSeriesNumber()
void SetSeriesNumber |
( |
int |
seriesNumber | ) |
|
|
inline |
◆ GetSeriesNumber()
int GetSeriesNumber |
( |
| ) |
const |
|
inline |
◆ SetEpisodeNumber()
void SetEpisodeNumber |
( |
int |
episodeNumber | ) |
|
|
inline |
◆ GetEpisodeNumber()
int GetEpisodeNumber |
( |
| ) |
const |
|
inline |
◆ SetEpisodePartNumber()
void SetEpisodePartNumber |
( |
int |
episodePartNumber | ) |
|
|
inline |
optional
Episode part number.
◆ GetEpisodePartNumber()
int GetEpisodePartNumber |
( |
| ) |
const |
|
inline |
◆ SetEpisodeName()
void SetEpisodeName |
( |
const std::string & |
episodeName | ) |
|
|
inline |
◆ GetEpisodeName()
std::string GetEpisodeName |
( |
| ) |
const |
|
inline |
◆ SetFlags()
void SetFlags |
( |
unsigned int |
flags | ) |
|
|
inline |
optional
Bit field of independent flags associated with the EPG entry.
See enum EPG_TAG_FLAG for available bit flags.
Here's example about the use of this:
@ EPG_TAG_FLAG_IS_NEW
0000 0010 : This EPG entry will be flagged as new.
Definition: pvr_epg.h:552
@ EPG_TAG_FLAG_IS_SERIES
0000 0001 : This EPG entry is part of a series.
Definition: pvr_epg.h:549
void SetFlags(unsigned int flags)
optional Bit field of independent flags associated with the EPG entry.
Definition: EPG.h:393
◆ GetFlags()
unsigned int GetFlags |
( |
| ) |
const |
|
inline |
◆ SetSeriesLink()
void SetSeriesLink |
( |
const std::string & |
seriesLink | ) |
|
|
inline |
optional
Series link for this event.
◆ GetSeriesLink()
std::string GetSeriesLink |
( |
| ) |
const |
|
inline |