Kodi Development  17.0
for Binary and Script based Add-Ons
List of GUI access messages

Description

Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with xbmc.getCondVisibility(condition).

Skins can use infolabels with $INFO[infolabel] or the <info> tag. Scripts can read infolabels with xbmc.getInfoLabel('infolabel').

Player

LabelsTypeDescription
Player.HasAudio booleanReturns true if the player has an audio file.
Player.HasMedia booleanReturns true if the player has an audio or video file.
Player.HasVideo booleanReturns true if the player has a video file.
Player.Paused booleanReturns true if the player is paused.
Player.Playing booleanReturns true if the player is currently playing (ie not ffwding, rewinding or paused.)
Player.Rewinding booleanReturns true if the player is rewinding.
Player.Rewinding2x booleanReturns true if the player is rewinding at 2x.
Player.Rewinding4x booleanReturns true if the player is rewinding at 4x.
Player.Rewinding8x booleanReturns true if the player is rewinding at 8x.
Player.Rewinding16x booleanReturns true if the player is rewinding at 16x.
Player.Rewinding32x booleanReturns true if the player is rewinding at 32x.
Player.Forwarding booleanReturns true if the player is fast forwarding.
Player.Forwarding2x booleanReturns true if the player is fast forwarding at 2x.
Player.Forwarding4x booleanReturns true if the player is fast forwarding at 4x.
Player.Forwarding8x booleanReturns true if the player is fast forwarding at 8x.
Player.Forwarding16x booleanReturns true if the player is fast forwarding at 16x.
Player.Forwarding32x booleanReturns true if the player is fast forwarding at 32x.
Player.CanRecord booleanReturns true if the player can record the current internet stream.
Player.Recording booleanReturns true if the player is recording the current internet stream.
Player.Caching booleanReturns true if the player is current re-caching data (internet based video playback).
Player.DisplayAfterSeek booleanReturns true for the first 2.5 seconds after a seek.
Player.Seekbar integerReturns amount of percent of one seek to other position
Player.Seeking booleanReturns true if a seek is in progress
Player.ShowTime booleanReturns true if the user has requested the time to show (occurs in video fullscreen)
Player.ShowInfo booleanReturns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
Player.ShowCodec booleanReturns true if the user has requested the codec to show (occurs in visualisation and video fullscreen)
Player.Title booleanReturns the musicplayer title for audio and the videoplayer title for videos.
Player.Muted booleanReturns true if the volume is muted.
Player.HasDuration booleanReturns true if Media isn't a true stream
Player.Passthrough booleanReturns true if the player is using audio passthrough.
Player.CacheLevel stringGet the used cache level as string with an integer number
Player.Progress integerReturns the progress position as percent
Player.ProgressCache booleanShows how much of the file is cached above current play percentage
Player.Volume stringReturns the current player volume with the format %2.1f dB
Player.SubtitleDelay stringReturn the used subtitle delay with the format %2.3f s
Player.AudioDelay stringReturn the used audio delay with the format %2.3f s
Player.Chapter integerCurrent chapter of current playing media
Player.ChapterCount integerTotal number of chapters of current playing media
Player.ChapterName stringReturn the name of currently used chapter if available
Player.Folderpath pathShows the full path of the currently playing song or movie
Player.FilenameAndPath booleanShows the full path with filename of the currently playing song or movie
Player.Filename pathReturns the filename of the currently playing media.
Player.IsInternetStream booleanReturns true if the player is playing an internet stream.
Player.PauseEnabled booleanReturns true if played stream is paused
Player.SeekEnabled booleanReturns true if seek on playing is enabled
Player.ChannelPreviewActive booleanReturns true if pvr channel preview is active (used channel tag different from played tag)
Player.Art(fanart) stringFanart Image of the currently playing episode's parent TV show
Player.Art(thumb) stringReturns the thumbnail image of the currently playing item.
Player.Art(poster) stringReturns the poster of the currently playing movie.
Player.Art(tvshow.poster) stringReturns the tv show poster of the currently playing episode's parent TV show.
Player.Art(tvshow.banner) stringReturns the tv show banner of the currently playing episode's parent TV show.
Player.SeekTime stringTime to which the user is seeking
Player.SeekOffset stringIndicates the seek offset after a seek press (eg user presses BigStepForward, player.seekoffset returns +10:00)
Player.SeekOffset(format) stringShows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.SeekStepSize stringDisplays the seek step size. (v15 addition)
Player.TimeRemaining stringRemaining time of current playing media
Player.TimeRemaining(format) stringShows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.TimeSpeed stringBoth the time and the playspeed formatted up. eg 1:23 (2x)
Player.Time stringElapsed time of current playing media
Player.Time(format) stringShows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.Duration stringTotal duration of the current playing media
Player.Duration(format) stringShows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.FinishTime stringTime playing media will end
Player.FinishTime(format) stringShows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.StartTime stringTime playing media began
Player.StartTime(format) stringShows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.SeekNumeric stringTime to which the user is seeking via numeric keys.
Player.SeekNumeric(format) stringShows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).

Weather

LabelsTypeDescription
Weather.IsFetched booleanReturns true if the weather data has been downloaded.
Weather.Conditions stringCurrent weather conditions – this is looked up in a background process.
Weather.Temperature stringCurrent weather temperature
Weather.Location stringCity/town which the above two items are for
Weather.fanartcode stringCurrent weather fanartcode.
Weather.plugin stringCurrent weather plugin.

System

