class PVREPGTag

Detailed Description

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
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	int	SetParentalRating	GetParentalRating	optional
Parental rating code	int	SetParentalRatingCode	GetParentalRatingCode	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

Topics
	Value Help
	class PVREPGTagsResultSet
	PVR add-on EPG entry transfer class To transfer the content of kodi::addon::CInstancePVRClient::GetEPGForChannel().

Function Documentation

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

To get with SetUniqueBroadcastId changed values.

SetUniqueChannelId()

void SetUniqueChannelId ( unsigned int uniqueChannelId )

inline

required
Unique identifier of the channel this event belongs to.

GetUniqueChannelId()

unsigned int GetUniqueChannelId ( ) const

inline

To get with SetUniqueChannelId changed values.

SetTitle()

void SetTitle ( const std::string & title )

inline

required
This event's title.

GetTitle()

std::string GetTitle ( ) const

inline

To get with SetTitle changed values.

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

To get with SetStartTime changed values.

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

To get with SetEndTime 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 GetPlot changed values.

SetOriginalTitle()

void SetOriginalTitle ( const std::string & originalTitle )

inline

optional
Original title.

GetOriginalTitle()

std::string GetOriginalTitle ( ) const

inline

To get with SetOriginalTitle changed values.

SetCast()

void SetCast ( const std::string & cast )

inline

optional
Cast name(s).

Note

Use EPG_STRING_TOKEN_SEPARATOR to separate different persons.

GetCast()

std::string GetCast ( ) const

inline

To get with SetCast changed values.

SetDirector()

void SetDirector ( const std::string & director )

inline

optional
Director name(s).

Note

Use EPG_STRING_TOKEN_SEPARATOR to separate different persons.

GetDirector()

std::string GetDirector ( ) const

inline

To get with SetDirector changed values.

SetWriter()

void SetWriter ( const std::string & writer )

inline

optional
Writer name(s).

Note

Use EPG_STRING_TOKEN_SEPARATOR to separate different persons.

GetWriter()

std::string GetWriter ( ) const

inline

To get with SetDirector changed values.

SetYear()

void SetYear ( int year )

inline

optional
Year.

GetYear()

int GetYear ( ) const

inline

To get with SetYear changed values.

SetIMDBNumber()

void SetIMDBNumber ( const std::string & IMDBNumber )

inline

optional
IMDB identification number.

GetIMDBNumber()

std::string GetIMDBNumber ( ) const

inline

To get with SetIMDBNumber changed values.

SetIconPath()

void SetIconPath ( const std::string & iconPath )

inline

optional
Icon path.

GetIconPath()

std::string GetIconPath ( ) const

inline

To get with SetIconPath 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::PVREPGTag tag;
tag.SetGenreType(EPG_EVENT_CONTENTMASK_MOVIEDRAMA);

---

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

kodi::addon::PVREPGTag 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::PVREPGTag 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
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:

kodi::addon::PVREPGTag 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.

SetFirstAired()

void SetFirstAired ( const std::string & firstAired )

inline

optional
First aired in UTC.

GetFirstAired()

std::string GetFirstAired ( ) const

inline

To get with SetFirstAired changed values.

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

To get with SetParentalRatingCode changed values.

SetStarRating()

void SetStarRating ( int starRating )

inline

optional
Star rating.

GetStarRating()

int GetStarRating ( ) const

inline

To get with SetStarRating changed values.

SetSeriesNumber()

void SetSeriesNumber ( int seriesNumber )

inline

optional
Series number.

GetSeriesNumber()

int GetSeriesNumber ( ) const

inline

To get with SetSeriesNumber changed values.

SetEpisodeNumber()

void SetEpisodeNumber ( int episodeNumber )

inline

optional
Episode number.

GetEpisodeNumber()

int GetEpisodeNumber ( ) const

inline

To get with SetEpisodeNumber changed values.

SetEpisodePartNumber()

void SetEpisodePartNumber ( int episodePartNumber )

inline

optional
Episode part number.

GetEpisodePartNumber()

int GetEpisodePartNumber ( ) const

inline

To get with SetEpisodePartNumber changed values.

SetEpisodeName()

void SetEpisodeName ( const std::string & episodeName )

inline

optional
Episode name.

GetEpisodeName()

std::string GetEpisodeName ( ) const

inline

To get with SetEpisodeName changed values.

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:

kodi::addon::PVREPGTag tag;
tag.SetFlags(EPG_TAG_FLAG_IS_SERIES | EPG_TAG_FLAG_IS_NEW);

GetFlags()

unsigned int GetFlags ( ) const

inline

To get with SetFlags changed values.

SetSeriesLink()

void SetSeriesLink ( const std::string & seriesLink )

inline

optional
Series link for this event.

GetSeriesLink()

std::string GetSeriesLink ( ) const

inline

To get with SetSeriesLink changed values.