CVideoInfoTag Class Reference

#include <VideoInfoTag.h>

Inheritance diagram for CVideoInfoTag:

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

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

Public Member Functions
	CVideoInfoTag ()
virtual	~CVideoInfoTag ()=default
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 CDateTime &	GetPremiered () const
const CDateTime &	GetFirstAired () 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
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 () const
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.
virtual bool	SetPlayCount (int count)
	Set this videos's play count.
virtual bool	IncrementPlayCount ()
	Increment this videos's play count.
virtual void	ResetPlayCount ()
	Reset playcount.
virtual bool	IsPlayCountSet () const
	Check if the playcount is set.
virtual CBookmark	GetResumePoint () const
	Get this videos's resume point.
virtual bool	SetResumePoint (const CBookmark &resumePoint)
	Set this videos's resume point.
const CAssetInfo &	GetAssetInfo () const
	Get the video's asset info.
CAssetInfo &	GetAssetInfo ()
bool	HasVideoVersions () const
	Whether the item has multiple video versions.
void	SetHasVideoVersions (bool hasVersions)
	Set whether this video has video versions.
bool	HasVideoExtras () const
	Whether the item has video extras.
void	SetHasVideoExtras (bool hasExtras)
	Set whether this video has video extras.
bool	IsDefaultVideoVersion () const
	Whether the item is the default video version.
void	SetIsDefaultVideoVersion (bool isDefaultVideoVersion)
	Set whether the item is the default version.
bool	GetUpdateSetOverview () const
	Get whether the Set Overview should be updated. If an NFO contains a <name> but no <overview> then this allows the current Overview to be kept. Otherwise it is overwritten. Default is true - so if updated by a scraper the Overview will be overwritten.
virtual bool	SetResumePoint (double timeInSeconds, double totalTimeInSeconds, const std::string &playerState)
	Set this videos's resume point.

Static Public Member Functions
static unsigned int	GetDurationFromMinuteString (const std::string &runtime)
	get the duration in seconds from a minute string

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< SActorInfo >	m_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< EmbeddedArtInfo >	m_coverArt
	art information
unsigned int	m_duration
	duration in seconds

Additional Inherited Members
Protected Member Functions inherited from IArchivable
virtual	~IArchivable ()=default
Protected Member Functions inherited from ISerializable
	~ISerializable ()=default
Protected Member Functions inherited from ISortable
	~ISortable ()=default

Member Typedef Documentation

iCast

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

Constructor & Destructor Documentation

CVideoInfoTag()

CVideoInfoTag::CVideoInfoTag ( )

inline

~CVideoInfoTag()

virtual CVideoInfoTag::~CVideoInfoTag ( )

virtualdefault

Member Function Documentation

Archive()

void CVideoInfoTag::Archive ( CArchive & ar )

overridevirtual

Implements IArchivable.

GetAssetInfo() [1/2]

CAssetInfo & CVideoInfoTag::GetAssetInfo ( )

inline

GetAssetInfo() [2/2]

const CAssetInfo & CVideoInfoTag::GetAssetInfo ( ) const

inline

Get the video's asset info.

Returns

The info.

GetCast()

const std::string CVideoInfoTag::GetCast

(

bool

bIncludeRole = false

)

const

GetDefaultRating()

const std::string & CVideoInfoTag::GetDefaultRating

(

)

const

GetDefaultUniqueID()

const std::string & CVideoInfoTag::GetDefaultUniqueID

(

)

const

GetDuration()

unsigned int CVideoInfoTag::GetDuration

(

)

const

retrieve the duration in seconds. Prefers the duration from stream details if available.

GetDurationFromMinuteString()

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

static

get the duration in seconds from a minute string

Parameters

runtime

the runtime string from a scraper or similar

Returns

the time in seconds, if decipherable.

GetFirstAired()

const CDateTime & CVideoInfoTag::GetFirstAired

(

)

const

GetPath()

const std::string & CVideoInfoTag::GetPath ( ) const

inline

GetPlayCount()

int CVideoInfoTag::GetPlayCount ( ) const

virtual

Get this videos's play count.

Returns

the play count.

GetPremiered()

const CDateTime & CVideoInfoTag::GetPremiered

(

)

const

GetRating()

const CRating CVideoInfoTag::GetRating

(

std::string

type = ""

)

const

GetResumePoint()

CBookmark CVideoInfoTag::GetResumePoint ( ) const

virtual

Get this videos's resume point.

Returns

the resume point.

Reimplemented in PVR::CPVRRecording.

GetStaticDuration()

