Kodi Documentation  20.0
Kodi is an open source media player and entertainment hub.
XBMCAddon::xbmc::InfoTagVideo Class Reference

#include <InfoTagVideo.h>

Inheritance diagram for XBMCAddon::xbmc::InfoTagVideo:
Collaboration diagram for XBMCAddon::xbmc::InfoTagVideo:

Public Member Functions

 InfoTagVideo (const CVideoInfoTag *tag)
 
 InfoTagVideo (CVideoInfoTag *tag, bool offscreen=false)
 
 InfoTagVideo (...)
 

Function: xbmc.InfoTagVideo([offscreen])


Create a video info tag. More...
 
 ~InfoTagVideo () override
 
 getDbId ()
 

Function: getDbId()


Get identification number of tag in database More...
 
 getDirector ()
 

Function: getDirector()


Get film director who has made the film (if present). More...
 
 getDirectors ()
 

Function: getDirectors()


Get a list of film directors who have made the film (if present). More...
 
 getWritingCredits ()
 

Function: getWritingCredits()


Get the writing credits if present from video info tag. More...
 
 getWriters ()
 

Function: getWriters()


Get the list of writers (if present) from video info tag. More...
 
 getGenre ()
 

Function: getGenre()


To get the Video Genre if available. More...
 
 getGenres ()
 

Function: getGenres()


Get the list of Video Genres if available. More...
 
 getTagLine ()
 

Function: getTagLine()


Get video tag line if available. More...
 
 getPlotOutline ()
 

Function: getPlotOutline()


Get the outline plot of the video if present. More...
 
 getPlot ()
 

Function: getPlot()


Get the plot of the video if present. More...
 
 getPictureURL ()
 

Function: getPictureURL()


Get a picture URL of the video to show as screenshot. More...
 
 getTitle ()
 

Function: getTitle()


Get the video title. More...
 
 getTVShowTitle ()
 

Function: getTVShowTitle()


Get the video TV show title. More...
 
 getMediaType ()
 

Function: getMediaType()


Get the media type of the video. More...
 
 getVotes ()
 

Function: getVotes()


Get the video votes if available from video info tag. More...
 
 getVotesAsInt (type)
 

Function: getVotesAsInt([type])


Get the votes of the rating (if available) as an integer. More...
 
 getCast ()
 

Function: getCast()


To get the cast of the video when available. More...
 
 getActors ()
 

Function: getActors()


Get the cast of the video if available. More...
 
 getFile ()
 

Function: getFile()


To get the video file name. More...
 
 getPath ()
 

Function: getPath()


To get the path where the video is stored. More...
 
 getFilenameAndPath ()
 

Function: getFilenameAndPath()


To get the full path with filename where the video is stored. More...
 
 getIMDBNumber ()
 

Function: getIMDBNumber()


To get the IMDb number of the video (if present). More...
 
 getSeason ()
 

Function: getSeason()


To get season number of a series More...
 
 getEpisode ()
 

Function: getEpisode()


To get episode number of a series More...
 
 getYear ()
 

Function: getYear()


Get production year of video if present. More...
 
 getRating (type)
 

Function: getRating([type])


Get the video rating if present as float (double where supported). More...
 
 getUserRating ()
 

Function: getUserRating()


Get the user rating if present as integer. More...
 
 getPlayCount ()
 

Function: getPlayCount()


To get the number of plays of the video. More...
 
 getLastPlayed ()
 

Function: getLastPlayed()


Get the last played date / time as string. More...
 
 getLastPlayedAsW3C ()
 

Function: getLastPlayedAsW3C()


Get last played datetime as string in W3C format (YYYY-MM-DDThh:mm:ssTZD). More...
 
 getOriginalTitle ()
 

Function: getOriginalTitle()


To get the original title of the video. More...
 
 getPremiered ()
 

Function: getPremiered()


To get premiered date of the video, if available. More...
 
 getPremieredAsW3C ()
 

Function: getPremieredAsW3C()


Get premiered date as string in W3C format (YYYY-MM-DD). More...
 
 getFirstAired ()
 

Function: getFirstAired()


Returns first aired date as string from info tag. More...
 
 getFirstAiredAsW3C ()
 

Function: getFirstAiredAsW3C()


Get first aired date as string in W3C format (YYYY-MM-DD). More...
 
 getTrailer ()
 

Function: getTrailer()


To get the path where the trailer is stored. More...
 
 getArtist ()
 

Function: getArtist()


To get the artist name (for musicvideos) More...
 
 getAlbum ()
 

Function: getAlbum()


To get the album name (for musicvideos) More...
 
 getTrack ()
 