LabelsTypeDescription
System.AlarmLessOrEqual(alarmname,seconds) booleanReturns true if the alarm with alarmname has less or equal to seconds left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left.
System.HasNetwork booleanReturns true if the ethernet cable is plugged in.
System.HasMediadvd booleanReturns true if there is a CD or DVD in the DVD-ROM drive.
System.DVDReady booleanReturns true if disc is ready to use.
System.TrayOpen booleanReturns true if discs tray is open
System.HasLocks booleanTodo
System.IsMaster booleanTodo
System.ShowExitButton booleanTodo
System.DPMSActive booleanTodo
System.IdleTime(time) booleanReturns true if Kodi has had no input for ?time? amount of seconds.
System.IsStandalone booleanReturns true if Kodi is running in standalone mode.
System.IsFullscreen booleanReturns true if Kodi is running fullscreen.
System.LoggedOn booleanReturns true if a user is currently logged on under a profile
System.HasLoginScreen booleanReturns true if the profile login screen is enabled
System.HasPVR booleanReturns true if PVR is supported from Kodi
Note
normally always true
System.HasPVRAddon(id) booleanReturns true if at least one pvr client addon is installed and enabled.
System.HasADSP booleanReturns true if ADSP is supported from Kodi
Note
normally always true
System.HasCMS booleanReturns true if colour management is supported from Kodi
Note
currently only supported for OpenGL
System.HasModalDialog booleanReturns true true if a modal dialog is visible
System.Time(startTime,endTime) booleanReturns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock.
System.Date(startDate,endDate) booleanReturns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
System.Platform.Linux booleanReturns true if Kodi is running on a linux/unix based computer.
System.Platform.Linux.RaspberryPi booleanReturns true if Kodi is running on a Raspberry Pi.
System.Platform.Windows booleanReturns true if Kodi is running on a windows based computer.
System.Platform.OSX booleanReturns true if Kodi is running on an OSX based computer.
System.Platform.IOS booleanReturns true if Kodi is running on an IOS device.
System.Platform.Darwin booleanReturns true if Kodi is running on an OSX or IOS system.
System.Platform.ATV2 booleanReturns true if Kodi is running on an atv2.
System.Platform.Android booleanReturns true if Kodi is running on an android device.
System.CanPowerDown booleanReturns true if Kodi can powerdown the system.
System.CanSuspend booleanReturns true if Kodi can suspend the system.
System.CanHibernate booleanReturns true if Kodi can hibernate the system.
System.HasHiddenInput booleanReturn true when to osd keyboard/numeric dialog requests a password/pincode.
System.CanReboot booleanReturns true if Kodi can reboot the system.
System.ScreenSaverActive booleanReturns true if ScreenSaver is active.
System.IsInhibit booleanReturns true when shutdown on idle is disabled.
System.HasShutdown booleanReturns true when shutdown on idle is enabled.
System.Time stringCurrent time
System.Time(format) stringShows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
System.Date stringCurrent date
System.Date(format) stringShow current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January - December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
System.AlarmPos stringShutdown Timer position
System.BatteryLevel stringReturns the remaining battery level in range 0-100
System.FreeSpace stringTotal Freespace on the drive
System.UsedSpace stringTotal Usedspace on the drive
System.TotalSpace stringTotalspace on the drive
System.UsedSpacePercent stringTotal Usedspace Percent on the drive
System.FreeSpacePercent stringTotal Freespace Percent on the drive
System.CPUTemperature stringCurrent CPU temperature
System.CpuUsage stringDisplays the cpu usage for each individual cpu core.
System.GPUTemperature stringCurrent GPU temperature
System.FanSpeed stringCurrent fan speed
System.BuildVersion stringVersion of build
System.BuildVersionShort stringShorter string with version of build
System.BuildDate stringDate of build
System.FriendlyName stringReturns the Kodi instance name. It will auto append (hostname%) in case the device name was not changed. eg. "Kodi (htpc)"
System.FPS stringCurrent rendering speed (frames per second)
System.FreeMemory stringAmount of free memory in Mb
System.ScreenMode stringScreenmode (eg windowed / fullscreen)
System.ScreenWidth stringWidth of screen in pixels
System.ScreenHeight stringHeight of screen in pixels
System.StartupWindow stringThe Window Kodi will load on startup
System.CurrentWindow stringCurrent Window we are in
System.CurrentControl stringCurrent focused control
System.CurrentControlId stringTodo
System.DVDLabel stringLabel of the disk in the DVD-ROM drive
System.KernelVersion stringSystem kernel version
System.OSVersionInfo stringTodo
System.Uptime stringSystem current uptime
System.TotalUptime stringSystem total uptime
System.CpuFrequency stringSystem cpu frequency
System.ScreenResolution stringScreen resolution
System.VideoEncoderInfo stringVideo encoder info
System.InternetState stringWill return the internet state, connected or not connected and for Conditional use: Connected->TRUE, not Connected->FALSE, do not use to check status in a pythonscript since it is threaded.
System.Language stringShows the current language
System.ProfileName stringShows the User name of the currently logged in Kodi user
System.ProfileThumb stringTodo
System.ProfileCount stringShows the number of defined profiles
System.ProfileAutoLogin stringThe profile Kodi will auto login to
System.StereoscopicMode stringThe prefered stereoscopic mode (settings > video > playback)
System.TemperatureUnits stringShows Celsius or Fahrenheit symbol
System.Progressbar stringTodo
System.GetBool(boolean) stringReturns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
System.AddonTitle(id) stringReturns the title of the addon with the given id
System.AddonVersion(id) stringReturns the version of the addon with the given id
System.PrivacyPolicy stringReturns the official Kodi privacy policy
System.HasAddon(id) booleanReturns true if the specified addon is installed on the system.
System.HasCoreId(id) booleanTodo
System.HasAlarm(alarm) booleanReturns true if the system has the ?alarm? alarm set.
System.CoreUsage(id) stringDisplays the usage of the cpu core with the given 'id'
System.Setting(hidewatched) booleanReturns true if 'hide watched items' is selected.

Network

LabelsTypeDescription
Network.IsDHCP booleanNetwork type is DHCP or FIXED
Network.IPAddress stringThe system's IP Address (formatted as IP: <ipaddress>)
Network.LinkState stringNetwork linkstate e.g. 10mbit/100mbit etc.
Network.MacAddress stringThe system's mac address
Network.SubnetMask stringNetwork subnet mask
Network.GatewayAddress stringNetwork gateway address
Network.DNS1Address stringNetwork dns 1 address
Network.DNS2Address stringNetwork dns 2 address
Network.DHCPAddress stringDHCP ip address

Music party mode

LabelsTypeDescription
MusicPartyMode.Enabled booleanReturns true if Party Mode is enabled
MusicPartyMode.SongsPlayed stringNumber of songs played during Party Mode
MusicPartyMode.MatchingSongs stringNumber of songs available to Party Mode
MusicPartyMode.MatchingSongsPicked stringNumber of songs picked already for Party Mode
MusicPartyMode.MatchingSongsLeft stringNumber of songs left to be picked from for Party Mode
MusicPartyMode.RelaxedSongsPicked stringNot currently used
MusicPartyMode.RandomSongsPicked stringNumber of unique random songs picked during Party Mode

Music player

LabelsTypeDescription
MusicPlayer.Offset(number).Exists booleanReturns true if the music players playlist has a song queued in position (number).
MusicPlayer.Title stringTitle of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
MusicPlayer.Album stringAlbum from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
MusicPlayer.Property(Album_Mood) stringShows the moods of the currently playing Album
MusicPlayer.Property(Album_Style) stringShows the styles of the currently playing Album
MusicPlayer.Property(Album_Theme) stringShows the themes of the currently playing Album
MusicPlayer.Property(Album_Type) stringShows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
MusicPlayer.Property(Album_Label) stringShows the record label of the currently playing Album
MusicPlayer.Property(Album_Description) stringShows a review of the currently playing Album
MusicPlayer.Artist stringArtist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
MusicPlayer.AlbumArtist stringTodo
MusicPlayer.Cover stringTodo
MusicPlayer.Property(Artist_Born) stringDate of Birth of the currently playing Artist
MusicPlayer.Property(Artist_Died) stringDate of Death of the currently playing Artist
MusicPlayer.Property(Artist_Formed) stringFormation date of the currently playing Artist/Band
MusicPlayer.Property(Artist_Disbanded) stringDisbanding date of the currently playing Artist/Band
MusicPlayer.Property(Artist_YearsActive) stringYears the currently Playing artist has been active
MusicPlayer.Property(Artist_Instrument) stringInstruments played by the currently playing artist
MusicPlayer.Property(Artist_Description) stringShows a biography of the currently playing artist
MusicPlayer.Property(Artist_Mood) stringShows the moods of the currently playing artist
MusicPlayer.Property(Artist_Style) stringShows the styles of the currently playing artist
MusicPlayer.Property(Artist_Genre) stringShows the genre of the currently playing artist
MusicPlayer.Genre stringGenre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
MusicPlayer.Lyrics stringLyrics of current song stored in ID tag info
MusicPlayer.Year stringYear of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
MusicPlayer.Rating stringNumeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
MusicPlayer.RatingAndVotes stringTodo
MusicPlayer.UserRating stringTodo
MusicPlayer.Votes stringTodo
MusicPlayer.DiscNumber stringDisc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
MusicPlayer.Comment stringComment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
MusicPlayer.Mood stringTodo
MusicPlayer.PlaylistPlaying booleanTodo
MusicPlayer.Exists booleanTodo
MusicPlayer.HasPrevious booleanReturns true if the music player has a a Previous Song in the Playlist .
MusicPlayer.HasNext booleanReturns true if the music player has a next song queued in the Playlist.
MusicPlayer.PlayCount integerTodo
MusicPlayer.LastPlayed stringTodo
MusicPlayer.TrackNumber stringTrack number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
MusicPlayer.Duration stringDuration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
MusicPlayer.BitRate stringBitrate of current song
MusicPlayer.Channels stringNumber of channels of current song
MusicPlayer.BitsPerSample stringNumber of bits per sample of current song
MusicPlayer.SampleRate stringSamplerate of current song
MusicPlayer.Codec stringCodec of current song
MusicPlayer.PlaylistPosition stringPosition of the current song in the current music playlist
MusicPlayer.PlaylistLength stringTotal size of the current music playlist
MusicPlayer.ChannelNameg stringChannel name of the radio programme that's currently playing (PVR).
MusicPlayer.ChannelNumber stringChannel number of the radio programme that's currently playing (PVR).
MusicPlayer.SubChannelNumber stringSubchannel number of the radio channel that's currently playing (PVR).
MusicPlayer.ChannelNumberLabel stringChannel and subchannel number of the radio channel that's currently playing (PVR).
MusicPlayer.ChannelGroup stringChannel group of of the radio programme that's currently playing (PVR).