unsigned int CVideoInfoTag::GetStaticDuration

(

)

const

retrieve the duration in seconds. Ignores the duration from stream details even if available.

GetTitle()

std::string const & CVideoInfoTag::GetTitle

(

)

const

GetUniqueID()

const std::string CVideoInfoTag::GetUniqueID

(

std::string

type = ""

)

const

GetUniqueIDs()

const std::map< std::string, std::string > & CVideoInfoTag::GetUniqueIDs

(

)

const

GetUpdateSetOverview()

bool CVideoInfoTag::GetUpdateSetOverview ( ) const

inline

Get whether the Set Overview should be updated. If an NFO contains a <name> but no <overview> then this allows the current Overview to be kept. Otherwise it is overwritten. Default is true - so if updated by a scraper the Overview will be overwritten.

GetYear()

int CVideoInfoTag::GetYear ( ) const

virtual

Reimplemented in PVR::CPVRRecording.

HasPremiered()

bool CVideoInfoTag::HasPremiered

(

)

const

HasStreamDetails()

bool CVideoInfoTag::HasStreamDetails

(

)

const

HasUniqueID()

bool CVideoInfoTag::HasUniqueID

(

)

const

HasVideoExtras()

bool CVideoInfoTag::HasVideoExtras ( ) const

inline

Whether the item has video extras.

Returns

True if the item has video extras, false otherwise.

HasVideoVersions()

bool CVideoInfoTag::HasVideoVersions ( ) const

inline

Whether the item has multiple video versions.

Returns

True if the item has multiple video versions, false otherwise.

HasYear()

bool CVideoInfoTag::HasYear ( ) const

virtual

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.

IsDefaultVideoVersion()

bool CVideoInfoTag::IsDefaultVideoVersion ( ) const

inline

Whether the item is the default video version.

Returns

True if the item is the default version, false otherwise.

IsEmpty()

bool CVideoInfoTag::IsEmpty

(

)

const

IsPlayCountSet()

bool CVideoInfoTag::IsPlayCountSet ( ) const

virtual

Check if the playcount is set.

Returns

True if play count value is set

Load()

bool CVideoInfoTag::Load	(	const TiXmlElement *	element,
		bool	append = false,
		bool	prioritise = false )

Merge()

void CVideoInfoTag::Merge

(

CVideoInfoTag &

other

)

RemoveRating()

void CVideoInfoTag::RemoveRating

(

const std::string &

type

)

RemoveUniqueID()

void CVideoInfoTag::RemoveUniqueID

(

const std::string &

type

)

Reset()

void CVideoInfoTag::Reset

(

)

ResetPlayCount()

void CVideoInfoTag::ResetPlayCount ( )

virtual

Reset playcount.

Save()

bool CVideoInfoTag::Save	(	TiXmlNode *	node,
		const std::string &	tag,
		bool	savePathInfo = true,
		const TiXmlElement *	additionalNode = NULL )

Serialize()

void CVideoInfoTag::Serialize ( CVariant & value ) const

overridevirtual

Implements ISerializable.

SetAlbum()

void CVideoInfoTag::SetAlbum

(

std::string

album

)

SetArtist()

void CVideoInfoTag::SetArtist

(

std::vector< std::string >

artist

)

SetBasePath()

void CVideoInfoTag::SetBasePath

(

std::string

basePath

)

SetCountry()

void CVideoInfoTag::SetCountry

(

std::vector< std::string >

country

)

SetDirector()

void CVideoInfoTag::SetDirector

(

std::vector< std::string >

director

)

SetDuration()

void CVideoInfoTag::SetDuration

(

int

duration

)

set the duration in seconds

Parameters

duration

the duration to set

SetEpisodeGuide()

void CVideoInfoTag::SetEpisodeGuide

(

std::string

episodeGuide

)

SetFile()

void CVideoInfoTag::SetFile

(

std::string

file

)

SetFileNameAndPath()

void CVideoInfoTag::SetFileNameAndPath

(

std::string

fileNameAndPath

)

SetGenre()

void CVideoInfoTag::SetGenre

(

std::vector< std::string >

genre

)

SetHasVideoExtras()

void CVideoInfoTag::SetHasVideoExtras

(

bool

hasExtras

)

Set whether this video has video extras.

Parameters

hasExtras

The extras flag.

SetHasVideoVersions()

void CVideoInfoTag::SetHasVideoVersions

(

bool

hasVersions

)

Set whether this video has video versions.

Parameters

hasVersion

The versions flag.

SetIsDefaultVideoVersion()