Function: getTrack()


To get the track number (for musicvideos) More...
 
 getDuration ()
 

Function: getDuration()


To get the duration More...
 
 getResumeTime (...)
 

Function: getResumeTime())


Gets the resume time of the video item. More...
 
 setSortEpisode (...)
 

Function: getResumeTimeTotal())


Gets the total duration stored with the resume time of the video item. More...
 
 getUniqueID (key)
 

Function: getUniqueID(key)



Get the unique ID of the given key. A unique ID is an identifier used by a (online) video database used to identify a video in its database. More...

 
 setUniqueID (...)
 

Function: setUniqueID(uniqueID, [type], [isDefault])


Set the given unique ID. A unique ID is an identifier used by a (online) video database used to identify a video in its database. More...
 
 setUniqueIDs (...)
 

Function: setUniqueIDs(values, defaultUniqueID)



Set the given unique IDs. A unique ID is an identifier used by a (online) video database used to identify a video in its database. More...

 
 setDbId (...)
 

Function: setDbId(dbId)


Set the database identifier of the video item. More...
 
 setYear (...)
 

Function: setYear(year)


Set the year of the video item. More...
 
 setEpisode (...)
 

Function: setEpisode(episode)


Set the episode number of the episode. More...
 
 setSeason (...)
 

Function: setSeason(season)


Set the season number of the video item. More...
 
 setSortEpisode (...)
 

Function: setSortEpisode(sortEpisode)


Set the episode sort number of the episode. More...
 
 setSortSeason (...)
 

Function: setSortSeason(sortSeason)


Set the season sort number of the season. More...
 
 setEpisodeGuide (...)
 

Function: setEpisodeGuide(episodeGuide)


Set the episode guide of the video item. More...
 
 setTop250 (...)
 

Function: setTop250(top250)


Set the top 250 number of the video item. More...
 
 setSetId (...)
 

Function: setSetId(setId)


Set the movie set identifier of the video item. More...
 
 setTrackNumber (...)
 

Function: setTrackNumber(trackNumber)


Set the track number of the music video item. More...
 
 setRating (...)
 

Function: setRating(rating, [votes], [type], [isDefault])


Set the rating of the video item. More...
 
 setRatings (...)
 

Function: setRatings(ratings, [defaultRating])


Set the ratings of the video item. More...
 
 setUserRating (...)
 

Function: setUserRating(userRating)


Set the user rating of the video item. More...
 
 setPlaycount (...)
 

Function: setPlaycount(playcount)


Set the playcount of the video item. More...
 
 setMpaa (...)
 

Function: setMpaa(mpaa)


Set the MPAA rating of the video item. More...
 
 setPlot (...)
 

Function: setPlot(plot)


Set the plot of the video item. More...
 
 setPlotOutline (...)
 

Function: setPlotOutline(plotOutline)


Set the plot outline of the video item. More...
 
 setTitle (...)
 

Function: setTitle(title)


Set the title of the video item. More...
 
 setOriginalTitle (...)
 

Function: setOriginalTitle(originalTitle)


Set the original title of the video item. More...
 
 setSortTitle (...)
 

Function: setSortTitle(sortTitle)


Set the sort title of the video item. More...
 
 setTagLine (...)
 

Function: setTagLine(tagLine)


Set the tagline of the video item. More...
 
 setTvShowTitle (...)
 

Function: setTvShowTitle(tvshowTitle)


Set the TV show title of the video item. More...
 
 setTvShowStatus (...)
 

Function: setTvShowStatus(tvshowStatus)


Set the TV show status of the video item. More...
 
 setGenres (...)
 

Function: setGenres(genre)


Set the genres of the video item. More...
 
 setCountries (...)
 

Function: setCountries(countries)


Set the countries of the video item. More...
 
 setDirectors (...)
 

Function: setDirectors(directors)


Set the directors of the video item. More...
 
 setStudios (...)
 

Function: setStudios(studios)


Set the studios of the video item. More...
 
 setWriters (...)
 

Function: setWriters(writers)


Set the writers of the video item. More...
 
 setDuration (...)
 

Function: setDuration(duration)


Set the duration of the video item. More...
 
 setPremiered (...)
 

Function: setPremiered(premiered)


Set the premiere date of the video item. More...
 
 setSet (...)
 

Function: setSet(set)


Set the movie set (name) of the video item. More...
 
 setSetOverview (...)
 

Function: setSetOverview(setOverview)


Set the movie set overview of the video item. More...
 
 setTags (...)
 

Function: setTags(tags)


Set the tags of the video item. More...
 
 setProductionCode (...)
 