Video player

LabelsTypeDescription
VideoPlayer.UsingOverlays booleanReturns true if the video player is using the hardware overlays render method. Useful, as with hardware overlays you have no alpha blending to the video image, so shadows etc. need redoing, or disabling.
VideoPlayer.IsFullscreen booleanReturns true if the video player is in fullscreen mode.
VideoPlayer.HasMenu booleanReturns true if the video player has a menu (ie is playing a DVD)
VideoPlayer.HasInfo booleanReturns true if the current playing video has information from the library or from a plugin (eg director/plot etc.)
VideoPlayer.Content(parameter) booleanReturns true if the current Video you are playing is contained in corresponding Video Library sections.
The following values are accepted :
  • files
  • movies
  • episodes
  • musicvideos
  • livetv
VideoPlayer.HasSubtitles booleanReturns true if there are subtitles available for video.
VideoPlayer.HasTeletext booleanReturns true if teletext is usable on played TV channel
VideoPlayer.IsStereoscopic booleanReturns true when the currently playing video is a 3D (stereoscopic) video
VideoPlayer.SubtitlesEnabled booleanReturns true if subtitles are turned on for video.
VideoPlayer.HasEpg booleanReturns true if epg information is available for the currently playing programme (PVR).
VideoPlayer.CanResumeLiveTV booleanReturns true if a in-progress PVR recording is playing an the respective live TV channel is available
VideoPlayer.Title stringTitle of currently playing video. If it's in the database it will return the database title, else the filename
VideoPlayer.OriginalTitle stringTodo
VideoPlayer.TVShowTitle stringTitle of currently playing episode's tvshow name
VideoPlayer.Season stringSeason number of the currently playing episode, if it's in the database
VideoPlayer.Episode stringEpisode number of the currently playing episode
VideoPlayer.Genre stringGenre(s) of current movie, if it's in the database
VideoPlayer.Director stringDirector of current movie, if it's in the database
VideoPlayer.Country stringProduction country of current movie, if it's in the database
VideoPlayer.Year stringYear of release of current movie, if it's in the database
VideoPlayer.Cover stringTodo
VideoPlayer.Rating stringIMDb user rating of current movie, if it's in the database
VideoPlayer.UserRating stringShows the user rating of the currently playing item
VideoPlayer.Votes stringIMDb votes of current movie, if it's in the database
VideoPlayer.RatingAndVotes stringIMDb user rating and votes of current movie, if it's in the database
VideoPlayer.mpaa stringMPAA rating of current movie, if it's in the database
VideoPlayer.IMDBNumber stringThe IMDB iD of the current video, if it's in the database
VideoPlayer.Top250 stringTodo
VideoPlayer.EpisodeName string(PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
VideoPlayer.PlaylistPosition stringPosition of the current song in the current video playlist
VideoPlayer.PlaylistLength stringTotal size of the current video playlist
VideoPlayer.Cast stringA concatenated string of cast members of the current movie, if it's in the database
VideoPlayer.CastAndRole stringA concatenated string of cast members and roles of the current movie, if it's in the database
VideoPlayer.Album stringAlbum from which the current Music Video is from, if it's in the database
VideoPlayer.Artist stringArtist(s) of current Music Video, if it's in the database
VideoPlayer.Studio stringStudio of current Music Video, if it's in the database
VideoPlayer.Writer stringName of Writer of current playing Video, if it's in the database
VideoPlayer.Tagline stringSmall Summary of current playing Video, if it's in the database
VideoPlayer.PlotOutline stringSmall Summary of current playing Video, if it's in the database
VideoPlayer.Plot stringComplete Text Summary of current playing Video, if it's in the database
VideoPlayer.Premiered stringTodo
VideoPlayer.Trailer stringTodo
VideoPlayer.LastPlayed stringLast play date of current playing Video, if it's in the database
VideoPlayer.PlayCount stringPlaycount of current playing Video, if it's in the database
VideoPlayer.VideoCodec stringShows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
VideoPlayer.VideoResolution stringShows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
VideoPlayer.VideoAspect stringShows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
VideoPlayer.AudioCodec stringShows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
VideoPlayer.AudioChannels stringShows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
VideoPlayer.AudioLanguage stringShows the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage)
VideoPlayer.SubtitlesLanguage stringShows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitleLanguage)
VideoPlayer.StereoscopicMode stringShows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
VideoPlayer.EndTime stringEnd date of the currently playing programme (PVR).
VideoPlayer.NextTitle stringTitle of the programme that will be played next (PVR).
VideoPlayer.NextGenre stringGenre of the programme that will be played next (PVR).
VideoPlayer.NextPlot stringPlot of the programme that will be played next (PVR).
VideoPlayer.NextPlotOutline stringPlot outline of the programme that will be played next (PVR).
VideoPlayer.NextStartTime stringStart time of the programme that will be played next (PVR).
VideoPlayer.NextEndTime stringEnd time of the programme that will be played next (PVR).
VideoPlayer.NextDuration stringDuration of the programme that will be played next (PVR).
VideoPlayer.ChannelName stringName of the currently tuned channel (PVR).
VideoPlayer.ChannelNumber stringNumber of the currently tuned channel (PVR).
VideoPlayer.SubChannelNumber stringSubchannel number of the tv channel that's currently playing (PVR).
VideoPlayer.ChannelNumberLabel stringChannel and subchannel number of the tv channel that's currently playing (PVR).
VideoPlayer.ChannelGroup stringGroup of the currently tuned channel (PVR).
VideoPlayer.ParentalRating stringParental rating of the currently playing programme (PVR).

Container

