xbmc
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CVideoInfoTag Class Reference
Inheritance diagram for CVideoInfoTag:
Inheritance graph
[legend]
Collaboration diagram for CVideoInfoTag:
Collaboration graph
[legend]

Classes

struct  SetInfo
 < Struct holding information about a movie set More...
 

Public Types

typedef std::vector< SActorInfo >::const_iterator iCast
 

Public Member Functions

void Reset ()
 
bool Load (const TiXmlElement *element, bool append=false, bool prioritise=false)
 
bool Save (TiXmlNode *node, const std::string &tag, bool savePathInfo=true, const TiXmlElement *additionalNode=NULL)
 
void Merge (CVideoInfoTag &other)
 
void Archive (CArchive &ar) override
 
void Serialize (CVariant &value) const override
 
void ToSortable (SortItem &sortable, Field field) const override
 
const CRating GetRating (std::string type="") const
 
const std::string & GetDefaultRating () const
 
const std::string GetUniqueID (std::string type="") const
 
const std::map< std::string, std::string > & GetUniqueIDs () const
 
const std::string & GetDefaultUniqueID () const
 
bool HasUniqueID () const
 
virtual bool HasYear () const
 
virtual int GetYear () const
 
bool HasPremiered () const
 
const CDateTimeGetPremiered () const
 
const CDateTimeGetFirstAired () const
 
const std::string GetCast (bool bIncludeRole=false) const
 
bool HasStreamDetails () const
 
bool IsEmpty () const
 
const std::string & GetPath () const
 
void SetDuration (int duration)
 set the duration in seconds More...
 
unsigned int GetDuration () const
 retrieve the duration in seconds. Prefers the duration from stream details if available.
 
unsigned int GetStaticDuration () const
 retrieve the duration in seconds. Ignores the duration from stream details even if available.
 
void SetBasePath (std::string basePath)
 
void SetDirector (std::vector< std::string > director)
 
void SetWritingCredits (std::vector< std::string > writingCredits)
 
void SetGenre (std::vector< std::string > genre)
 
void SetCountry (std::vector< std::string > country)
 
void SetTagLine (std::string tagLine)
 
void SetPlotOutline (std::string plotOutline)
 
void SetTrailer (std::string trailer)
 
void SetPlot (std::string plot)
 
std::string const & GetTitle ()
 
void SetTitle (std::string title)
 
void SetSortTitle (std::string sortTitle)
 
void SetPictureURL (CScraperUrl &pictureURL)
 
void SetRating (float rating, int votes, const std::string &type="", bool def=false)
 
void SetRating (CRating rating, const std::string &type="", bool def=false)
 
void SetRating (float rating, const std::string &type="", bool def=false)
 
void RemoveRating (const std::string &type)
 
void SetRatings (RatingMap ratings, const std::string &defaultRating="")
 
void SetVotes (int votes, const std::string &type="")
 
void SetUniqueIDs (std::map< std::string, std::string > uniqueIDs)
 
void SetPremiered (const CDateTime &premiered)
 
void SetPremieredFromDBDate (const std::string &premieredString)
 
virtual void SetYear (int year)
 
void SetArtist (std::vector< std::string > artist)
 
void SetSet (std::string set)
 
void SetSetOverview (std::string setOverview)
 
void SetTags (std::vector< std::string > tags)
 
void SetFile (std::string file)
 
void SetPath (std::string path)
 
void SetMPAARating (std::string mpaaRating)
 
void SetFileNameAndPath (std::string fileNameAndPath)
 
void SetOriginalTitle (std::string originalTitle)
 
void SetEpisodeGuide (std::string episodeGuide)
 
void SetStatus (std::string status)
 
void SetProductionCode (std::string productionCode)
 
void SetShowTitle (std::string showTitle)
 
void SetStudio (std::vector< std::string > studio)
 
void SetAlbum (std::string album)
 
void SetShowLink (std::vector< std::string > showLink)
 
void SetUniqueID (const std::string &uniqueid, const std::string &type="", bool def=false)
 
void RemoveUniqueID (const std::string &type)
 
void SetNamedSeasons (std::map< int, std::string > namedSeasons)
 
void SetUserrating (int userrating)
 
virtual int GetPlayCount () const
 Get this videos's play count. More...
 
virtual bool SetPlayCount (int count)
 Set this videos's play count. More...
 
virtual bool IncrementPlayCount ()
 Increment this videos's play count. More...
 
virtual void ResetPlayCount ()
 Reset playcount.
 
virtual bool IsPlayCountSet () const
 Check if the playcount is set. More...
 
virtual CBookmark GetResumePoint () const
 Get this videos's resume point. More...
 
virtual bool SetResumePoint (const CBookmark &resumePoint)
 Set this videos's resume point. More...
 