Function: setProductionCode(const String& productionCode)


Set the production code of the video item. More...
 
 setFirstAired (...)
 

Function: setFirstAired(firstAired)


Set the first aired date of the video item. More...
 
 setLastPlayed (...)
 

Function: setLastPlayed(lastPlayed)


Set the last played date of the video item. More...
 
 setAlbum (...)
 

Function: setAlbum(album)


Set the album of the video item. More...
 
 setVotes (...)
 

Function: setVotes(votes)


Set the number of votes of the video item. More...
 
 setTrailer (...)
 

Function: setTrailer(trailer)


Set the trailer of the video item. More...
 
 setPath (...)
 

Function: setPath(path)


Set the path of the video item. More...
 
 setFilenameAndPath (...)
 

Function: setFilenameAndPath(filenameAndPath)


Set the filename and path of the video item. More...
 
 setIMDBNumber (...)
 

Function: setIMDBNumber(imdbNumber)


Set the IMDb number of the video item. More...
 
 setDateAdded (...)
 

Function: setDateAdded(dateAdded)


Set the date added of the video item. More...
 
 setMediaType (...)
 

Function: setMediaType(mediaType)


Set the media type of the video item. More...
 
 setShowLinks (...)
 

Function: setShowLinks(showLinks)


Set the TV show links of the movie. More...
 
 setArtists (...)
 

Function: setArtists(artists)


Set the artists of the music video item. More...
 
 setCast (...)
 

Function: setCast(actors)


Set the cast / actors of the video item. More...
 
 setResumePoint (...)
 

Function: setResumePoint(time, [totalTime])


Set the resume point of the video item. More...
 
 addSeason (...)
 

Function: addSeason(number, [name])


Add a season with name. It needs at least the season number. More...
 
 addSeasons (...)
 

Function: addSeasons(namedSeasons)


Add named seasons to the TV show. More...
 
 addVideoStream (...)
 

Function: addVideoStream(stream)


Add a video stream to the video item. More...
 
 addAudioStream (...)
 

Function: addAudioStream(stream)


Add an audio stream to the video item. More...
 
 addSubtitleStream (...)
 

Function: addSubtitleStream(stream)


Add a subtitle stream to the video item. More...
 
 addAvailableArtwork (...)
 

Function: addAvailableArtwork(images)


Add an image to available artworks (needed for video scrapers) More...
 
- Public Member Functions inherited from XBMCAddon::AddonClass
 AddonClass ()
 
virtual ~AddonClass ()
 
const char * GetClassname () const
 
LanguageHookGetLanguageHook ()
 
bool isDeallocating ()
 
void Release () const
 
void Acquire () const
 
- Public Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
 CountingLockable ()=default
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
unsigned int exit (unsigned int leave=0)
 
void restore (unsigned int restoreCount)
 
XbmcThreads::CRecursiveMutex & get_underlying ()
 

Static Public Member Functions

static void setDbIdRaw (CVideoInfoTag *infoTag, int dbId)
 
static void setUniqueIDRaw (CVideoInfoTag *infoTag, const String &uniqueID, const String &type="", bool isDefault=false)
 
static void setUniqueIDsRaw (CVideoInfoTag *infoTag, std::map< String, String > uniqueIDs, const String &defaultUniqueID="")
 
static void setYearRaw (CVideoInfoTag *infoTag, int year)
 
static void setEpisodeRaw (CVideoInfoTag *infoTag, int episode)
 
static void setSeasonRaw (CVideoInfoTag *infoTag, int season)
 
static void setSortEpisodeRaw (CVideoInfoTag *infoTag, int sortEpisode)
 
static void setSortSeasonRaw (CVideoInfoTag *infoTag, int sortSeason)
 
static void setEpisodeGuideRaw (CVideoInfoTag *infoTag, const String &episodeGuide)
 
static void setTop250Raw (CVideoInfoTag *infoTag, int top250)
 
static void setSetIdRaw (CVideoInfoTag *infoTag, int setId)
 
static void setTrackNumberRaw (CVideoInfoTag *infoTag, int trackNumber)
 
static void setRatingRaw (CVideoInfoTag *infoTag, float rating, int votes=0, const std::string &type="", bool isDefault=false)
 
static void setRatingsRaw (CVideoInfoTag *infoTag, const std::map< String, Tuple< float, int >> &ratings, const String &defaultRating="")
 
static void setUserRatingRaw (CVideoInfoTag *infoTag, int userRating)
 
static void setPlaycountRaw (CVideoInfoTag *infoTag, int playcount)
 
static void setMpaaRaw (CVideoInfoTag *infoTag, const String &mpaa)
 