LabelsTypeDescription
Container(id).HasFiles booleanReturns true if the container contains files (or current container if id is omitted).
Container(id).HasFolders booleanReturns true if the container contains folders (or current container if id is omitted).
Container(id).IsStacked booleanReturns true if the container is currently in stacked mode (or current container if id is omitted).
Container.FolderPath stringShows complete path of currently displayed folder
Container.FolderName stringShows top most folder in currently displayed folder
Container.PluginName stringReturns the current plugins base folder name
Container.Viewmode stringReturns the current viewmode (list, icons etc.)
Container.ViewCount integerTodo
Container(id).Totaltime stringReturns the total time of all items in the current container
Container(id).TotalWatched stringReturns the number of watched items in the current container
Container(id).TotalUnWatched stringReturns the number of unwatched items in the current container
Container.HasThumb stringReturns true if the current container you are in has a thumb assigned to it
Container.SortMethod stringReturns the current sort method (name, year, rating, etc.)
Container.SortOrder stringReturns the current sort order (Ascending/Descending)
Container.ShowPlot stringReturns the TV Show plot of the current container and can be used at season and episode level
Container.ShowTitle stringReturns the TV Show title of the current container and can be used at season and episode level
Container(id).OnNext booleanReturns true if the container with id (or current container if id is omitted) is moving to the next item. Allows views to be custom-designed (such as 3D coverviews etc.)
Container(id).OnScrollNext booleanReturns true if the container with id (or current container if id is omitted) is scrolling to the next item. Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.
Container(id).OnPrevious booleanReturns true if the container with id (or current container if id is omitted) is moving to the previous item. Allows views to be custom-designed (such as 3D coverviews etc.)
Container(id).OnScrollPrevious booleanReturns true if the container with id (or current container if id is omitted) is scrolling to the previous item. Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.
Container(id).NumPages booleanNumber of pages in the container with given id. If no id is specified it grabs the current container.
Container(id).NumItems booleanNumber of items in the container or grouplist with given id excluding parent folder item. If no id is specified it grabs the current container.
Container(id).NumAllItems booleanNumber of all items in the container or grouplist with given id including parent folder item. If no id is specified it grabs the current container. } { Container(id).NumNonFolderItems, boolean, Number of items in the container or grouplist with given id excluding all folder items (example: pvr recordings folders, parent ".." folder). If no id is specified it grabs the current container. }
Container(id).CurrentPage booleanCurrent page in the container with given id. If no id is specified it grabs the current container.
Container(id).Scrolling booleanReturns true if the user is currently scrolling through the container with id (or current container if id is omitted). Note that this is slightly delayed from the actual scroll start. Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.
Container(id).HasNext booleanReturns true if the container or textbox with id (id) has a next page.
Container.HasParent booleanReturn true when the container contains a parent ('..') item.
Container(id).HasPrevious booleanReturns true if the container or textbox with id (id) has a previous page.
Container.CanFilter booleanReturns true when the current container can be filtered.
Container.CanFilterAdvanced booleanReturns true when advanced filtering can be applied to the current container.
Container.Filtered booleanReturns true when a mediafilter is applied to the current container.
Container(id).IsUpdating booleanReturns true if the container with dynamic list content is currently updating.
Container(id).Row integerReturns the row number of the focused position in a panel container.
Container(id).Column integerReturns the column number of the focused position in a panel container.
Container(id).Position integerReturns the current focused position of container / grouplist (id) as a numeric label.
Container(id).CurrentItem integerCurrent item in the container or grouplist with given id. If no id is specified it grabs the current container.
Container(id).SubItem integerTodo
Container(id).HasFocus(item_number) booleanReturns true if the container with id (or current container if id is omitted) has static content and is focused on the item with id item_number.
Container.Property(addoncategory) stringReturns the current add-on category
Container.Property(reponame) stringReturns the current add-on repository name
Container.Content(parameter) stringReturns true if the current container you are in contains the following: files, songs, artists, albums, movies, tvshows, seasons, episodes, musicvideos, genres, years, actors, playlists, plugins, studios, directors, sets, tags (Note: these currently only work in the Video and Music Library or unless a Plugin has set the value) also available are Addons true when a list of add-ons is shown LiveTV true when a htsp (tvheadend) directory is shown
Container.Art stringTodo

ListItem

LabelsTypeDescription
ListItem.Thumb stringTodo
ListItem.Icon stringTodo
ListItem.ActualIcon stringTodo
ListItem.Overlay stringTodo
ListItem.IsFolder booleanReturns whether the current ListItem is a folder
ListItem.IsPlaying booleanReturns whether the current ListItem.* info labels and images are currently Playing media
ListItem.IsResumable booleanReturns true when the current ListItem has been partially played
ListItem.IsCollection booleanReturns true when the current ListItem is a movie set
ListItem.IsSelected booleanReturns whether the current ListItem is selected (f.e. currently playing in playlist window)
ListItem.HasEpg booleanReturns true when the selected programme has epg info (PVR)
ListItem.HasTimer booleanReturns true when a recording timer has been set for the selected programme (PVR)
ListItem.IsRecording booleanReturns true when the selected programme is being recorded (PVR)
ListItem.IsEncrypted booleanReturns true when the selected programme is encrypted (PVR)
ListItem.IsStereoscopic booleanReturns true when the selected video is a 3D (stereoscopic) video
ListItem.Property(IsSpecial) booleanReturns whether the current Season/Episode is a Special
ListItem.Property(DateLabel) stringCan be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label.
ListItem.Property(Addon.Enabled) booleanReturns true when the selected addon is enabled (for use in the addon info dialog only).
ListItem.Property(Addon.Installed) booleanReturns true when the selected addon is installed (for use in the addon info dialog only).
ListItem.Property(Addon.UpdateAvail) booleanReturns true when there's an update available for the selected addon.
ListItem.Label stringShows the left label of the currently selected item in a container
ListItem.Label2 stringShows the right label of the currently selected item in a container
ListItem.Title stringShows the title of the currently selected song or movie in a container
ListItem.OriginalTitle stringShows the original title of the currently selected movie in a container
ListItem.SortLetter stringShows the first letter of the current file in a container
ListItem.TrackNumber stringShows the track number of the currently selected song in a container
ListItem.Artist stringShows the artist of the currently selected song in a container
ListItem.AlbumArtist stringShows the artist of the currently selected album in a list
ListItem.Property(Artist_Born) stringDate of Birth of the currently selected Artist
ListItem.Property(Artist_Died) stringDate of Death of the currently selected Artist
ListItem.Property(Artist_Formed) stringFormation date of the currently selected Band
ListItem.Property(Artist_Disbanded) stringDisbanding date of the currently selected Band
ListItem.Property(Artist_YearsActive) stringYears the currently selected artist has been active
ListItem.Property(Artist_Instrument) stringInstruments played by the currently selected artist
ListItem.Property(Artist_Description) stringShows a biography of the currently selected artist
ListItem.Property(Artist_Mood) stringShows the moods of the currently selected artist
ListItem.Property(Artist_Style) stringShows the styles of the currently selected artist
ListItem.Property(Artist_Genre) stringShows the genre of the currently selected artist
ListItem.Album stringShows the album of the currently selected song in a container
ListItem.Property(Album_Mood) stringShows the moods of the currently selected Album
ListItem.Property(Album_Style) stringShows the styles of the currently selected Album
ListItem.Property(Album_Theme) stringShows the themes of the currently selected Album
ListItem.Property(Album_Type) stringShows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album
ListItem.Property(Album_Label) stringShows the record label of the currently selected Album
ListItem.Property(Album_Description) stringShows a review of the currently selected Album
ListItem.DiscNumber stringShows the disc number of the currently selected song in a container
ListItem.Year stringShows the year of the currently selected song, album or movie in a container
ListItem.Premiered stringShows the release/aired date of the currently selected episode, show, movie or EPG item in a container
ListItem.Genre stringShows the genre of the currently selected song, album or movie in a container
ListItem.Contributor stringTodo
ListItem.ContributorAndRole stringTodo
ListItem.Director stringShows the director of the currently selected movie in a container
ListItem.Country stringShows the production country of the currently selected movie in a container
ListItem.Episode stringShows the episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
ListItem.Season stringShows the season value for the currently selected tvshow
ListItem.TVShowTitle stringShows the name value for the currently selected tvshow in the season and episode depth of the video library
ListItem.Property(TotalSeasons) stringShows the total number of seasons for the currently selected tvshow
ListItem.Property(TotalEpisodes) stringShows the total number of episodes for the currently selected tvshow or season
ListItem.Property(WatchedEpisodes) stringShows the number of watched episodes for the currently selected tvshow or season
ListItem.Property(UnWatchedEpisodes) stringShows the number of unwatched episodes for the currently selected tvshow or season
ListItem.Property(NumEpisodes) stringShows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
ListItem.PictureAperture stringShows the F-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
ListItem.PictureAuthor stringShows the name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
ListItem.PictureByline stringShows the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
ListItem.PictureBylineTitle stringShows the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
ListItem.PictureCamMake stringShows the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
ListItem.PictureCamModel stringShows the manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
ListItem.PictureCaption stringShows a description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
ListItem.PictureCategory stringShows the subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
ListItem.PictureCCDWidth stringShows the width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
ListItem.PictureCity stringShows the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
ListItem.PictureColour stringShows whether the selected picture is "Colour" or "Black and White".
ListItem.PictureComment stringShows a description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
ListItem.PictureCopyrightNotice stringShows the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
ListItem.PictureCountry stringShows the full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
ListItem.PictureCountryCode stringShows the country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
ListItem.PictureCredit stringShows who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
ListItem.PictureDate stringShows the localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
ListItem.PictureDatetime stringShows the date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
ListItem.PictureDesc stringShows a short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
ListItem.PictureDigitalZoom stringShows the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
ListItem.PictureExpMode stringShows the exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
ListItem.PictureExposure stringShows the class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
ListItem.PictureExposureBias stringShows the exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
ListItem.PictureExpTime stringShows the exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
ListItem.PictureFlashUsed stringShows the status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
ListItem.PictureFocalLen stringShows the lens focal length of the selected picture
ListItem.PictureFocusDist stringShows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
ListItem.PictureGPSLat stringShows the latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
ListItem.PictureGPSLon stringShows the longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
ListItem.PictureGPSAlt stringShows the altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
ListItem.PictureHeadline stringShows a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
ListItem.PictureImageType stringShows the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
ListItem.PictureIPTCDate stringShows the date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
ListItem.PictureIPTCTime stringShows the time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
ListItem.PictureISO stringShows the ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
ListItem.PictureKeywords stringShows keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
ListItem.PictureLightSource stringShows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
ListItem.PictureLongDate stringShows only the localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
ListItem.PictureLongDatetime stringShows the date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
ListItem.PictureMeteringMode stringShows the metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
ListItem.PictureObjectName stringShows a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
ListItem.PictureOrientation stringShows the orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
ListItem.PicturePath stringShows the filename and path of the selected picture
ListItem.PictureProcess stringShows the process used to compress the selected picture
ListItem.PictureReferenceService stringShows the Service Identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
ListItem.PictureResolution stringShows the dimensions of the selected picture
ListItem.PictureSource stringShows the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
ListItem.PictureSpecialInstructions stringShows other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
ListItem.PictureState stringShows the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
ListItem.PictureSublocation stringShows the location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
ListItem.PictureSupplementalCategories stringShows supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
ListItem.PictureTransmissionReference stringShows a code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
ListItem.PictureUrgency stringShows the urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
ListItem.PictureWhiteBalance stringShows the white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
ListItem.FileName stringShows the filename of the currently selected song or movie in a container
ListItem.Path stringShows the complete path of the currently selected song or movie in a container
ListItem.FolderName stringShows top most folder of the path of the currently selected song or movie in a container
ListItem.FolderPath stringShows the complete path of the currently selected song or movie in a container (without user details).
ListItem.FileNameAndPath stringShows the full path with filename of the currently selected song or movie in a container
ListItem.FileExtension stringShows the file extension (without leading dot) of the currently selected item in a container
ListItem.Date stringShows the file date of the currently selected song or movie in a container / Aired date of an episode / Day, start time and end time of current selected TV programme (PVR)
ListItem.DateAdded stringShows the date the currently selected item was added to the library / Date and time of an event in the EventLog window.
ListItem.Size stringShows the file size of the currently selected song or movie in a container
ListItem.Rating stringShows the IMDB rating of the currently selected movie in a container
ListItem.Set stringShows the name of the set the movie is part of
ListItem.SetId stringShows the id of the set the movie is part of
ListItem.UserRating stringShows the user rating of the currently selected item in a container
ListItem.Votes stringShows the IMDB votes of the currently selected movie in a container
ListItem.RatingAndVotes stringShows the IMDB rating and votes of the currently selected movie in a container
ListItem.Mood stringTodo
ListItem.Mpaa stringShow the MPAA rating of the currently selected movie in a container
ListItem.ProgramCount stringShows the number of times an xbe has been run from "my programs"
ListItem.Duration stringShows the song or movie duration of the currently selected movie in a container
ListItem.DBTYPE stringShows the database type of the ListItem.DBID for videos (movie, set, genre, actor, tvshow, season, episode). It does not return any value for the music library. Beware with season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.
ListItem.DBID stringShows the database id of the currently selected listitem in a container
ListItem.Cast stringShows a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml
ListItem.CastAndRole stringShows a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml
ListItem.Studio stringStudio of current selected Music Video in a container
ListItem.Top250 stringShows the IMDb top250 position of the currently selected listitem in a container.
ListItem.Trailer stringShows the full trailer path with filename of the currently selected movie in a container
ListItem.Writer stringName of Writer of current Video in a container
ListItem.Tag stringSummary of current Video in a container
ListItem.Tagline stringSmall Summary of current Video in a container
ListItem.PlotOutline stringSmall Summary of current Video in a container
ListItem.Plot stringComplete Text Summary of Video in a container
ListItem.IMDBNumber stringThe IMDB iD of the selected Video in a container
ListItem.EpisodeName string(PVR only) The name of the episode if the selected EPG item is a TV Show
ListItem.PercentPlayed stringReturns percentage value [0-100] of how far the selected video has been played
ListItem.LastPlayed stringLast play date of Video in a container
ListItem.PlayCount stringPlaycount of Video in a container
ListItem.ChannelNumber stringNumber of current selected TV channel in a container
ListItem.ChannelName stringName of current selected TV channel in a container
ListItem.VideoCodec stringShows the video codec of the currently selected video (common values: 3iv2, avc1, div2, div3, divx, divx 4, dx50, flv, h264, microsoft, mp42, mp43, mp4v, mpeg1video, mpeg2video, mpg4, rv40, svq1, svq3, theora, vp6f, wmv2, wmv3, wvc1, xvid)
ListItem.VideoResolution stringShows the resolution of the currently selected video (possible values: 480, 576, 540, 720, 1080, 4K). Note that 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.
ListItem.VideoAspect stringShows the aspect ratio of the currently selected video (possible values: 1.33, 1.37, 1.66, 1.78, 1.85, 2.20, 2.35, 2.40, 2.55, 2.76)
ListItem.AudioCodec stringShows the audio codec of the currently selected video (common values: aac, ac3, cook, dca, dtshd_hra, dtshd_ma, eac3, mp1, mp2, mp3, pcm_s16be, pcm_s16le, pcm_u8, truehd, vorbis, wmapro, wmav2)
ListItem.AudioChannels stringShows the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 8, 10)
ListItem.AudioLanguage stringShows the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
ListItem.SubtitleLanguage stringShows the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
ListItem.Property(AudioCodec.[n]) stringShows the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec)
ListItem.Property(AudioChannels.[n]) stringShows the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels)
ListItem.Property(AudioLanguage.[n]) stringShows the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage)
ListItem.Property(SubtitleLanguage.[n]) stringShows the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage)
ListItem.Property(Addon.Name) stringShows the name of the currently selected addon
ListItem.Property(Addon.Version) stringShows the version of the currently selected addon
ListItem.Property(Addon.Summary) stringShows a short description of the currently selected addon
ListItem.Property(Addon.Description) stringShows the full description of the currently selected addon
ListItem.Property(Addon.Type) stringShows the type (screensaver, script, skin, etc...) of the currently selected addon
ListItem.Property(Addon.Creator) stringShows the name of the author the currently selected addon
ListItem.Property(Addon.Disclaimer) stringShows the disclaimer of the currently selected addon
ListItem.Property(Addon.Changelog) stringShows the changelog of the currently selected addon
ListItem.Property(Addon.ID) stringShows the identifier of the currently selected addon
ListItem.Property(Addon.Status) stringShows the status of the currently selected addon
ListItem.Property(Addon.Broken) stringShows a message when the addon is marked as broken in the repo
ListItem.Property(Addon.Path) stringShows the path of the currently selected addon
ListItem.StartTime stringStart time of current selected TV programme in a container
ListItem.EndTime stringEnd time of current selected TV programme in a container
ListItem.StartDate stringStart date of current selected TV programme in a container
ListItem.EndDate stringEnd date of current selected TV programme in a container
ListItem.NextTitle stringTitle of the next item (PVR).
ListItem.NextGenre stringGenre of the next item (PVR).
ListItem.NextPlot stringPlot of the next item (PVR).
ListItem.NextPlotOutline stringPlot outline of the next item (PVR).
ListItem.NextStartTime stringStart time of the next item (PVR).
ListItem.NextEndTime stringEnd of the next item (PVR).
ListItem.NextStartDate stringStart date of the next item (PVR).
ListItem.NextEndDate stringEnd date of the next item (PVR).
ListItem.ChannelGroup stringChannel group of the selected item (PVR).
ListItem.SubChannelNumber stringSubchannel number of the currently selected channel that's currently playing (PVR).
ListItem.ChannelNumberLabel stringChannel and subchannel number of the currently selected channel that's currently playing (PVR).
ListItem.Progress stringPart of the programme that's been played (PVR).
ListItem.StereoscopicMode stringReturns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta)
ListItem.HasTimerSchedule booleanWhether the item was scheduled by a timer rule (PVR). (v16 addition)
ListItem.HasRecording booleanReturns true if a given epg tag item currently gets recorded or has been recorded
ListItem.TimerHasError booleanWhether the item has a timer and it won't be recorded because of an error (PVR). (v17 addition)
ListItem.TimerHasConflict booleanWhether the item has a timer and it won't be recorded because of a conflict (PVR). (v17 addition)
ListItem.TimerIsActive booleanWhether the item has a timer that will be recorded, i.e. the timer is enabled (PVR). (v17 addition)
ListItem.Comment stringComment assigned to the item (PVR/MUSIC).
ListItem.TimerType stringReturns the type of the PVR timer / timer rule item as a human readable string
ListItem.EpgEventTitle stringReturns the title of the epg event associated with the item, if any
ListItem.InProgress booleanReturns true if the epg event item is currently active (time-wise)
ListItem.IsParentFolder booleanTodo
ListItem.AddonName stringTodo
ListItem.AddonVersion stringTodo
ListItem.AddonCreator stringTodo
ListItem.AddonSummary stringTodo
ListItem.AddonDescription stringTodo
ListItem.AddonDisclaimer stringTodo
ListItem.AddonBroken booleanTodo
ListItem.AddonType stringTodo
ListItem.AddonInstallDate stringTodo
ListItem.AddonLastUpdated stringTodo
ListItem.AddonLastUsed string

