Kodi Documentation
Kodi is an open source media player and entertainment hub.

Kodi's video info tag class. More...

Collaboration diagram for InfoTagVideo:

Classes

class  XBMCAddon::xbmc::InfoTagVideo
 

Functions

SActorInfo XBMCAddon::xbmc::Actor::ToActorInfo () const
 
CStreamDetailVideoXBMCAddon::xbmc::VideoStreamDetail::ToStreamDetailVideo () const
 
CStreamDetailAudioXBMCAddon::xbmc::AudioStreamDetail::ToStreamDetailAudio () const
 
CStreamDetailSubtitleXBMCAddon::xbmc::SubtitleStreamDetail::ToStreamDetailSubtitle () const
 
 XBMCAddon::xbmc::InfoTagVideo::InfoTagVideo (const CVideoInfoTag *tag)
 
 XBMCAddon::xbmc::InfoTagVideo::InfoTagVideo (CVideoInfoTag *tag, bool offscreen=false)
 
 XBMCAddon::xbmc::InfoTagVideo::InfoTagVideo (...)
 { xbmc.InfoTagVideo([offscreen]) } Create a video info tag. More...
 
 XBMCAddon::xbmc::InfoTagVideo::~InfoTagVideo () override
 
 XBMCAddon::xbmc::InfoTagVideo::getDbId ()
 { getDbId() } Get identification number of tag in database More...
 
 XBMCAddon::xbmc::InfoTagVideo::getDirector ()
 { getDirector() } Get film director who has made the film (if present). More...
 
 XBMCAddon::xbmc::InfoTagVideo::getDirectors ()
 { getDirectors() } Get a list of film directors who have made the film (if present). More...
 
 XBMCAddon::xbmc::InfoTagVideo::getWritingCredits ()
 { getWritingCredits() } Get the writing credits if present from video info tag. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getWriters ()
 { getWriters() } Get the list of writers (if present) from video info tag. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getGenre ()
 { getGenre() } To get the Video Genre if available. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getGenres ()
 { getGenres() } Get the list of Video Genres if available. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getTagLine ()
 { getTagLine() } Get video tag line if available. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getPlotOutline ()
 { getPlotOutline() } Get the outline plot of the video if present. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getPlot ()
 { getPlot() } Get the plot of the video if present. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getPictureURL ()
 { getPictureURL() } Get a picture URL of the video to show as screenshot. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getTitle ()
 { getTitle() } Get the video title. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getTVShowTitle ()
 { getTVShowTitle() } Get the video TV show title. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getMediaType ()
 { getMediaType() } Get the media type of the video. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getVotes ()
 { getVotes() } Get the video votes if available from video info tag. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getVotesAsInt (type)
 { getVotesAsInt([type]) } Get the votes of the rating (if available) as an integer. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getCast ()
 { getCast() } To get the cast of the video when available. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getActors ()
 { getActors() } Get the cast of the video if available. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getFile ()
 { getFile() } To get the video file name. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getPath ()
 { getPath() } To get the path where the video is stored. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getFilenameAndPath ()
 { getFilenameAndPath() } To get the full path with filename where the video is stored. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getIMDBNumber ()
 { getIMDBNumber() } To get the IMDb number of the video (if present). More...
 
 XBMCAddon::xbmc::InfoTagVideo::getSeason ()
 { getSeason() } To get season number of a series More...
 
 XBMCAddon::xbmc::InfoTagVideo::getEpisode ()
 { getEpisode() } To get episode number of a series More...
 
 XBMCAddon::xbmc::InfoTagVideo::getYear ()
 { getYear() } Get production year of video if present. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getRating (type)
 { getRating([type]) } Get the video rating if present as float (double where supported). More...
 
 XBMCAddon::xbmc::InfoTagVideo::getUserRating ()
 { getUserRating() } Get the user rating if present as integer. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getPlayCount ()
 { getPlayCount() } To get the number of plays of the video. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getLastPlayed ()
 { getLastPlayed() } Get the last played date / time as string. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getLastPlayedAsW3C ()
 { getLastPlayedAsW3C() } Get last played datetime as string in W3C format (YYYY-MM-DDThh:mm:ssTZD). More...
 
 XBMCAddon::xbmc::InfoTagVideo::getOriginalTitle ()
 { getOriginalTitle() } To get the original title of the video. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getPremiered ()
 { getPremiered() } To get premiered date of the video, if available. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getPremieredAsW3C ()
 { getPremieredAsW3C() } Get premiered date as string in W3C format (YYYY-MM-DD). More...
 
 XBMCAddon::xbmc::InfoTagVideo::getFirstAired ()
 { getFirstAired() } Returns first aired date as string from info tag. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getFirstAiredAsW3C ()
 { getFirstAiredAsW3C() } Get first aired date as string in W3C format (YYYY-MM-DD). More...
 
 XBMCAddon::xbmc::InfoTagVideo::getTrailer ()
 { getTrailer() } To get the path where the trailer is stored. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getArtist ()
 { getArtist() } To get the artist name (for musicvideos) More...
 
 XBMCAddon::xbmc::InfoTagVideo::getAlbum ()
 { getAlbum() } To get the album name (for musicvideos) More...
 
 XBMCAddon::xbmc::InfoTagVideo::getTrack ()
 { getTrack() } To get the track number (for musicvideos) More...
 
 XBMCAddon::xbmc::InfoTagVideo::getDuration ()
 { getDuration() } To get the duration More...
 
 XBMCAddon::xbmc::InfoTagVideo::getResumeTime (...)
 { getResumeTime()) } Gets the resume time of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setSortEpisode (...)
 { getResumeTimeTotal()) } Gets the total duration stored with the resume time of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::getUniqueID (key)
 { 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...
 
 XBMCAddon::xbmc::InfoTagVideo::setUniqueID (...)
 { 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...
 
 XBMCAddon::xbmc::InfoTagVideo::setUniqueIDs (...)
 { 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...
 
 XBMCAddon::xbmc::InfoTagVideo::setDbId (...)
 { setDbId(dbId) } Set the database identifier of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setYear (...)
 { setYear(year) } Set the year of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setEpisode (...)
 { setEpisode(episode) } Set the episode number of the episode. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setSeason (...)
 { setSeason(season) } Set the season number of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setSortSeason (...)
 { setSortSeason(sortSeason) } Set the season sort number of the season. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setEpisodeGuide (...)
 { setEpisodeGuide(episodeGuide) } Set the episode guide of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setTop250 (...)
 { setTop250(top250) } Set the top 250 number of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setSetId (...)
 { setSetId(setId) } Set the movie set identifier of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setTrackNumber (...)
 { setTrackNumber(trackNumber) } Set the track number of the music video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setRating (...)
 { setRating(rating, [votes], [type], [isDefault]) } Set the rating of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setRatings (...)
 { setRatings(ratings, [defaultRating]) } Set the ratings of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setUserRating (...)
 { setUserRating(userRating) } Set the user rating of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setPlaycount (...)
 { setPlaycount(playcount) } Set the playcount of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setMpaa (...)
 { setMpaa(mpaa) } Set the MPAA rating of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setPlot (...)
 { setPlot(plot) } Set the plot of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setPlotOutline (...)
 { setPlotOutline(plotOutline) } Set the plot outline of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setTitle (...)
 { setTitle(title) } Set the title of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setOriginalTitle (...)
 { setOriginalTitle(originalTitle) } Set the original title of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setSortTitle (...)
 { setSortTitle(sortTitle) } Set the sort title of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setTagLine (...)
 { setTagLine(tagLine) } Set the tagline of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setTvShowTitle (...)
 { setTvShowTitle(tvshowTitle) } Set the TV show title of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setTvShowStatus (...)
 { setTvShowStatus(tvshowStatus) } Set the TV show status of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setGenres (...)
 { setGenres(genre) } Set the genres of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setCountries (...)
 { setCountries(countries) } Set the countries of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setDirectors (...)
 { setDirectors(directors) } Set the directors of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setStudios (...)
 { setStudios(studios) } Set the studios of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setWriters (...)
 { setWriters(writers) } Set the writers of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setDuration (...)
 { setDuration(duration) } Set the duration of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setPremiered (...)
 { setPremiered(premiered) } Set the premiere date of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setSet (...)
 { setSet(set) } Set the movie set (name) of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setSetOverview (...)
 { setSetOverview(setOverview) } Set the movie set overview of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setTags (...)
 { setTags(tags) } Set the tags of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setProductionCode (...)
 { setProductionCode(const String& productionCode) } Set the production code of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setFirstAired (...)
 { setFirstAired(firstAired) } Set the first aired date of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setLastPlayed (...)
 { setLastPlayed(lastPlayed) } Set the last played date of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setAlbum (...)
 { setAlbum(album) } Set the album of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setVotes (...)
 { setVotes(votes) } Set the number of votes of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setTrailer (...)
 { setTrailer(trailer) } Set the trailer of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setPath (...)
 { setPath(path) } Set the path of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setFilenameAndPath (...)
 { setFilenameAndPath(filenameAndPath) } Set the filename and path of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setIMDBNumber (...)
 { setIMDBNumber(imdbNumber) } Set the IMDb number of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setDateAdded (...)
 { setDateAdded(dateAdded) } Set the date added of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setMediaType (...)
 { setMediaType(mediaType) } Set the media type of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setShowLinks (...)
 { setShowLinks(showLinks) } Set the TV show links of the movie. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setArtists (...)
 { setArtists(artists) } Set the artists of the music video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setCast (...)
 { setCast(actors) } Set the cast / actors of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::setResumePoint (...)
 { setResumePoint(time, [totalTime]) } Set the resume point of the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::addSeason (...)
 { addSeason(number, [name]) } Add a season with name. It needs at least the season number. More...
 
 XBMCAddon::xbmc::InfoTagVideo::addSeasons (...)
 { addSeasons(namedSeasons) } Add named seasons to the TV show. More...
 
 XBMCAddon::xbmc::InfoTagVideo::addVideoStream (...)
 { addVideoStream(stream) } Add a video stream to the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::addAudioStream (...)
 { addAudioStream(stream) } Add an audio stream to the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::addSubtitleStream (...)
 { addSubtitleStream(stream) } Add a subtitle stream to the video item. More...
 
 XBMCAddon::xbmc::InfoTagVideo::addAvailableArtwork (...)
 { addAvailableArtwork(images) } Add an image to available artworks (needed for video scrapers) More...
 
static void XBMCAddon::xbmc::InfoTagVideo::setDbIdRaw (CVideoInfoTag *infoTag, int dbId)
 
static void XBMCAddon::xbmc::InfoTagVideo::setUniqueIDRaw (CVideoInfoTag *infoTag, const String &uniqueID, const String &type="", bool isDefault=false)
 
static void XBMCAddon::xbmc::InfoTagVideo::setUniqueIDsRaw (CVideoInfoTag *infoTag, std::map< String, String > uniqueIDs, const String &defaultUniqueID="")
 
static void XBMCAddon::xbmc::InfoTagVideo::setYearRaw (CVideoInfoTag *infoTag, int year)
 
static void XBMCAddon::xbmc::InfoTagVideo::setEpisodeRaw (CVideoInfoTag *infoTag, int episode)
 
static void XBMCAddon::xbmc::InfoTagVideo::setSeasonRaw (CVideoInfoTag *infoTag, int season)
 
static void XBMCAddon::xbmc::InfoTagVideo::setSortEpisodeRaw (CVideoInfoTag *infoTag, int sortEpisode)
 
static void XBMCAddon::xbmc::InfoTagVideo::setSortSeasonRaw (CVideoInfoTag *infoTag, int sortSeason)
 
static void XBMCAddon::xbmc::InfoTagVideo::setEpisodeGuideRaw (CVideoInfoTag *infoTag, const String &episodeGuide)
 
static void XBMCAddon::xbmc::InfoTagVideo::setTop250Raw (CVideoInfoTag *infoTag, int top250)
 
static void XBMCAddon::xbmc::InfoTagVideo::setSetIdRaw (CVideoInfoTag *infoTag, int setId)
 
static void XBMCAddon::xbmc::InfoTagVideo::setTrackNumberRaw (CVideoInfoTag *infoTag, int trackNumber)
 
static void XBMCAddon::xbmc::InfoTagVideo::setRatingRaw (CVideoInfoTag *infoTag, float rating, int votes=0, const std::string &type="", bool isDefault=false)
 
static void XBMCAddon::xbmc::InfoTagVideo::setRatingsRaw (CVideoInfoTag *infoTag, const std::map< String, Tuple< float, int >> &ratings, const String &defaultRating="")
 
static void XBMCAddon::xbmc::InfoTagVideo::setUserRatingRaw (CVideoInfoTag *infoTag, int userRating)
 
static void XBMCAddon::xbmc::InfoTagVideo::setPlaycountRaw (CVideoInfoTag *infoTag, int playcount)
 
static void XBMCAddon::xbmc::InfoTagVideo::setMpaaRaw (CVideoInfoTag *infoTag, const String &mpaa)
 
static void XBMCAddon::xbmc::InfoTagVideo::setPlotRaw (CVideoInfoTag *infoTag, const String &plot)
 
static void XBMCAddon::xbmc::InfoTagVideo::setPlotOutlineRaw (CVideoInfoTag *infoTag, const String &plotOutline)
 
static void XBMCAddon::xbmc::InfoTagVideo::setTitleRaw (CVideoInfoTag *infoTag, const String &title)
 
static void XBMCAddon::xbmc::InfoTagVideo::setOriginalTitleRaw (CVideoInfoTag *infoTag, const String &originalTitle)
 
static void XBMCAddon::xbmc::InfoTagVideo::setSortTitleRaw (CVideoInfoTag *infoTag, const String &sortTitle)
 
static void XBMCAddon::xbmc::InfoTagVideo::setTagLineRaw (CVideoInfoTag *infoTag, const String &tagLine)
 
static void XBMCAddon::xbmc::InfoTagVideo::setTvShowTitleRaw (CVideoInfoTag *infoTag, const String &tvshowTitle)
 
static void XBMCAddon::xbmc::InfoTagVideo::setTvShowStatusRaw (CVideoInfoTag *infoTag, const String &tvshowStatus)
 
static void XBMCAddon::xbmc::InfoTagVideo::setGenresRaw (CVideoInfoTag *infoTag, std::vector< String > genre)
 
static void XBMCAddon::xbmc::InfoTagVideo::setCountriesRaw (CVideoInfoTag *infoTag, std::vector< String > countries)
 
static void XBMCAddon::xbmc::InfoTagVideo::setDirectorsRaw (CVideoInfoTag *infoTag, std::vector< String > directors)
 
static void XBMCAddon::xbmc::InfoTagVideo::setStudiosRaw (CVideoInfoTag *infoTag, std::vector< String > studios)
 
static void XBMCAddon::xbmc::InfoTagVideo::setWritersRaw (CVideoInfoTag *infoTag, std::vector< String > writers)
 
static void XBMCAddon::xbmc::InfoTagVideo::setDurationRaw (CVideoInfoTag *infoTag, int duration)
 
static void XBMCAddon::xbmc::InfoTagVideo::setPremieredRaw (CVideoInfoTag *infoTag, const String &premiered)
 
static void XBMCAddon::xbmc::InfoTagVideo::setSetRaw (CVideoInfoTag *infoTag, const String &set)
 
static void XBMCAddon::xbmc::InfoTagVideo::setSetOverviewRaw (CVideoInfoTag *infoTag, const String &setOverview)
 
static void XBMCAddon::xbmc::InfoTagVideo::setTagsRaw (CVideoInfoTag *infoTag, std::vector< String > tags)
 
static void XBMCAddon::xbmc::InfoTagVideo::setProductionCodeRaw (CVideoInfoTag *infoTag, const String &productionCode)
 
static void XBMCAddon::xbmc::InfoTagVideo::setFirstAiredRaw (CVideoInfoTag *infoTag, const String &firstAired)
 
static void XBMCAddon::xbmc::InfoTagVideo::setLastPlayedRaw (CVideoInfoTag *infoTag, const String &lastPlayed)
 
static void XBMCAddon::xbmc::InfoTagVideo::setAlbumRaw (CVideoInfoTag *infoTag, const String &album)
 
static void XBMCAddon::xbmc::InfoTagVideo::setVotesRaw (CVideoInfoTag *infoTag, int votes)
 
static void XBMCAddon::xbmc::InfoTagVideo::setTrailerRaw (CVideoInfoTag *infoTag, const String &trailer)
 
static void XBMCAddon::xbmc::InfoTagVideo::setPathRaw (CVideoInfoTag *infoTag, const String &path)
 
static void XBMCAddon::xbmc::InfoTagVideo::setFilenameAndPathRaw (CVideoInfoTag *infoTag, const String &filenameAndPath)
 
static void XBMCAddon::xbmc::InfoTagVideo::setIMDBNumberRaw (CVideoInfoTag *infoTag, const String &imdbNumber)
 
static void XBMCAddon::xbmc::InfoTagVideo::setDateAddedRaw (CVideoInfoTag *infoTag, const String &dateAdded)
 
static void XBMCAddon::xbmc::InfoTagVideo::setMediaTypeRaw (CVideoInfoTag *infoTag, const String &mediaType)
 
static void XBMCAddon::xbmc::InfoTagVideo::setShowLinksRaw (CVideoInfoTag *infoTag, std::vector< String > showLinks)
 
static void XBMCAddon::xbmc::InfoTagVideo::setArtistsRaw (CVideoInfoTag *infoTag, std::vector< String > artists)
 
static void XBMCAddon::xbmc::InfoTagVideo::setCastRaw (CVideoInfoTag *infoTag, std::vector< SActorInfo > cast)
 
static void XBMCAddon::xbmc::InfoTagVideo::setResumePointRaw (CVideoInfoTag *infoTag, double time, double totalTime=0.0)
 
static void XBMCAddon::xbmc::InfoTagVideo::addSeasonRaw (CVideoInfoTag *infoTag, int number, std::string name="")
 
static void XBMCAddon::xbmc::InfoTagVideo::addSeasonsRaw (CVideoInfoTag *infoTag, const std::vector< Tuple< int, std::string >> &namedSeasons)
 
static void XBMCAddon::xbmc::InfoTagVideo::addStreamRaw (CVideoInfoTag *infoTag, CStreamDetail *stream)
 
static void XBMCAddon::xbmc::InfoTagVideo::finalizeStreamsRaw (CVideoInfoTag *infoTag)
 
static void XBMCAddon::xbmc::InfoTagVideo::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)
 

Detailed Description

Kodi's video info tag class.

{ xbmc.InfoTagVideo([offscreen]) }

Access and / or modify the video metadata of a ListItem.


Example:

...
tag = xbmc.Player().getVideoInfoTag()
title = tag.getTitle()
file = tag.getFile()
...

Function Documentation

◆ addAudioStream()

void XBMCAddon::xbmc::InfoTagVideo::addAudioStream (   ...)

{ addAudioStream(stream) } Add an audio stream to the video item.

Parameters
streamAudioStreamDetail - Audio stream.

New function added.

◆ addAvailableArtwork()

void XBMCAddon::xbmc::InfoTagVideo::addAvailableArtwork (   ...)

{ addAvailableArtwork(images) } Add an image to available artworks (needed for video scrapers)

Parameters
urlstring - image path url
art_typestring - image type
preview[opt] string - image preview path url
referrer[opt] string - referrer url
cache[opt] string - filename in cache
post[opt] bool - use post to retrieve the image (default false)
isgz[opt] bool - use gzip to retrieve the image (default false)
season[opt] integer - number of season in case of season thumb

New function added.

Example:

...
infotagvideo.addAvailableArtwork(path_to_image_1, "thumb")
...

◆ addAvailableArtworkRaw()

void XBMCAddon::xbmc::InfoTagVideo::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

◆ addSeason()

void XBMCAddon::xbmc::InfoTagVideo::addSeason (   ...)

{ addSeason(number, [name]) } Add a season with name. It needs at least the season number.

Parameters
numberint - the number of the season.
namestring - the name of the season. Default "".

New function added.

Example:

...
# addSeason(number, name))
infotagvideo.addSeason(1, "Murder House")
...

◆ addSeasonRaw()

void XBMCAddon::xbmc::InfoTagVideo::addSeasonRaw ( CVideoInfoTag infoTag,
int  number,
std::string  name = "" 
)
static

◆ addSeasons()

void XBMCAddon::xbmc::InfoTagVideo::addSeasons (   ...)

{ addSeasons(namedSeasons) } Add named seasons to the TV show.

Parameters
namedSeasonslist - [ (season, name) ].

New function added.

◆ addSeasonsRaw()

void XBMCAddon::xbmc::InfoTagVideo::addSeasonsRaw ( CVideoInfoTag infoTag,
const std::vector< Tuple< int, std::string >> &  namedSeasons 
)
static

◆ addStreamRaw()

void XBMCAddon::xbmc::InfoTagVideo::addStreamRaw ( CVideoInfoTag infoTag,
CStreamDetail stream 
)
static

◆ addSubtitleStream()

void XBMCAddon::xbmc::InfoTagVideo::addSubtitleStream (   ...)

{ addSubtitleStream(stream) } Add a subtitle stream to the video item.

Parameters
streamSubtitleStreamDetail - Subtitle stream.

New function added.

◆ addVideoStream()

void XBMCAddon::xbmc::InfoTagVideo::addVideoStream (   ...)

{ addVideoStream(stream) } Add a video stream to the video item.

Parameters
streamVideoStreamDetail - Video stream.

New function added.

◆ finalizeStreamsRaw()

void XBMCAddon::xbmc::InfoTagVideo::finalizeStreamsRaw ( CVideoInfoTag infoTag)
static

◆ getActors()

std::vector< Actor * > XBMCAddon::xbmc::InfoTagVideo::getActors ( )

{ getActors() } Get the cast of the video if available.

Returns
[list] List of actors

New function added.

◆ getAlbum()

String XBMCAddon::xbmc::InfoTagVideo::getAlbum ( )

{ getAlbum() } To get the album name (for musicvideos)

Returns
[string] Album name

New function added.

◆ getArtist()

std::vector< std::string > XBMCAddon::xbmc::InfoTagVideo::getArtist ( )

{ getArtist() } To get the artist name (for musicvideos)

Returns
[std::vector<std::string>] Artist name

New function added.

◆ getCast()

String XBMCAddon::xbmc::InfoTagVideo::getCast ( )

{ getCast() } To get the cast of the video when available.

Returns
[string] Video casts

Deprecated. Use getActors() instead.

◆ getDbId()

int XBMCAddon::xbmc::InfoTagVideo::getDbId ( )

{ getDbId() } Get identification number of tag in database

Returns
[integer] database id

New function added.

◆ getDirector()

String XBMCAddon::xbmc::InfoTagVideo::getDirector ( )

{ getDirector() } Get film director who has made the film (if present).

Returns
[string] Film director name.

Deprecated. Use getDirectors() instead.

◆ getDirectors()

std::vector< String > XBMCAddon::xbmc::InfoTagVideo::getDirectors ( )

{ getDirectors() } Get a list of film directors who have made the film (if present).

Returns
[list] List of film director names.

New function added.

◆ getDuration()

unsigned int XBMCAddon::xbmc::InfoTagVideo::getDuration ( )

{ getDuration() } To get the duration

Returns
[unsigned int] Duration

New function added.

◆ getEpisode()

int XBMCAddon::xbmc::InfoTagVideo::getEpisode ( )

{ getEpisode() } To get episode number of a series

Returns
[integer] episode number

New function added.

◆ getFile()

String XBMCAddon::xbmc::InfoTagVideo::getFile ( )

{ getFile() } To get the video file name.

Returns
[string] File name

◆ getFilenameAndPath()

String XBMCAddon::xbmc::InfoTagVideo::getFilenameAndPath ( )

{ getFilenameAndPath() } To get the full path with filename where the video is stored.

Returns
[string] File name and Path

New function added.

◆ getFirstAired()

String XBMCAddon::xbmc::InfoTagVideo::getFirstAired ( )

{ getFirstAired() } Returns first aired date as string from info tag.

Returns
[string] First aired date

Deprecated. Use getFirstAiredAsW3C() instead.

◆ getFirstAiredAsW3C()

String XBMCAddon::xbmc::InfoTagVideo::getFirstAiredAsW3C ( )

{ getFirstAiredAsW3C() } Get first aired date as string in W3C format (YYYY-MM-DD).

Returns
[string] First aired date (W3C)

New function added.

◆ getGenre()

String XBMCAddon::xbmc::InfoTagVideo::getGenre ( )

{ getGenre() } To get the Video Genre if available.

Returns
[string] Genre name

Deprecated. Use getGenres() instead.

◆ getGenres()

std::vector< String > XBMCAddon::xbmc::InfoTagVideo::getGenres ( )

{ getGenres() } Get the list of Video Genres if available.

Returns
[list] List of genres

New function added.

◆ getIMDBNumber()

String XBMCAddon::xbmc::InfoTagVideo::getIMDBNumber ( )

{ getIMDBNumber() } To get the IMDb number of the video (if present).

Returns
[string] IMDb number

◆ getLastPlayed()

String XBMCAddon::xbmc::InfoTagVideo::getLastPlayed ( )

{ getLastPlayed() } Get the last played date / time as string.

Returns
[string] Last played date / time

Deprecated. Use getLastPlayedAsW3C() instead.

◆ getLastPlayedAsW3C()

String XBMCAddon::xbmc::InfoTagVideo::getLastPlayedAsW3C ( )

{ getLastPlayedAsW3C() } Get last played datetime as string in W3C format (YYYY-MM-DDThh:mm:ssTZD).

Returns
[string] Last played datetime (W3C)

New function added.

◆ getMediaType()

String XBMCAddon::xbmc::InfoTagVideo::getMediaType ( )

{ getMediaType() } Get the media type of the video.

Returns
[string] media type

Available strings about media type for video:

String Description
video For normal video
set For a selection of video
musicvideo To define it as music video
movie To define it as normal movie
tvshow If this is it defined as tvshow
season The type is used as a series season
episode The type is used as a series episode

New function added.

◆ getOriginalTitle()

String XBMCAddon::xbmc::InfoTagVideo::getOriginalTitle ( )

{ getOriginalTitle() } To get the original title of the video.

Returns
[string] Original title

◆ getPath()

String XBMCAddon::xbmc::InfoTagVideo::getPath ( )

{ getPath() } To get the path where the video is stored.

Returns
[string] Path

◆ getPictureURL()

String XBMCAddon::xbmc::InfoTagVideo::getPictureURL ( )

{ getPictureURL() } Get a picture URL of the video to show as screenshot.

Returns
[string] Picture URL

◆ getPlayCount()

int XBMCAddon::xbmc::InfoTagVideo::getPlayCount ( )

{ getPlayCount() } To get the number of plays of the video.

Returns
[integer] Play Count

◆ getPlot()

String XBMCAddon::xbmc::InfoTagVideo::getPlot ( )

{ getPlot() } Get the plot of the video if present.

Returns
[string] Plot

◆ getPlotOutline()

String XBMCAddon::xbmc::InfoTagVideo::getPlotOutline ( )

{ getPlotOutline() } Get the outline plot of the video if present.

Returns
[string] Outline plot

◆ getPremiered()

String XBMCAddon::xbmc::InfoTagVideo::getPremiered ( )

{ getPremiered() } To get premiered date of the video, if available.

Returns
[string]

Deprecated. Use getPremieredAsW3C() instead.

◆ getPremieredAsW3C()

String XBMCAddon::xbmc::InfoTagVideo::getPremieredAsW3C ( )

{ getPremieredAsW3C() } Get premiered date as string in W3C format (YYYY-MM-DD).

Returns
[string] Premiered date (W3C)

New function added.

◆ getRating()

double XBMCAddon::xbmc::InfoTagVideo::getRating ( type  )

{ getRating([type]) } Get the video rating if present as float (double where supported).

Parameters
type[opt] string - the type of the rating.
  • Some rating type values (any string possible):
    Label Type
    imdb string - type name
    tvdb string - type name
    tmdb string - type name
    anidb string - type name
Returns
[float] The rating of the video

Optional type parameter added.

◆ getResumeTime()

double XBMCAddon::xbmc::InfoTagVideo::getResumeTime (   ...)

{ getResumeTime()) } Gets the resume time of the video item.

Returns
[double] Resume time

New function added.

◆ getSeason()

int XBMCAddon::xbmc::InfoTagVideo::getSeason ( )

{ getSeason() } To get season number of a series

Returns
[integer] season number

New function added.

◆ getTagLine()

String XBMCAddon::xbmc::InfoTagVideo::getTagLine ( )

{ getTagLine() } Get video tag line if available.

Returns
[string] Video tag line

◆ getTitle()

String XBMCAddon::xbmc::InfoTagVideo::getTitle ( )

{ getTitle() } Get the video title.

Returns
[string] Video title

◆ getTrack()

int XBMCAddon::xbmc::InfoTagVideo::getTrack ( )

{ getTrack() } To get the track number (for musicvideos)

Returns
[int] Track number

New function added.

◆ getTrailer()

String XBMCAddon::xbmc::InfoTagVideo::getTrailer ( )

{ getTrailer() } To get the path where the trailer is stored.

Returns
[string] Trailer path

New function added.

◆ getTVShowTitle()

String XBMCAddon::xbmc::InfoTagVideo::getTVShowTitle ( )

{ getTVShowTitle() } Get the video TV show title.

Returns
[string] TV show title

New function added.

◆ getUniqueID()

String XBMCAddon::xbmc::InfoTagVideo::getUniqueID ( key  )

{ 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.

Parameters
keystring - uniqueID name.
  • Some default uniqueID values (any string possible):
    Label Type
    imdb string - uniqueid name
    tvdb string - uniqueid name
    tmdb string - uniqueid name
    anidb string - uniqueid name

New function added.

◆ getUserRating()

int XBMCAddon::xbmc::InfoTagVideo::getUserRating ( )

{ getUserRating() } Get the user rating if present as integer.

Returns
[integer] The user rating of the video

◆ getVotes()

String XBMCAddon::xbmc::InfoTagVideo::getVotes ( )

{ getVotes() } Get the video votes if available from video info tag.

Returns
[string] Votes

Deprecated. Use getVotesAsInt() instead.

◆ getVotesAsInt()

int XBMCAddon::xbmc::InfoTagVideo::getVotesAsInt ( type  )

{ getVotesAsInt([type]) } Get the votes of the rating (if available) as an integer.

Parameters
type[opt] string - the type of the rating.
  • Some rating type values (any string possible):
    Label Type
    imdb string - type name
    tvdb string - type name
    tmdb string - type name
    anidb string - type name
Returns
[integer] Votes

New function added.

◆ getWriters()

std::vector< String > XBMCAddon::xbmc::InfoTagVideo::getWriters ( )

{ getWriters() } Get the list of writers (if present) from video info tag.

Returns
[list] List of writers

New function added.

◆ getWritingCredits()

String XBMCAddon::xbmc::InfoTagVideo::getWritingCredits ( )

{ getWritingCredits() } Get the writing credits if present from video info tag.

Returns
[string] Writing credits

Deprecated. Use getWriters() instead.

◆ getYear()

int XBMCAddon::xbmc::InfoTagVideo::getYear ( )

{ getYear() } Get production year of video if present.

Returns
[integer] Production Year

◆ InfoTagVideo() [1/3]

XBMCAddon::xbmc::InfoTagVideo::InfoTagVideo ( const CVideoInfoTag tag)
explicit

◆ InfoTagVideo() [2/3]

XBMCAddon::xbmc::InfoTagVideo::InfoTagVideo ( CVideoInfoTag tag,
bool  offscreen = false 
)
explicit

◆ InfoTagVideo() [3/3]

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

{ xbmc.InfoTagVideo([offscreen]) } Create a video info tag.

Parameters
offscreen[opt] bool (default False) - if GUI based locks should be avoided. Most of the times listitems are created offscreen and added later to a container for display (e.g. plugins) or they are not even displayed (e.g. python scrapers). In such cases, there is no need to lock the GUI when creating the items (increasing your addon performance). Note however, that if you are creating listitems and managing the container itself (e.g using WindowXML or WindowXMLDialog classes) subsquent modifications to the item will require locking. Thus, in such cases, use the default value (False).

Added offscreen argument.

Example:

...
videoinfo = xbmc.InfoTagVideo(offscreen=False)
...

◆ setAlbum()

void XBMCAddon::xbmc::InfoTagVideo::setAlbum (   ...)

{ setAlbum(album) } Set the album of the video item.

Parameters
albumstring - Album.

New function added.

◆ setAlbumRaw()

void XBMCAddon::xbmc::InfoTagVideo::setAlbumRaw ( CVideoInfoTag infoTag,
const String album 
)
static

◆ setArtists()

void XBMCAddon::xbmc::InfoTagVideo::setArtists (   ...)

{ setArtists(artists) } Set the artists of the music video item.

Parameters
artistslist - Artists.

New function added.

◆ setArtistsRaw()

void XBMCAddon::xbmc::InfoTagVideo::setArtistsRaw ( CVideoInfoTag infoTag,
std::vector< String artists 
)
static

◆ setCast()

void XBMCAddon::xbmc::InfoTagVideo::setCast (   ...)

{ setCast(actors) } Set the cast / actors of the video item.

Parameters
actorslist - Cast / Actors.

New function added.

◆ setCastRaw()

void XBMCAddon::xbmc::InfoTagVideo::setCastRaw ( CVideoInfoTag infoTag,
std::vector< SActorInfo cast 
)
static

◆ setCountries()

void XBMCAddon::xbmc::InfoTagVideo::setCountries (   ...)

{ setCountries(countries) } Set the countries of the video item.

Parameters
countrieslist - Countries.

New function added.

◆ setCountriesRaw()

void XBMCAddon::xbmc::InfoTagVideo::setCountriesRaw ( CVideoInfoTag infoTag,
std::vector< String countries 
)
static

◆ setDateAdded()

void XBMCAddon::xbmc::InfoTagVideo::setDateAdded (   ...)

{ setDateAdded(dateAdded) } Set the date added of the video item.

Parameters
dateAddedstring - Date added (YYYY-MM-DD HH:MM:SS).

New function added.

◆ setDateAddedRaw()

void XBMCAddon::xbmc::InfoTagVideo::setDateAddedRaw ( CVideoInfoTag infoTag,
const String dateAdded 
)
static

◆ setDbId()

void XBMCAddon::xbmc::InfoTagVideo::setDbId (   ...)

{ setDbId(dbId) } Set the database identifier of the video item.

Parameters
dbIdinteger - Database identifier.

New function added.

◆ setDbIdRaw()

void XBMCAddon::xbmc::InfoTagVideo::setDbIdRaw ( CVideoInfoTag infoTag,
int  dbId 
)
static

◆ setDirectors()

void XBMCAddon::xbmc::InfoTagVideo::setDirectors (   ...)

{ setDirectors(directors) } Set the directors of the video item.

Parameters
directorslist - Directors.

New function added.

◆ setDirectorsRaw()

void XBMCAddon::xbmc::InfoTagVideo::setDirectorsRaw ( CVideoInfoTag infoTag,
std::vector< String directors 
)
static

◆ setDuration()

void XBMCAddon::xbmc::InfoTagVideo::setDuration (   ...)

{ setDuration(duration) } Set the duration of the video item.

Parameters
durationinteger - Duration in seconds.

New function added.

◆ setDurationRaw()

void XBMCAddon::xbmc::InfoTagVideo::setDurationRaw ( CVideoInfoTag infoTag,
int  duration 
)
static

◆ setEpisode()

void XBMCAddon::xbmc::InfoTagVideo::setEpisode (   ...)

{ setEpisode(episode) } Set the episode number of the episode.

Parameters
episodeinteger - Episode number.

New function added.

◆ setEpisodeGuide()

void XBMCAddon::xbmc::InfoTagVideo::setEpisodeGuide (   ...)

{ setEpisodeGuide(episodeGuide) } Set the episode guide of the video item.

Parameters
episodeGuidestring - Episode guide.

New function added.

◆ setEpisodeGuideRaw()

void XBMCAddon::xbmc::InfoTagVideo::setEpisodeGuideRaw ( CVideoInfoTag infoTag,
const String episodeGuide 
)
static

◆ setEpisodeRaw()

void XBMCAddon::xbmc::InfoTagVideo::setEpisodeRaw ( CVideoInfoTag infoTag,
int  episode 
)
static

◆ setFilenameAndPath()

void XBMCAddon::xbmc::InfoTagVideo::setFilenameAndPath (   ...)

{ setFilenameAndPath(filenameAndPath) } Set the filename and path of the video item.

Parameters
filenameAndPathstring - Filename and path.

New function added.

◆ setFilenameAndPathRaw()

void XBMCAddon::xbmc::InfoTagVideo::setFilenameAndPathRaw ( CVideoInfoTag infoTag,
const String filenameAndPath 
)
static

◆ setFirstAired()

void XBMCAddon::xbmc::InfoTagVideo::setFirstAired (   ...)

{ setFirstAired(firstAired) } Set the first aired date of the video item.

Parameters
firstAiredstring - First aired date.

New function added.

◆ setFirstAiredRaw()

void XBMCAddon::xbmc::InfoTagVideo::setFirstAiredRaw ( CVideoInfoTag infoTag,
const String firstAired 
)
static

◆ setGenres()

void XBMCAddon::xbmc::InfoTagVideo::setGenres (   ...)

{ setGenres(genre) } Set the genres of the video item.

Parameters
genrelist - Genres.

New function added.

◆ setGenresRaw()

void XBMCAddon::xbmc::InfoTagVideo::setGenresRaw ( CVideoInfoTag infoTag,
std::vector< String genre 
)
static

◆ setIMDBNumber()

void XBMCAddon::xbmc::InfoTagVideo::setIMDBNumber (   ...)

{ setIMDBNumber(imdbNumber) } Set the IMDb number of the video item.

Parameters
imdbNumberstring - IMDb number.

New function added.

◆ setIMDBNumberRaw()

void XBMCAddon::xbmc::InfoTagVideo::setIMDBNumberRaw ( CVideoInfoTag infoTag,
const String imdbNumber 
)
static

◆ setLastPlayed()

void XBMCAddon::xbmc::InfoTagVideo::setLastPlayed (   ...)

{ setLastPlayed(lastPlayed) } Set the last played date of the video item.

Parameters
lastPlayedstring - Last played date (YYYY-MM-DD HH:MM:SS).

New function added.

◆ setLastPlayedRaw()

void XBMCAddon::xbmc::InfoTagVideo::setLastPlayedRaw ( CVideoInfoTag infoTag,
const String lastPlayed 
)
static

◆ setMediaType()

void XBMCAddon::xbmc::InfoTagVideo::setMediaType (   ...)

{ setMediaType(mediaType) } Set the media type of the video item.

Parameters
mediaTypestring - Media type.

New function added.

◆ setMediaTypeRaw()

void XBMCAddon::xbmc::InfoTagVideo::setMediaTypeRaw ( CVideoInfoTag infoTag,
const String mediaType 
)
static

◆ setMpaa()

void XBMCAddon::xbmc::InfoTagVideo::setMpaa (   ...)

{ setMpaa(mpaa) } Set the MPAA rating of the video item.

Parameters
mpaastring - MPAA rating.

New function added.

◆ setMpaaRaw()

void XBMCAddon::xbmc::InfoTagVideo::setMpaaRaw ( CVideoInfoTag infoTag,
const String mpaa 
)
static

◆ setOriginalTitle()

void XBMCAddon::xbmc::InfoTagVideo::setOriginalTitle (   ...)

{ setOriginalTitle(originalTitle) } Set the original title of the video item.

Parameters
originalTitlestring - Original title.

New function added.

◆ setOriginalTitleRaw()

void XBMCAddon::xbmc::InfoTagVideo::setOriginalTitleRaw ( CVideoInfoTag infoTag,
const String originalTitle 
)
static

◆ setPath()

void XBMCAddon::xbmc::InfoTagVideo::setPath (   ...)

{ setPath(path) } Set the path of the video item.

Parameters
pathstring - Path.

New function added.

◆ setPathRaw()

void XBMCAddon::xbmc::InfoTagVideo::setPathRaw ( CVideoInfoTag infoTag,
const String path 
)
static

◆ setPlaycount()

void XBMCAddon::xbmc::InfoTagVideo::setPlaycount (   ...)

{ setPlaycount(playcount) } Set the playcount of the video item.

Parameters
playcountinteger - Playcount.

New function added.

◆ setPlaycountRaw()

void XBMCAddon::xbmc::InfoTagVideo::setPlaycountRaw ( CVideoInfoTag infoTag,
int  playcount 
)
static

◆ setPlot()

void XBMCAddon::xbmc::InfoTagVideo::setPlot (   ...)

{ setPlot(plot) } Set the plot of the video item.

Parameters
plotstring - Plot.

New function added.

◆ setPlotOutline()

void XBMCAddon::xbmc::InfoTagVideo::setPlotOutline (   ...)

{ setPlotOutline(plotOutline) } Set the plot outline of the video item.

Parameters
plotOutlinestring - Plot outline.

New function added.

◆ setPlotOutlineRaw()

void XBMCAddon::xbmc::InfoTagVideo::setPlotOutlineRaw ( CVideoInfoTag infoTag,
const String plotOutline 
)
static

◆ setPlotRaw()

void XBMCAddon::xbmc::InfoTagVideo::setPlotRaw ( CVideoInfoTag infoTag,
const String plot 
)
static

◆ setPremiered()

void XBMCAddon::xbmc::InfoTagVideo::setPremiered (   ...)

{ setPremiered(premiered) } Set the premiere date of the video item.

Parameters
premieredstring - Premiere date.

New function added.

◆ setPremieredRaw()

void XBMCAddon::xbmc::InfoTagVideo::setPremieredRaw ( CVideoInfoTag infoTag,
const String premiered 
)
static

◆ setProductionCode()

void XBMCAddon::xbmc::InfoTagVideo::setProductionCode (   ...)

{ setProductionCode(const String& productionCode) } Set the production code of the video item.

Parameters
productionCodestring - Production code.

New function added.

◆ setProductionCodeRaw()

void XBMCAddon::xbmc::InfoTagVideo::setProductionCodeRaw ( CVideoInfoTag infoTag,
const String productionCode 
)
static

◆ setRating()

void XBMCAddon::xbmc::InfoTagVideo::setRating (   ...)

{ setRating(rating, [votes], [type], [isDefault]) } Set the rating of the video item.

Parameters
ratingfloat - Rating number.
votesinteger - Number of votes.
typestring - Type of the rating.
isDefaultbool - Whether the rating is the default or not.

New function added.

◆ setRatingRaw()

void XBMCAddon::xbmc::InfoTagVideo::setRatingRaw ( CVideoInfoTag infoTag,
float  rating,
int  votes = 0,
const std::string &  type = "",
bool  isDefault = false 
)
static

◆ setRatings()

void XBMCAddon::xbmc::InfoTagVideo::setRatings (   ...)

{ setRatings(ratings, [defaultRating]) } Set the ratings of the video item.

Parameters
ratingsdictionary - `{ 'type': (rating, votes) }`.
defaultRatingstring - Type / Label of the default rating.

New function added.

◆ setRatingsRaw()

void XBMCAddon::xbmc::InfoTagVideo::setRatingsRaw ( CVideoInfoTag infoTag,
const std::map< String, Tuple< float, int >> &  ratings,
const String defaultRating = "" 
)
static

◆ setResumePoint()

void XBMCAddon::xbmc::InfoTagVideo::setResumePoint (   ...)

{ setResumePoint(time, [totalTime]) } Set the resume point of the video item.

Parameters
timefloat - Resume point in seconds.
totalTimefloat - Total duration in seconds.

New function added.

◆ setResumePointRaw()

void XBMCAddon::xbmc::InfoTagVideo::setResumePointRaw ( CVideoInfoTag infoTag,
double  time,
double  totalTime = 0.0 
)
static

◆ setSeason()

void XBMCAddon::xbmc::InfoTagVideo::setSeason (   ...)

{ setSeason(season) } Set the season number of the video item.

Parameters
seasoninteger - Season number.

New function added.

◆ setSeasonRaw()

void XBMCAddon::xbmc::InfoTagVideo::setSeasonRaw ( CVideoInfoTag infoTag,
int  season 
)
static

◆ setSet()

void XBMCAddon::xbmc::InfoTagVideo::setSet (   ...)

{ setSet(set) } Set the movie set (name) of the video item.

Parameters
setstring - Movie set (name).

New function added.

◆ setSetId()

void XBMCAddon::xbmc::InfoTagVideo::setSetId (   ...)

{ setSetId(setId) } Set the movie set identifier of the video item.

Parameters
setIdinteger - Set identifier.

New function added.

◆ setSetIdRaw()

void XBMCAddon::xbmc::InfoTagVideo::setSetIdRaw ( CVideoInfoTag infoTag,
int  setId 
)
static

◆ setSetOverview()

void XBMCAddon::xbmc::InfoTagVideo::setSetOverview (   ...)

{ setSetOverview(setOverview) } Set the movie set overview of the video item.

Parameters
setOverviewstring - Movie set overview.

New function added.

◆ setSetOverviewRaw()

void XBMCAddon::xbmc::InfoTagVideo::setSetOverviewRaw ( CVideoInfoTag infoTag,
const String setOverview 
)
static

◆ setSetRaw()

void XBMCAddon::xbmc::InfoTagVideo::setSetRaw ( CVideoInfoTag infoTag,
const String set 
)
static

◆ setShowLinks()

void XBMCAddon::xbmc::InfoTagVideo::setShowLinks (   ...)

{ setShowLinks(showLinks) } Set the TV show links of the movie.

Parameters
showLinkslist - TV show links.

New function added.

◆ setShowLinksRaw()

void XBMCAddon::xbmc::InfoTagVideo::setShowLinksRaw ( CVideoInfoTag infoTag,
std::vector< String showLinks 
)
static

◆ setSortEpisode()

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

{ getResumeTimeTotal()) } Gets the total duration stored with the resume time of the video item.

Returns
[double] Total duration stored with the resume time

New function added.

◆ setSortEpisodeRaw()

void XBMCAddon::xbmc::InfoTagVideo::setSortEpisodeRaw ( CVideoInfoTag infoTag,
int  sortEpisode 
)
static

◆ setSortSeason()

void XBMCAddon::xbmc::InfoTagVideo::setSortSeason (   ...)

{ setSortSeason(sortSeason) } Set the season sort number of the season.

Parameters
sortSeasoninteger - Season sort number.

New function added.

◆ setSortSeasonRaw()

void XBMCAddon::xbmc::InfoTagVideo::setSortSeasonRaw ( CVideoInfoTag infoTag,
int  sortSeason 
)
static

◆ setSortTitle()

void XBMCAddon::xbmc::InfoTagVideo::setSortTitle (   ...)

{ setSortTitle(sortTitle) } Set the sort title of the video item.

Parameters
sortTitlestring - Sort title.

New function added.

◆ setSortTitleRaw()

void XBMCAddon::xbmc::InfoTagVideo::setSortTitleRaw ( CVideoInfoTag infoTag,
const String sortTitle 
)
static

◆ setStudios()

void XBMCAddon::xbmc::InfoTagVideo::setStudios (   ...)

{ setStudios(studios) } Set the studios of the video item.

Parameters
studioslist - Studios.

New function added.

◆ setStudiosRaw()

void XBMCAddon::xbmc::InfoTagVideo::setStudiosRaw ( CVideoInfoTag infoTag,
std::vector< String studios 
)
static

◆ setTagLine()

void XBMCAddon::xbmc::InfoTagVideo::setTagLine (   ...)

{ setTagLine(tagLine) } Set the tagline of the video item.

Parameters
tagLinestring - Tagline.

New function added.

◆ setTagLineRaw()

void XBMCAddon::xbmc::InfoTagVideo::setTagLineRaw ( CVideoInfoTag infoTag,
const String tagLine 
)
static

◆ setTags()

void XBMCAddon::xbmc::InfoTagVideo::setTags (   ...)

{ setTags(tags) } Set the tags of the video item.

Parameters
tagslist - Tags.

New function added.

◆ setTagsRaw()

void XBMCAddon::xbmc::InfoTagVideo::setTagsRaw ( CVideoInfoTag infoTag,
std::vector< String tags 
)
static

◆ setTitle()

void XBMCAddon::xbmc::InfoTagVideo::setTitle (   ...)

{ setTitle(title) } Set the title of the video item.

Parameters
titlestring - Title.

New function added.

◆ setTitleRaw()

void XBMCAddon::xbmc::InfoTagVideo::setTitleRaw ( CVideoInfoTag infoTag,
const String title 
)
static

◆ setTop250()

void XBMCAddon::xbmc::InfoTagVideo::setTop250 (   ...)

{ setTop250(top250) } Set the top 250 number of the video item.

Parameters
top250integer - Top 250 number.

New function added.

◆ setTop250Raw()

void XBMCAddon::xbmc::InfoTagVideo::setTop250Raw ( CVideoInfoTag infoTag,
int  top250 
)
static

◆ setTrackNumber()

void XBMCAddon::xbmc::InfoTagVideo::setTrackNumber (   ...)

{ setTrackNumber(trackNumber) } Set the track number of the music video item.

Parameters
trackNumberinteger - Track number.

New function added.

◆ setTrackNumberRaw()

void XBMCAddon::xbmc::InfoTagVideo::setTrackNumberRaw ( CVideoInfoTag infoTag,
int  trackNumber 
)
static

◆ setTrailer()

void XBMCAddon::xbmc::InfoTagVideo::setTrailer (   ...)

{ setTrailer(trailer) } Set the trailer of the video item.

Parameters
trailerstring - Trailer.

New function added.

◆ setTrailerRaw()

void XBMCAddon::xbmc::InfoTagVideo::setTrailerRaw ( CVideoInfoTag infoTag,
const String trailer 
)
static

◆ setTvShowStatus()

void XBMCAddon::xbmc::InfoTagVideo::setTvShowStatus (   ...)

{ setTvShowStatus(tvshowStatus) } Set the TV show status of the video item.

Parameters
tvshowStatusstring - TV show status.

New function added.

◆ setTvShowStatusRaw()

void XBMCAddon::xbmc::InfoTagVideo::setTvShowStatusRaw ( CVideoInfoTag infoTag,
const String tvshowStatus 
)
static

◆ setTvShowTitle()

void XBMCAddon::xbmc::InfoTagVideo::setTvShowTitle (   ...)

{ setTvShowTitle(tvshowTitle) } Set the TV show title of the video item.

Parameters
tvshowTitlestring - TV show title.

New function added.

◆ setTvShowTitleRaw()

void XBMCAddon::xbmc::InfoTagVideo::setTvShowTitleRaw ( CVideoInfoTag infoTag,
const String tvshowTitle 
)
static

◆ setUniqueID()

void XBMCAddon::xbmc::InfoTagVideo::setUniqueID (   ...)

{ 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.

Parameters
uniqueIDstring - value of the unique ID.
type[opt] string - type / label of the unique ID.
isDefault[opt] bool - whether the given unique ID is the default unique ID.

New function added.

◆ setUniqueIDRaw()

void XBMCAddon::xbmc::InfoTagVideo::setUniqueIDRaw ( CVideoInfoTag infoTag,
const String uniqueID,
const String type = "",
bool  isDefault = false 
)
static

◆ setUniqueIDs()

void XBMCAddon::xbmc::InfoTagVideo::setUniqueIDs (   ...)

{ 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.

Parameters
valuesdictionary - pairs of `{ 'label': 'value' }`.
defaultUniqueID[opt] string - the name of default uniqueID.
  • Some example values (any string possible):
    Label Type
    imdb string - uniqueid name
    tvdb string - uniqueid name
    tmdb string - uniqueid name
    anidb string - uniqueid name

New function added.

◆ setUniqueIDsRaw()

void XBMCAddon::xbmc::InfoTagVideo::setUniqueIDsRaw ( CVideoInfoTag infoTag,
std::map< String, String uniqueIDs,
const String defaultUniqueID = "" 
)
static

◆ setUserRating()

void XBMCAddon::xbmc::InfoTagVideo::setUserRating (   ...)

{ setUserRating(userRating) } Set the user rating of the video item.

Parameters
userRatinginteger - User rating.

New function added.

◆ setUserRatingRaw()

void XBMCAddon::xbmc::InfoTagVideo::setUserRatingRaw ( CVideoInfoTag infoTag,
int  userRating 
)
static

◆ setVotes()

void XBMCAddon::xbmc::InfoTagVideo::setVotes (   ...)

{ setVotes(votes) } Set the number of votes of the video item.

Parameters
votesinteger - Number of votes.

New function added.

◆ setVotesRaw()

void XBMCAddon::xbmc::InfoTagVideo::setVotesRaw ( CVideoInfoTag infoTag,
int  votes 
)
static

◆ setWriters()

void XBMCAddon::xbmc::InfoTagVideo::setWriters (   ...)

{ setWriters(writers) } Set the writers of the video item.

Parameters
writerslist - Writers.

New function added.

◆ setWritersRaw()

void XBMCAddon::xbmc::InfoTagVideo::setWritersRaw ( CVideoInfoTag infoTag,
std::vector< String writers 
)
static

◆ setYear()

void XBMCAddon::xbmc::InfoTagVideo::setYear (   ...)

{ setYear(year) } Set the year of the video item.

Parameters
yearinteger - Year.

New function added.

◆ setYearRaw()

void XBMCAddon::xbmc::InfoTagVideo::setYearRaw ( CVideoInfoTag infoTag,
int  year 
)
static

◆ ToActorInfo()

SActorInfo XBMCAddon::xbmc::Actor::ToActorInfo ( ) const

◆ ToStreamDetailAudio()

CStreamDetailAudio * XBMCAddon::xbmc::AudioStreamDetail::ToStreamDetailAudio ( ) const

◆ ToStreamDetailSubtitle()

CStreamDetailSubtitle * XBMCAddon::xbmc::SubtitleStreamDetail::ToStreamDetailSubtitle ( ) const

◆ ToStreamDetailVideo()

CStreamDetailVideo * XBMCAddon::xbmc::VideoStreamDetail::ToStreamDetailVideo ( ) const

◆ ~InfoTagVideo()

XBMCAddon::xbmc::InfoTagVideo::~InfoTagVideo ( )
override