Kodi Development  19.0
for Binary and Script based Add-Ons
InfoTagVideo

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

◆ getDbId()

getDbId ( )

Function: getDbId()


Get identification number of tag in database

Returns
[integer] database id

v17 Python API changes:
New function added.

◆ getDirector()

getDirector ( )

Function: getDirector()


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

Returns
[string] Film director name.

◆ getWritingCredits()

getWritingCredits ( )

Function: getWritingCredits()


Get the writing credits if present from video info tag.

Returns
[string] Writing credits

◆ getGenre()

getGenre ( )

Function: getGenre()


To get the Video Genre if available.

Returns
[string] Genre name

◆ getTagLine()

getTagLine ( )

Function: getTagLine()


Get video tag line if available.

Returns
[string] Video tag line

◆ getPlotOutline()

getPlotOutline ( )

Function: getPlotOutline()


Get the outline plot of the video if present.

Returns
[string] Outline plot

◆ getPlot()

getPlot ( )

Function: getPlot()


Get the plot of the video if present.

Returns
[string] Plot

◆ getPictureURL()

getPictureURL ( )

Function: getPictureURL()


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

Returns
[string] Picture URL

◆ getTitle()

getTitle ( )

Function: getTitle()


Get the video title.

Returns
[string] Video title

◆ getTVShowTitle()

getTVShowTitle ( )

Function: getTVShowTitle()


Get the video TV show title.

Returns
[string] TV show title

v17 Python API changes:
New function added.

◆ getMediaType()

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.

◆ getVotes()

getVotes ( )

Function: getVotes()


Get the video votes if available from video info tag.

Returns
[string] Votes

◆ getCast()

getCast ( )

Function: getCast()


To get the cast of the video when available.

Returns
[string] Video casts

◆ getFile()

getFile ( )

Function: getFile()


To get the video file name.

Returns
[string] File name

◆ getPath()

getPath ( )

Function: getPath()


To get the path where the video is stored.

Returns
[string] Path

◆ getFilenameAndPath()

getFilenameAndPath ( )

Function: getFilenameAndPath()


To get the full path with filename where the video is stored.

Returns
[string] File name and Path

v19 Python API changes:
New function added.

◆ getIMDBNumber()

getIMDBNumber ( )

Function: getIMDBNumber()


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

Returns
[string] IMDb number

◆ getSeason()

getSeason ( )

Function: getSeason()


To get season number of a series

Returns
[integer] season number

v17 Python API changes:
New function added.

◆ getEpisode()

getEpisode ( )

Function: getEpisode()


To get episode number of a series

Returns
[integer] episode number

v17 Python API changes:
New function added.

◆ getYear()

getYear ( )

Function: getYear()


Get production year of video if present.

Returns
[integer] Production Year

◆ getRating()

getRating ( )

Function: getRating()


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

Returns
[float] The rating of the video

◆ getUserRating()

getUserRating ( )

Function: getUserRating()


Get the user rating if present as integer.

Returns
[integer] The user rating of the video

◆ getPlayCount()

getPlayCount ( )

Function: getPlayCount()


To get the number of plays of the video.

Returns
[integer] Play Count

◆ getLastPlayed()

getLastPlayed ( )

Function: getLastPlayed()


Get the last played date / time as string.

Returns
[string] Last played date / time

◆ getOriginalTitle()

getOriginalTitle ( )

Function: getOriginalTitle()


To get the original title of the video.

Returns
[string] Original title

◆ getPremiered()

getPremiered ( )

Function: getPremiered()


To get premiered date of the video, if available.

Returns
[string]

◆ getFirstAired()

getFirstAired ( )

Function: getFirstAired()


Returns first aired date as string from info tag.

Returns
[string] First aired date

◆ getTrailer()

getTrailer ( )

Function: getTrailer()


To get the path where the trailer is stored.

Returns
[string] Trailer path

v17 Python API changes:
New function added.

◆ getArtist()

getArtist ( )

Function: getArtist()


To get the artist name (for musicvideos)

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

v18 Python API changes:
New function added.

◆ getAlbum()

getAlbum ( )

Function: getAlbum()


To get the album name (for musicvideos)

Returns
[string] Album name

v18 Python API changes:
New function added.

◆ getTrack()

getTrack ( )

Function: getTrack()


To get the track number (for musicvideos)

Returns
[int] Track number

v18 Python API changes:
New function added.

◆ getDuration()

getDuration ( )

Function: getDuration()


To get the duration

Returns
[unsigned int] Duration

v18 Python API changes:
New function added.