void CVideoInfoTag::SetIsDefaultVideoVersion

(

bool

isDefaultVideoVersion

)

Set whether the item is the default version.

Parameters

isDefaultVideoVersion

The default flag.

SetMPAARating()

void CVideoInfoTag::SetMPAARating

(

std::string

mpaaRating

)

SetNamedSeasons()

void CVideoInfoTag::SetNamedSeasons

(

std::map< int, std::string >

namedSeasons

)

SetOriginalTitle()

void CVideoInfoTag::SetOriginalTitle

(

std::string

originalTitle

)

SetPath()

void CVideoInfoTag::SetPath

(

std::string

path

)

SetPictureURL()

void CVideoInfoTag::SetPictureURL

(

CScraperUrl &

pictureURL

)

SetPlayCount()

bool CVideoInfoTag::SetPlayCount ( int count )

virtual

Set this videos's play count.

Parameters

count

play count.

Returns

True if play count was set successfully, false otherwise.

Reimplemented in PVR::CPVRRecording.

SetPlot()

void CVideoInfoTag::SetPlot

(

std::string

plot

)

SetPlotOutline()

void CVideoInfoTag::SetPlotOutline

(

std::string

plotOutline

)

SetPremiered()

void CVideoInfoTag::SetPremiered

(

const CDateTime &

premiered

)

SetPremieredFromDBDate()

void CVideoInfoTag::SetPremieredFromDBDate

(

const std::string &

premieredString

)

SetProductionCode()

void CVideoInfoTag::SetProductionCode

(

std::string

productionCode

)

SetRating() [1/3]

void CVideoInfoTag::SetRating	(	CRating	rating,
		const std::string &	type = "",
		bool	def = false )

SetRating() [2/3]

void CVideoInfoTag::SetRating	(	float	rating,
		const std::string &	type = "",
		bool	def = false )

SetRating() [3/3]

void CVideoInfoTag::SetRating	(	float	rating,
		int	votes,
		const std::string &	type = "",
		bool	def = false )

SetRatings()

void CVideoInfoTag::SetRatings	(	RatingMap	ratings,
		const std::string &	defaultRating = "" )

SetResumePoint() [1/2]

bool CVideoInfoTag::SetResumePoint ( const CBookmark & resumePoint )

virtual

Set this videos's resume point.

Parameters

resumePoint

resume 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

timeInSeconds	the time of the resume point
totalTimeInSeconds	the total time of the video
playerState	the player state

Returns

True if resume point was set successfully, false otherwise.

Reimplemented in PVR::CPVRRecording.

SetSet()

void CVideoInfoTag::SetSet

(

std::string

set

)

SetSetOverview()

void CVideoInfoTag::SetSetOverview

(

std::string

setOverview

)

SetShowLink()

void CVideoInfoTag::SetShowLink

(

std::vector< std::string >

showLink

)

SetShowTitle()

void CVideoInfoTag::SetShowTitle

(

std::string

showTitle

)

SetSortTitle()

void CVideoInfoTag::SetSortTitle

(

std::string

sortTitle

)

SetStatus()

void CVideoInfoTag::SetStatus

(

std::string

status

)

SetStudio()

void CVideoInfoTag::SetStudio

(

std::vector< std::string >

studio

)

SetTagLine()

void CVideoInfoTag::SetTagLine

(

std::string

tagLine

)

SetTags()

void CVideoInfoTag::SetTags

(

std::vector< std::string >

tags

)

SetTitle()

void CVideoInfoTag::SetTitle

(

std::string

title

)

SetTrailer()

void CVideoInfoTag::SetTrailer

(

std::string

trailer

)

SetUniqueID()

void CVideoInfoTag::SetUniqueID	(	const std::string &	uniqueid,
		const std::string &	type = "",
		bool	def = false )

SetUniqueIDs()

void CVideoInfoTag::SetUniqueIDs

(

std::map< std::string, std::string >

uniqueIDs

)

SetUserrating()

void CVideoInfoTag::SetUserrating

(

int

userrating

)

SetVotes()

void CVideoInfoTag::SetVotes	(	int	votes,
		const std::string &	type = "" )

SetWritingCredits()

void CVideoInfoTag::SetWritingCredits

(

std::vector< std::string >

writingCredits

)

SetYear()

void CVideoInfoTag::SetYear ( int year )

virtual

Reimplemented in PVR::CPVRRecording.

ToSortable()

void CVideoInfoTag::ToSortable ( SortItem & sortable, Field field ) const

overridevirtual