Todo

Visualisation

LabelsTypeDescription
Visualisation.Enabled booleanReturns true if any visualisation has been set in settings (so not None).
Visualisation.HasPresets booleanReturns true if the visualisation has built in presets.
Visualisation.Locked booleanReturns true if the current visualisation preset is locked (eg in Milkdrop.)
Visualisation.Preset stringShows the current preset of the visualisation.
Visualisation.Name stringShows the name of the visualisation.

Fanart

LabelsTypeDescription
Fanart.Color1 stringReturns the first of three colors included in the currently selected Fanart theme for the parent TV Show. Colors are arranged Lightest to Darkest.
Fanart.Color2 stringReturns the second of three colors included in the currently selected Fanart theme for the parent TV Show. Colors are arranged Lightest to Darkest.
Fanart.Color3 stringReturns the third of three colors included in the currently selected Fanart theme for the parent TV Show. Colors are arranged Lightest to Darkest.
Fanart.Image stringtodo

Skin

LabelsTypeDescription
Skin.CurrentTheme booleantodo
Skin.CurrentColourTheme booleantodo
Skin.AspectRatio booleantodo
Skin.Font stringtodo

Window

LabelsTypeDescription
Window.IsMedia booleanReturns true if this window is a media window (programs, music, video, scripts, pictures)
Window.Is(window) booleantodo
Window.IsActive(window) booleanReturns true if the window with id or title window is active (excludes fade out time on dialogs) See here for a list of windows
Window.IsTopMost(window) booleanReturns true if the window with id or title window is on top of the window stack (excludes fade out time on dialogs) See here for a list of windows
Window.IsVisible(window) booleanReturns true if the window is visible (includes fade out time on dialogs)
Window.Previous(window) booleanReturns true if the window with id or title window is being moved from. See here for a list of windows. Only valid while windows are changing.
Window.Next(window) booleanReturns true if the window with id or title window is being moved to. See here for a list of windows. Only valid while windows are changing.

Control

LabelsTypeDescription
Control.HasFocus(id) booleanReturns true if the currently focused control has id "id".
Control.IsVisible(id) booleanReturns true if the control with id "id" is visible.
Control.IsEnabled(id) booleanReturns true if the control with id "id" is enabled.
Control.GetLabel(id)[.index()] stringReturns the label value or texture name of the control with the given id. Optionally you can specify index(1) to retrieve label2 from an Edit control.

Playlist

LabelsTypeDescription
Playlist.Length(media) integerTotal size of the current playlist. optional parameter media is either video or music.
Playlist.Position(media) integerPosition of the current item in the current playlist. optional parameter media is either video or music.
Playlist.Random integerReturns string ID's 590 (Randomize Play Enabled) or 591 (Disabled)
Playlist.Repeat integerReturns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
Playlist.IsRandom booleanReturns true if the player is in random mode.
Playlist.IsRepeat booleanReturns true if the player is in repeat all mode.
Playlist.IsRepeatOne booleanReturns true if the player is in repeat one mode.

Pvr