static void setPlotRaw (CVideoInfoTag *infoTag, const String &plot)
 
static void setPlotOutlineRaw (CVideoInfoTag *infoTag, const String &plotOutline)
 
static void setTitleRaw (CVideoInfoTag *infoTag, const String &title)
 
static void setOriginalTitleRaw (CVideoInfoTag *infoTag, const String &originalTitle)
 
static void setSortTitleRaw (CVideoInfoTag *infoTag, const String &sortTitle)
 
static void setTagLineRaw (CVideoInfoTag *infoTag, const String &tagLine)
 
static void setTvShowTitleRaw (CVideoInfoTag *infoTag, const String &tvshowTitle)
 
static void setTvShowStatusRaw (CVideoInfoTag *infoTag, const String &tvshowStatus)
 
static void setGenresRaw (CVideoInfoTag *infoTag, std::vector< String > genre)
 
static void setCountriesRaw (CVideoInfoTag *infoTag, std::vector< String > countries)
 
static void setDirectorsRaw (CVideoInfoTag *infoTag, std::vector< String > directors)
 
static void setStudiosRaw (CVideoInfoTag *infoTag, std::vector< String > studios)
 
static void setWritersRaw (CVideoInfoTag *infoTag, std::vector< String > writers)
 
static void setDurationRaw (CVideoInfoTag *infoTag, int duration)
 
static void setPremieredRaw (CVideoInfoTag *infoTag, const String &premiered)
 
static void setSetRaw (CVideoInfoTag *infoTag, const String &set)
 
static void setSetOverviewRaw (CVideoInfoTag *infoTag, const String &setOverview)
 
static void setTagsRaw (CVideoInfoTag *infoTag, std::vector< String > tags)
 
static void setProductionCodeRaw (CVideoInfoTag *infoTag, const String &productionCode)
 
static void setFirstAiredRaw (CVideoInfoTag *infoTag, const String &firstAired)
 
static void setLastPlayedRaw (CVideoInfoTag *infoTag, const String &lastPlayed)
 
static void setAlbumRaw (CVideoInfoTag *infoTag, const String &album)
 
static void setVotesRaw (CVideoInfoTag *infoTag, int votes)
 
static void setTrailerRaw (CVideoInfoTag *infoTag, const String &trailer)
 
static void setPathRaw (CVideoInfoTag *infoTag, const String &path)
 
static void setFilenameAndPathRaw (CVideoInfoTag *infoTag, const String &filenameAndPath)
 
static void setIMDBNumberRaw (CVideoInfoTag *infoTag, const String &imdbNumber)
 
static void setDateAddedRaw (CVideoInfoTag *infoTag, const String &dateAdded)
 
static void setMediaTypeRaw (CVideoInfoTag *infoTag, const String &mediaType)
 
static void setShowLinksRaw (CVideoInfoTag *infoTag, std::vector< String > showLinks)
 
static void setArtistsRaw (CVideoInfoTag *infoTag, std::vector< String > artists)
 
static void setCastRaw (CVideoInfoTag *infoTag, std::vector< SActorInfo > cast)
 
static void setResumePointRaw (CVideoInfoTag *infoTag, double time, double totalTime=0.0)
 
static void addSeasonRaw (CVideoInfoTag *infoTag, int number, std::string name="")
 
static void addSeasonsRaw (CVideoInfoTag *infoTag, const std::vector< Tuple< int, std::string >> &namedSeasons)
 
static void addStreamRaw (CVideoInfoTag *infoTag, CStreamDetail *stream)
 
static void finalizeStreamsRaw (CVideoInfoTag *infoTag)
 
static void addAvailableArtworkRaw (CVideoInfoTag *infoTag, const std::string &url, const std::string &art_type="", const std::string &preview="", const std::string &referrer="", const std::string &cache="", bool post=false, bool isgz=false, int season=-1)
 
- Static Public Member Functions inherited from XBMCAddon::AddonClass
static short getNumAddonClasses ()
 

Additional Inherited Members

- Protected Member Functions inherited from XBMCAddon::AddonClass
virtual void deallocating ()
 
- Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short getNextClassIndex ()
 
- Protected Attributes inherited from XBMCAddon::AddonClass
LanguageHooklanguageHook
 
- Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex mutex
 
unsigned int count
 

Member Function Documentation

◆ setSortEpisode()

XBMCAddon::xbmc::InfoTagVideo::setSortEpisode (   ...)

Function: setSortEpisode(sortEpisode)


Set the episode sort number of the episode.

Parameters
sortEpisodeinteger - Episode sort number.

v20 Python API changes:
New function added.

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