Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
PVR add-on EPG data tag
Representation of an EPG event.
More...
Topics | |
Value Help | |
class PVREPGTagsResultSet | |
PVR add-on EPG entry transfer class To transfer the content of kodi::addon::CInstancePVRClient::GetEPGForChannel(). | |
Classes | |
class | kodi::addon::PVREPGTag |
Functions | |
void | kodi::addon::PVREPGTag::SetUniqueBroadcastId (unsigned int uniqueBroadcastId) |
required Identifier for this event. Event uids must be unique for a channel. Valid uids must be greater than EPG_TAG_INVALID_UID. | |
unsigned int | kodi::addon::PVREPGTag::GetUniqueBroadcastId () const |
To get with SetUniqueBroadcastId changed values. | |
void | kodi::addon::PVREPGTag::SetUniqueChannelId (unsigned int uniqueChannelId) |
required Unique identifier of the channel this event belongs to. | |
unsigned int | kodi::addon::PVREPGTag::GetUniqueChannelId () const |
To get with SetUniqueChannelId changed values. | |
void | kodi::addon::PVREPGTag::SetTitle (const std::string &title) |
required This event's title. | |
std::string | kodi::addon::PVREPGTag::GetTitle () const |
To get with SetTitle changed values. | |
void | kodi::addon::PVREPGTag::SetTitleExtraInfo (const std::string &titleExtraInfo) |
optional This event's title extra information. | |
std::string | kodi::addon::PVREPGTag::GetTitleExtraInfo () const |
To get with SetTitleExtraInfo changed values. | |
void | kodi::addon::PVREPGTag::SetStartTime (time_t startTime) |
required Start time in UTC. | |
time_t | kodi::addon::PVREPGTag::GetStartTime () const |
To get with SetStartTime changed values. | |
void | kodi::addon::PVREPGTag::SetEndTime (time_t endTime) |
required End time in UTC. | |
time_t | kodi::addon::PVREPGTag::GetEndTime () const |
To get with SetEndTime changed values. | |
void | kodi::addon::PVREPGTag::SetPlotOutline (const std::string &plotOutline) |
optional Plot outline name. | |
std::string | kodi::addon::PVREPGTag::GetPlotOutline () const |
To get with SetPlotOutline changed values. | |
void | kodi::addon::PVREPGTag::SetPlot (const std::string &plot) |
optional Plot name. | |
std::string | kodi::addon::PVREPGTag::GetPlot () const |
To get with GetPlot changed values. | |
void | kodi::addon::PVREPGTag::SetOriginalTitle (const std::string &originalTitle) |
optional Original title. | |
std::string | kodi::addon::PVREPGTag::GetOriginalTitle () const |
To get with SetOriginalTitle changed values. | |
void | kodi::addon::PVREPGTag::SetCast (const std::string &cast) |
optional Cast name(s). | |
std::string | kodi::addon::PVREPGTag::GetCast () const |
To get with SetCast changed values. | |
void | kodi::addon::PVREPGTag::SetDirector (const std::string &director) |
optional Director name(s). | |
std::string | kodi::addon::PVREPGTag::GetDirector () const |
To get with SetDirector changed values. | |
void | kodi::addon::PVREPGTag::SetWriter (const std::string &writer) |
optional Writer name(s). | |
std::string | kodi::addon::PVREPGTag::GetWriter () const |
To get with SetDirector changed values. | |
void | kodi::addon::PVREPGTag::SetYear (int year) |
optional Year. | |
int | kodi::addon::PVREPGTag::GetYear () const |
To get with SetYear changed values. | |
void | kodi::addon::PVREPGTag::SetIMDBNumber (const std::string &IMDBNumber) |
optional IMDB identification number. | |
std::string | kodi::addon::PVREPGTag::GetIMDBNumber () const |
To get with SetIMDBNumber changed values. | |
void | kodi::addon::PVREPGTag::SetIconPath (const std::string &iconPath) |
optional Icon path. | |
std::string | kodi::addon::PVREPGTag::GetIconPath () const |
To get with SetIconPath changed values. | |
void | kodi::addon::PVREPGTag::SetGenreType (int genreType) |
optional Genre type. | |
int | kodi::addon::PVREPGTag::GetGenreType () const |
To get with SetGenreType changed values. | |
void | kodi::addon::PVREPGTag::SetGenreSubType (int genreSubType) |
optional Genre sub type. | |
int | kodi::addon::PVREPGTag::GetGenreSubType () const |
To get with SetGenreSubType changed values. | |
void | kodi::addon::PVREPGTag::SetGenreDescription (const std::string &genreDescription) |
optional genre. Will be used only when genreType == EPG_GENRE_USE_STRING or genreSubType == EPG_GENRE_USE_STRING. | |
std::string | kodi::addon::PVREPGTag::GetGenreDescription () const |
To get with SetGenreDescription changed values. | |
void | kodi::addon::PVREPGTag::SetFirstAired (const std::string &firstAired) |
optional First aired in UTC. | |
std::string | kodi::addon::PVREPGTag::GetFirstAired () const |
To get with SetFirstAired changed values. | |
void | kodi::addon::PVREPGTag::SetParentalRating (unsigned int parentalRating) |
optional Parental rating. | |
unsigned int | kodi::addon::PVREPGTag::GetParentalRating () const |
To get with SetParentalRating changed values. | |
void | kodi::addon::PVREPGTag::SetParentalRatingCode (const std::string &parentalRatingCode) |
optional This event's parental rating code. | |
std::string | kodi::addon::PVREPGTag::GetParentalRatingCode () const |
To get with SetParentalRatingCode changed values. | |
void | kodi::addon::PVREPGTag::SetParentalRatingIcon (const std::string &parentalRatingIcon) |
optional This event's parental rating icon. | |
std::string | kodi::addon::PVREPGTag::GetParentalRatingIcon () const |
To get with SetParentalRatingIcon changed values. | |
void | kodi::addon::PVREPGTag::SetParentalRatingSource (const std::string &parentalRatingSource) |
optional The event's parental rating source. | |
std::string | kodi::addon::PVREPGTag::GetParentalRatingSource () const |
To get with SetParentalRatingSource changed values. | |
void | kodi::addon::PVREPGTag::SetStarRating (int starRating) |
optional Star rating. | |
int | kodi::addon::PVREPGTag::GetStarRating () const |
To get with SetStarRating changed values. | |
void | kodi::addon::PVREPGTag::SetSeriesNumber (int seriesNumber) |
optional Series number. | |
int | kodi::addon::PVREPGTag::GetSeriesNumber () const |
To get with SetSeriesNumber changed values. | |
void | kodi::addon::PVREPGTag::SetEpisodeNumber (int episodeNumber) |
optional Episode number. | |
int | kodi::addon::PVREPGTag::GetEpisodeNumber () const |
To get with SetEpisodeNumber changed values. | |
void | kodi::addon::PVREPGTag::SetEpisodePartNumber (int episodePartNumber) |
optional Episode part number. | |
int | kodi::addon::PVREPGTag::GetEpisodePartNumber () const |
To get with SetEpisodePartNumber changed values. | |
void | kodi::addon::PVREPGTag::SetEpisodeName (const std::string &episodeName) |
optional Episode name. | |
std::string | kodi::addon::PVREPGTag::GetEpisodeName () const |
To get with SetEpisodeName changed values. | |
void | kodi::addon::PVREPGTag::SetFlags (unsigned int flags) |
optional Bit field of independent flags associated with the EPG entry. | |
unsigned int | kodi::addon::PVREPGTag::GetFlags () const |
To get with SetFlags changed values. | |
void | kodi::addon::PVREPGTag::SetSeriesLink (const std::string &seriesLink) |
optional Series link for this event. | |
std::string | kodi::addon::PVREPGTag::GetSeriesLink () const |
To get with SetSeriesLink changed values. | |
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 :
Name | Type | Set call | Get call | Usage |
---|---|---|---|---|
Unique broadcast id | unsigned int | SetUniqueBroadcastId | GetUniqueBroadcastId | required to set |
Unique channel id | unsigned int | SetUniqueChannelId | GetUniqueChannelId | required to set |
Title | std::string | SetTitle | GetTitle | required to set |
Title extra info | std::string | SetTitleExtraInfo | GetTitleExtraInfo | optional |
Start time | time_t | SetStartTime | GetStartTime | required to set |
End time | time_t | SetEndTime | GetEndTime | required to set |
Plot outline | std::string | SetPlotOutline | GetPlotOutline | optional |
Plot | std::string | SetPlot | GetPlot | optional |
Original title | std::string | SetOriginalTitle | GetOriginalTitle | optional |
Cast | std::string | SetCast | GetCast | optional |
Director | std::string | SetDirector | GetDirector | optional |
Writer | std::string | SetWriter | GetWriter | optional |
Year | int | SetYear | GetYear | optional |
IMDB number | std::string | SetIMDBNumber | GetIMDBNumber | optional |
Icon path | std::string | SetIconPath | GetIconPath | optional |
Genre type | int | SetGenreType | GetGenreType | optional |
Genre sub type | int | SetGenreSubType | GetGenreSubType | optional |
Genre description | std::string | SetGenreDescription | GetGenreDescription | optional |
First aired | time_t | SetFirstAired | GetFirstAired | optional |
Parental rating | unsigned int | SetParentalRating | GetParentalRating | optional |
Parental rating code | std::string | SetParentalRatingCode | GetParentalRatingCode | optional |
Parental rating icon | std::string | SetParentalRatingIcon | GetParentalRatingIcon | optional |
Parental rating source | std::string | SetParentalRatingSource | GetParentalRatingSource | optional |
Star rating | int | SetStarRating | GetStarRating | optional |
Series number | int | SetSeriesNumber | GetSeriesNumber | optional |
Episode number | int | SetEpisodeNumber | GetEpisodeNumber | optional |
Episode part number | int | SetEpisodePartNumber | GetEpisodePartNumber | optional |
Episode name | std::string | SetEpisodeName | GetEpisodeName | optional |
Flags | unsigned int | SetFlags | GetFlags | optional |
Series link | std::string | SetSeriesLink | GetSeriesLink | optional |
|
inline |
To get with SetCast changed values.
|
inline |
To get with SetDirector changed values.
|
inline |
To get with SetEndTime changed values.
|
inline |
To get with SetEpisodeName changed values.
|
inline |
To get with SetEpisodeNumber changed values.
|
inline |
To get with SetEpisodePartNumber changed values.
|
inline |
To get with SetFirstAired changed values.
|
inline |
To get with SetGenreDescription changed values.
|
inline |
To get with SetGenreSubType changed values.
|
inline |
To get with SetGenreType changed values.
|
inline |
To get with SetIconPath changed values.
|
inline |
To get with SetIMDBNumber changed values.
|
inline |
To get with SetOriginalTitle changed values.
|
inline |
To get with SetParentalRating changed values.
|
inline |
To get with SetParentalRatingCode changed values.
|
inline |
To get with SetParentalRatingIcon changed values.
|
inline |
To get with SetParentalRatingSource changed values.
|
inline |
To get with GetPlot changed values.
|
inline |
To get with SetPlotOutline changed values.
|
inline |
To get with SetSeriesLink changed values.
|
inline |
To get with SetSeriesNumber changed values.
|
inline |
To get with SetStarRating changed values.
|
inline |
To get with SetStartTime changed values.
|
inline |
To get with SetTitle changed values.
|
inline |
To get with SetTitleExtraInfo changed values.
|
inline |
To get with SetUniqueBroadcastId changed values.
|
inline |
To get with SetUniqueChannelId changed values.
|
inline |
To get with SetDirector changed values.
|
inline |
optional
Cast name(s).
|
inline |
optional
Director name(s).
|
inline |
required
End time in UTC.
Seconds elapsed since 00:00 hours, Jan 1, 1970 UTC.
|
inline |
optional
Episode name.
optional
Episode part number.
|
inline |
optional
First aired in UTC.
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:
|
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:
optional
Genre sub type.
Subtypes groups related to set by SetGenreType:
Example:
optional
Genre type.
Use EPG_GENRE_USE_STRING if type becomes given by SetGenreDescription.
Example 1:
Example 2 (in case of other, not ETSI EN 300 468 conform genre types):
|
inline |
optional
Icon path.
|
inline |
optional
IMDB identification number.
|
inline |
optional
Original title.
optional
Parental rating.
|
inline |
optional
This event's parental rating code.
|
inline |
optional
This event's parental rating icon.
|
inline |
optional
The event's parental rating source.
|
inline |
optional
Plot name.
|
inline |
optional
Plot outline name.
|
inline |
optional
Series link for this event.
|
inline |
required
Start time in UTC.
Seconds elapsed since 00:00 hours, Jan 1, 1970 UTC.
|
inline |
required
This event's title.
|
inline |
optional
This event's title extra information.
required
Identifier for this event. Event uids must be unique for a channel. Valid uids must be greater than EPG_TAG_INVALID_UID.
required
Unique identifier of the channel this event belongs to.
|
inline |
optional
Writer name(s).