virtual bool SetResumePoint (double timeInSeconds, double totalTimeInSeconds, const std::string &playerState)
 Set this videos's resume point. More...
 

Static Public Member Functions

static unsigned int GetDurationFromMinuteString (const std::string &runtime)
 get the duration in seconds from a minute string More...
 

Public Attributes

std::string m_basePath
 
int m_parentPathID
 
std::vector< std::string > m_director
 
std::vector< std::string > m_writingCredits
 
std::vector< std::string > m_genre
 
std::vector< std::string > m_country
 
std::string m_strTagLine
 
std::string m_strPlotOutline
 
std::string m_strTrailer
 
std::string m_strPlot
 
CScraperUrl m_strPictureURL
 
std::string m_strTitle
 
std::string m_strSortTitle
 
std::vector< std::string > m_artist
 
std::vector< SActorInfom_cast
 
SetInfo m_set
 Assigned movie set.
 
std::vector< std::string > m_tags
 
std::string m_strFile
 
std::string m_strPath
 
std::string m_strMPAARating
 
std::string m_strFileNameAndPath
 
std::string m_strOriginalTitle
 
std::string m_strEpisodeGuide
 
CDateTime m_premiered
 
bool m_bHasPremiered
 
std::string m_strStatus
 
std::string m_strProductionCode
 
CDateTime m_firstAired
 
std::string m_strShowTitle
 
std::vector< std::string > m_studio
 
std::string m_strAlbum
 
CDateTime m_lastPlayed
 
std::vector< std::string > m_showLink
 
std::map< int, std::string > m_namedSeasons
 
int m_iTop250
 
int m_year
 
int m_iSeason
 
int m_iEpisode
 
int m_iIdUniqueID
 
int m_iDbId
 
int m_iFileId
 
int m_iSpecialSortSeason
 
int m_iSpecialSortEpisode
 
int m_iTrack
 
RatingMap m_ratings
 
int m_iIdRating
 
int m_iUserRating
 
CBookmark m_EpBookmark
 
int m_iBookmarkId
 
int m_iIdShow
 
int m_iIdSeason
 
CFanart m_fanart
 
CStreamDetails m_streamDetails
 
CDateTime m_dateAdded
 
MediaType m_type
 
int m_relevance
 
int m_parsedDetails
 
std::vector< EmbeddedArtInfom_coverArt
 art information
 
unsigned int m_duration
 duration in seconds
 

Member Function Documentation

◆ GetDurationFromMinuteString()

unsigned int CVideoInfoTag::GetDurationFromMinuteString ( const std::string &  runtime)
static

get the duration in seconds from a minute string

Parameters
runtimethe runtime string from a scraper or similar
Returns
the time in seconds, if decipherable.

◆ GetPlayCount()

int CVideoInfoTag::GetPlayCount ( ) const
virtual

Get this videos's play count.

Returns
the play count.

◆ GetResumePoint()

CBookmark CVideoInfoTag::GetResumePoint ( ) const
virtual

Get this videos's resume point.

Returns
the resume point.

Reimplemented in PVR::CPVRRecording.

◆ IncrementPlayCount()

bool CVideoInfoTag::IncrementPlayCount ( )
virtual

Increment this videos's play count.

Returns
True if play count was increased successfully, false otherwise.

Reimplemented in PVR::CPVRRecording.

◆ IsPlayCountSet()

bool CVideoInfoTag::IsPlayCountSet ( ) const
virtual

Check if the playcount is set.

Returns
True if play count value is set

◆ SetDuration()

void CVideoInfoTag::SetDuration ( int  duration)

set the duration in seconds

Parameters
durationthe duration to set

◆ SetPlayCount()

bool CVideoInfoTag::SetPlayCount ( int  count)
virtual

Set this videos's play count.

Parameters
countplay count.
Returns
True if play count was set successfully, false otherwise.

Reimplemented in PVR::CPVRRecording.

◆ SetResumePoint() [1/2]

bool CVideoInfoTag::SetResumePoint ( const CBookmark resumePoint)
virtual

Set this videos's resume point.

Parameters
resumePointresume point.
Returns
True if resume point was set successfully, false otherwise.

Reimplemented in PVR::CPVRRecording.

◆ SetResumePoint() [2/2]

bool CVideoInfoTag::SetResumePoint ( double  timeInSeconds,
double  totalTimeInSeconds,
const std::string &  playerState 
)
virtual

Set this videos's resume point.

Parameters
timeInSecondsthe time of the resume point
totalTimeInSecondsthe total time of the video
playerStatethe player state
Returns
True if resume point was set successfully, false otherwise.

Reimplemented in PVR::CPVRRecording.


The documentation for this class was generated from the following files: