InfoTagVideo

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

Classes
class	XBMCAddon::xbmc::InfoTagVideo

Functions
	XBMCAddon::xbmc::InfoTagVideo::InfoTagVideo (const CVideoInfoTag &tag)
	XBMCAddon::xbmc::InfoTagVideo::InfoTagVideo ()
	XBMCAddon::xbmc::InfoTagVideo::~InfoTagVideo () override
	XBMCAddon::xbmc::InfoTagVideo::getDbId ()
	Function: getDbId() Get identification number of tag in database More...
	XBMCAddon::xbmc::InfoTagVideo::getDirector ()
	Function: getDirector() Get film director who has made the film (if present). More...
	XBMCAddon::xbmc::InfoTagVideo::getWritingCredits ()
	Function: getWritingCredits() Get the writing credits if present from video info tag. More...
	XBMCAddon::xbmc::InfoTagVideo::getGenre ()
	Function: getGenre() To get the Video Genre if available. More...
	XBMCAddon::xbmc::InfoTagVideo::getTagLine ()
	Function: getTagLine() Get video tag line if available. More...
	XBMCAddon::xbmc::InfoTagVideo::getPlotOutline ()
	Function: getPlotOutline() Get the outline plot of the video if present. More...
	XBMCAddon::xbmc::InfoTagVideo::getPlot ()
	Function: getPlot() Get the plot of the video if present. More...
	XBMCAddon::xbmc::InfoTagVideo::getPictureURL ()
	Function: getPictureURL() Get a picture URL of the video to show as screenshot. More...
	XBMCAddon::xbmc::InfoTagVideo::getTitle ()
	Function: getTitle() Get the video title. More...
	XBMCAddon::xbmc::InfoTagVideo::getTVShowTitle ()
	Function: getTVShowTitle() Get the video TV show title. More...
	XBMCAddon::xbmc::InfoTagVideo::getMediaType ()
	Function: getMediaType() Get the media type of the video. More...
	XBMCAddon::xbmc::InfoTagVideo::getVotes ()
	Function: getVotes() Get the video votes if available from video info tag. More...
	XBMCAddon::xbmc::InfoTagVideo::getCast ()
	Function: getCast() To get the cast of the video when available. More...
	XBMCAddon::xbmc::InfoTagVideo::getFile ()
	Function: getFile() To get the video file name. More...
	XBMCAddon::xbmc::InfoTagVideo::getPath ()
	Function: getPath() To get the path where the video is stored. More...
	XBMCAddon::xbmc::InfoTagVideo::getIMDBNumber ()
	Function: getIMDBNumber() To get the IMDb number of the video (if present). More...
	XBMCAddon::xbmc::InfoTagVideo::getSeason ()
	Function: getSeason() To get season number of a series More...
	XBMCAddon::xbmc::InfoTagVideo::getEpisode ()
	Function: getEpisode() To get episode number of a series More...
	XBMCAddon::xbmc::InfoTagVideo::getYear ()
	Function: getYear() Get production year of video if present. More...
	XBMCAddon::xbmc::InfoTagVideo::getRating ()
	Function: getRating() Get the video rating if present as float (double where supported). More...
	XBMCAddon::xbmc::InfoTagVideo::getUserRating ()
	Function: getUserRating() Get the user rating if present as integer. More...
	XBMCAddon::xbmc::InfoTagVideo::getPlayCount ()
	Function: getPlayCount() To get the number of plays of the video. More...
	XBMCAddon::xbmc::InfoTagVideo::getLastPlayed ()
	Function: getLastPlayed() Get the last played date / time as string. More...
	XBMCAddon::xbmc::InfoTagVideo::getOriginalTitle ()
	Function: getOriginalTitle() To get the original title of the video. More...
	XBMCAddon::xbmc::InfoTagVideo::getPremiered ()
	Function: getPremiered() To get premiered date of the video, if available. More...
	XBMCAddon::xbmc::InfoTagVideo::getFirstAired ()
	Function: getFirstAired() Returns first aired date as string from info tag. More...
	XBMCAddon::xbmc::InfoTagVideo::getTrailer ()
	Function: getTrailer() To get the path where the trailer is stored. More...
	XBMCAddon::xbmc::InfoTagVideo::getArtist ()
	Function: getArtist() To get the artist name (for musicvideos) More...
	XBMCAddon::xbmc::InfoTagVideo::getAlbum ()
	Function: getAlbum() To get the album name (for musicvideos) More...
	XBMCAddon::xbmc::InfoTagVideo::getTrack ()
	Function: getTrack() To get the track number (for musicvideos) More...
	XBMCAddon::xbmc::InfoTagVideo::getDuration ()
	Function: getDuration() To get the duration More...

Detailed Description

Kodi's video info tag class.

Class: InfoTagVideo()

To get video info tag data of currently played source.

Note

Info tag load is only be possible from present player class.

---

Example:

...
tag = xbmc.Player().getVideoInfoTag()

title = tag.getTitle()
file  = tag.getFile()
...

Function Documentation

getAlbum()

String XBMCAddon::xbmc::InfoTagVideo::getAlbum

(

)

Function: getAlbum()

---

To get the album name (for musicvideos)

Returns

[string] Album name

---

v18 Python API changes:

New function added.

getArtist()

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

(

)

Function: getArtist()

---

To get the artist name (for musicvideos)

Returns

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

---

v18 Python API changes:

New function added.

getCast()

String XBMCAddon::xbmc::InfoTagVideo::getCast

(

)

Function: getCast()

---

To get the cast of the video when available.

Returns

[string] Video casts

---

getDbId()

int XBMCAddon::xbmc::InfoTagVideo::getDbId

(

)

Function: getDbId()

---

Get identification number of tag in database

Returns

[integer] database id

---

v17 Python API changes:

New function added.

getDirector()

String XBMCAddon::xbmc::InfoTagVideo::getDirector

(

)

Function: getDirector()

---

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

Returns

[string] Film director name.

---

getDuration()

unsigned int XBMCAddon::xbmc::InfoTagVideo::getDuration

(

)

Function: getDuration()

---

To get the duration

Returns

[unsigned int] Duration

---

v18 Python API changes:

New function added.

getEpisode()

int XBMCAddon::xbmc::InfoTagVideo::getEpisode

(

)

Function: getEpisode()

---

To get episode number of a series

Returns

[integer] episode number

---

v17 Python API changes:

New function added.

getFile()

String XBMCAddon::xbmc::InfoTagVideo::getFile

(

)

Function: getFile()

---

To get the video file name.

Returns

[string] File name

---

getFirstAired()

String XBMCAddon::xbmc::InfoTagVideo::getFirstAired

(

)

Function: getFirstAired()

---

Returns first aired date as string from info tag.

Returns

[string] First aired date

---

getGenre()

String XBMCAddon::xbmc::InfoTagVideo::getGenre

(

)

Function: getGenre()

---

To get the Video Genre if available.

Returns

[string] Genre name

---

getIMDBNumber()

String XBMCAddon::xbmc::InfoTagVideo::getIMDBNumber

(

)

Function: getIMDBNumber()

---

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

Returns

[string] IMDb number

---

getLastPlayed()

String XBMCAddon::xbmc::InfoTagVideo::getLastPlayed

(

)

Function: getLastPlayed()

---

Get the last played date / time as string.

Returns

[string] Last played date / time

---

getMediaType()

String XBMCAddon::xbmc::InfoTagVideo::getMediaType

(

)

Function: 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

---

v17 Python API changes:

New function added.

getOriginalTitle()

String XBMCAddon::xbmc::InfoTagVideo::getOriginalTitle

(

)

Function: getOriginalTitle()

---

To get the original title of the video.

Returns

[string] Original title

---

getPath()

String XBMCAddon::xbmc::InfoTagVideo::getPath

(

)

Function: getPath()

---

To get the path where the video is stored.

Returns

[string] Path

---

getPictureURL()

String XBMCAddon::xbmc::InfoTagVideo::getPictureURL

(

)

Function: getPictureURL()

---

Get a picture URL of the video to show as screenshot.

Returns

[string] Picture URL

---

getPlayCount()

int XBMCAddon::xbmc::InfoTagVideo::getPlayCount

(

)

Function: getPlayCount()

---

To get the number of plays of the video.

Returns

[integer] Play Count

---

getPlot()

String XBMCAddon::xbmc::InfoTagVideo::getPlot

(

)

Function: getPlot()

---

Get the plot of the video if present.

Returns

[string] Plot

---

getPlotOutline()

String XBMCAddon::xbmc::InfoTagVideo::getPlotOutline

(

)

Function: getPlotOutline()

---

Get the outline plot of the video if present.

Returns

[string] Outline plot

---

getPremiered()

String XBMCAddon::xbmc::InfoTagVideo::getPremiered

(

)

Function: getPremiered()

---

To get premiered date of the video, if available.

Returns

[string]

---

getRating()

double XBMCAddon::xbmc::InfoTagVideo::getRating

(

)

Function: getRating()

---

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

Returns

[float] The rating of the video

---

getSeason()

int XBMCAddon::xbmc::InfoTagVideo::getSeason

(

)

Function: getSeason()

---

To get season number of a series

Returns

[integer] season number

---

v17 Python API changes:

New function added.

getTagLine()

String XBMCAddon::xbmc::InfoTagVideo::getTagLine

(

)

Function: getTagLine()

---

Get video tag line if available.

Returns

[string] Video tag line

---

getTitle()

String XBMCAddon::xbmc::InfoTagVideo::getTitle

(

)

Function: getTitle()

---

Get the video title.

Returns

[string] Video title

---

getTrack()

int XBMCAddon::xbmc::InfoTagVideo::getTrack

(

)

Function: getTrack()

---

To get the track number (for musicvideos)

Returns

[int] Track number

---

v18 Python API changes:

New function added.

getTrailer()

String XBMCAddon::xbmc::InfoTagVideo::getTrailer

(

)

Function: getTrailer()

---

To get the path where the trailer is stored.

Returns

[string] Trailer path

---

v17 Python API changes:

New function added.

getTVShowTitle()

String XBMCAddon::xbmc::InfoTagVideo::getTVShowTitle

(

)

Function: getTVShowTitle()

---

Get the video TV show title.

Returns

[string] TV show title

---

v17 Python API changes:

New function added.

getUserRating()

int XBMCAddon::xbmc::InfoTagVideo::getUserRating

(

)

Function: getUserRating()

---

Get the user rating if present as integer.

Returns

[integer] The user rating of the video

---

getVotes()

String XBMCAddon::xbmc::InfoTagVideo::getVotes

(

)

Function: getVotes()

---

Get the video votes if available from video info tag.

Returns

[string] Votes

---

getWritingCredits()

String XBMCAddon::xbmc::InfoTagVideo::getWritingCredits

(

)

Function: getWritingCredits()

---

Get the writing credits if present from video info tag.

Returns

[string] Writing credits

---

getYear()

int XBMCAddon::xbmc::InfoTagVideo::getYear

(

)

Function: getYear()

---

Get production year of video if present.

Returns

[integer] Production Year

---

InfoTagVideo() [1/2]

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

explicit

InfoTagVideo() [2/2]

XBMCAddon::xbmc::InfoTagVideo::InfoTagVideo

(

)

~InfoTagVideo()

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

override