LabelsTypeDescription
Pvr.IsRecording booleanReturns true when the system is recording a tv or radio programme.
Pvr.HasTimer booleanReturns true when a recording timer is active.
Pvr.HasTVChannels booleanReturns true if there are TV channels available
Pvr.HasRadioChannels booleanReturns true if there are radio channels available
Pvr.HasNonRecordingTimer booleanReturns true if there are timers present who currently not do recording
Pvr.NowRecordingTitle stringTitle of the programme being recorded
Pvr.NowRecordingDateTime Date/Time stringStart date and time of the current recording
Pvr.NowRecordingChannel stringChannel name of the current recording
Pvr.NowRecordingChannelIcon pathIcon of the current recording channel
Pvr.NextRecordingTitle stringTitle of the next programme that will be recorded
Pvr.NextRecordingDateTime Date/Time stringStart date and time of the next recording
Pvr.NextRecordingChannel stringChannel name of the next recording
Pvr.NextRecordingChannelIcon pathIcon of the next recording channel
Pvr.BackendName stringName of the backend being used
Pvr.BackendVersion stringVersion of the backend that's being used
Pvr.BackendHost stringBackend hostname
Pvr.BackendDiskSpace stringAvailable diskspace on the backend as string with size
Pvr.BackendDiskSpaceProgr integerAvailable diskspace on the backend as percent value
Pvr.BackendChannels string (integer)Number of available channels the backend provides
Pvr.BackendTimers string (integer)Number of timers set for the backend
Pvr.BackendRecordings string (integer)Number of recording available on the backend
Pvr.BackendDeletedRecordings string (integer)Number of deleted recording present on the backend
Pvr.BackendNumber stringBackend number
Pvr.TotalDiscSpace stringTotal diskspace available for recordings
Pvr.NextTimer booleanNext timer date
Pvr.IsPlayingTv booleanReturns true when live tv is being watched.
Pvr.IsPlayingRadio booleanReturns true when live radio is being listened to.
Pvr.IsPlayingRecording booleanReturns true when a recording is being watched.
Pvr.Duration time stringReturns the duration of the currently played title on TV
Pvr.Time time stringReturns the time position of the currently played title on TV
Pvr.Progress integerReturns the position of currently played title on TV as integer
Pvr.ActStreamClient stringStream client name
Pvr.ActStreamDevice stringStream device name
Pvr.ActStreamStatus stringStatus of the stream
Pvr.ActStreamSignal stringSignal quality of the stream
Pvr.ActStreamSnr stringSignal to noise ratio of the stream
Pvr.ActStreamBer stringBit error rate of the stream
Pvr.ActStreamUnc stringUNC value of the stream
Pvr.ActStreamProgrSignal integerSignal quality of the programme
Pvr.ActStreamProgrSnr integerSignal to noise ratio of the programme
Pvr.ActStreamIsEncrypted booleanReturns true when channel is encrypted on source
Pvr.ActStreamEncryptionName stringEncryption used on the stream
Pvr.ActStreamServiceName stringReturns the service name of played channel if available
Pvr.ActStreamMux stringReturns the multiplex type of played channel if available
Pvr.ActStreamProviderName stringReturns the provider name of the played channel if available
Pvr.IsTimeShift booleanReturns true when for channel is timeshift available
Pvr.TimeShiftStart time stringStart position of the timeshift
Pvr.TimeShiftEnd time stringEnd position of the timeshift
Pvr.TimeShiftCur time stringCurrent position of the timeshift
Pvr.TimeShiftProgress integerReturns the position of currently timeshifted title on TV as integer
Pvr.TVNowRecordingTitle stringTitle of the tv programme being recorded
Pvr.TVNowRecordingDateTime Date/Time stringStart date and time of the current tv recording
Pvr.TVNowRecordingChannel stringChannel name of the current tv recording
Pvr.TVNowRecordingChannelIcon pathIcon of the current recording TV channel
Pvr.TVNextRecordingTitle stringTitle of the next tv programme that will be recorded
Pvr.TVNextRecordingDateTime Date/Time stringStart date and time of the next tv recording
Pvr.TVNextRecordingChannel stringChannel name of the next tv recording
Pvr.TVNextRecordingChannelIcon pathIcon of the next recording tv channel
Pvr.RadioNowRecordingTitle stringTitle of the radio programme being recorded
Pvr.RadioNowRecordingDateTime Date/Time stringStart date and time of the current radio recording
Pvr.RadioNowRecordingChannel stringChannel name of the current radio recording
Pvr.RadioNowRecordingChannelIcon pathIcon of the current recording radio channel
Pvr.RadioNextRecordingTitle stringTitle of the next radio programme that will be recorded
Pvr.RadioNextRecordingDateTime Date/Time stringStart date and time of the next radio recording
Pvr.RadioNextRecordingChannel stringChannel name of the next radio recording
Pvr.RadioNextRecordingChannelIcon pathIcon of the next recording radio channel
Pvr.IsRecordingTV booleanReturns true when the system is recording a tv programme.
Pvr.HasTVTimer booleanReturns true if at least one tv timer is active.
Pvr.HasNonRecordingTVTimer booleanReturns true if there are tv timers present who currently not do recording
Pvr.IsRecordingRadio booleanReturns true when the system is recording a radio programme.
Pvr.HasRadioTimer booleanReturns true if at least one radio timer is active.
Pvr.HasNonRecordingRadioTimer booleanReturns true if there are radio timers present who currently not do recording { Pvr.ChannelNumberInput, string, Returns the currently entered channel number while in numeric channel input mode, an empty string otherwise }

ADSP

LabelsTypeDescription
ADSP.IsActive booleanReturns true if dsp system is enabled
ADSP.HasModes booleanReturns true if one or more modes are present on any of the types
ADSP.HasInputResample booleanReturns true if on stream is a input resample is active
ADSP.HasPreProcess booleanReturns true if on stream is a pre process mode active
ADSP.HasMasterProcess booleanReturns true if on stream is a master process mode available
ADSP.HasPostProcess booleanReturns true if on stream is a post process
ADSP.HasOutputResample booleanReturns true if on stream is a output resample
ADSP.MasterActive booleanReturns true if on stream is a master mode selected and active
ADSP.ActiveStreamType stringFrom user wanted and selected stream type, e.g. music or video
ADSP.DetectedStreamType stringFrom Kodi detected stream type
ADSP.MasterName stringName of the currently selected and used master dsp mode
ADSP.MasterInfo stringContinues updated information label of master mode (if available)
ADSP.MasterOwnIcon pathIcon to use for selected master mode
ADSP.MasterOverrideIcon pathIcon to override Kodi's codec icon with one of add-on, e.g. Dolby Digital EX on Dolby Digital

Radio RDS