Implements ISortable.

Member Data Documentation

m_artist

std::vector<std::string> CVideoInfoTag::m_artist

m_basePath

std::string CVideoInfoTag::m_basePath

m_bHasPremiered

bool CVideoInfoTag::m_bHasPremiered

m_cast

std::vector< SActorInfo > CVideoInfoTag::m_cast

m_country

std::vector<std::string> CVideoInfoTag::m_country

m_coverArt

std::vector<EmbeddedArtInfo> CVideoInfoTag::m_coverArt

art information

m_dateAdded

CDateTime CVideoInfoTag::m_dateAdded

m_director

std::vector<std::string> CVideoInfoTag::m_director

m_duration

unsigned int CVideoInfoTag::m_duration

duration in seconds

m_EpBookmark

CBookmark CVideoInfoTag::m_EpBookmark

m_fanart

CFanart CVideoInfoTag::m_fanart

m_firstAired

CDateTime CVideoInfoTag::m_firstAired

m_genre

std::vector<std::string> CVideoInfoTag::m_genre

m_iBookmarkId

int CVideoInfoTag::m_iBookmarkId

m_iDbId

int CVideoInfoTag::m_iDbId

m_iEpisode

int CVideoInfoTag::m_iEpisode

m_iFileId

int CVideoInfoTag::m_iFileId

m_iIdRating

int CVideoInfoTag::m_iIdRating

m_iIdSeason

int CVideoInfoTag::m_iIdSeason

m_iIdShow

int CVideoInfoTag::m_iIdShow

m_iIdUniqueID

int CVideoInfoTag::m_iIdUniqueID

m_iSeason

int CVideoInfoTag::m_iSeason

m_iSpecialSortEpisode

int CVideoInfoTag::m_iSpecialSortEpisode

m_iSpecialSortSeason

int CVideoInfoTag::m_iSpecialSortSeason

m_iTop250

int CVideoInfoTag::m_iTop250

m_iTrack

int CVideoInfoTag::m_iTrack

m_iUserRating

int CVideoInfoTag::m_iUserRating

m_lastPlayed

CDateTime CVideoInfoTag::m_lastPlayed

m_namedSeasons

std::map<int, std::string> CVideoInfoTag::m_namedSeasons

m_parentPathID

int CVideoInfoTag::m_parentPathID

m_parsedDetails

int CVideoInfoTag::m_parsedDetails

m_premiered

CDateTime CVideoInfoTag::m_premiered

m_ratings

RatingMap CVideoInfoTag::m_ratings

m_relevance

int CVideoInfoTag::m_relevance

m_set

SetInfo CVideoInfoTag::m_set

Assigned movie set.

m_showLink

std::vector<std::string> CVideoInfoTag::m_showLink

m_strAlbum

std::string CVideoInfoTag::m_strAlbum

m_streamDetails

CStreamDetails CVideoInfoTag::m_streamDetails

m_strEpisodeGuide

std::string CVideoInfoTag::m_strEpisodeGuide

m_strFile

std::string CVideoInfoTag::m_strFile

m_strFileNameAndPath

std::string CVideoInfoTag::m_strFileNameAndPath

m_strMPAARating

std::string CVideoInfoTag::m_strMPAARating

m_strOriginalTitle

std::string CVideoInfoTag::m_strOriginalTitle

m_strPath

std::string CVideoInfoTag::m_strPath

m_strPictureURL

CScraperUrl CVideoInfoTag::m_strPictureURL

m_strPlot

std::string CVideoInfoTag::m_strPlot

m_strPlotOutline

std::string CVideoInfoTag::m_strPlotOutline

m_strProductionCode

std::string CVideoInfoTag::m_strProductionCode

m_strShowTitle

std::string CVideoInfoTag::m_strShowTitle

m_strSortTitle

std::string CVideoInfoTag::m_strSortTitle

m_strStatus

std::string CVideoInfoTag::m_strStatus

m_strTagLine

std::string CVideoInfoTag::m_strTagLine

m_strTitle

std::string CVideoInfoTag::m_strTitle

m_strTrailer

std::string CVideoInfoTag::m_strTrailer

m_studio

std::vector<std::string> CVideoInfoTag::m_studio

m_tags

std::vector<std::string> CVideoInfoTag::m_tags

m_type

MediaType CVideoInfoTag::m_type

m_writingCredits

std::vector<std::string> CVideoInfoTag::m_writingCredits

m_year

int CVideoInfoTag::m_year

---

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

• VideoInfoTag.h
• VideoInfoTag.cpp