Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
#include <EpgInfoTag.h>
Public Member Functions | |
CPVREpgInfoTag (const EPG_TAG &data, int iClientId, const std::shared_ptr< CPVREpgChannelData > &channelData, int iEpgID) | |
Create a new EPG infotag. | |
CPVREpgInfoTag (const std::shared_ptr< CPVREpgChannelData > &channelData, int iEpgID, const CDateTime &start, const CDateTime &end, bool bIsGapTag) | |
Create a new EPG infotag. | |
void | SetChannelData (const std::shared_ptr< CPVREpgChannelData > &data) |
Set data for the channel linked to this EPG infotag. | |
bool | operator== (const CPVREpgInfoTag &right) const |
bool | operator!= (const CPVREpgInfoTag &right) const |
void | Serialize (CVariant &value) const override |
int | ClientID () const |
Get the identifier of the client that serves this event. | |
bool | IsActive () const |
Check if this event is currently active. | |
bool | WasActive () const |
Check if this event is in the past. | |
bool | IsUpcoming () const |
Check if this event is in the future. | |
float | ProgressPercentage () const |
Get the progress of this tag in percent. | |
unsigned int | Progress () const |
Get the progress of this tag in seconds. | |
int | EpgID () const |
Get EPG ID of this tag. | |
void | SetEpgID (int iEpgID) |
Sets the EPG id for this event. | |
void | SetUniqueBroadcastID (unsigned int iUniqueBroadcastID) |
Change the unique broadcast ID of this event. | |
unsigned int | UniqueBroadcastID () const |
Get the unique broadcast ID. | |
int | DatabaseID () const |
Get the event's database ID. | |
int | UniqueChannelID () const |
Get the unique ID of the channel associated with this event. | |
std::string | ChannelIconPath () const |
Get the path for the icon of the channel associated with this event. | |
CDateTime | StartAsUTC () const |
Get the event's start time. | |
CDateTime | StartAsLocalTime () const |
Get the event's start time. | |
CDateTime | EndAsUTC () const |
Get the event's end time. | |
CDateTime | EndAsLocalTime () const |
Get the event's end time. | |
void | SetEndFromUTC (const CDateTime &end) |
Change the event's end time. | |
unsigned int | GetDuration () const |
Get the duration of this event in seconds. | |
const std::string & | Title () const |
Get the title of this event. | |
const std::string & | TitleExtraInfo () const |
Get the title extra information of this event. | |
const std::string & | PlotOutline () const |
Get the plot outline of this event. | |
const std::string & | Plot () const |
Get the plot of this event. | |
const std::string & | OriginalTitle () const |
Get the original title of this event. | |
const std::vector< std::string > & | Cast () const |
Get the cast of this event. | |
const std::vector< std::string > & | Directors () const |
Get the director(s) of this event. | |
const std::vector< std::string > & | Writers () const |
Get the writer(s) of this event. | |
const std::string | GetCastLabel () const |
Get the cast of this event as formatted string. | |
const std::string | GetDirectorsLabel () const |
Get the director(s) of this event as formatted string. | |
const std::string | GetWritersLabel () const |
Get the writer(s) of this event as formatted string. | |
const std::string | GetGenresLabel () const |
Get the genre(s) of this event as formatted string. | |
int | Year () const |
Get the year of this event. | |
const std::string & | IMDBNumber () const |
Get the imdbnumber of this event. | |
int | GenreType () const |
Get the genre type ID of this event. | |
int | GenreSubType () const |
Get the genre subtype ID of this event. | |
const std::string & | GenreDescription () const |
Get the genre description of this event. | |
const std::vector< std::string > | Genre () const |
Get the genre as human readable string. | |
CDateTime | FirstAired () const |
Get the first air date of this event. | |
unsigned int | ParentalRating () const |
Get the parental rating of this event. | |
const std::string & | ParentalRatingCode () const |
Get the parental rating code of this event. | |
const std::string & | ParentalRatingIcon () const |
Get the parental rating icon path of this event. | |
std::string | ClientParentalRatingIconPath () const |
Get the parental rating icon path of this event as given by the client. | |
const std::string & | ParentalRatingSource () const |
Get the parental rating source of this event. | |
int | StarRating () const |
Get the star rating of this event. | |
int | SeriesNumber () const |
The series number of this event. | |
const std::string & | SeriesLink () const |
The series link for this event. | |
int | EpisodeNumber () const |
The episode number of this event. | |
int | EpisodePart () const |
The episode part number of this event. | |
const std::string & | EpisodeName () const |
The episode name of this event. | |
std::string | IconPath () const |
Get the path to the icon for this event used by Kodi. | |
std::string | ClientIconPath () const |
Get the path to the icon for this event as given by the client. | |
std::string | Path () const |
The path to this event. | |
bool | IsRecordable () const |
Check if this event can be recorded. | |
bool | IsPlayable () const |
Check if this event can be played. | |
bool | QueuePersistQuery (const std::shared_ptr< CPVREpgDatabase > &database) |
Write query to persist this tag in the query queue of the given database. | |
bool | Update (const CPVREpgInfoTag &tag, bool bUpdateBroadcastId=true) |
Update the information in this tag with the info in the given tag. | |
std::vector< EDL::Edit > | GetEdl () const |
Retrieve the edit decision list (EDL) of an EPG tag. | |
bool | IsSeries () const |
Check whether this tag has any series attributes. | |
bool | IsRadio () const |
Check whether this tag is associated with a radion or TV channel. | |
bool | IsParentalLocked () const |
Check whether this event is parental locked. | |
bool | IsGapTag () const |
Check whether this event is a real event or a gap in the EPG timeline. | |
bool | IsNew () const |
Check whether this tag will be flagged as new. | |
bool | IsPremiere () const |
Check whether this tag will be flagged as a premiere. | |
bool | IsFinale () const |
Check whether this tag will be flagged as a finale. | |
bool | IsLive () const |
Check whether this tag will be flagged as live. | |
unsigned int | Flags () const |
Return the flags (EPG_TAG_FLAG_*) of this event as a bitfield. | |
Public Member Functions inherited from ISerializable |
Static Public Member Functions | |
static const std::vector< std::string > | Tokenize (const std::string &str) |
Split the given string into tokens. Interprets occurrences of EPG_STRING_TOKEN_SEPARATOR in the string as separator. | |
static const std::string | DeTokenize (const std::vector< std::string > &tokens) |
Combine the given strings to a single string. Inserts EPG_STRING_TOKEN_SEPARATOR as separator. | |
Static Public Attributes | |
static const std::string | IMAGE_OWNER_PATTERN = "epgtag_{}" |
Friends | |
class | CPVREpgDatabase |
Additional Inherited Members | |
Protected Member Functions inherited from ISerializable | |
~ISerializable ()=default | |
CPVREpgInfoTag::CPVREpgInfoTag | ( | const EPG_TAG & | data, |
int | iClientId, | ||
const std::shared_ptr< CPVREpgChannelData > & | channelData, | ||
int | iEpgID ) |
Create a new EPG infotag.
data | The tag's data. |
iClientId | The client id. |
channelData | The channel data. |
iEpgId | The id of the EPG this tag belongs to. |
CPVREpgInfoTag::CPVREpgInfoTag | ( | const std::shared_ptr< CPVREpgChannelData > & | channelData, |
int | iEpgID, | ||
const CDateTime & | start, | ||
const CDateTime & | end, | ||
bool | bIsGapTag ) |
Create a new EPG infotag.
channelData | The channel data. |
iEpgId | The id of the EPG this tag belongs to. |
start | The start time of the event |
end | The end time of the event |
bIsGapTagTrue | if this is a "gap" tag, false if this is a real EPG event |
|
inline |
Get the cast of this event.
std::string CPVREpgInfoTag::ChannelIconPath | ( | ) | const |
Get the path for the icon of the channel associated with this event.
std::string CPVREpgInfoTag::ClientIconPath | ( | ) | const |
Get the path to the icon for this event as given by the client.
int CPVREpgInfoTag::ClientID | ( | ) | const |
Get the identifier of the client that serves this event.
|
inline |
Get the parental rating icon path of this event as given by the client.
int CPVREpgInfoTag::DatabaseID | ( | ) | const |
Get the event's database ID.
|
static |
Combine the given strings to a single string. Inserts EPG_STRING_TOKEN_SEPARATOR as separator.
tokens | The tokens. |
|
inline |
Get the director(s) of this event.
CDateTime CPVREpgInfoTag::EndAsLocalTime | ( | ) | const |
Get the event's end time.
CDateTime CPVREpgInfoTag::EndAsUTC | ( | ) | const |
Get the event's end time.
int CPVREpgInfoTag::EpgID | ( | ) | const |
Get EPG ID of this tag.
|
inline |
The episode name of this event.
int CPVREpgInfoTag::EpisodeNumber | ( | ) | const |
The episode number of this event.
int CPVREpgInfoTag::EpisodePart | ( | ) | const |
The episode part number of this event.
CDateTime CPVREpgInfoTag::FirstAired | ( | ) | const |
Get the first air date of this event.
|
inline |
Return the flags (EPG_TAG_FLAG_*) of this event as a bitfield.
const std::vector< std::string > CPVREpgInfoTag::Genre | ( | ) | const |
Get the genre as human readable string.
|
inline |
Get the genre description of this event.
int CPVREpgInfoTag::GenreSubType | ( | ) | const |
Get the genre subtype ID of this event.
int CPVREpgInfoTag::GenreType | ( | ) | const |
Get the genre type ID of this event.
const std::string CPVREpgInfoTag::GetCastLabel | ( | ) | const |
Get the cast of this event as formatted string.
const std::string CPVREpgInfoTag::GetDirectorsLabel | ( | ) | const |
Get the director(s) of this event as formatted string.
unsigned int CPVREpgInfoTag::GetDuration | ( | ) | const |
Get the duration of this event in seconds.
std::vector< EDL::Edit > CPVREpgInfoTag::GetEdl | ( | ) | const |
Retrieve the edit decision list (EDL) of an EPG tag.
const std::string CPVREpgInfoTag::GetGenresLabel | ( | ) | const |
Get the genre(s) of this event as formatted string.
const std::string CPVREpgInfoTag::GetWritersLabel | ( | ) | const |
Get the writer(s) of this event as formatted string.
std::string CPVREpgInfoTag::IconPath | ( | ) | const |
Get the path to the icon for this event used by Kodi.
|
inline |
Get the imdbnumber of this event.
bool CPVREpgInfoTag::IsActive | ( | ) | const |
Check if this event is currently active.
bool CPVREpgInfoTag::IsFinale | ( | ) | const |
Check whether this tag will be flagged as a finale.
bool CPVREpgInfoTag::IsGapTag | ( | ) | const |
Check whether this event is a real event or a gap in the EPG timeline.
bool CPVREpgInfoTag::IsLive | ( | ) | const |
Check whether this tag will be flagged as live.
bool CPVREpgInfoTag::IsNew | ( | ) | const |
Check whether this tag will be flagged as new.
bool CPVREpgInfoTag::IsParentalLocked | ( | ) | const |
Check whether this event is parental locked.
bool CPVREpgInfoTag::IsPlayable | ( | ) | const |
Check if this event can be played.
bool CPVREpgInfoTag::IsPremiere | ( | ) | const |
Check whether this tag will be flagged as a premiere.
bool CPVREpgInfoTag::IsRadio | ( | ) | const |
Check whether this tag is associated with a radion or TV channel.
bool CPVREpgInfoTag::IsRecordable | ( | ) | const |
Check if this event can be recorded.
bool CPVREpgInfoTag::IsSeries | ( | ) | const |
Check whether this tag has any series attributes.
bool CPVREpgInfoTag::IsUpcoming | ( | ) | const |
Check if this event is in the future.
bool CPVREpgInfoTag::operator!= | ( | const CPVREpgInfoTag & | right | ) | const |
bool CPVREpgInfoTag::operator== | ( | const CPVREpgInfoTag & | right | ) | const |
|
inline |
Get the original title of this event.
unsigned int CPVREpgInfoTag::ParentalRating | ( | ) | const |
Get the parental rating of this event.
|
inline |
Get the parental rating code of this event.
|
inline |
Get the parental rating icon path of this event.
|
inline |
Get the parental rating source of this event.
std::string CPVREpgInfoTag::Path | ( | ) | const |
The path to this event.
|
inline |
Get the plot of this event.
|
inline |
Get the plot outline of this event.
unsigned int CPVREpgInfoTag::Progress | ( | ) | const |
Get the progress of this tag in seconds.
float CPVREpgInfoTag::ProgressPercentage | ( | ) | const |
Get the progress of this tag in percent.
bool CPVREpgInfoTag::QueuePersistQuery | ( | const std::shared_ptr< CPVREpgDatabase > & | database | ) |
Write query to persist this tag in the query queue of the given database.
database | The database. |
Implements ISerializable.
|
inline |
The series link for this event.
int CPVREpgInfoTag::SeriesNumber | ( | ) | const |
The series number of this event.
void CPVREpgInfoTag::SetChannelData | ( | const std::shared_ptr< CPVREpgChannelData > & | data | ) |
Set data for the channel linked to this EPG infotag.
data | The channel data. |
Change the event's end time.
end | The new end time. |
Sets the EPG id for this event.
iEpgID | The EPG id. |
Change the unique broadcast ID of this event.
iUniqueBroadcastId | The new unique broadcast ID. |
int CPVREpgInfoTag::StarRating | ( | ) | const |
Get the star rating of this event.
CDateTime CPVREpgInfoTag::StartAsLocalTime | ( | ) | const |
Get the event's start time.
CDateTime CPVREpgInfoTag::StartAsUTC | ( | ) | const |
Get the event's start time.
|
inline |
Get the title of this event.
|
inline |
Get the title extra information of this event.
|
static |
Split the given string into tokens. Interprets occurrences of EPG_STRING_TOKEN_SEPARATOR in the string as separator.
str | The string to tokenize. |
unsigned int CPVREpgInfoTag::UniqueBroadcastID | ( | ) | const |
Get the unique broadcast ID.
int CPVREpgInfoTag::UniqueChannelID | ( | ) | const |
Get the unique ID of the channel associated with this event.
bool CPVREpgInfoTag::Update | ( | const CPVREpgInfoTag & | tag, |
bool | bUpdateBroadcastId = true ) |
Update the information in this tag with the info in the given tag.
tag | The new info. |
bUpdateBroadcastId | If set to false, the tag BroadcastId (locally unique) will not be checked/updated |
bool CPVREpgInfoTag::WasActive | ( | ) | const |
Check if this event is in the past.
|
inline |
Get the writer(s) of this event.
int CPVREpgInfoTag::Year | ( | ) | const |
Get the year of this event.
|
friend |
|
static |