Note
Only be supported on PVR Radio where the related add-on client can bring it.
LabelsTypeDescription
RDS.HasRds booleanReturns true if RDS is present
RDS.HasRadioText booleanReturns true if RDS contains also Radiotext
RDS.HasRadioTextPlus booleanReturns true if RDS with Radiotext contains also the plus information
RDS.HasHotline booleanReturns true if a hotline phone number is present
(Only be available on RadiotextPlus)
RDS.HasStudio booleanReturns true if a studio name is present
(Only be available on RadiotextPlus)
RDS.AudioLanguage stringThe from RDS reported audio language of channel
RDS.ChannelCountry stringCountry where the radio channel is sended
RDS.GetLine(number) stringReturns the last sended RDS text messages on given number, 0 is the last and 4 rows are supported (0-3)
RDS.Title stringTitle of item; e.g. track title of an album
(Only be available on RadiotextPlus)
RDS.Artist stringA person or band/collective generally considered responsible for the work
(Only be available on RadiotextPlus)
RDS.Band stringBand/orchestra/accompaniment/musician
(Only be available on RadiotextPlus)
RDS.Composer stringName of the original composer/author
(Only be available on RadiotextPlus)
RDS.Conductor stringThe artist(s) who performed the work. In classical music this would be the conductor
(Only be available on RadiotextPlus)
RDS.Album stringThe collection name to which this track belongs
(Only be available on RadiotextPlus)
RDS.TrackNumber stringThe track number of the item on the album on which it was originally released.
(Only be available on RadiotextPlus)
RDS.RadioStyle stringThe from radio channel used style of currently played part, is always updated on changed, e.g "popmusic" to "news" or "weather"...
RDS RBDS
none none
news news
currentaffairs information
information sport
sport talk
education rockmusic
drama classicrockmusic
cultures adulthits
science softrock
variedspeech top40
popmusic countrymusic
rockmusic oldiesmusic
easylistening softmusic
lightclassics nostalgia
seriousclassics jazzmusic
othermusic classical
weather randb
finance softrandb
childrensprogs language
socialaffairs religiousmusic
religion religioustalk
phonein personality
travelandtouring public
leisureandhobby college
jazzmusic spanishtalk
countrymusic spanishmusic
nationalmusic hiphop
oldiesmusic
folkmusic
documentary weather
alarmtest alarmtest
alarm-alarm alarm-alarm
Note
"alarm-alarm" is normally not used from radio stations, is thought to inform about horrible messages who are needed asap to all people.
RDS.Comment stringRadio station comment string if available
(Only be available on RadiotextPlus)
RDS.InfoNews stringMessage / headline (if available)
(Only be available on RadiotextPlus)
RDS.InfoNewsLocal stringLocal information news sended from radio channel (if available)
(Only be available on RadiotextPlus)
RDS.InfoStock stringQuote information; either as one part or as several distinct parts: "name 99latest value 99change 99high 99low 99volume" (if available)
(Only be available on RadiotextPlus)
RDS.InfoStockSize stringNumber of rows present in stock information
(Only be available on RadiotextPlus)
RDS.InfoSport stringResult of a game; either as one part or as several distinct parts: "match 99result", e.g. "Bayern München : Borussia 995:5" (if available)
(Only be available on RadiotextPlus)
RDS.InfoSportSize stringNumber of rows present in sport information
(Only be available on RadiotextPlus)
RDS.InfoLottery stringRaffle / lottery: "key word 99values" (if available)
(Only be available on RadiotextPlus)
RDS.InfoLotterySize stringNumber of rows present in lottery information
(Only be available on RadiotextPlus)
RDS.InfoWeather stringWeather informations sended from radio channel (if available)
(Only be available on RadiotextPlus)
RDS.InfoWeatherSize stringNumber of rows present in weather information
(Only be available on RadiotextPlus)
RDS.InfoCinema stringInformation about movies in cinema (if available)
(Only be available on RadiotextPlus)
RDS.InfoCinemaSize stringNumber of rows present in cinema information
(Only be available on RadiotextPlus)
RDS.InfoHoroscope stringHoroscope; either as one part or as two distinct parts: "key word 99text", e.g. "sign of the zodiac 99blablabla" (if available)
(Only be available on RadiotextPlus)
RDS.InfoHoroscopeSize stringNumber of rows present in horoscope information
(Only be available on RadiotextPlus)
RDS.InfoOther stringOther information, not especially specified: "key word 99info" (if available)
(Only be available on RadiotextPlus)
RDS.InfoOtherSize stringNumber of rows present with other informations
(Only be available on RadiotextPlus)
RDS.ProgStation stringName of the radio channel
Note
becomes also be set from epg if from RDS not available
RDS.ProgNow stringNow played program name
Note
becomes also be set from epg if from RDS not available
RDS.ProgNext stringNext played program name (if available)
Note
becomes also be set from epg if from RDS not available
RDS.ProgHost stringName of the host of the radio show
RDS.ProgEditStaff stringName of the editorial staff; e.g. name of editorial journalist
(Only be available on RadiotextPlus)
RDS.ProgHomepage stringLink to radio station homepage
(Only be available on RadiotextPlus)
RDS.ProgStyle stringHuman readable string about radiostyle defined from RDS or RBDS
RDS.PhoneHotline stringThe telephone number of the radio station's hotline
(Only be available on RadiotextPlus)
RDS.PhoneStudio stringThe telephone number of the radio station's studio
(Only be available on RadiotextPlus)
RDS.SmsStudio stringThe sms number of the radio stations studio (to send directly a sms to the studio) (if available)
(Only be available on RadiotextPlus)
RDS.EmailHotline stringThe email address of the radio stations hotline (if available)
(Only be available on RadiotextPlus)
RDS.EmailStudio stringThe email address of the radio stations studio (if available)
(Only be available on RadiotextPlus)

Slideshow

LabelsTypeDescription
Slideshow.IsActive booleanReturns true if the picture slideshow is running
Slideshow.IsPaused booleanReturns true if the picture slideshow is paused
Slideshow.IsRandom booleanReturns true if the picture slideshow is in random mode
Slideshow.IsVideo booleanReturns true if the picture slideshow is playing a video
Slideshow.Altitude stringShows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
Slideshow.Aperture stringShows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
Slideshow.Author stringShows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
Slideshow.Byline stringShows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
Slideshow.BylineTitle stringShows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
Slideshow.CameraMake stringShows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
Slideshow.CameraModel stringShows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
Slideshow.Caption stringShows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
Slideshow.Category stringShows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
Slideshow.CCDWidth stringShows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
Slideshow.City stringShows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
Slideshow.Colour stringShows whether the current picture is "Colour" or "Black and White".
Slideshow.CopyrightNotice stringShows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
Slideshow.Country stringShows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
Slideshow.CountryCode stringShows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
Slideshow.Credit stringShows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
Slideshow.DigitalZoom stringShows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
Slideshow.EXIFComment stringShows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
Slideshow.EXIFDate stringShows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
Slideshow.EXIFDescription stringShows a short description of the current picture. The SlideComment, EXIFComment or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
Slideshow.EXIFSoftware stringShows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
Slideshow.EXIFTime stringShows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
Slideshow.Exposure stringShows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
Slideshow.ExposureBias stringShows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
Slideshow.ExposureMode stringShows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
Slideshow.ExposureTime stringShows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
Slideshow.Filedate stringShows the file date of the current picture
Slideshow.Filename stringShows the file name of the current picture
Slideshow.Filesize stringShows the file size of the current picture
Slideshow.FlashUsed stringShows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
Slideshow.FocalLength stringShows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
Slideshow.FocusDistance stringShows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
Slideshow.Headline stringShows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
Slideshow.ImageType stringShows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
Slideshow.IPTCDate stringShows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
Slideshow.ISOEquivalence stringShows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
Slideshow.Keywords stringShows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
Slideshow.Latitude stringShows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
Slideshow.LightSource stringShows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
Slideshow.LongEXIFDate stringShows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
Slideshow.LongEXIFTime stringShows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
Slideshow.Longitude stringShows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
Slideshow.MeteringMode stringShows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
Slideshow.ObjectName stringShows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
Slideshow.Orientation stringShows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
Slideshow.Path stringShows the file path of the current picture
Slideshow.Process stringShows the process used to compress the current picture
Slideshow.ReferenceService stringShows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
Slideshow.Resolution stringShows the dimensions of the current picture (Width x Height)
Slideshow.SlideComment stringShows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
Slideshow.SlideIndex stringShows the slide index of the current picture
Slideshow.Source stringShows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
Slideshow.SpecialInstructions stringShows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
Slideshow.State stringShows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
Slideshow.Sublocation stringShows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
Slideshow.SupplementalCategories stringShows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
Slideshow.TimeCreated stringShows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
Slideshow.TransmissionReference stringShows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
Slideshow.Urgency stringShows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
Slideshow.WhiteBalance stringShows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).