Kodi Development  20.0
for Binary and Script based Add-Ons
Infolabels and Boolean conditions

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').

Todo:

[docs] Improve the description and create links for functions

[docs] Separate boolean conditions from infolabels

[docs] Order items alphabetically within subsections for a better search experience

[docs] Order subsections alphabetically

[docs] Use links instead of bold values for infolabels/bools so we can use a link to point users when providing help

List of Infolabels and Boolean conditions

Global

Labels Type Description
true boolean
Returns
Always evaluates to true.
false boolean
Returns
Always evaluates to false.
yes boolean
Returns
same as true .
no boolean
Returns
same as false .

String

Labels Type

Description

String.IsEmpty(info) boolean

Returns
True if the info is empty.
Parameters
info- infolabel
Note
Example of info: ListItem.Title , ListItem.Genre . Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item

v17 Skinning engine changes:
[New Boolean Condition] String.IsEmpty(info)

String.IsEqual(info,string) boolean

Returns
True if the info is equal to the given string.
Parameters
info- infolabel
string- comparison string
Note
Example of info: ListItem.Title , ListItem.Genre . Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item

v17 Skinning engine changes:
[New Boolean Condition] String.IsEqual(info,string)

String.StartsWith(info,substring) boolean

Returns
True if the info starts with the given substring.
Parameters
info- infolabel
substring- substring to check
Note
Example of info: ListItem.Title , ListItem.Genre . Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item

v17 Skinning engine changes:
[New Boolean Condition] String.StartsWith(info,substring)

String.EndsWith(info,substring) boolean

Returns
True if the info ends with the given substring.
Parameters
info- infolabel
substring- substring to check
Note
Example of info: ListItem.Title , ListItem.Genre . Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item

v17 Skinning engine changes:
[New Boolean Condition] String.EndsWith(info,substring)

String.Contains(info,substring) boolean

Returns
True if the info contains the given substring.
Parameters
info- infolabel
substring- substring to check
Note
Example of info: ListItem.Title , ListItem.Genre . Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item

v17 Skinning engine changes:
[New Boolean Condition] String.Contains(info,substring)


Integer

Labels Type

Description

Integer.IsEqual(info,number) boolean

Returns
True if the value of the infolabel is equal to the supplied number.
Parameters
info- infolabel
number- number to compare
Note
Example: Integer.IsEqual(ListItem.Year,2000)

v17 Skinning engine changes:
[New Boolean Condition] Integer.IsEqual(info,number)

Integer.IsGreater(info,number) boolean

Returns
True if the value of the infolabel is greater than to the supplied number.
Parameters
info- infolabel
number- number to compare
Note
Example: Integer.IsGreater(ListItem.Year,2000)

v17 Skinning engine changes:
[New Boolean Condition] Integer.IsGreater(info,number)

Integer.IsGreaterOrEqual(info,number) boolean

Returns
True if the value of the infolabel is greater or equal to the supplied number.
Parameters
info- infolabel
number- number to compare
Note
Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)

v17 Skinning engine changes:
[New Boolean Condition] Integer.IsGreaterOrEqual(info,number)

Integer.IsLess(info,number) boolean

Returns
True if the value of the infolabel is less than the supplied number.
Parameters
info- infolabel
number- number to compare
Note
Example: Integer.IsLess(ListItem.Year,2000)

v17 Skinning engine changes:
[New Boolean Condition] Integer.IsLess(info,number)

Integer.IsLessOrEqual(info,number) boolean

Returns
True if the value of the infolabel is less or equal to the supplied number.
Parameters
info- infolabel
number- number to compare
Note
Example: Integer.IsLessOrEqual(ListItem.Year,2000)

v17 Skinning engine changes:
[New Boolean Condition] Integer.IsLessOrEqual(info,number)

Integer.IsEven(info) boolean

Returns
True if the value of the infolabel is odd
Parameters
info- infolabel
Note
Example: Integer.IsEven(ListItem.CurrentItem)

v19 Skinning engine changes:
[New Boolean Condition] Integer.IsEven(info)

Integer.IsOdd(info) boolean

Returns
True if the value of the infolabel is odd
Parameters
info- infolabel
Note
Example: Integer.IsOdd(ListItem.CurrentItem)

v19 Skinning engine changes:
[New Boolean Condition] Integer.IsOdd(info)


Player

Labels Type

Description

Player.HasAudio boolean

Returns
True if the player has an audio file.

Player.HasGame boolean

Returns
True if the player has a game file (RETROPLAYER).

v18 Skinning engine changes:
[New Boolean Condition] Player.HasGame

Player.HasMedia boolean

Returns
True if the player has an audio or video file.

Player.HasVideo boolean

Returns
True if the player has a video file.

Player.Paused boolean

Returns
True if the player is paused.

Player.Playing boolean

Returns
True if the player is currently playing (i.e. not ffwding, rewinding or paused.)

Player.Rewinding boolean

Returns
True if the player is rewinding.

Player.Rewinding2x boolean

Returns
True if the player is rewinding at 2x.

Player.Rewinding4x boolean

Returns
True if the player is rewinding at 4x.

Player.Rewinding8x boolean

Returns
True if the player is rewinding at 8x.

Player.Rewinding16x boolean

Returns
True if the player is rewinding at 16x.

Player.Rewinding32x boolean

Returns
True if the player is rewinding at 32x.

Player.Forwarding boolean

Returns
True if the player is fast forwarding.

Player.Forwarding2x boolean

Returns
True if the player is fast forwarding at 2x.

Player.Forwarding4x boolean

Returns
True if the player is fast forwarding at 4x.

Player.Forwarding8x boolean

Returns
True if the player is fast forwarding at 8x.

Player.Forwarding16x boolean

Returns
True if the player is fast forwarding at 16x.

Player.Forwarding32x boolean

Returns
True if the player is fast forwarding at 32x.

Player.Caching boolean

Returns
True if the player is current re-caching data (internet based video playback).

Player.DisplayAfterSeek boolean

Returns
True for the first 2.5 seconds after a seek.

Player.Seekbar integer

Returns
The percentage of one seek to other position.

Player.Seeking boolean

Returns
True if a seek is in progress.

Player.ShowTime boolean

Returns
True if the user has requested the time to show (occurs in video fullscreen).

Player.ShowInfo boolean

Returns
True if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow).

Player.Title string

Returns
The Musicplayer title for audio and the Videoplayer title for video.

Player.offset(number).Title string

Returns
The title of audio or video which has an offset number with respect to the currently playing item.

v19 Skinning engine changes:
[New Infolabel] Player.offset(number).Title

Player.position(number).Title string

Returns
The title of the audio or video which has an offset number with respect to the start of the playlist.

>


v19 Skinning engine changes:
[New Infolabel] Player.position(number).Title

Player.Muted boolean

Returns
True if the volume is muted.

Player.HasDuration boolean

Returns
True if Media is not a true stream.

Player.Passthrough boolean

Returns
True if the player is using audio passthrough.

Player.CacheLevel string

Returns
The used cache level as a string with an integer number.

Player.Progress integer / string

Returns
The progress position as percentage.

v19 Skinning engine changes:
Player.Progress infolabel also exposed as a string.

Player.ProgressCache integer / string

Returns
How much of the file is cached above current play percentage

v19 Skinning engine changes:
Player.ProgressCache infolabel also exposed as a string.

Player.Volume string

Returns
The current player volume with the format %2.1f dB

Player.SubtitleDelay string

Returns
The used subtitle delay with the format %2.3f s

Player.AudioDelay string

Returns
The used audio delay with the format %2.3f s

Player.Chapter integer

Returns
The current chapter of current playing media.

Player.ChapterCount integer

Returns
The total number of chapters of current playing media.

Player.ChapterName string

Returns
The name of currently used chapter if available.

Player.Folderpath string

Returns
The full path of the currently playing song or movie

Player.offset(number).Folderpath string

Returns
The full path of the audio or video file which has an offset number with respect to the currently playing item.

v19 Skinning engine changes:
[New Infolabel] Player.offset(number).Folderpath

Player.position(number).Folderpath string

Returns
The full path of the audio or video file which has an offset number with respect to the start of the playlist.

>


v19 Skinning engine changes:
[New Infolabel] Player.position(number).Folderpath

Player.FilenameAndPath string

Returns
The full path with filename of the currently playing song or movie

Player.offset(number).FilenameAndPath string

Returns
The full path with filename of audio or video file which has an offset number with respect to the currently playing item.

v19 Skinning engine changes:
[New Infolabel] Player.offset(number).FilenameAndPath

Player.position(number).FilenameAndPath string

Returns
The full path with filename of the audio or video file which has an offset number with respect to the start of the playlist.

>


v19 Skinning engine changes:
[New Infolabel] Player.position(number).FilenameAndPath

Player.Filename string

Returns
The filename of the currently playing media.

v13 Skinning engine changes:
[New Infolabel] Player.Filename

Player.offset(number).Filename string

Returns
The filename of audio or video file which has an offset number with respect to the currently playing item.

v19 Skinning engine changes:
[New Infolabel] Player.offset(number).Filename

Player.position(number).Filename string

Returns
The filename of the audio or video file which has an offset number with respect to the start of the playlist.

>


v19 Skinning engine changes:
[New Infolabel] Player.position(number).Filename

Player.IsInternetStream boolean

Returns
True if the player is playing an internet stream.

Player.PauseEnabled boolean

Returns
True if played stream is paused.

Player.SeekEnabled boolean

Returns
True if seek on playing is enabled.

Player.ChannelPreviewActive boolean

Returns
True if PVR channel preview is active (used channel tag different from played tag)

Player.TempoEnabled boolean

Returns
True if player supports tempo (i.e. speed up/down normal playback speed)

v17 Skinning engine changes:
[New Boolean Condition] Player.TempoEnabled

Player.IsTempo boolean

Returns
True if player has tempo (i.e. is playing with a playback speed higher or lower than normal playback speed)

v17 Skinning engine changes:
[New Boolean Condition] Player.IsTempo

Player.PlaySpeed string

Returns
The player playback speed with the format %1.2f (1.00 means normal playback speed).
Note
For Tempo, the default range is 0.80 - 1.50 (it can be changed in advanced settings). If Player.PlaySpeed returns a value different from 1.00 and Player.IsTempo is false it means the player is in ff/rw mode.

Player.HasResolutions boolean

Returns
True if the player is allowed to switch resolution and refresh rate (i.e. if whitelist modes are configured in Kodi's System/Display settings)

v18 Skinning engine changes:
[New Boolean Condition] Player.HasResolutions

Player.HasPrograms boolean

Returns
True if the media file being played has programs, i.e. groups of streams.
Note
Ex: if a media file has multiple streams (quality, channels, etc) a program represents a particular stream combo.

Player.FrameAdvance boolean

Returns
True if player is in frame advance mode.
Note
Skins should hide seek bar in this mode

v18 Skinning engine changes:
[New Boolean Condition] Player.FrameAdvance

Player.Icon string

Returns
The thumbnail of the currently playing item. If no thumbnail image exists, the icon will be returned, if available.

v18 Skinning engine changes:
[New Infolabel] Player.Icon

Player.Cutlist string

Returns
The cutlist of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens must have values in the range from 0.0 to 100.0. end token must be less or equal than start token.

v19 Skinning engine changes:
[New Infolabel] Player.Cutlist

Player.Chapters string

Returns
The chapters of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens must have values in the range from 0.0 to 100.0. end token must be less or equal than start token.

v19 Skinning engine changes:
[New Infolabel] Player.Chapters

Player.Art(type) string

Returns
The Image for the defined art type for the current playing ListItem.
Parameters
type- The art type. The type is defined by scripts and scrappers and can have any value. Common example values for type are:
  • fanart
  • thumb
  • poster
  • banner
  • clearlogo
  • tvshow.poster
  • tvshow.banner
  • etc
Todo:
get a way of centralize all random art strings used in core so we can point users to them while still making it clear they can have any value.

Player.SeekTime string

Returns
The time to which the user is seeking.

Player.SeekOffset([format]) string

Returns
The seek offset after a seek press in a given format.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.
Note
Example: user presses BigStepForward, player.seekoffset returns +10:00

Player.SeekStepSize string

Returns
The seek step size.

v15 Skinning engine changes:
[New Infolabel] Player.SeekStepSize

Player.TimeRemaining([format]) string

Returns
The remaining time of current playing media in a given format.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

Player.TimeSpeed string

Returns
The time and the playspeed formatted: "1:23 (2x)".

Player.Time([format]) string

Returns
The elapsed time of current playing media in a given format.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

Player.Duration([format]) string

Returns
The total duration of the current playing media in a given format.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

Player.FinishTime([format]) string

Returns
The time at which the playing media will end (in a specified format).
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

Player.StartTime([format]) string

Returns
The time at which the playing media began (in a specified format).
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

Player.SeekNumeric([format]) string

Returns
The time at which the playing media began (in a specified format).
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

Player.Process(videohwdecoder) boolean

Returns
True if the currently playing video is decoded in hardware.

v17 Skinning engine changes:
[New Boolean Condition] Player.Process(videohwdecoder)

Player.Process(videodecoder) string

Returns
The videodecoder name of the currently playing video.

v17 Skinning engine changes:
[New Infolabel] Player.Process(videodecoder)

Player.Process(deintmethod) string

Returns
The deinterlace method of the currently playing video.

v17 Skinning engine changes:
[New Infolabel] Player.Process(deintmethod)

Player.Process(pixformat) string

Returns
The pixel format of the currently playing video.

v17 Skinning engine changes:
[New Infolabel] Player.Process(pixformat)

Player.Process(videowidth) string

Returns
The width of the currently playing video.

v17 Skinning engine changes:
[New Infolabel] Player.Process(videowidth)

Player.Process(videoheight) string

Returns
The width of the currently playing video.

v17 Skinning engine changes:
[New Infolabel] Player.Process(videoheight)

Player.Process(videofps) string

Returns
The video framerate of the currently playing video.

v17 Skinning engine changes:
[New Infolabel] Player.Process(videofps)

Player.Process(videodar) string

Returns
The display aspect ratio of the currently playing video.

v17 Skinning engine changes:
[New Infolabel] Player.Process(videodar)

Player.Process(audiodecoder) string

Returns
The audiodecoder name of the currently playing item.

v17 Skinning engine changes:
[New Infolabel] Player.Process(audiodecoder)

Player.Process(audiochannels) string

Returns
The audiodecoder name of the currently playing item.

v17 Skinning engine changes:
[New Infolabel] Player.Process(audiochannels)

Player.Process(audiosamplerate) string

Returns
The samplerate of the currently playing item.

v17 Skinning engine changes:
[New Infolabel] Player.Process(audiosamplerate)

Player.Process(audiobitspersample) string

Returns
The bits per sample of the currently playing item.

v17 Skinning engine changes:
[New Infolabel] Player.Process(audiobitspersample)


Weather

Labels Type Description
Weather.IsFetched boolean
Returns
True if the weather data has been downloaded.
Weather.Conditions string
Returns
The current weather conditions as textual description.
Note
This is looked up in a background process.
Weather.ConditionsIcon string
Returns
The current weather conditions as an icon.
Note
This is looked up in a background process.
Weather.Temperature string
Returns
The current weather temperature.
Weather.Location string
Returns
The city/town which the above two items are for.
Weather.Fanartcode string
Returns
The current weather fanartcode.
Weather.Plugin string
Returns
The current weather plugin.

System

Todo:
some values are hardcoded in the middle of the code - refactor to make it easier to track

Labels Type

Description

System.AlarmLessOrEqual(alarmname,seconds) boolean

Returns
True if the alarm with alarmname has less or equal to seconds left.
Parameters
alarmname- The name of the alarm. It can be one of the following:
  • shutdowntimer
seconds- Time in seconds to compare with the alarm trigger event
Note
Example: System.Alarmlessorequal(shutdowntimer,119), will return true when the shutdowntimer has less then 2 minutes left.

System.HasNetwork boolean

Returns
True if the Kodi host has a network available.

System.HasMediadvd boolean

Returns
True if there is a CD or DVD in the DVD-ROM drive.

System.HasMediaAudioCD boolean

Returns
True if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.

v18 Skinning engine changes:
[New Boolean Condition] System.HasMediaAudioCD

System.DVDReady boolean

Returns
True if the disc is ready to use.

System.TrayOpen boolean

Returns
True if the disc tray is open.

System.HasLocks boolean

Returns
True if the system has an active lock mode.

System.IsMaster boolean

Returns
True if the system is in master mode.

System.ShowExitButton boolean

Returns
True if the exit button should be shown (configurable via advanced settings).

System.DPMSActive boolean

Returns
True if DPMS (VESA Display Power Management Signaling) mode is active.

System.IsStandalone boolean

Returns
True if Kodi is running in standalone mode.

System.IsFullscreen boolean

Returns
True if Kodi is running fullscreen.

System.LoggedOn boolean

Returns
True if a user is currently logged on under a profile.

System.HasLoginScreen boolean

Returns
True if the profile login screen is enabled.

System.HasPVR boolean

Returns
True if PVR is supported from Kodi.
Note
normally always true /
System.HasPVRAddon boolean
Returns
True if at least one pvr client addon is installed and enabled.
Parameters
id- addon id of the PVR addon

v17 Skinning engine changes:
[New Boolean Condition] System.HasPVRAddon

System.HasCMS boolean

Returns
True if colour management is supported from Kodi.
Note
currently only supported for OpenGL

v17 Skinning engine changes:
[New Boolean Condition] System.HasCMS

System.HasActiveModalDialog boolean

Returns
True if a modal dialog is active.

v18 Skinning engine changes:
[New Boolean Condition] System.HasActiveModalDialog

System.HasVisibleModalDialog boolean

Returns
True if a modal dialog is visible.

v18 Skinning engine changes:
[New Boolean Condition] System.HasVisibleModalDialog

System.Platform.Linux boolean

Returns
True if Kodi is running on a linux/unix based computer.

System.Platform.Windows boolean

Returns
True if Kodi is running on a windows based computer.

System.Platform.UWP boolean

Returns
True if Kodi is running on Universal Windows Platform (UWP).

v18 Skinning engine changes:
[New Boolean Condition] System.Platform.UWP

System.Platform.OSX boolean

Returns
True if Kodi is running on an OSX based computer.

System.Platform.IOS boolean

Returns
True if Kodi is running on an IOS device.

System.Platform.TVOS boolean

Returns
True if Kodi is running on a tvOS device.

v19 Skinning engine changes:
[New Boolean Condition] System.Platform.TVOS

System.Platform.Darwin boolean

Returns
True if Kodi is running on an OSX or IOS system.

System.Platform.Android boolean

Returns
True if Kodi is running on an android device.

System.CanPowerDown boolean

Returns
True if Kodi can powerdown the system.

System.CanSuspend boolean

Returns
True if Kodi can suspend the system.

System.CanHibernate boolean

Returns
True if Kodi can hibernate the system.

System.HasHiddenInput boolean

Returns
True when to osd keyboard/numeric dialog requests a password/pincode.

v16 Skinning engine changes:
[New Boolean Condition] System.HasHiddenInput

System.CanReboot boolean

Returns
True if Kodi can reboot the system.

System.ScreenSaverActive boolean

Returns
True if ScreenSaver is active.

System.IsInhibit boolean

Returns
True when shutdown on idle is disabled.

System.HasShutdown boolean

Returns
True when shutdown on idle is enabled.

System.Time string

Returns
The current time.

System.Time(format) string

Returns
The current time in a specified format.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

System.Time(startTime[,endTime]) boolean

Returns
True if the current system time is >= startTime and < endTime (if defined).
Parameters
startTime- Start time
endTime- [opt] End time
Note
Time must be specified in the format HH:mm, using a 24 hour clock.

System.Date string

Returns
The current date.

v16 Skinning engine changes:
[Infolabel Updated] System.Date will now return the full day and month names. old: sat, jul 18 2015 new: saturday, july 18 2015

System.Date(format) string

Returns
The current date using a specified format.
Parameters
format- the format for the date. It can be one of the following values:
  • 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

System.Date(startDate[,endDate]) boolean

Returns
True if the current system date is >= startDate and < endDate (if defined).
Parameters
startDate- The start date
endDate- [opt] The end date
Note
Date must be specified in the format MM-DD or YY-MM-DD.

System.AlarmPos string

Returns
The shutdown Timer position.

System.BatteryLevel string

Returns
The remaining battery level in range 0-100.

System.FreeSpace string

Returns
The total Freespace on the drive.

System.UsedSpace string

Returns
The total Usedspace on the drive.

System.TotalSpace string

Returns
The total space on the drive.

System.UsedSpacePercent string

Returns
The total Usedspace Percent on the drive.

System.FreeSpacePercent string

Returns
The total Freespace Percent on the drive.

System.CPUTemperature string

Returns
The current CPU temperature.

System.CpuUsage string

Returns
The the cpu usage for each individual cpu core.

System.GPUTemperature string

Returns
The current GPU temperature.

System.FanSpeed string

Returns
The current fan speed.

System.BuildVersion string

Returns
The version of build.

System.BuildVersionShort string

Returns
The shorter string with version of build.

System.BuildDate string

Returns
The date of build.

System.BuildVersionCode string

Returns
The version code of build.

System.BuildVersionGit string

Returns
The git version of build.

System.FriendlyName string

Returns
The Kodi instance name.
Note
It will auto append (hostname%) in case the device name was not changed. eg. "Kodi (htpc)"

System.FPS string

Returns
The current rendering speed (frames per second).

System.FreeMemory string

Returns
The amount of free memory in Mb.

System.ScreenMode string

Returns
The screenmode (eg windowed / fullscreen).

System.ScreenWidth string

Returns
The width of screen in pixels.

System.ScreenHeight string

Returns
The height of screen in pixels.

System.StartupWindow string

Returns
The Window Kodi will load on startup.

v13 Skinning engine changes:
[New Infolabel] System.StartupWindow

System.CurrentWindow string

Returns
The current Window in use.

System.CurrentControl string

Returns
The current focused control

System.CurrentControlId string

Returns
The ID of the currently focused control.

System.DVDLabel string

Returns
the label of the disk in the DVD-ROM drive.

System.KernelVersion string

Returns
The System kernel version.

System.OSVersionInfo string

Returns
The system name + kernel version.

System.Uptime string

Returns
The system current uptime.

System.TotalUptime string

Returns
The system total uptime.

System.CpuFrequency string

Returns
The system cpu frequency.

System.ScreenResolution string

Returns
The screen resolution.

System.VideoEncoderInfo string

Returns
The video encoder info.

System.InternetState string

Returns
The internet state: connected or not connected.
Warning
Do not use to check status in a pythonscript since it is threaded.

System.Language string

Returns
the current language.

System.ProfileName string

Returns
The user name of the currently logged in Kodi user

System.ProfileThumb string

Returns
The thumbnail image of the currently logged in Kodi user

System.ProfileCount string

Returns
The number of defined profiles.

System.ProfileAutoLogin string

Returns
The profile Kodi will auto login to.

v13 Skinning engine changes:
[New Infolabel] System.ProfileAutoLogin

System.StereoscopicMode string

Returns
The prefered stereoscopic mode.
Note
Configured in settings > video > playback).

v13 Skinning engine changes:
[New Infolabel] System.StereoscopicMode

System.TemperatureUnits string

Returns
the Celsius or the Fahrenheit symbol.

System.Progressbar string

Returns
The percentage of the currently active progress.

System.GetBool(boolean) string

Returns
The value of any standard system boolean setting.
Note
Will not work with settings in advancedsettings.xml

System.Memory(type) string

Returns
The memory value depending on the requested type.
Parameters
type- Can be one of the following:
  • free
  • free.percent
  • used
  • used.percent
  • total

System.AddonTitle(id) string

Returns
The title of the addon with the given id
Parameters
id- the addon id

System.AddonVersion(id) string

Returns
The version of the addon with the given id.
Parameters
id- the addon id

v13 Skinning engine changes:
[New Infolabel] System.AddonVersion(id)

System.AddonIcon(id) string

Returns
The icon of the addon with the given id.
Parameters
id- the addon id

System.AddonUpdateCount string

Returns
The number of available addon updates.

v19 Skinning engine changes:
[New Infolabel] System.AddonUpdateCount

System.IdleTime(time) boolean

Returns
True if Kodi has had no input for time amount of seconds.
Parameters
time- elapsed seconds to check for idle activity.

System.PrivacyPolicy string

Returns
The official Kodi privacy policy.

v17 Skinning engine changes:
[New Infolabel] System.PrivacyPolicy

System.SupportsCPUUsage boolean

Returns
True if the system can provide CPU usage information.

v19 Skinning engine changes:
[New Boolean Condition] System.SupportsCPUUsage

System.HasAddon(id) boolean

Returns
True if the specified addon is installed on the system.
Parameters
id- the addon id
v19 Skinning engine changes:
[Boolean Condition Updated] System.HasAddon(id)

System.AddonIsEnabled(id) boolean

Returns
True if the specified addon is enabled on the system.
Parameters
id- The addon Id

v19 Skinning engine changes:
[New Boolean Condition] System.AddonIsEnabled(id)

System.HasCoreId(id) boolean

Returns
True if the CPU core with the given 'id' exists.
Parameters
id- the id of the CPU core

System.HasAlarm(alarm) boolean

Returns
True if the system has the alarm alarm set.
Parameters
alarm- the name of the alarm

System.CoreUsage(id) string

Returns
the usage of the CPU core with the given 'id'
Parameters
id- the id of the CPU core

System.Setting(hidewatched) boolean

Returns
True if 'hide watched items' is selected.


Network

Labels Type Description
Network.IsDHCP boolean
Returns
True if the network type is DHCP.
Note
Network type can be either DHCP or FIXED
Network.IPAddress string
Returns
The system's IP Address. e.g. 192.168.1.15
Network.LinkState string
Returns
The network linkstate e.g. 10mbit/100mbit etc.
Network.MacAddress string
Returns
The system's MAC address.
Network.SubnetMask string
Returns
The network subnet mask.
Network.GatewayAddress string
Returns
The network gateway address.
Network.DNS1Address string
Returns
The network DNS 1 address.
Network.DNS2Address string
Returns
The network DNS 2 address.
Network.DHCPAddress string
Returns
The DHCP IP address.

Music party mode

Labels Type

Description

MusicPartyMode.Enabled boolean

Returns
True if Party Mode is enabled.

MusicPartyMode.SongsPlayed string

Returns
The number of songs played during Party Mode.

MusicPartyMode.MatchingSongs string

Returns
The number of songs available to Party Mode.

MusicPartyMode.MatchingSongsPicked string

Returns
The number of songs picked already for Party Mode.

MusicPartyMode.MatchingSongsLeft string

Returns
The number of songs left to be picked from for Party Mode.

MusicPartyMode.RelaxedSongsPicked string

Todo:
Not currently used

MusicPartyMode.RandomSongsPicked string

Returns
The number of unique random songs picked during Party Mode.


Music player

Labels Type

Description

MusicPlayer.Offset(number).Exists boolean

Returns
True if the music players playlist has a song queued in position (number).
Parameters
number- song position

MusicPlayer.Title string

Returns
The title of the currently playing song.

MusicPlayer.offset(number).Title string

Returns
The title of the song which has an offset number with respect to the current playing song.
Parameters
number- the offset number with respect to the current playing song

MusicPlayer.Position(number).Title string

Returns
The title of the song which as an offset number with respect to the start of the playlist.
Parameters
number- the offset number with respect to the start of the playlist

MusicPlayer.Album string

Returns
The album from which the current song is from.

MusicPlayer.offset(number).Album string

Returns
The album from which the song with offset number with respect to the current song is from.
Parameters
number- the offset number with respect to the current playing song

MusicPlayer.Position(number).Album string

Returns
The album from which the song with offset number with respect to the start of the playlist is from.
Parameters
number- the offset number with respect to the start of the playlist

MusicPlayer.Property(Album_Mood) string

Returns
The moods of the currently playing Album

MusicPlayer.Property(Role.Composer) string

Returns
The name of the person who composed the selected song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.Composer)

MusicPlayer.Property(Role.Conductor) string

Returns
The name of the person who conducted the selected song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.Conductor)

MusicPlayer.Property(Role.Orchestra) string

Returns
The name of the orchestra performing the selected song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.Orchestra)

MusicPlayer.Property(Role.Lyricist) string

Returns
The name of the person who wrote the lyrics of the selected song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.Lyricist)

MusicPlayer.Property(Role.Remixer) string

Returns
The name of the person who remixed the selected song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.Remixer)

MusicPlayer.Property(Role.Arranger) string

Returns
The name of the person who arranged the selected song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.Arranger)

MusicPlayer.Property(Role.Engineer) string

Returns
The name of the person who was the engineer of the selected song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.Engineer)

MusicPlayer.Property(Role.Producer) string

Returns
The name of the person who produced the selected song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.Producer)

MusicPlayer.Property(Role.DJMixer) string

Returns
The name of the dj who remixed the selected song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.DJMixer)

MusicPlayer.Property(Role.Mixer) string

Returns
The name of the dj who remixed the selected song.
Todo:
So maybe rather than a row each have one entry for Role.XXXXX with composer, arranger etc. as listed values
Note
MusicPlayer.Property(Role.any_custom_role) also works, where any_custom_role could be an instrument violin or some other production activity e.g. sound engineer. The roles listed (composer, arranger etc.) are standard ones but there are many possible. Music file tagging allows for the musicians and all other people involved in the recording to be added, Kodi will gathers and stores that data, and it is availlable to GUI.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Role.Mixer)

MusicPlayer.Property(Album_Mood) string

Returns
the moods of the currently playing Album

MusicPlayer.Property(Album_Style) string

Returns
the styles of the currently playing Album.

MusicPlayer.Property(Album_Theme) string

Returns
The themes of the currently playing Album

MusicPlayer.Property(Album_Type) string

Returns
The album type (e.g. compilation, enhanced, explicit lyrics) of the currently playing album.

MusicPlayer.Property(Album_Label) string

Returns
The record label of the currently playing album.

MusicPlayer.Property(Album_Description) string

Returns
A review of the currently playing album

MusicPlayer.Artist string

Returns
Artist(s) of current song.

MusicPlayer.offset(number).Artist string

Returns
Artist(s) of the song which has an offset number with respect to the current playing song.
Parameters
number- the offset of the song with respect to the current playing song

MusicPlayer.Position(number).Artist string

Returns
Artist(s) of the song which has an offset number with respect to the start of the playlist.
Parameters
number- the offset of the song with respect to the start of the playlist

MusicPlayer.AlbumArtist string

Returns
The album artist of the currently playing song.

MusicPlayer.Cover string

Returns
The album cover of currently playing song.

MusicPlayer.Property(Artist_Sortname) string

Returns
The sortname of the currently playing Artist.

v18 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Artist_Sortname)

MusicPlayer.Property(Artist_Type) string

Returns
The type of the currently playing Artist - person, group, orchestra, choir etc.

v18 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Artist_Type)

MusicPlayer.Property(Artist_Gender) string

Returns
The gender of the currently playing Artist - male, female, other.

v18 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Artist_Gender)

MusicPlayer.Property(Artist_Disambiguation) string

Returns
A brief description of the currently playing Artist that differentiates them from others with the same name.

v18 Skinning engine changes:
[New Infolabel] MusicPlayer.Property(Artist_Disambiguation)

MusicPlayer.Property(Artist_Born) string

Returns
The date of Birth of the currently playing Artist.

MusicPlayer.Property(Artist_Died) string

Returns
The date of Death of the currently playing Artist.

MusicPlayer.Property(Artist_Formed) string

Returns
The Formation date of the currently playing Artist/Band.

MusicPlayer.Property(Artist_Disbanded) string

Returns
The disbanding date of the currently playing Artist/Band.

MusicPlayer.Property(Artist_YearsActive) string

Returns
The years the currently Playing artist has been active.

MusicPlayer.Property(Artist_Instrument) string

Returns
The instruments played by the currently playing artist.

MusicPlayer.Property(Artist_Description) string

Returns
A biography of the currently playing artist.

MusicPlayer.Property(Artist_Mood) string

Returns
The moods of the currently playing artist.

MusicPlayer.Property(Artist_Style) string

Returns
The styles of the currently playing artist.

MusicPlayer.Property(Artist_Genre) string

Returns
The genre of the currently playing artist.

MusicPlayer.Genre string

Returns
The genre(s) of current song.

MusicPlayer.offset(number).Genre string

Returns
The genre(s) of the song with an offset number with respect to the current playing song.
Parameters
number- the offset song number with respect to the current playing song.

MusicPlayer.Position(number).Genre string

Returns
The genre(s) of the song with an offset number with respect to the start of the playlist.
Parameters
number- the offset song number with respect to the start of the playlist song.

MusicPlayer.Lyrics string

Returns
The lyrics of current song stored in ID tag info.

MusicPlayer.Year string

Returns
The year of release of current song.

MusicPlayer.offset(number).Year string

Returns
The year of release of the song with an offset number with respect to the current playing song.
Parameters
number- the offset numbet with respect to the current song.

MusicPlayer.Position(number).Year string

Returns
The year of release of the song with an offset number with respect to the start of the playlist.
Parameters
number- the offset numbet with respect to the start of the playlist.

MusicPlayer.Rating string

Returns
The numeric Rating of current song (1-10).

MusicPlayer.offset(number).Rating string

Returns
The numeric Rating of song with an offset number with respect to the current playing song.
Parameters
number- the offset with respect to the current playing song

MusicPlayer.Position(number).Rating string

Returns
The numeric Rating of song with an offset number with respect to the start of the playlist.
Parameters
number- the offset with respect to the start of the playlist

MusicPlayer.RatingAndVotes string

Returns
The scraped rating and votes of currently playing song, if it's in the database.

MusicPlayer.UserRating string

Returns
The scraped rating of the currently playing song (1-10).

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.UserRating

MusicPlayer.Votes string

Returns
The scraped votes of currently playing song, if it's in the database.

MusicPlayer.DiscNumber string

Returns
The Disc Number of current song stored in ID tag info.

MusicPlayer.offset(number).DiscNumber string

Returns
The Disc Number of current song stored in ID tag info for the song with an offset number with respect to the playing song.
Parameters
number- The offset value for the song with respect to the playing song.

MusicPlayer.Position(number).DiscNumber string

Returns
The Disc Number of current song stored in ID tag info for the song with an offset number with respect to the start of the playlist.
Parameters
number- The offset value for the song with respect to the start of the playlist.

MusicPlayer.Comment string

Returns
The Comment of current song stored in ID tag info.

MusicPlayer.offset(number).Comment string

Returns
The Comment of current song stored in ID tag info for the song with an offset number with respect to the playing song.
Parameters
number- The offset value for the song with respect to the playing song.

MusicPlayer.Position(number).Comment string

Returns
The Comment of current song stored in ID tag info for the song with an offset number with respect to the start of the playlist.
Parameters
number- The offset value for the song with respect to the start of the playlist.

MusicPlayer.Contributors string

Returns
The list of all people who've contributed to the currently playing song

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Contributors

MusicPlayer.ContributorAndRole string

Returns
The list of all people and their role who've contributed to the currently playing song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.ContributorAndRole

MusicPlayer.Mood string

Returns
The mood of the currently playing song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.Mood

MusicPlayer.PlaylistPlaying boolean

Returns
True if a playlist is currently playing.

MusicPlayer.Exists(relative,position) boolean

Returns
True if the currently playing playlist has a song queued at the given position.
Parameters
relative- bool - If the position is relative
position- int - The position of the song
Note
It is possible to define whether the position is relative or not, default is false.

MusicPlayer.HasPrevious boolean

Returns
True if the music player has a a Previous Song in the Playlist.

MusicPlayer.HasNext boolean

Returns
True if the music player has a next song queued in the Playlist.

MusicPlayer.PlayCount integer

Returns
The play count of currently playing song, if it's in the database.

MusicPlayer.LastPlayed string

Returns
The last play date of currently playing song, if it's in the database.

MusicPlayer.TrackNumber string

Returns
The track number of current song.

MusicPlayer.offset(number).TrackNumber string

Returns
The track number of the song with an offset number with respect to the current playing song.
Parameters
number- The offset number of the song with respect to the playing song

MusicPlayer.Position(number).TrackNumber string

Returns
The track number of the song with an offset number with respect to start of the playlist.
Parameters
number- The offset number of the song with respect to start of the playlist

MusicPlayer.Duration string

Returns
The duration of the current song.

MusicPlayer.offset(number).Duration string

Returns
The duration of the song with an offset number with respect to the current playing song.
Parameters
number- the offset number of the song with respect to the current playing song

MusicPlayer.Position(number).Duration string

Returns
The duration of the song with an offset number with respect to the start of the playlist.
Parameters
number- the offset number of the song with respect to the start of the playlist

MusicPlayer.BitRate string

Returns
The bitrate of current song.

MusicPlayer.Channels string

Returns
The number of channels of current song.

MusicPlayer.BitsPerSample string

Returns
The number of bits per sample of current song.

MusicPlayer.SampleRate string

Returns
The samplerate of current playing song.

MusicPlayer.Codec string

Returns
The codec of current playing song.

MusicPlayer.PlaylistPosition string

Returns
The position of the current song in the current music playlist.

MusicPlayer.PlaylistLength string

Returns
The total size of the current music playlist.

MusicPlayer.ChannelName string

Returns
The channel name of the radio programme that's currently playing (PVR).

MusicPlayer.ChannelNumberLabel string

Returns
The channel and subchannel number of the radio channel that's currently playing (PVR).

v14 Skinning engine changes:
[New Infolabel] MusicPlayer.ChannelNumberLabel

MusicPlayer.ChannelGroup string

Returns
The channel group of the radio programme that's currently playing (PVR).

MusicPlayer.Property(propname) string

Returns
The requested property value of the currently playing item.
Parameters
propname- The requested property

MusicPlayer.DBID string

Returns
The database id of the currently playing song.

v17 Skinning engine changes:
[New Infolabel] MusicPlayer.DBID

MusicPlayer.DiscTitle string

Returns
The title of the disc currently playing.

v19 Skinning engine changes:
[New Infolabel] MusicPlayer.DiscTitle

MusicPlayer.ReleaseDate string

Returns
The release date of the song currently playing.

v19 Skinning engine changes:
[New Infolabel] MusicPlayer.ReleaseDate

MusicPlayer.OriginalDate string

Returns
The original release date of the song currently playing.

v19 Skinning engine changes:
[New Infolabel] MusicPlayer.OriginalDate

MusicPlayer.BPM string

Returns
The bpm of the track currently playing.

v19 Skinning engine changes:
[New Infolabel] MusicPlayer.BPM

MusicPlayer.IsMultiDisc boolean

Returns
Returns true if the album currently playing has more than one disc.

v19 Skinning engine changes:
[New Infolabel] MusicPlayer.IsMultiDisc

MusicPlayer.TotalDiscs string

Returns
The number of discs associated with the currently playing album.

v19 Skinning engine changes:
[New Infolabel] MusicPlayer.TotalDiscs

MusicPlayer.Station string

Returns
The name of the radio station currently playing (if available).

v19 Skinning engine changes:
[New Infolabel] MusicPlayer.Station


Video player

Labels Type

Description

VideoPlayer.UsingOverlays boolean

Returns
True if the video player is using the hardware overlays render method.
Note
This is useful, as with hardware overlays you have no alpha blending to the video image, so shadows etc. need redoing, or disabling.

VideoPlayer.IsFullscreen boolean

Returns
True if the video player is in fullscreen mode.

VideoPlayer.HasMenu boolean

Returns
True if the video player has a menu (ie is playing a DVD).

VideoPlayer.HasInfo boolean

Returns
True if the current playing video has information from the library or from a plugin (eg director/plot etc.)

VideoPlayer.Content(parameter) boolean

Returns
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 boolean

Returns
True if there are subtitles available for video.

VideoPlayer.HasTeletext boolean

Returns
True if teletext is usable on played TV channel.

VideoPlayer.IsStereoscopic boolean

Returns
True when the currently playing video is a 3D (stereoscopic) video.

v13 Skinning engine changes:
[New Boolean Condition] VideoPlayer.IsStereoscopic

VideoPlayer.SubtitlesEnabled boolean

Returns
True if subtitles are turned on for video.

VideoPlayer.HasEpg boolean

Returns
True if epg information is available for the currently playing programme (PVR).

VideoPlayer.CanResumeLiveTV boolean

Returns
True if a in-progress PVR recording is playing an the respective live TV channel is available.

VideoPlayer.Title string

Returns
The title of currently playing video.
Note
If it's in the database it will return the database title, else the filename.

VideoPlayer.offset(number).Title string

Returns
The title of video which has an offset number with respect to the currently playing video.
Note
If it's in the database it will return the database title, else the filename.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Title

VideoPlayer.position(number).Title string

Returns
The title of the video which has an offset number with respect to the start of the playlist.
Note
If it's in the database it will return the database title, else the filename.

>


v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Title

VideoPlayer.OriginalTitle string

Returns
The original title of currently playing video. If it's in the database.

VideoPlayer.offset(number).OriginalTitle string

Returns
The original title of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).OriginalTitle

VideoPlayer.position(number).OriginalTitle string

Returns
The original title of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).OriginalTitle

VideoPlayer.TVShowTitle string

Returns
The title of currently playing episode's tvshow name.

VideoPlayer.offset(number).TVShowTitle string

Returns
The title of the episode's tvshow name which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).TVShowTitle

VideoPlayer.position(number).TVShowTitle string

Returns
The title of the episode's tvshow name which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).TVShowTitle

VideoPlayer.Season string

Returns
The season number of the currently playing episode, if it's in the database.

v15 Skinning engine changes:
[Infolabel Updated] VideoPlayer.Season also supports EPG.

VideoPlayer.offset(number).Season string

Returns
The season number of the episode which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Season

VideoPlayer.position(number).Season string

Returns
The season number of the episode which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Season

VideoPlayer.Episode string

Returns
The episode number of the currently playing episode.

v15 Skinning engine changes:
[Infolabel Updated] VideoPlayer.Episode also supports EPG.

VideoPlayer.offset(number).Episode string

Returns
The episode number of the episode which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Episode

VideoPlayer.position(number).Episode string

Returns
The episode number of the episode which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Episode

VideoPlayer.Genre string

Returns
The genre(s) of current movie, if it's in the database.

VideoPlayer.offset(number).Genre string

Returns
The genre(s) of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Genre

VideoPlayer.position(number).Genre string

Returns
The genre(s) of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Genre

VideoPlayer.Director string

Returns
The director of current movie, if it's in the database.

v15 Skinning engine changes:
[Infolabel Updated] VideoPlayer.Director also supports EPG.

VideoPlayer.offset(number).Director string

Returns
The director of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).VideoPlayer_Offset_Director

VideoPlayer.position(number).Director string

Returns
The director of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Director

VideoPlayer.Country string

Returns
The production country of current movie, if it's in the database.

VideoPlayer.offset(number).Country string

Returns
The production country of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Country

VideoPlayer.position(number).Country string

Returns
The production country of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Country

VideoPlayer.Year string

Returns
The year of release of current movie, if it's in the database.

VideoPlayer.offset(number).Year string

Returns
The year of release of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Year

VideoPlayer.position(number).Year string

Returns
The year of release of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Year

VideoPlayer.Cover string

Returns
The cover of currently playing movie.

VideoPlayer.offset(number).Cover string

Returns
The cover of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Cover

VideoPlayer.position(number).Cover string

Returns
The cover of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Cover

VideoPlayer.Rating string

Returns
The scraped rating of current movie, if it's in the database.

VideoPlayer.offset(number).Rating string

Returns
The scraped rating of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Rating

VideoPlayer.position(number).Rating string

Returns
The scraped rating of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Rating

VideoPlayer.UserRating string

Returns
The user rating of the currently playing item.

v16 Skinning engine changes:
[New Infolabel] VideoPlayer.UserRating

VideoPlayer.offset(number).UserRating string

Returns
The user rating of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).UserRating

VideoPlayer.position(number).UserRating string

Returns
The user rating of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).UserRating

VideoPlayer.Votes string

Returns
The scraped votes of current movie, if it's in the database.

v13 Skinning engine changes:
[New Infolabel] VideoPlayer.Votes

VideoPlayer.offset(number).Votes string

Returns
The scraped votes of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Votes

VideoPlayer.position(number).Votes string

Returns
The scraped votes of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Votes

VideoPlayer.RatingAndVotes string

Returns
The scraped rating and votes of current movie, if it's in the database

VideoPlayer.offset(number).RatingAndVotes string

Returns
The scraped rating and votes of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).RatingAndVotes

VideoPlayer.position(number).RatingAndVotes string

Returns
The scraped rating and votes of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).RatingAndVotes

VideoPlayer.mpaa string

Returns
The MPAA rating of current movie, if it's in the database.

VideoPlayer.offset(number).mpaa string

Returns
The MPAA rating of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).mpaa

VideoPlayer.position(number).mpaa string

Returns
The MPAA rating of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).mpaa

VideoPlayer.IMDBNumber string

Returns
The IMDb ID of the current movie, if it's in the database.

v15 Skinning engine changes:
[New Infolabel] VideoPlayer.IMDBNumber

VideoPlayer.offset(number).IMDBNumber string

Returns
The IMDb ID of the the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).IMDBNumber

VideoPlayer.position(number).IMDBNumber string

Returns
The IMDb ID of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).IMDBNumber

VideoPlayer.Top250 string

Returns
The IMDb Top250 position of the currently playing movie, if it's in the database.

VideoPlayer.offset(number).Top250 string

Returns
The IMDb Top250 position of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Top250

VideoPlayer.position(number).Top250 string

Returns
The IMDb Top250 position of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Top250

VideoPlayer.EpisodeName string

Returns
The name of the episode if the playing video is a TV Show, if it's in the database (PVR).

v15 Skinning engine changes:
[New Infolabel] VideoPlayer.EpisodeName

VideoPlayer.PlaylistPosition string

Returns
The position of the current song in the current video playlist.

VideoPlayer.PlaylistLength string

Returns
The total size of the current video playlist.

VideoPlayer.Cast string

Returns
A concatenated string of cast members of the current movie, if it's in the database.

v15 Skinning engine changes:
[Infolabel Updated] VideoPlayer.Cast also supports EPG.

VideoPlayer.CastAndRole string

Returns
A concatenated string of cast members and roles of the current movie, if it's in the database.

VideoPlayer.Album string

Returns
The album from which the current Music Video is from, if it's in the database.

VideoPlayer.offset(number).Album string

Returns
The album from which the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Album

VideoPlayer.position(number).Album string

Returns
The album from which the music video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Album

VideoPlayer.Artist string

Returns
The artist(s) of current Music Video, if it's in the database.

VideoPlayer.offset(number).Artist string

Returns
The artist(s) of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Artist

VideoPlayer.position(number).Artist string

Returns
The artist(s) of the music video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Artist

VideoPlayer.Studio string

Returns
The studio of current Music Video, if it's in the database.

VideoPlayer.offset(number).Studio string

Returns
The studio of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Studio

VideoPlayer.position(number).Studio string

Returns
The studio of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Studio

VideoPlayer.Writer string

Returns
The name of Writer of current playing Video, if it's in the database.

v15 Skinning engine changes:
[Infolabel Updated] VideoPlayer.Writer also supports EPG.

VideoPlayer.offset(number).Writer string

Returns
The name of Writer of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Writer

VideoPlayer.position(number).Writer string

Returns
The name of Writer of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Writer

VideoPlayer.Tagline string

Returns
The small Summary of current playing Video, if it's in the database.

VideoPlayer.offset(number).Tagline string

Returns
The small Summary of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Tagline

VideoPlayer.position(number).Tagline string

Returns
The small Summary of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Tagline

VideoPlayer.PlotOutline string

Returns
The small Summary of current playing Video, if it's in the database.

VideoPlayer.offset(number).PlotOutline string

Returns
The small Summary of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).PlotOutline

VideoPlayer.position(number).PlotOutline string

Returns
The small Summary of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).PlotOutline

VideoPlayer.Plot string

Returns
The complete Text Summary of current playing Video, if it's in the database.

VideoPlayer.offset(number).Plot string

Returns
The complete Text Summary of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Plot

VideoPlayer.position(number).Plot string

Returns
The complete Text Summary of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Plot

VideoPlayer.Premiered string

Returns
The release or aired date of the currently playing episode, show, movie or EPG item, if it's in the database.

VideoPlayer.offset(number).Premiered string

Returns
The release or aired date of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Premiered

VideoPlayer.position(number).Premiered string

Returns
The release or aired date of the video which has an offset number with respect to the start of the playlist. if it's in the database.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Premiered

VideoPlayer.Trailer string

Returns
The path to the trailer of the currently playing movie, if it's in the database.

VideoPlayer.offset(number).Trailer string

Returns
The path to the trailer of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).Title

VideoPlayer.position(number).Trailer string

Returns
The path to the trailer of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).Trailer

VideoPlayer.LastPlayed string

Returns
The last play date of current playing Video, if it's in the database.

VideoPlayer.offset(number).LastPlayed string

Returns
The last play date of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).LastPlayed

VideoPlayer.position(number).LastPlayed string

Returns
The last play date of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).LastPlayed

VideoPlayer.PlayCount string

Returns
The playcount of current playing Video, if it's in the database.

VideoPlayer.offset(number).PlayCount string

Returns
The playcount of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).PlayCount

VideoPlayer.position(number).PlayCount string

Returns
The playcount of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).PlayCount

VideoPlayer.VideoCodec string

Returns
The video codec of the currently playing video (common values: see ListItem.VideoCodec).

VideoPlayer.VideoResolution string

Returns
The video resolution of the currently playing video (possible values: see ListItem.VideoResolution).

VideoPlayer.VideoAspect string

Returns
The aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect).

VideoPlayer.AudioCodec string

Returns
The audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec).

VideoPlayer.AudioChannels string

Returns
The number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels).

v16 Skinning engine changes:
[Infolabel Updated] VideoPlayer.AudioChannels if a video contains no audio, these infolabels will now return empty. (they used to return 0)

VideoPlayer.AudioLanguage string

Returns
The language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage).

v13 Skinning engine changes:
[New Infolabel] VideoPlayer.AudioLanguage

VideoPlayer.SubtitlesLanguage string

Returns
The language of the subtitle of the currently playing video (possible values: see ListItem.SubtitleLanguage).
Note
VideoPlayer.SubtitlesLanguage holds the language of the next available subtitle stream if subtitles are disabled in the player

v13 Skinning engine changes:
[New Infolabel] VideoPlayer.SubtitlesLanguage

VideoPlayer.StereoscopicMode string

Returns
The stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode).

v13 Skinning engine changes:
[New Infolabel] VideoPlayer.StereoscopicMode

VideoPlayer.StartTime string

Returns
The start date and time of the currently playing epg event or recording (PVR).

VideoPlayer.EndTime string

Returns
The end date and time of the currently playing epg event or recording (PVR).

VideoPlayer.NextTitle string

Returns
The title of the programme that will be played next (PVR).

VideoPlayer.NextGenre string

Returns
The genre of the programme that will be played next (PVR).

VideoPlayer.NextPlot string

Returns
The plot of the programme that will be played next (PVR).

VideoPlayer.NextPlotOutline string

Returns
The plot outline of the programme that will be played next (PVR).

VideoPlayer.NextStartTime string

Returns
The start time of the programme that will be played next (PVR).

VideoPlayer.NextEndTime string

Returns
The end time of the programme that will be played next (PVR).

VideoPlayer.NextDuration string

Returns
The duration of the programme that will be played next (PVR).

VideoPlayer.ChannelName string

Returns
The name of the currently tuned channel (PVR).

VideoPlayer.ChannelNumberLabel string

Returns
The channel and subchannel number of the tv channel that's currently playing (PVR).

v14 Skinning engine changes:
[New Infolabel] VideoPlayer.ChannelNumberLabel

VideoPlayer.ChannelGroup string

Returns
The group of the currently tuned channel (PVR).

VideoPlayer.ParentalRating string

Returns
The parental rating of the currently playing programme (PVR).

VideoPlayer.DBID string

Returns
The database id of the currently playing video

v17 Skinning engine changes:
[New Infolabel] VideoPlayer.DBID

VideoPlayer.offset(number).DBID string

Returns
The database id of the video which has an offset number with respect to the currently playing video.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.offset(number).DBID

VideoPlayer.position(number).DBID string

Returns
The database id of the video which has an offset number with respect to the start of the playlist.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.position(number).DBID

VideoPlayer.UniqueID(name) string

Returns
The scraped metadata id of current movie, if it's in the database.
Parameters
name- the name of the metadata provider.

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.UniqueID(name)

VideoPlayer.TvShowDBID string

Returns
The database id of the TvShow for the currently playing Episode

v19 Skinning engine changes:
[New Infolabel] VideoPlayer.TvShowDBID

VideoPlayer.AudioStreamCount integer

Returns
The number of audio streams of the currently playing video.
Note
If the video contains no audio streams it returns 0.

v20 Skinning engine changes:
[New Infolabel] VideoPlayer.AudioStreamCount


RetroPlayer

Labels Type

Description

RetroPlayer.VideoFilter string

Returns
The video filter of the currently-playing game. The following values are possible:
  • nearest (Nearest neighbor, i.e. pixelate)
  • linear (Bilinear filtering, i.e. smooth blur)

v18 Skinning engine changes:
[New Infolabel] RetroPlayer.VideoFilter

RetroPlayer.StretchMode string

Returns
The stretch mode of the currently-playing game. The following values are possible:
  • normal (Show the game normally)
  • 4:3 (Stretch to a 4:3 aspect ratio)
  • fullscreen (Stretch to the full viewing area)
  • original (Shrink to the original resolution)

v18 Skinning engine changes:
[New Infolabel] RetroPlayer.StretchMode

RetroPlayer.VideoRotation integer

Returns
The video rotation of the currently-playing game in degrees counter-clockwise. The following values are possible:
  • 0
  • 90 (Shown in the GUI as 270 degrees)
  • 180
  • 270 (Shown in the GUI as 90 degrees)

v18 Skinning engine changes:
[New Infolabel] RetroPlayer.VideoRotation


Container

Labels Type

Description

Container.HasFiles boolean

Returns
True if the container contains files.

Container.HasFolders boolean

Returns
True if the container contains folders.

Container.IsStacked boolean

Returns
True if the container is currently in stacked mode.

Container.FolderPath string

Returns
The complete path of currently displayed folder.

Container.FolderName string

Returns
The top most folder in currently displayed folder.

Container.PluginName string

Returns
The current plugins base folder name.

Container.PluginCategory string

Returns
The current plugins category (set by the scripter).

v17 Skinning engine changes:
[New Infolabel] Container.PluginCategory

Container.Viewmode string

Returns
The current viewmode (list, icons etc).

Container.ViewCount integer

Returns
The number of available skin view modes for the current container listing.

v17 Skinning engine changes:
[New Infolabel] Container.ViewCount

Container.Totaltime string

Returns
The total time of all items in the current container.

Container.TotalWatched string

Returns
The number of watched items in the container.
Parameters
id- [opt] if not supplied the current container will be used.

v16 Skinning engine changes:
[New Infolabel] Container(id).TotalWatched

Container.TotalUnWatched string

Returns
The number of unwatched items in the container.
Parameters
id- [opt] if not supplied the current container will be used.

v16 Skinning engine changes:
[New Infolabel] Container(id).TotalUnWatched

Container.HasThumb boolean

Returns
True if the current container you are in has a thumb assigned to it.

Container.SortOrder string

Returns
The current sort order (Ascending/Descending).

v16 Skinning engine changes:
[New Infolabel] Container.SortOrder

Container.CanFilter boolean

Returns
True when the current container can be filtered.

Container.CanFilterAdvanced boolean

Returns
True when advanced filtering can be applied to the current container.

Container.Filtered boolean

Returns
True when a mediafilter is applied to the current container.

Container.ShowPlot string

Returns
The TV Show plot of the current container and can be used at season and episode level.

Container.ShowTitle string

Returns
The TV Show title of the current container and can be used at season and episode level.

v17 Skinning engine changes:
[New Infolabel] Container.ShowTitle

Container(id).OnNext boolean

Returns
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 boolean

Returns
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 boolean

Returns
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 boolean

Returns
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 integer

Returns
The number of pages in the container with given id. If no id is specified it grabs the current container.

Container(id).NumItems integer

Returns
The number of items in the container or grouplist with given id excluding parent folder item.
Note
If no id is specified it grabs the current container.

Container(id).NumAllItems integer

Returns
The number of all items in the container or grouplist with given id including parent folder item.
Note
If no id is specified it grabs the current container.

v18 Skinning engine changes:
[New Infolabel] Container(id).NumAllItems

Container(id).NumNonFolderItems integer

Returns
The Number of items in the container or grouplist with given id excluding all folder items.
Note
Example: pvr recordings folders, parent ".." folder). If no id is specified it grabs the current container.

v18 Skinning engine changes:
[New Infolabel] Container(id).NumNonFolderItems

Container(id).CurrentPage string

Returns
THe current page in the container with given id.
Note
If no id is specified it grabs the current container.

Container(id).CurrentItem integer

Returns
The current item in the container or grouplist with given id.
Note
If no id is specified it grabs the current container.

v15 Skinning engine changes:
[New Infolabel] Container(id).CurrentItem

Container(id).Scrolling boolean

Returns
True if the user is currently scrolling through the container with id (or current container if id is omitted).
Note
This is slightly delayed from the actual scroll start. Use Container(id).OnScrollNext or Container(id).OnScrollPrevious to trigger animations immediately on scroll.

Container(id).HasNext boolean

Returns
True if the container or textbox with id (id) has a next page.

Container(id).HasParent boolean

Returns
True when the container with given id contains a parent ('..') item.
Note
If no id is specified it grabs the current container.

v16 Skinning engine changes:
[New Boolean Condition] Container.HasParent

Container(id).HasPrevious boolean

Returns
True if the container or textbox with id (id) has a previous page.

Container(id).IsUpdating boolean

Returns
True if the container with dynamic list content is currently updating.
Container(id).Row integer

Returns
The row number of the focused position in a panel container.

v16 Skinning engine changes:
[New Infolabel] Container(id).Row

Container(id).Row(parameter) boolean

Returns
True if the row number of the focused position matches the specified parameter.

Container(id).Column integer

Returns
The column number of the focused position in a panel container.

v16 Skinning engine changes:
[New Infolabel] Container(id).Column

Container(id).Column(parameter) boolean

Returns
True if the column number of the focused position matches the specified parameter.

Container(id).Position integer

Returns
The current focused position of container / grouplist (id) as a numeric label.

v16 Skinning engine changes:
[Infolabel Updated] Container(id).Position now also returns the position for items inside a grouplist.

Container(id).Position(parameter) boolean

Returns
True if the container with id (or current container if id is omitted) is focused on the specified position.

Container(id).SubItem(item_number) boolean

Returns
True if the container with id (or current container if id is omitted) is focused on the specified subitem.
Note
If no id is specified it grabs the current container.

Container(id).HasFocus(item_number) boolean

Returns
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.SortMethod string

Returns
The current sort method (returns a localized value).

Container.SortMethod(sortid) boolean

Returns
True if the current sort method matches the specified SortID (see SortUtils).

Container.Property(addoncategory) string

Returns
The current add-on category.

Container.Property(reponame) string

Returns
The current add-on repository name.

Container.Content string

Returns
The content of the current container.

v16 Skinning engine changes:
[New Infolabel] Container.Content

Container(id).ListItem(offset).Property string

Returns
the property of the ListItem with a given offset.
Parameters
offset- The offset for the listitem.
Note
Property has to be replaced with Label, Label2, Icon etc.
Example: Container(50).Listitem(2).Label

Container(id).ListItemNoWrap(offset).Property string

Returns
the same as Container(id).ListItem(offset).Property but it won't wrap.
Parameters
offset- The offset for the listitem.
Note
That means if the last item of a list is focused, ListItemNoWrap(1) will be empty while ListItem(1) will return the first item of the list. Property has to be replaced with Label, Label2, Icon etc.
Example: Container(50).ListitemNoWrap(1).Plot

Container(id).ListItemPosition(x).[infolabel] string

Returns
The infolabel for an item in a Container.
Parameters
x- the position in the container relative to the cursor position.
Note
Example: Container(50).ListItemPosition(4).Genre

Container(id).ListItemAbsolute(x).[infolabel] string

Returns
The infolabel for an item in a Container.
Parameters
x- the absolute position in the container.
Note
Example: Container(50).ListItemAbsolute(4).Genre

v16 Skinning engine changes:
[New Infolabel] Container(id).ListItemAbsolute(x).[infolabel]

Container.Content(parameter) string

Returns
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(type) string

Returns
The path to the art image file for the given type of the current container.
Parameters
type- the art type to request.
Todo:
List of all art types

v16 Skinning engine changes:
[Infolabel Updated] Container.Art(type) set.fanart as possible type value.
v15 Skinning engine changes:
[New Infolabel] Container.Art(type)

Container.SortDirection(direction) boolean

Returns
True if the sort direction of a container equals direction.
Parameters
direction- The direction to check. It can be:
  • ascending
  • descending


ListItem

Labels Type

Description

ListItem.Thumb string

Returns
The thumbnail (if it exists) of the currently selected item in a list or thumb control.
Deprecated:
but still available, returns the same as ListItem.Art(thumb)

ListItem.Icon string

Returns
The thumbnail (if it exists) of the currently selected item in a list or thumb control.
Note
If no thumbnail image exists, it will show the icon.

ListItem.ActualIcon string

Returns
The icon of the currently selected item in a list or thumb control.

ListItem.Overlay string

Returns
The overlay icon status of the currently selected item in a list or thumb control.
  • compressed file – OverlayRAR.png
  • watched – OverlayWatched.png
  • unwatched – OverlayUnwatched.png
  • locked – OverlayLocked.png

ListItem.IsFolder boolean

Returns
True if the current ListItem is a folder.

ListItem.IsPlaying boolean

Returns
True if the current ListItem.* info labels and images are currently Playing media.

ListItem.IsResumable boolean

Returns
True when the current ListItem has been partially played.

ListItem.IsCollection boolean

Returns
True when the current ListItem is a movie set.

v15 Skinning engine changes:
[New Boolean Condition] ListItem.IsCollection

ListItem.IsSelected boolean

Returns
True if the current ListItem is selected (f.e. currently playing in playlist window).

ListItem.HasEpg boolean

Returns
True when the selected programme has epg info (PVR).

ListItem.HasTimer boolean

Returns
True when a recording timer has been set for the selected programme (PVR).

ListItem.IsRecording boolean

Returns
True when the selected programme is being recorded (PVR).

ListItem.IsPlayable boolean

Returns
True when the selected programme can be played (PVR)

v19 Skinning engine changes:
[New Boolean Condition] ListItem.IsPlayable

ListItem.HasArchive boolean

Returns
True when the selected channel has a server-side back buffer (PVR)

v19 Skinning engine changes:
[New Boolean Condition] ListItem.HasArchive

ListItem.IsEncrypted boolean

Returns
True when the selected programme is encrypted (PVR).

ListItem.IsStereoscopic boolean

Returns
True when the selected video is a 3D (stereoscopic) video.

v13 Skinning engine changes:
[New Boolean Condition] ListItem.IsStereoscopic

ListItem.Property(IsSpecial) boolean

Returns
True if the current Season/Episode is a Special.

ListItem.Property(DateLabel) boolean

Returns
True if the item is a date label, returns false if the item is a time label.
Note
Can be used in the rulerlayout of the epggrid control.

ListItem.Property(Addon.IsEnabled) boolean

Returns
True when the selected addon is enabled (for use in the addon info dialog only).

v17 Skinning engine changes:
[Boolean Condition Updated] ListItem.Property(Addon.IsEnabled) replaces ListItem.Property(Addon.Enabled).

ListItem.Property(Addon.IsInstalled) boolean

Returns
True when the selected addon is installed (for use in the addon info dialog only).

v17 Skinning engine changes:
[Boolean Condition Updated] ListItem.Property(Addon.IsInstalled) replaces ListItem.Property(Addon.Installed).

ListItem.Property(Addon.HasUpdate) boolean

Returns
True when there's an update available for the selected addon.

v17 Skinning engine changes:
[Boolean Condition Updated] ListItem.Property(Addon.HasUpdate) replaces ListItem.Property(Addon.UpdateAvail).

ListItem.IsAutoUpdateable boolean

Returns
True if this add-on can be updated automatically.

v19 Skinning engine changes:
[New Boolean Condition] ListItem.IsAutoUpdateable

ListItem.Property(Addon.IsFromOfficialRepo) boolean

Returns
True if this add-on is from an official repository.

v19 Skinning engine changes:
[New Boolean Condition] ListItem.Property(Addon.IsFromOfficialRepo)

ListItem.Property(Addon.IsBinary) boolean

Returns
True if this add-on is a binary addon.

v19 Skinning engine changes:
[New Boolean Condition] ListItem.Property(Addon.IsBinary)

ListItem.Property(Addon.IsUpdate) boolean

Returns
True if this add-on is a valid update of an installed outdated add-on.

v19 Skinning engine changes:
[New Boolean Condition] ListItem.Property(Addon.IsUpdate)

ListItem.Property(Addon.ValidUpdateOrigin) string

Returns
The origin string of a valid update for the addon. Empty string if there is no valid update available.

v19 Skinning engine changes:
[New Infolabel] ListItem.Property(Addon.ValidUpdateOrigin)

ListItem.Property(Addon.ValidUpdateVersion) string

Returns
The version string of a valid update for the addon. Empty string if there is no valid update available.

v19 Skinning engine changes:
[New Infolabel] ListItem.Property(Addon.ValidUpdateVersion)

ListItem.Label string

Returns
The left label of the currently selected item in a container.

ListItem.Label2 string

Returns
The right label of the currently selected item in a container.

ListItem.Title string

Returns
The title of the currently selected song, movie, game in a container.

v18 Skinning engine changes:
[Infolabel Updated] ListItem.Title extended to support games

ListItem.OriginalTitle string

Returns
The original title of the currently selected movie in a container.

ListItem.SortLetter string

Returns
The first letter of the current file in a container.

ListItem.TrackNumber string

Returns
The track number of the currently selected song in a container.

ListItem.Artist string

Returns
The artist of the currently selected song in a container.

ListItem.AlbumArtist string

Returns
The artist of the currently selected album in a list.

ListItem.Property(Artist_Sortname) string

Returns
The sortname of the currently selected Artist.

v18 Skinning engine changes:
[New Infolabel] ListItem.Property(Artist_Sortname)

ListItem.Property(Artist_Type) string

Returns
The type of the currently selected Artist - person, group, orchestra, choir etc.

v18 Skinning engine changes:
[New Infolabel] ListItem.Property(Artist_Type)

ListItem.Property(Artist_Gender) string

Returns
The Gender of the currently selected Artist - male, female, other.

v18 Skinning engine changes:
[New Infolabel] ListItem.Property(Artist_Gender)

ListItem.Property(Artist_Disambiguation) string

Returns
A Brief description of the currently selected Artist that differentiates them from others with the same name.

v18 Skinning engine changes:
[New Infolabel] ListItem.Property(Artist_Disambiguation)

ListItem.Property(Artist_Born) string

Returns
The date of Birth of the currently selected Artist.

ListItem.Property(Artist_Died) string

Returns
The date of Death of the currently selected Artist.

ListItem.Property(Artist_Formed) string

Returns
The formation date of the currently selected Band.

ListItem.Property(Artist_Disbanded) string

Returns
The disbanding date of the currently selected Band.

ListItem.Property(Artist_YearsActive) string

Returns
The years the currently selected artist has been active.

ListItem.Property(Artist_Instrument) string

Returns
The instruments played by the currently selected artist.

ListItem.Property(Artist_Description) string

Returns
A biography of the currently selected artist.

ListItem.Property(Artist_Mood) string

Returns
The moods of the currently selected artist.

ListItem.Property(Artist_Style) string

Returns
The styles of the currently selected artist.

ListItem.Property(Artist_Genre) string

Returns
The genre of the currently selected artist.

ListItem.Album string

Returns
The album of the currently selected song in a container.

ListItem.Property(Album_Mood) string

Returns
The moods of the currently selected Album.

ListItem.Property(Album_Style) string

Returns
The styles of the currently selected Album.

ListItem.Property(Album_Theme) string

Returns
The themes of the currently selected Album.

ListItem.Property(Album_Type) string

Returns
The Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album.

ListItem.Property(Album_Label) string

Returns
The record label of the currently selected Album.

ListItem.Property(Album_Description) string

Returns
A review of the currently selected Album.

ListItem.Property(Album_Totaldiscs) string

Returns
The total number of discs belonging to an album.

v19 Skinning engine changes:
[New Infolabel] ListItem.Property(Album_Totaldiscs)

ListItem.Property(Album_Isboxset) string

Returns
True if the album is a boxset.

v19 Skinning engine changes:
[New Infobool] ListItem.Property(Album_Isboxset)

ListItem.Property(Album_Duration) string

Returns
The duration of the album in HH:MM:SS.

v19 Skinning engine changes:
[New Infolabel] ListItem.Property(Album_Duration)

ListItem.DiscNumber string

Returns
The disc number of the currently selected song in a container.

ListItem.Year string

Returns
The year of the currently selected song, album, movie, game in a container.

v18 Skinning engine changes:
[Infolabel Updated] ListItem.Title extended to support games

ListItem.Premiered string

Returns
The release/aired date of the currently selected episode, show, movie or EPG item in a container.

v15 Skinning engine changes:
[Infolabel Updated] ListItem.Premiered now also available for EPG items.

ListItem.Genre string

Returns
The genre of the currently selected song, album or movie in a container.

ListItem.Contributors string

Returns
The list of all people who've contributed to the selected song.

v17 Skinning engine changes:
[New Infolabel] ListItem.Contributors

ListItem.ContributorAndRole string

Returns
The list of all people and their role who've contributed to the selected song.

v17 Skinning engine changes:
[New Infolabel] ListItem.ContributorAndRole

ListItem.Director string

Returns
The director of the currently selected movie in a container.

v15 Skinning engine changes:
[Infolabel Updated] ListItem.Director also supports EPG.

ListItem.Country string

Returns
The production country of the currently selected movie in a container.

ListItem.Episode string

Returns
The episode number value for the currently selected episode. It also returns the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.

v15 Skinning engine changes:
[Infolabel Updated] ListItem.Episode also supports EPG.

ListItem.Season string

Returns
The season value for the currently selected tvshow.

v15 Skinning engine changes:
[Infolabel Updated] ListItem.Season also supports EPG.

ListItem.TVShowTitle string

Returns
The name value for the currently selected tvshow in the season and episode depth of the video library.

ListItem.Property(TotalSeasons) string

Returns
The total number of seasons for the currently selected tvshow.

ListItem.Property(TotalEpisodes) string

Returns
the total number of episodes for the currently selected tvshow or season.

ListItem.Property(WatchedEpisodes) string

Returns
The number of watched episodes for the currently selected tvshow or season.

ListItem.Property(UnWatchedEpisodes) string

Returns
The number of unwatched episodes for the currently selected tvshow or season.

ListItem.Property(NumEpisodes) string

Returns
The number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.

ListItem.PictureAperture string

Returns
The F-stop used to take the selected picture.
Note
This is the value of the EXIF FNumber tag (hex code 0x829D).

ListItem.PictureAuthor string

Returns
The name of the person involved in writing about the selected picture.
Note
This is the value of the IPTC Writer tag (hex code 0x7A).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureAuthor

ListItem.PictureByline string

Returns
The name of the person who created the selected picture.
Note
This is the value of the IPTC Byline tag (hex code 0x50).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureByline

ListItem.PictureBylineTitle string

Returns
The title of the person who created the selected picture.
Note
This is the value of the IPTC BylineTitle tag (hex code 0x55).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureBylineTitle

ListItem.PictureCamMake string

Returns
The manufacturer of the camera used to take the selected picture.
Note
This is the value of the EXIF Make tag (hex code 0x010F).

ListItem.PictureCamModel string

Returns
The manufacturer's model name or number of the camera used to take the selected picture.
Note
This is the value of the EXIF Model tag (hex code 0x0110).

ListItem.PictureCaption string

Returns
A description of the selected picture.
Note
This is the value of the IPTC Caption tag (hex code 0x78).

ListItem.PictureCategory string

Returns
The subject of the selected picture as a category code.
Note
This is the value of the IPTC Category tag (hex code 0x0F).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureCategory

ListItem.PictureCCDWidth string

Returns
The width of the CCD in the camera used to take the selected picture.
Note
This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureCCDWidth

ListItem.PictureCity string

Returns
The city where the selected picture was taken.
Note
This is the value of the IPTC City tag (hex code 0x5A).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureCity

ListItem.PictureColour string

Returns
Whether the selected picture is "Colour" or "Black and White".

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureColour

ListItem.PictureComment string

Returns
A description of the selected picture.
Note
This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.

ListItem.PictureCopyrightNotice string

Returns
The copyright notice of the selected picture.
Note
This is the value of the IPTC Copyright tag (hex code 0x74).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureCopyrightNotice

ListItem.PictureCountry string

Returns
The full name of the country where the selected picture was taken.
Note
This is the value of the IPTC CountryName tag (hex code 0x65).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureCountry

ListItem.PictureCountryCode string

Returns
The country code of the country where the selected picture was taken.
Note
This is the value of the IPTC CountryCode tag (hex code 0x64).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureCountryCode

ListItem.PictureCredit string

Returns
Who provided the selected picture.
Note
This is the value of the IPTC Credit tag (hex code 0x6E).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureCredit

ListItem.PictureDate string

Returns
The localized date of the selected picture. The short form of the date is used.
Note
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.

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureDate

ListItem.PictureDatetime string

Returns
The date/timestamp of the selected picture. The localized short form of the date and time is used.
Note
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.

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureDatetime

ListItem.PictureDesc string

Returns
A short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description.
Note
This is the value of the EXIF ImageDescription tag (hex code 0x010E).

ListItem.PictureDigitalZoom string

Returns
The digital zoom ratio when the selected picture was taken.
Note
This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureDigitalZoom

ListItem.PictureExpMode string

Returns
The exposure mode of the selected picture. The possible values are:
  • "Automatic"
  • "Manual"
  • "Auto bracketing"
Note
This is the value of the EXIF ExposureMode tag (hex code 0xA402).

ListItem.PictureExposure string

Returns
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
Note
This is the value of the EXIF ExposureProgram tag (hex code 0x8822).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureExposure

ListItem.PictureExposureBias string

Returns
The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99.
Note
This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureExposureBias

ListItem.PictureExpTime string

Returns
The exposure time of the selected picture, in seconds.
Note
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 string

Returns
The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information.
Note
This is the value of the EXIF Flash tag (hex code 0x9209).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureFlashUsed

ListItem.PictureFocalLen string

Returns
The lens focal length of the selected picture.

ListItem.PictureFocusDist string

Returns
The focal length of the lens, in mm.
Note
This is the value of the EXIF FocalLength tag (hex code 0x920A).
ListItem.PictureGPSLat string
Returns
The latitude where the selected picture was taken (degrees, minutes, seconds North or South).
Note
This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.

ListItem.PictureGPSLon string

Returns
The longitude where the selected picture was taken (degrees, minutes, seconds East or West).
Note
This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.

ListItem.PictureGPSAlt string

Returns
The altitude in meters where the selected picture was taken.
Note
This is the value of the EXIF GPSInfo.GPSAltitude tag.

ListItem.PictureHeadline string

Returns
A synopsis of the contents of the selected picture.
Note
This is the value of the IPTC Headline tag (hex code 0x69).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureHeadline

ListItem.PictureImageType string

Returns
The color components of the selected picture.
Note
This is the value of the IPTC ImageType tag (hex code 0x82).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureImageType

ListItem.PictureIPTCDate string

Returns
The date when the intellectual content of the selected picture was created, rather than when the picture was created.
Note
This is the value of the IPTC DateCreated tag (hex code 0x37).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureIPTCDate

ListItem.PictureIPTCTime string

Returns
The time when the intellectual content of the selected picture was created, rather than when the picture was created.
Note
This is the value of the IPTC TimeCreated tag (hex code 0x3C).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureIPTCTime

ListItem.PictureISO string

Returns
The ISO speed of the camera when the selected picture was taken.
Note
This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).

ListItem.PictureKeywords string

Returns
The keywords assigned to the selected picture.
Note
This is the value of the IPTC Keywords tag (hex code 0x19).

ListItem.PictureLightSource string

Returns
The kind of light source when the picture was taken. Possible values include:
  • "Daylight"
  • "Fluorescent"
  • "Incandescent
  • etc
Note
This is the value of the EXIF LightSource tag (hex code 0x9208).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureLightSource

ListItem.PictureLongDate string

Returns
Only the localized date of the selected picture. The long form of the date is used.
Note
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.

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureLongDate

ListItem.PictureLongDatetime string

Returns
The date/timestamp of the selected picture. The localized long form of the date and time is used.
Note
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 string

Returns
The metering mode used when the selected picture was taken. The possible values are:
  • "Center weight"
  • "Spot"
  • "Matrix"
Note
This is the value of the EXIF MeteringMode tag (hex code 0x9207).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureMeteringMode

ListItem.PictureObjectName string

Returns
A shorthand reference for the selected picture.
Note
This is the value of the IPTC ObjectName tag (hex code 0x05).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureObjectName

ListItem.PictureOrientation string

Returns
The orientation of the selected picture. Possible values are:
  • "Top Left"
  • "Top Right"
  • "Left Top"
  • "Right Bottom"
  • etc
Note
This is the value of the EXIF Orientation tag (hex code 0x0112).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureOrientation

ListItem.PicturePath string

Returns
The filename and path of the selected picture.

ListItem.PictureProcess string

Returns
The process used to compress the selected picture.

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureProcess

ListItem.PictureReferenceService string

Returns
The Service Identifier of a prior envelope to which the selected picture refers.
Note
This is the value of the IPTC ReferenceService tag (hex code 0x2D).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureReferenceService

ListItem.PictureResolution string

Returns
The dimensions of the selected picture.

ListItem.PictureSource string

Returns
The original owner of the selected picture.
Note
This is the value of the IPTC Source tag (hex code 0x73).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureSource

ListItem.PictureSpecialInstructions string

Returns
Other editorial instructions concerning the use of the selected picture.
Note
This is the value of the IPTC SpecialInstructions tag (hex code 0x28).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureSpecialInstructions

ListItem.PictureState string

Returns
The State/Province where the selected picture was taken.
Note
This is the value of the IPTC ProvinceState tag (hex code 0x5F).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureState

ListItem.PictureSublocation string

Returns
The location within a city where the selected picture was taken - might indicate the nearest landmark.
Note
This is the value of the IPTC SubLocation tag (hex code 0x5C).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureSublocation

ListItem.PictureSupplementalCategories string

Returns
A supplemental category codes to further refine the subject of the selected picture.
Note
This is the value of the IPTC SuppCategory tag (hex code 0x14).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureSupplementalCategories

ListItem.PictureTransmissionReference string

Returns
A code representing the location of original transmission of the selected picture.
Note
This is the value of the IPTC TransmissionReference tag (hex code 0x67).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureTransmissionReference

ListItem.PictureUrgency string

Returns
The urgency of the selected picture. Values are 1-9.
Note
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).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureUrgency

ListItem.PictureWhiteBalance string

Returns
The white balance mode set when the selected picture was taken. The possible values are:
  • "Manual"
  • "Auto"
Note
This is the value of the EXIF WhiteBalance tag (hex code 0xA403).

v13 Skinning engine changes:
[New Infolabel] ListItem.PictureWhiteBalance

ListItem.FileName string

Returns
The filename of the currently selected song or movie in a container.

ListItem.Path string

Returns
The complete path of the currently selected song or movie in a container.

ListItem.FolderName string

Returns
The top most folder of the path of the currently selected song or movie in a container.

ListItem.FolderPath string

Returns
The complete path of the currently selected song or movie in a container (without user details).

ListItem.FileNameAndPath string

Returns
The full path with filename of the currently selected song or movie in a container.

ListItem.FileExtension string

Returns
The file extension (without leading dot) of the currently selected item in a container.

ListItem.FileNameNoExtension string

Returns
The filename without extension of the currently selected item in a container.

v19 Skinning engine changes:
[New Infolabel] ListItem.FileNameNoExtension

ListItem.Date string

Returns
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.DateTime string

Returns
The date and time a certain event happened (event log).

v16 Skinning engine changes:
[New Infolabel] ListItem.DateTime

ListItem.DateAdded string

Returns
The date the currently selected item was added to the library / Date and time of an event in the EventLog window.

ListItem.Size string

Returns
The file size of the currently selected song or movie in a container.

ListItem.Rating([name]) string

Returns
The scraped rating of the currently selected item in a container (1-10).
Parameters
name- [opt] you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.

v18 Skinning engine changes:
[Infolabel Updated] ListItem.Rating([name]) replaces the old ListItem.Ratings([name]) infolabel.
v17 Skinning engine changes:

[New Infolabel] ListItem.Ratings([name])

[Infolabel Updated] ListItem.Ratings for songs it's now the scraped rating.

ListItem.Set string

Returns
The name of the set the movie is part of.

v17 Skinning engine changes:
[New Infolabel] ListItem.Set

ListItem.SetId string

Returns
The id of the set the movie is part of.

v17 Skinning engine changes:
[New Infolabel] ListItem.SetId

ListItem.Status string

Returns
One of the following status:
  • "returning series"
  • "in production"
  • "planned"
  • "cancelled"
  • "ended"
Note
For use with tv shows.

v17 Skinning engine changes:
[New Infolabel] ListItem.Status

ListItem.EndTimeResume string

Returns
Returns the time a video will end if you resume it, instead of playing it from the beginning.

v17 Skinning engine changes:
[New Infolabel] ListItem.EndTimeResume

ListItem.UserRating string

Returns
The user rating of the currently selected item in a container (1-10).

v17 Skinning engine changes:
[Infolabel Updated] ListItem.UserRating now available for albums/songs.
v16 Skinning engine changes:
[New Infolabel] ListItem.UserRating

ListItem.Votes([name]) string

Returns
The scraped votes of the currently selected movie in a container.
Parameters
name- [opt] you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.

v17 Skinning engine changes:
[Infolabel Updated] ListItem.Votes([name]) add optional param name to specify the scrapper.
v13 Skinning engine changes:
[New Infolabel] ListItem.Votes

ListItem.RatingAndVotes([name]) string

Returns
The scraped rating and votes of the currently selected movie in a container (1-10).
Parameters
name- [opt] you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.

v17 Skinning engine changes:

[New Infolabel] ListItem.RatingAndVotes([name])

[Infolabel Updated] ListItem.RatingAndVotes now available for albums/songs.

ListItem.Mood string

Returns
The mood of the selected song.

v17 Skinning engine changes:
[New Infolabel] ListItem.Mood

ListItem.Mpaa string

Returns
The MPAA rating of the currently selected movie in a container.

ListItem.ProgramCount string

Returns
The number of times an xbe has been run from "my programs".
Todo:
description might be outdated

ListItem.Duration string

Returns
The duration of the currently selected item in a container in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[Infolabel Updated] ListItem.Duration will return hh:mm:ss instead of the duration in minutes.

ListItem.Duration(format) string

Returns
The duration of the currently selected item in a container in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

ListItem.DBTYPE string

Returns
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.
Note
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.

v17 Skinning engine changes:
[Infolabel Updated] ListItem.DBTYPE now available in the music library.

ListItem.DBID string

Returns
The database id of the currently selected listitem in a container.

ListItem.Appearances string

Returns
The number of movies featuring the selected actor / directed by the selected director.

v17 Skinning engine changes:
[New Infolabel] ListItem.Appearances

ListItem.Cast string

Returns
A concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml.

v15 Skinning engine changes:
[Infolabel Updated] ListItem.Cast also supports EPG.

ListItem.CastAndRole string

Returns
A concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml.

ListItem.Studio string

Returns
The studio of current selected Music Video in a container.

ListItem.Top250 string

Returns
The IMDb top250 position of the currently selected listitem in a container.

ListItem.Trailer string

Returns
The full trailer path with filename of the currently selected movie in a container.

ListItem.Writer string

Returns
The name of Writer of current Video in a container.

v15 Skinning engine changes:
[Infolabel Updated] ListItem.Writer also supports EPG.

ListItem.Tag string

Returns
The summary of current Video in a container.

v17 Skinning engine changes:
[New Infolabel] ListItem.Tag

ListItem.Tagline string

Returns
A Small Summary of current Video in a container.

ListItem.PlotOutline string

Returns
A small Summary of current Video in a container.

ListItem.Plot string

Returns
The complete Text Summary of Video in a container.

ListItem.IMDBNumber string

Returns
The IMDb ID of the selected Video in a container.

v15 Skinning engine changes:
[New Infolabel] ListItem.IMDBNumber

ListItem.EpisodeName string

Returns
The name of the episode if the selected EPG item is a TV Show (PVR).

v15 Skinning engine changes:
[New Infolabel] ListItem.EpisodeName

ListItem.PercentPlayed string

Returns
The percentage value [0-100] of how far the selected video has been played.

ListItem.LastPlayed string

Returns
The last play date of Video in a container.

ListItem.PlayCount string

Returns
The playcount of Video in a container.

ListItem.ChannelName string

Returns
The name of current selected TV channel in a container.

ListItem.VideoCodec string

Returns
The video codec of the currently selected video. Common values:
  • 3iv2
  • av1
  • 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
  • etc

ListItem.VideoResolution string

Returns
The resolution of the currently selected video. Possible values:
  • 480
  • 576
  • 540
  • 720
  • 1080
  • 4K
  • 8K
Note
540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.

v18 Skinning engine changes:
[Updated Infolabel] ListItem.VideoResolution added 8K as a possible value.

ListItem.VideoAspect string

Returns
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 string

Returns
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 string

Returns
The number of audio channels of the currently selected video. Possible values:
  • 1
  • 2
  • 4
  • 5
  • 6
  • 8
  • 10

v16 Skinning engine changes:
[Infolabel Updated] ListItem.AudioChannels if a video contains no audio, these infolabels will now return empty. (they used to return 0)

ListItem.AudioLanguage string

Returns
The audio language of the currently selected video (an ISO 639-2 three character code: e.g. eng, epo, deu)

ListItem.SubtitleLanguage string

Returns
The subtitle language of the currently selected video (an ISO 639-2 three character code: e.g. eng, epo, deu)

ListItem.Property(AudioCodec.[n]) string

Returns
The audio codec of the currently selected video
Parameters
n- the number of the audiostream (values: see ListItem.AudioCodec)

v16 Skinning engine changes:
[New Infolabel] ListItem.Property(AudioCodec.[n])

ListItem.Property(AudioChannels.[n]) string

Returns
The number of audio channels of the currently selected video
Parameters
n- the number of the audiostream (values: see ListItem.AudioChannels)

v16 Skinning engine changes:
[New Infolabel] ListItem.Property(AudioChannels.[n])

ListItem.Property(AudioLanguage.[n]) string

Returns
The audio language of the currently selected video
Parameters
n- the number of the audiostream (values: see ListItem.AudioLanguage)

v16 Skinning engine changes:
[New Infolabel] ListItem.Property(AudioLanguage.[n])

ListItem.Property(SubtitleLanguage.[n]) string

Returns
The subtitle language of the currently selected video
Parameters
n- the number of the subtitle (values: see ListItem.SubtitleLanguage)

v16 Skinning engine changes:
[New Infolabel] ListItem.Property(SubtitleLanguage.[n])

ListItem.Property(Addon.Disclaimer) string

Returns
The disclaimer of the currently selected addon.

ListItem.Property(Addon.Changelog) string

Returns
The changelog of the currently selected addon.

ListItem.Property(Addon.ID) string

Returns
The identifier of the currently selected addon.

ListItem.Property(Addon.Status) string

Returns
The status of the currently selected addon.
Todo:
missing reference in GuiInfoManager.cpp making it hard to track.

ListItem.Property(Addon.Orphaned) boolean

Returns
True if the Addon is orphanad.
Todo:
missing reference in GuiInfoManager.cpp making it hard to track.

v17 Skinning engine changes:
[New Boolean Condition] ListItem.Property(Addon.Orphaned)

ListItem.Property(Addon.Path) string

Returns
The path of the currently selected addon.

ListItem.StartTime string

Returns
The start time of current selected TV programme in a container.

ListItem.EndTime string

Returns
The end time of current selected TV programme in a container.

ListItem.StartDate string

Returns
The start date of current selected TV programme in a container.

ListItem.EndDate string

Returns
The end date of current selected TV programme in a container.

ListItem.NextTitle string

Returns
The title of the next item (PVR).

ListItem.NextGenre string

Returns
The genre of the next item (PVR).

ListItem.NextPlot string

Returns
The plot of the next item (PVR).

ListItem.NextPlotOutline string

Returns
The plot outline of the next item (PVR).

ListItem.NextStartTime string

Returns
The start time of the next item (PVR).

ListItem.NextEndTime string

Returns
The end of the next item (PVR).

ListItem.NextStartDate string

Returns
The start date of the next item (PVR).

ListItem.NextEndDate string

Returns
The end date of the next item (PVR).

ListItem.NextDuration string

Returns
The duration of the next item (PVR) in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[New Infolabel] ListItem.NextDuration

ListItem.NextDuration(format) string

Returns
The duration of the next item (PVR) in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

v18 Skinning engine changes:
[New Infolabel] ListItem.NextDuration(format)

ListItem.ChannelGroup string

Returns
The channel group of the selected item (PVR).

ListItem.ChannelNumberLabel string

Returns
The channel and subchannel number of the currently selected channel that's currently playing (PVR).

v14 Skinning engine changes:
[New Infolabel] ListItem.ChannelNumberLabel

ListItem.Progress string

Returns
The part of the programme that's been played (PVR).

ListItem.StereoscopicMode string

Returns
The stereomode of the selected video:
  • mono
  • split_vertical
  • split_horizontal
  • row_interleaved
  • anaglyph_cyan_red
  • anaglyph_green_magenta

v13 Skinning engine changes:
[New Infolabel] ListItem.StereoscopicMode

ListItem.HasTimerSchedule boolean

Returns
True if the item was scheduled by a timer rule (PVR).

v16 Skinning engine changes:
[New Boolean Condition] ListItem.HasTimerSchedule

ListItem.HasReminder boolean

Returns
True if the item has a reminder set (PVR).

v19 Skinning engine changes:
[New Boolean Condition] ListItem.HasReminder

ListItem.HasReminderRule .HasReminderRule boolean

Returns
True if the item was scheduled by a reminder timer rule (PVR).

v19 Skinning engine changes:
[New Boolean Condition] ListItem.HasReminderRule

ListItem.HasRecording boolean

Returns
True if a given epg tag item currently gets recorded or has been recorded.

ListItem.TimerHasError boolean

Returns
True if the item has a timer and it won't be recorded because of an error (PVR).

v17 Skinning engine changes:
[New Boolean Condition] ListItem.TimerHasError

ListItem.TimerHasConflict boolean

Returns
True if the item has a timer and it won't be recorded because of a conflict (PVR).

v17 Skinning engine changes:
[New Boolean Condition] ListItem.TimerHasConflict

ListItem.TimerIsActive boolean

Returns
True if the item has a timer that will be recorded, i.e. the timer is enabled (PVR).

v17 Skinning engine changes:
[New Boolean Condition] ListItem.TimerIsActive

ListItem.Comment string

Returns
The comment assigned to the item (PVR/MUSIC).

ListItem.TimerType string

Returns
The type of the PVR timer / timer rule item as a human readable string.

ListItem.EpgEventTitle string

Returns
The title of the epg event associated with the item, if any.

ListItem.EpgEventIcon string

Returns
The thumbnail for the EPG event associated with the item (if it exists).

v18 Skinning engine changes:
[New Infolabel] ListItem.EpgEventIcon

ListItem.InProgress boolean

Returns
True if the EPG event item is currently active (time-wise).

ListItem.IsParentFolder boolean

Returns
True if the current list item is the goto parent folder '..'.

v17 Skinning engine changes:
[New Boolean Condition] ListItem.IsParentFolder

ListItem.AddonName string

Returns
The name of the currently selected addon.

v17 Skinning engine changes:
[Infolabel Updated] ListItem.AddonName replaces ListItem.Property(Addon.Name).

ListItem.AddonVersion string

Returns
The version of the currently selected addon.

v17 Skinning engine changes:
[Infolabel Updated] ListItem.AddonVersion replaces ListItem.Property(Addon.Version).

ListItem.AddonCreator string

Returns
The name of the author the currently selected addon.

v17 Skinning engine changes:
[Infolabel Updated] ListItem.AddonCreator replaces ListItem.Property(Addon.Creator).

ListItem.AddonSummary string

Returns
A short description of the currently selected addon.

v17 Skinning engine changes:
[Infolabel Updated] ListItem.AddonSummary replaces ListItem.Property(Addon.Summary).

ListItem.AddonDescription string

Returns
The full description of the currently selected addon.

v17 Skinning engine changes:
[Infolabel Updated] ListItem.AddonDescription replaces ListItem.Property(Addon.Description).

ListItem.AddonDisclaimer string

Returns
The disclaimer of the currently selected addon.

v17 Skinning engine changes:
[Infolabel Updated] ListItem.AddonDisclaimer replaces ListItem.Property(Addon.Disclaimer).

ListItem.AddonBroken string

Returns
A message when the addon is marked as broken in the repo.
Deprecated:
but still available, use ListItem.AddonLifecycleDesc instead

v17 Skinning engine changes:
[Infolabel Updated] ListItem.AddonBroken replaces ListItem.Property(Addon.Broken).

ListItem.AddonLifecycleType string

Returns
String name when the addon is marked as special condition in the repo.
  • Label: 24169 (Normal) - Used if an add-on has no special lifecycle state which is the default state
  • Label: 24170 (Deprecated) - The add-on should be marked as deprecated but is still usable
  • Label: 24171 (Broken) - The add-on should marked as broken in the repository

v19 Skinning engine changes:
[New Infolabel] ListItem.AddonLifecycleType replaces ListItem.AddonBroken.

ListItem.AddonLifecycleDesc string

Returns
From addon defined message text when it is marked as special condition inside repository.

v19 Skinning engine changes:
[New Infolabel] ListItem.AddonLifecycleDesc\endlink replacesListItem.AddonBroken`.

Visualisation

Labels Type

Description

Visualisation.Enabled boolean

Returns
True if any visualisation has been set in settings (so not None).

Visualisation.HasPresets boolean

Returns
True if the visualisation has built in presets.

v16 Skinning engine changes:
[New Boolean Condition] Visualisation.HasPresets

Visualisation.Locked boolean

Returns
True if the current visualisation preset is locked (e.g. in Milkdrop).

Visualisation.Preset string

Returns
The current preset of the visualisation.

Visualisation.Name string

Returns
the name of the visualisation.


Fanart

Labels Type Description
Fanart.Color1 string
Returns
The first of three colors included in the currently selected Fanart theme for the parent TV Show.
Note
Colors are arranged Lightest to Darkest.
Fanart.Color2 string
Returns
The second of three colors included in the currently selected Fanart theme for the parent TV Show.
Note
Colors are arranged Lightest to Darkest.
Fanart.Color3 string
Returns
The third of three colors included in the currently selected Fanart theme for the parent TV Show.
Note
Colors are arranged Lightest to Darkest.
Fanart.Image string
Returns
The fanart image, if any

Skin

Labels Type

Description

Skin.CurrentTheme string

Returns
The current selected skin theme.

Skin.CurrentColourTheme string

Returns
the current selected colour theme of the skin.

Skin.AspectRatio string

Returns
The closest aspect ratio match using the resolution info from the skin's addon.xml file.

Skin.Font string

Returns
the current fontset from Font.xml.

v18 Skinning engine changes:
[New Infolabel] Skin.Font


Window

Labels Type

Description

Window.IsMedia boolean

Returns
True if this window is a media window (programs, music, video, scripts, pictures)

Window.Is(window) boolean

Returns
True if the window with the given name is the window which is currently rendered.
Parameters
window- the name of the window
Note
Useful in xml files that are shared between multiple windows or dialogs.

v17 Skinning engine changes:
[New Boolean Condition] Window.Is(window)

Window.IsActive(window) boolean

Returns
True if the window with id or title window is active
Parameters
window- the id or name of the window
Note
Excludes fade out time on dialogs

Window.IsVisible(window) boolean

Returns
True if the window is visible
Note
Includes fade out time on dialogs

Window.IsTopmost(window) boolean

Returns
True if the window with id or title window is on top of the window stack.
Parameters
window- the id or name of the window
Note
Excludes fade out time on dialogs
Deprecated:
use Window.IsDialogTopmost(dialog) instead

Window.IsDialogTopmost(dialog) boolean

Returns
True if the dialog with id or title dialog is on top of the dialog stack.
Parameters
window- the id or name of the window
Note
Excludes fade out time on dialogs

Window.IsModalDialogTopmost(dialog) boolean

Returns
True if the dialog with id or title dialog is on top of the modal dialog stack
Note
Excludes fade out time on dialogs

Window.Previous(window) boolean

Returns
True if the window with id or title window is being moved from.
Parameters
window- the window id or title
Note
Only valid while windows are changing.

Window.Next(window) boolean

Returns
True if the window with id or title window is being moved to.
Parameters
window- the window id or title
Note
Only valid while windows are changing.

Window.Property(Addon.ID) string

Returns
The id of the selected addon, in DialogAddonSettings.xml.

v17 Skinning engine changes:
[New Infolabel] Window.Property(Addon.ID)

Window.Property(IsRadio) string

Returns
"true" if the window is a radio window, empty string otherwise (for use in the PVR windows).

Window([window]).Property(key) string

Returns
A window property.
Parameters
window- [opt] window id or name.
key- any value.

Window(AddonBrowser).Property(Updated) string

Returns
The date and time the addon repo was last checked for updates.
Todo:
move to a future window document.

v15 Skinning engine changes:
[New Infolabel] Window(AddonBrowser).Property(Updated)

Window(Weather).Property(property) string

Returns
The property for the weather window.
Parameters
property- The requested property. The following are available:
  • Current.ConditionIcon
  • Day[0-6].OutlookIcon
  • Current.FanartCode
  • Day[0-6].FanartCode
  • WeatherProviderLogo
  • Daily.i.OutlookIcon
  • 36Hour.i.OutlookIcon
  • Weekend.i.OutlookIcon
  • Hourly.i.OutlookIcon
Todo:
move to a future window document.

v16 Skinning engine changes:
[Updated infolabel] Window(Weather).Property(property) For skins that support extended weather info, the following infolabels have been changed:
  • Daily.i.OutlookIcon
  • 36Hour.i.OutlookIcon
  • Weekend.i.OutlookIcon
  • Hourly.i.OutlookIcon / previously the openweathermap addon would provide the full, hardcoded path to the icon ie. resource://resource.images.weathericons.default/28.png to make it easier for skins to work with custom icon sets, it now will return the filename only i.e. 28.png
v13 Skinning engine changes:
[Infolabel Updated] Window(Weather).Property(property) added WeatherProviderLogo property - weather provider logo (for weather addons that support it).


Control

Labels Type

Description

Control.HasFocus(id) boolean

Returns
True if the currently focused control has id "id".
Parameters
id- The id of the control

Control.IsVisible(id) boolean

Returns
True if the control with id "id" is visible.
Parameters
id- The id of the control

Control.IsEnabled(id) boolean

Returns
True if the control with id "id" is enabled.
Parameters
id- The id of the control

Control.GetLabel(id)[.index()] string

Returns
The label value or texture name of the control with the given id.
Parameters
id- The id of the control
index- [opt] Optionally you can specify index(1) to retrieve label2 from an Edit control.

v15 Skinning engine changes:
[Infolabel Updated] Control.GetLabel(id) added index parameter - allows skinner to retrieve label2 of a control. Only edit controls are supported. Example** : Control.GetLabel(999).index(1) where:
  • index(0) = label
  • index(1) = label2


Playlist

Labels Type

Description

Playlist.Length(media) integer

Returns
The total size of the current playlist.
Parameters
media- [opt] mediatype with is either video or music.

Playlist.Position(media) integer

Returns
The position of the current item in the current playlist.
Parameters
media- [opt] mediatype with is either video or music.

Playlist.Random integer

Returns
String ID for the random mode:
  • 16041 (On)
  • 591 (Off)

v18 Skinning engine changes:
[Infolabel Updated] Playlist.Random will now return On/Off

Playlist.Repeat integer

Returns
The String Id for the repeat mode. It can be one of the following values:
  • 592 (Repeat One)
  • 593 (Repeat All)
  • 594 (Repeat Off)

Playlist.IsRandom boolean

Returns
True if the player is in random mode.

Playlist.IsRepeat boolean

Returns
True if the player is in repeat all mode.

Playlist.IsRepeatOne boolean

Returns
True if the player is in repeat one mode.


Pvr

Labels Type

Description

PVR.IsRecording boolean

Returns
True when the system is recording a tv or radio programme.

PVR.HasTimer boolean

Returns
True when a recording timer is active.

PVR.HasTVChannels boolean

Returns
True if there are TV channels available.

PVR.HasRadioChannels boolean

Returns
True if there are radio channels available.

PVR.HasNonRecordingTimer boolean

Returns
True if there are timers present who currently not do recording.

PVR.BackendName string

Returns
The name of the backend being used.

PVR.BackendVersion string

Returns
The version of the backend that's being used.

PVR.BackendHost string

Returns
The backend hostname.

PVR.BackendDiskSpace string

Returns
The available diskspace on the backend as string with size.

PVR.BackendDiskSpaceProgr integer

Returns
The available diskspace on the backend as percent value.

v14 Skinning engine changes:
[New Infolabel] PVR.BackendDiskSpaceProgr

PVR.BackendChannels string (integer)

Returns
The number of available channels the backend provides.

PVR.BackendTimers string (integer)

Returns
The number of timers set for the backend.

PVR.BackendRecordings string (integer)

Returns
The number of recordings available on the backend.

PVR.BackendDeletedRecordings string (integer)

Returns
The number of deleted recordings present on the backend.

PVR.BackendNumber string

Returns
The backend number.

PVR.TotalDiscSpace string

Returns
The total diskspace available for recordings.

PVR.NextTimer boolean

Returns
The next timer date.

PVR.IsPlayingTV boolean

Returns
True when live tv is being watched.

PVR.IsPlayingRadio boolean

Returns
True when live radio is being listened to.

PVR.IsPlayingRecording boolean

Returns
True when a recording is being watched.

PVR.IsPlayingEpgTag boolean

Returns
True when an epg tag is being watched.

PVR.EpgEventProgress integer

Returns
The percentage complete of the currently playing epg event.

v18 Skinning engine changes:
[Infolabel Updated] PVR.EpgEventProgress replaces the old PVR.Progress infolabel.

PVR.ActStreamClient string

Returns
The stream client name.

PVR.ActStreamDevice string

Returns
The stream device name.

PVR.ActStreamStatus string

Returns
The status of the stream.

PVR.ActStreamSignal string

Returns
The signal quality of the stream.

PVR.ActStreamSnr string

Returns
The signal to noise ratio of the stream.

PVR.ActStreamBer string

Returns
The bit error rate of the stream.

PVR.ActStreamUnc string

Returns
The UNC value of the stream.

PVR.ActStreamProgrSignal integer

Returns
The signal quality of the programme.

PVR.ActStreamProgrSnr integer

Returns
The signal to noise ratio of the programme.

PVR.ActStreamIsEncrypted boolean

Returns
True when channel is encrypted on source.

PVR.ActStreamEncryptionName string

Returns
The encryption used on the stream.

PVR.ActStreamServiceName string

Returns
The service name of played channel if available.

PVR.ActStreamMux string

Returns
The multiplex type of played channel if available.

PVR.ActStreamProviderName string

Returns
The provider name of the played channel if available.

PVR.IsTimeShift boolean

Returns
True when for channel is timeshift available.

PVR.TimeShiftProgress integer

Returns
The position of currently timeshifted title on TV as integer.

PVR.TimeShiftSeekbar integer

Returns
The percentage we are seeking to in a timeshifted title.

v19 Skinning engine changes:
[New Infolabel] PVR.TimeShiftSeekbar

PVR.NowRecordingTitle string

Returns
The title of the programme being recorded.

PVR.NowRecordingDateTime Date/Time string

Returns
The start date and time of the current recording.

PVR.NowRecordingChannel string

Returns
The channel name of the current recording.

PVR.NowRecordingChannelIcon string

Returns
The icon of the current recording channel.

PVR.NextRecordingTitle string

Returns
The title of the next programme that will be recorded.

PVR.NextRecordingDateTime Date/Time string

Returns
The start date and time of the next recording.

PVR.NextRecordingChannel string

Returns
The channel name of the next recording.

PVR.NextRecordingChannelIcon string

Returns
The icon of the next recording channel.

PVR.TVNowRecordingTitle string

Returns
The title of the tv programme being recorded.

v17 Skinning engine changes:
[New Infolabel] PVR.TVNowRecordingTitle

PVR.TVNowRecordingDateTime Date/Time string

Returns
The start date and time of the current tv recording.

v17 Skinning engine changes:
[New Infolabel] PVR.TVNowRecordingDateTime

PVR.TVNowRecordingChannel string

Returns
The channel name of the current tv recording.

v17 Skinning engine changes:
[New Infolabel] PVR.TVNowRecordingChannel

PVR.TVNowRecordingChannelIcon string

Returns
The icon of the current recording TV channel.

v17 Skinning engine changes:
[New Infolabel] PVR.TVNowRecordingChannelIcon

PVR.TVNextRecordingTitle string

Returns
The title of the next tv programme that will be recorded.

v17 Skinning engine changes:
[New Infolabel] PVR.TVNextRecordingTitle

PVR.TVNextRecordingDateTime Date/Time string

Returns
The start date and time of the next tv recording.

v17 Skinning engine changes:
[New Infolabel] PVR.TVNextRecordingDateTime

PVR.TVNextRecordingChannel string

Returns
The channel name of the next tv recording.

v17 Skinning engine changes:
[New Infolabel] PVR.TVNextRecordingChannel

PVR.TVNextRecordingChannelIcon string

Returns
The icon of the next recording tv channel.

v17 Skinning engine changes:
[New Infolabel] PVR.TVNextRecordingChannelIcon

PVR.RadioNowRecordingTitle string

Returns
The title of the radio programme being recorded.

v17 Skinning engine changes:
[New Infolabel] PVR.RadioNowRecordingTitle

PVR.RadioNowRecordingDateTime Date/Time string

Returns
The start date and time of the current radio recording.

v17 Skinning engine changes:
[New Infolabel] PVR.RadioNowRecordingDateTime

PVR.RadioNowRecordingChannel string

Returns
The channel name of the current radio recording.

v17 Skinning engine changes:
[New Infolabel] PVR.RadioNowRecordingChannel

PVR.RadioNowRecordingChannelIcon string

Returns
The icon of the current recording radio channel.

v17 Skinning engine changes:
[New Infolabel] PVR.RadioNowRecordingChannelIcon

PVR.RadioNextRecordingTitle string

Returns
The title of the next radio programme that will be recorded.

v17 Skinning engine changes:
[New Infolabel] PVR.RadioNextRecordingTitle

PVR.RadioNextRecordingDateTime Date/Time string

Returns
The start date and time of the next radio recording.

v17 Skinning engine changes:
[New Infolabel] PVR.RadioNextRecordingDateTime

PVR.RadioNextRecordingChannel string

Returns
The channel name of the next radio recording.

v17 Skinning engine changes:
[New Infolabel] PVR.RadioNextRecordingChannel

PVR.RadioNextRecordingChannelIcon string

Returns
The icon of the next recording radio channel.

v17 Skinning engine changes:
[New Infolabel] PVR.RadioNextRecordingChannelIcon

PVR.IsRecordingTV boolean

Returns
True when the system is recording a tv programme.

v17 Skinning engine changes:
[New Boolean Condition] PVR.IsRecordingTV

PVR.HasTVTimer boolean

Returns
True if at least one tv timer is active.

v17 Skinning engine changes:
[New Boolean Condition] PVR.HasTVTimer

PVR.HasNonRecordingTVTimer boolean

Returns
True if there are tv timers present who currently not do recording.

v17 Skinning engine changes:
[New Boolean Condition] PVR.HasNonRecordingTVTimer

PVR.IsRecordingRadio boolean

Returns
True when the system is recording a radio programme.

v17 Skinning engine changes:
[New Boolean Condition] PVR.IsRecordingRadio

PVR.HasRadioTimer boolean

Returns
True if at least one radio timer is active.

v17 Skinning engine changes:
[New Boolean Condition] PVR.HasRadioTimer

PVR.HasNonRecordingRadioTimer boolean

Returns
True if there are radio timers present who currently not do recording.

v17 Skinning engine changes:
[New Boolean Condition] PVR.HasRadioTimer

PVR.ChannelNumberInput string

Returns
The currently entered channel number while in numeric channel input mode, an empty string otherwise.

v18 Skinning engine changes:
[New Infolabel] PVR.ChannelNumberInput

PVR.CanRecordPlayingChannel boolean

Returns
True if PVR is currently playing a channel and if this channel can be recorded.

v18 Skinning engine changes:
[Infolabel Updated] PVR.CanRecordPlayingChannel replaces the old Player.CanRecord infolabel.

PVR.IsRecordingPlayingChannel boolean

Returns
True if PVR is currently playing a channel and if this channel is currently recorded.

v18 Skinning engine changes:
[Infolabel Updated] PVR.IsRecordingPlayingChannel replaces the old Player.Recording infolabel.

PVR.IsPlayingActiveRecording boolean

Returns
True if PVR is currently playing an in progress recording.

v19 Skinning engine changes:
[New Infolabel] PVR.IsPlayingActiveRecording

PVR.TimeshiftProgressPlayPos integer

Returns
The percentage of the current play position within the PVR timeshift progress.

v18 Skinning engine changes:
[New Infolabel] PVR.TimeshiftProgressPlayPos

PVR.TimeshiftProgressEpgStart integer

Returns
The percentage of the start of the currently playing epg event within the PVR timeshift progress.

v18 Skinning engine changes:
[New Infolabel] PVR.TimeshiftProgressEpgStart

PVR.TimeshiftProgressEpgEnd integer

Returns
The percentage of the end of the currently playing epg event within the PVR timeshift progress.

v18 Skinning engine changes:
[New Infolabel] PVR.TimeshiftProgressEpgEnd

PVR.TimeshiftProgressBufferStart integer

Returns
The percentage of the start of the timeshift buffer within the PVR timeshift progress.

v18 Skinning engine changes:
[New Infolabel] PVR.TimeshiftProgressBufferStart

PVR.TimeshiftProgressBufferEnd integer

Returns
The percentage of the end of the timeshift buffer within the PVR timeshift progress.

v18 Skinning engine changes:
[New Infolabel] PVR.TimeshiftProgressBufferEnd

PVR.EpgEventIcon string

Returns
The icon of the currently playing epg event, if any.

v18 Skinning engine changes:
[New Infolabel] PVR_EpgEventIcon

PVR.EpgEventDuration string

Returns
The duration of the currently playing epg event in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[Infolabel Updated] PVR.EpgEventDuration replaces the old PVR.Duration infolabel.

PVR.EpgEventDuration(format) string

Returns
The duration of the currently playing EPG event in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.EpgEventElapsedTime string

Returns
the time of the current position of the currently playing epg event in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[Infolabel Updated] PVR.EpgEventElapsedTime replaces the old PVR.Time infolabel.

PVR.EpgEventElapsedTime(format) string

Returns
The time of the current position of the currently playing epg event in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.EpgEventRemainingTime string

Returns
The remaining time for currently playing epg event in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[New Infolabel] PVR.EpgEventRemainingTime

PVR.EpgEventRemainingTime(format) string

Returns
The remaining time for currently playing epg event in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.EpgEventSeekTime string

Returns
The time the user is seeking within the currently playing epg event in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[New Infolabel] PVR.EpgEventSeekTime

PVR.EpgEventSeekTime(format) string

Returns
The time the user is seeking within the currently playing epg event in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.EpgEventFinishTime string

Returns
The time the currently playing epg event will end in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[New Infolabel] PVR.EpgEventFinishTime

PVR.EpgEventFinishTime(format) string Returns the time the currently playing epg event will end in different formats.

Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.TimeShiftStart string

Returns
The start time of the timeshift buffer in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

PVR.TimeShiftStart(format) string Returns the start time of the timeshift buffer in different formats.

Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.TimeShiftEnd string

Returns
The end time of the timeshift buffer in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

PVR.TimeShiftEnd(format) string

Returns
The end time of the timeshift buffer in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.TimeShiftCur string

Returns
The current playback time within the timeshift buffer in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

PVR.TimeShiftCur(format) string Returns the current playback time within the timeshift buffer in different formats.

Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.TimeShiftOffset string

Returns
The delta of timeshifted time to actual time in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

PVR.TimeShiftOffset(format) string Returns the delta of timeshifted time to actual time in different formats.

Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.TimeshiftProgressDuration string

Returns
the duration of the PVR timeshift progress in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[New Infolabel] PVR.TimeshiftProgressDuration

PVR.TimeshiftProgressDuration(format) string

Returns
The duration of the PVR timeshift progress in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.TimeshiftProgressStartTime string

Returns
The start time of the PVR timeshift progress in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[New Infolabel] PVR.TimeshiftProgressStartTime

PVR.TimeshiftProgressStartTime(format) string

Returns
The start time of the PVR timeshift progress in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.

PVR.TimeshiftProgressEndTime string

Returns
The end time of the PVR timeshift progress in the format hh:mm:ss.
Note
hh: will be omitted if hours value is zero.

v18 Skinning engine changes:
[New Infolabel] PVR.TimeshiftProgressEndTime

PVR.TimeshiftProgressEndTime(format) string

Returns
The end time of the PVR timeshift progress in different formats.
Parameters
format[opt] The format of the return time value. See TIME_FORMAT for the list of possible values.


RDS

Note
Only supported if both the PVR backend and the Kodi client support RDS.

Labels Type

Description

RDS.HasRds boolean

Returns
True if RDS is present.

v16 Skinning engine changes:
[New Boolean Condition] RDS.HasRds

RDS.HasRadioText boolean

Returns
True if RDS contains also Radiotext.

v16 Skinning engine changes:
[New Boolean Condition] RDS.HasRadioText

RDS.HasRadioTextPlus boolean

Returns
True if RDS with Radiotext contains also the plus information.

v16 Skinning engine changes:
[New Boolean Condition] RDS.HasRadioTextPlus

RDS.HasHotline boolean

Returns
True if a hotline phone number is present.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Boolean Condition] RDS.HasHotline

RDS.HasStudio boolean

Returns
True if a studio name is present.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Boolean Condition] RDS.HasStudio

RDS.AudioLanguage string

Returns
The RDS reported audio language of the channel.

v16 Skinning engine changes:
[New Infolabel] RDS.AudioLanguage

RDS.ChannelCountry string

Returns
The country where the radio channel is broadcasted.

v16 Skinning engine changes:
[New Infolabel] RDS.ChannelCountry

RDS.GetLine(number) string

Returns
The last sent RDS text messages on given number.
Parameters
number- given number for RDS, 0 is the last and 4 rows are supported (0-3)

v16 Skinning engine changes:
[New Infolabel] RDS.GetLine(number)

RDS.Title string

Returns
The title of item; e.g. track title of an album.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.Title

RDS.Artist string

Returns
A person or band/collective generally considered responsible for the work.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.Artist

RDS.Band string

Returns
The band/orchestra/musician.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.Band

RDS.Composer string

Returns
The name of the original composer/author.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.Composer

RDS.Conductor string

Returns
The artist(s) who performed the work. In classical music this would be the conductor.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.Conductor

RDS.Album string

Returns
The album of the song.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.Album

RDS.TrackNumber string

Returns
The track number of the item on the album on which it was originally released.
Note
Only be available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.TrackNumber

RDS.RadioStyle string

Returns
The style of current played radio channel, it is always updated once the style changes, 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.

v16 Skinning engine changes:
[New Infolabel] RDS.RadioStyle

RDS.Comment string

Returns
The radio station comment string if available.
Note
Only available on RadiotextPlus)

v16 Skinning engine changes:
[New Infolabel] RDS.Comment

RDS.InfoNews string

Returns
The message / headline (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoNews

RDS.InfoNewsLocal string

Returns
The local information news sended from radio channel (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoNewsLocal

RDS.InfoStock string

Returns
The stock information; either as one part or as several distinct parts: "name 99latest value 99change 99high 99low 99volume" (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoStock

RDS.InfoStockSize string

Returns
The number of rows present in stock information.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoStockSize

RDS.InfoSport string

Returns
The result of a match; either as one part or as several distinct parts: "match 99result", e.g. "Bayern M√ľnchen : Borussia 995:5" (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoSport

RDS.InfoSportSize string

Returns
The number of rows present in sport information.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoSportSize

RDS.InfoLottery string

Returns
The raffle / lottery: "key word 99values" (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoLottery

RDS.InfoLotterySize string

Returns
The number of rows present in lottery information.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoLotterySize

RDS.InfoWeather string

Returns
The weather information (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoWeather

RDS.InfoWeatherSize string

Returns
The number of rows present in weather information.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoWeatherSize

RDS.InfoCinema string

Returns
The information about movies in cinema (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoCinema

RDS.InfoCinemaSize string

Returns
The number of rows present in cinema information.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoCinemaSize

RDS.InfoHoroscope string

Returns
The horoscope; either as one part or as two distinct parts: "key word 99text", e.g. "sign of the zodiac 99blablabla" (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoHoroscope

RDS.InfoHoroscopeSize string

Returns
The Number of rows present in horoscope information.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoHoroscopeSize

RDS.InfoOther string

Returns
Other information, not especially specified: "key word 99info" (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoOther

RDS.InfoOtherSize string

Returns
The number of rows present with other information.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.InfoOtherSize

RDS.ProgStation string

Returns
The name of the radio channel.
Note
becomes also set from epg if it is not available from RDS

v16 Skinning engine changes:
[New Infolabel] RDS.ProgStation

RDS.ProgNow string

Returns
The now playing program name.
Note
becomes also be set from epg if from RDS not available

v16 Skinning engine changes:
[New Infolabel] RDS.ProgNow

RDS.ProgNext string

Returns
The next played program name (if available).
Note
becomes also be set from epg if from RDS not available

v16 Skinning engine changes:
[New Infolabel] RDS.ProgNext

RDS.ProgHost string

Returns
The name of the host of the radio show.

v16 Skinning engine changes:
[New Infolabel] RDS.ProgHost

RDS.ProgEditStaff string

Returns
The name of the editorial staff; e.g. name of editorial journalist.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.ProgEditStaff

RDS.ProgHomepage string

Returns
The Link to radio station homepage
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.ProgHomepage

RDS.ProgStyle string

Returns
A human readable string about radiostyle defined from RDS or RBDS.

v16 Skinning engine changes:
[New Infolabel] RDS.ProgStyle

RDS.PhoneHotline string

Returns
The telephone number of the radio station's hotline.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.PhoneHotline

RDS.PhoneStudio string

Returns
The telephone number of the radio station's studio.
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.PhoneStudio

RDS.SmsStudio string

Returns
The sms number of the radio stations studio (to send directly a sms to the studio) (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.SmsStudio

RDS.EmailHotline string

Returns
The email address of the radio stations hotline (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.EmailHotline

RDS.EmailStudio string

Returns
The email address of the radio station's studio (if available).
Note
Only available on RadiotextPlus

v16 Skinning engine changes:
[New Infolabel] RDS.EmailStudio


Slideshow

Labels Type

Description

Slideshow.IsActive boolean

Returns
True if the picture slideshow is running.

Slideshow.IsPaused boolean

Returns
True if the picture slideshow is paused.

Slideshow.IsRandom boolean

Returns
True if the picture slideshow is in random mode.

Slideshow.IsVideo boolean

Returns
True if the picture slideshow is playing a video.

v13 Skinning engine changes:
[New Boolean Condition] Slideshow.IsVideo

Slideshow.Altitude string

Returns
The altitude in meters where the current picture was taken.
Note
This is the value of the EXIF GPSInfo.GPSAltitude tag.

Slideshow.Aperture string

Returns
The F-stop used to take the current picture.
Note
This is the value of the EXIF FNumber tag (hex code 0x829D).

Slideshow.Author string

Returns
The name of the person involved in writing about the current picture.
Note
This is the value of the IPTC Writer tag (hex code 0x7A).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Author

Slideshow.Byline string

Returns
The name of the person who created the current picture.
Note
This is the value of the IPTC Byline tag (hex code 0x50).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Byline

Slideshow.BylineTitle string

Returns
The title of the person who created the current picture.
Note
This is the value of the IPTC BylineTitle tag (hex code 0x55).

v13 Skinning engine changes:
[New Infolabel] Slideshow.BylineTitle

Slideshow.CameraMake string

Returns
The manufacturer of the camera used to take the current picture.
Note
This is the value of the EXIF Make tag (hex code 0x010F).

Slideshow.CameraModel string

Returns
The manufacturer's model name or number of the camera used to take the current picture.
Note
This is the value of the EXIF Model tag (hex code 0x0110).

Slideshow.Caption string

Returns
A description of the current picture.
Note
This is the value of the IPTC Caption tag (hex code 0x78).

Slideshow.Category string

Returns
The subject of the current picture as a category code.
Note
This is the value of the IPTC Category tag (hex code 0x0F).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Category

Slideshow.CCDWidth string

Returns
The width of the CCD in the camera used to take the current picture.
Note
This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).

v13 Skinning engine changes:
[New Infolabel] Slideshow.CCDWidth

Slideshow.City string

Returns
The city where the current picture was taken.
Note
This is the value of the IPTC City tag (hex code 0x5A).

v13 Skinning engine changes:
[New Infolabel] Slideshow.City

Slideshow.Colour string

Returns
the colour of the picture. It can have one of the following values:
  • "Colour"
  • "Black and White"

v13 Skinning engine changes:
[New Infolabel] Slideshow.Colour

Slideshow.CopyrightNotice string

Returns
The copyright notice of the current picture.
Note
This is the value of the IPTC Copyright tag (hex code 0x74).

v13 Skinning engine changes:
[New Infolabel] Slideshow.CopyrightNotice

Slideshow.Country string

Returns
The full name of the country where the current picture was taken.
Note
This is the value of the IPTC CountryName tag (hex code 0x65).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Country

Slideshow.CountryCode string

Returns
The country code of the country where the current picture was taken.
Note
This is the value of the IPTC CountryCode tag (hex code 0x64).

v13 Skinning engine changes:
[New Infolabel] Slideshow.CountryCode

Slideshow.Credit string

Returns
Who provided the current picture.
Note
This is the value of the IPTC Credit tag (hex code 0x6E).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Credit

Slideshow.DigitalZoom string

Returns
The digital zoom ratio when the current picture was taken.
Note
This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).

v13 Skinning engine changes:
[New Infolabel] Slideshow.DigitalZoom

Slideshow.EXIFComment string

Returns
A description of the current picture.
Note
This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.

Slideshow.EXIFDate string

Returns
The localized date of the current picture. The short form of the date is used.
Note
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.

v13 Skinning engine changes:
[New Infolabel] Slideshow.EXIFDate

Slideshow.EXIFDescription string

Returns
A short description of the current picture. The SlideComment, EXIFComment or Caption values might contain a longer description.
Note
This is the value of the EXIF ImageDescription tag (hex code 0x010E).

Slideshow.EXIFSoftware string

Returns
The name and version of the firmware used by the camera that took the current picture.
Note
This is the value of the EXIF Software tag (hex code 0x0131).

Slideshow.EXIFTime string

Returns
The date/timestamp of the current picture. The localized short form of the date and time is used.
Note
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 string

Returns
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...
Note
This is the value of the EXIF ExposureProgram tag (hex code 0x8822).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Exposure

Slideshow.ExposureBias string

Returns
The exposure bias of the current picture. Typically this is a number between -99.99 and 99.99.
Note
This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).

v13 Skinning engine changes:
[New Infolabel] Slideshow.ExposureBias

Slideshow.ExposureMode string

Returns
The exposure mode of the current picture. The possible values are:
  • "Automatic"
  • "Manual"
  • "Auto bracketing"
Note
This is the value of the EXIF ExposureMode tag (hex code 0xA402).

Slideshow.ExposureTime string

Returns
The exposure time of the current picture, in seconds.
Note
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 string

Returns
The file date of the current picture.

Slideshow.Filename string

Returns
The file name of the current picture.

Slideshow.Filesize string

Returns
The file size of the current picture.

Slideshow.FlashUsed string

Returns
The status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information.
Note
This is the value of the EXIF Flash tag (hex code 0x9209).

v13 Skinning engine changes:
[New Infolabel] Slideshow.FlashUsed

Slideshow.FocalLength string

Returns
The focal length of the lens, in mm.
Note
This is the value of the EXIF FocalLength tag (hex code 0x920A).

Slideshow.FocusDistance string

Returns
The distance to the subject, in meters.
Note
This is the value of the EXIF SubjectDistance tag (hex code 0x9206).

Slideshow.Headline string

Returns
A synopsis of the contents of the current picture.
Note
This is the value of the IPTC Headline tag (hex code 0x69).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Headline

Slideshow.ImageType string

Returns
The color components of the current picture.
Note
This is the value of the IPTC ImageType tag (hex code 0x82).

v13 Skinning engine changes:
[New Infolabel] Slideshow.ImageType

Slideshow.IPTCDate string

Returns
The date when the intellectual content of the current picture was created, rather than when the picture was created.
Note
This is the value of the IPTC DateCreated tag (hex code 0x37).

Slideshow.ISOEquivalence string

Returns
The ISO speed of the camera when the current picture was taken.
Note
This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).

Slideshow.Keywords string

Returns
The keywords assigned to the current picture.
Note
This is the value of the IPTC Keywords tag (hex code 0x19).

Slideshow.Latitude string

Returns
The latitude where the current picture was taken (degrees, minutes, seconds North or South).
Note
This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.

Slideshow.LightSource string

Returns
The kind of light source when the picture was taken. Possible values include:
  • "Daylight"
  • "Fluorescent"
  • "Incandescent"
  • etc...
Note
This is the value of the EXIF LightSource tag (hex code 0x9208).

v13 Skinning engine changes:
[New Infolabel] Slideshow.LightSource

Slideshow.LongEXIFDate string

Returns
Only the localized date of the current picture. The long form of the date is used.
Note
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.

v13 Skinning engine changes:
[New Infolabel] Slideshow.LongEXIFDate

Slideshow.LongEXIFTime string

Returns
The date/timestamp of the current picture. The localized long form of the date and time is used.
Note
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.

v13 Skinning engine changes:
[New Infolabel] Slideshow.LongEXIFTime

Slideshow.Longitude string

Returns
The longitude where the current picture was taken (degrees, minutes, seconds East or West).
Note
This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.

Slideshow.MeteringMode string

Returns
The metering mode used when the current picture was taken. The possible values are:
  • "Center weight"
  • "Spot"
  • "Matrix"
Note
This is the value of the EXIF MeteringMode tag (hex code 0x9207).

v13 Skinning engine changes:
[New Infolabel] Slideshow.MeteringMode

Slideshow.ObjectName string

Returns
a shorthand reference for the current picture.
Note
This is the value of the IPTC ObjectName tag (hex code 0x05).

v13 Skinning engine changes:
[New Infolabel] Slideshow.ObjectName

Slideshow.Orientation string

Returns
The orientation of the current picture. Possible values are:
  • "Top Left"
  • "Top Right"
  • "Left Top"
  • "Right Bottom"
  • etc...
Note
This is the value of the EXIF Orientation tag (hex code 0x0112).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Orientation

Slideshow.Path string

Returns
The file path of the current picture.

Slideshow.Process string

Returns
The process used to compress the current picture.

v13 Skinning engine changes:
[New Infolabel] Slideshow.Process

Slideshow.ReferenceService string

Returns
The Service Identifier of a prior envelope to which the current picture refers.
Note
This is the value of the IPTC ReferenceService tag (hex code 0x2D).

v13 Skinning engine changes:
[New Infolabel] Slideshow.ReferenceService

Slideshow.Resolution string

Returns
The dimensions of the current picture (Width x Height)

Slideshow.SlideComment string

Returns
A description of the current picture.
Note
This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.

Slideshow.SlideIndex string

Returns
The slide index of the current picture.

Slideshow.Source string

Returns
The original owner of the current picture.
Note
This is the value of the IPTC Source tag (hex code 0x73).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Source

Slideshow.SpecialInstructions string

Returns
Other editorial instructions concerning the use of the current picture.
Note
This is the value of the IPTC SpecialInstructions tag (hex code 0x28).

v13 Skinning engine changes:
[New Infolabel] Slideshow.SpecialInstructions

Slideshow.State string

Returns
The State/Province where the current picture was taken.
Note
This is the value of the IPTC ProvinceState tag (hex code 0x5F).

v13 Skinning engine changes:
[New Infolabel] Slideshow.State

Slideshow.Sublocation string

Returns
The location within a city where the current picture was taken - might indicate the nearest landmark.
Note
This is the value of the IPTC SubLocation tag (hex code 0x5C).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Sublocation

Slideshow.SupplementalCategories string

Returns
The supplemental category codes to further refine the subject of the current picture.
Note
This is the value of the IPTC SuppCategory tag (hex code 0x14).

v13 Skinning engine changes:
[New Infolabel] Slideshow.SupplementalCategories

Slideshow.TimeCreated string

Returns
The time when the intellectual content of the current picture was created, rather than when the picture was created.
Note
This is the value of the IPTC TimeCreated tag (hex code 0x3C).

v13 Skinning engine changes:
[New Infolabel] Slideshow.TimeCreated

Slideshow.TransmissionReference string

Returns
A code representing the location of original transmission of the current picture.
Note
This is the value of the IPTC TransmissionReference tag (hex code 0x67).

v13 Skinning engine changes:
[New Infolabel] Slideshow.TransmissionReference

Slideshow.Urgency string

Returns
The urgency of the current picture. Values are 1-9. The 1 is most urgent.
Note
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).

v13 Skinning engine changes:
[New Infolabel] Slideshow.Urgency

Slideshow.WhiteBalance string

Returns
The white balance mode set when the current picture was taken. The possible values are:
  • "Manual"
  • "Auto"
Note
This is the value of the EXIF WhiteBalance tag (hex code 0xA403).

v13 Skinning engine changes:
[New Infolabel] Slideshow.WhiteBalance


Library

Todo:
Make this annotate an array of infobools/labels to make it easier to track

Labels Type

Description

Library.IsScanning boolean

Returns
True if the library is being scanned.

Library.IsScanningVideo boolean

Returns
True if the video library is being scanned.

Library.IsScanningMusic boolean

Returns
True if the music library is being scanned.

Library.HasContent(music) boolean

Returns
True if the library has music content.

Library.HasContent(video) boolean

Returns
True if the library has video content.

Library.HasContent(movies) boolean

Returns
True if the library has movies.

Library.HasContent(tvshows) boolean

Returns
True if the library has tvshows.

Library.HasContent(musicvideos) boolean

Returns
True if the library has music videos.

Library.HasContent(moviesets) boolean

Returns
True if the library has movie sets.

Library.HasContent(singles) boolean

Returns
True if the library has singles.

Library.HasContent(compilations) boolean

Returns
True if the library has compilations.

Library.HasContent(Role.Composer) boolean

Returns
True if there are songs in the library which have composers.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.Composer)

Library.HasContent(Role.Conductor) boolean

Returns
True if there are songs in the library which have a conductor.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.Conductor)

Library.HasContent(Role.Orchestra) boolean

Returns
True if there are songs in the library which have an orchestra.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.Orchestra)

Library.HasContent(Role.Lyricist) boolean

Returns
True if there are songs in the library which have a lyricist.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.Lyricist)

Library.HasContent(Role.Remixer) boolean

Returns
True if there are songs in the library which have a remixer.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.Remixer)

Library.HasContent(Role.Arranger) boolean

Returns
True if there are songs in the library which have an arranger.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.Arranger)

Library.HasContent(Role.Engineer) boolean

Returns
True if there are songs in the library which have an engineer.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.Engineer)

Library.HasContent(Role.Producer) boolean

Returns
True if there are songs in the library which have an producer.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.Producer)

Library.HasContent(Role.DJMixer) boolean

Returns
True if there are songs in the library which have a DJMixer.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.DJMixer)

Library.HasContent(Role.Mixer) boolean

Returns
True if there are songs in the library which have a mixer.

v17 Skinning engine changes:
[New Boolean Condition] Library.HasContent(Role.Mixer)

Library.HasContent(boxsets) boolean

Returns
True if there are albums in the library which are boxsets.

v19 Skinning engine changes:
[New Boolean Condition] Library.HasContent(boxsets)

Library.HasNode(path) boolean

Returns
True if there the node is present in the library.

v19 Skinning engine changes:
[New Boolean Condition] Library.HasNode(path)


Additional revision history for Infolabels and Boolean Conditions


Kodi v19 (Matrix)

v19 Skinning engine changes:
[Removed Infolabels] The following infolabels have been removed:

Kodi v18 (Leia)

v18 Skinning engine changes:
[Removed Infolabels] The following infolabels have been removed:
  • Listitem.Property(artistthumbs), Listitem.Property(artistthumb) - use ListItem.Art(type) with albumartist[n].* or artist[n].* as type
  • ADSP.ActiveStreamType
  • ADSP.DetectedStreamType
  • ADSP.MasterName
  • ADSP.MasterInfo
  • ADSP.MasterOwnIcon
  • ADSP.MasterOverrideIcon
  • ListItem.ChannelNumber, ListItem.SubChannelNumber, MusicPlayer.ChannelNumber, MusicPlayer.SubChannelNumber, VideoPlayer.ChannelNumber, VideoPlayer.SubChannelNumber. Please use the following alternatives ListItem.ChannelNumberLabel , MusicPlayer.ChannelNumberLabel VideoPlayer.ChannelNumberLabel from now on.
v18 Skinning engine changes:
[Removed Boolean Conditions] The following infobools have been removed:

Kodi v17 (Krypton)

v17 Skinning engine changes:
[Removed Infolabels] The following infolabels have been removed:
  • ListItem.StarRating - use the other ratings instead.
v17 Skinning engine changes:
[Removed Boolean Conditions] The following infobools have been removed:
  • on - use true instead
  • off - use false instead
  • Player.ShowCodec
  • System.GetBool(pvrmanager.enabled)

Kodi v16 (Jarvis)

v16 Skinning engine changes:
[New Boolean Conditions] The following infobools were added:
  • System.HasADSP
  • ADSP.IsActive
  • ADSP.HasInputResample
  • ADSP.HasPreProcess
  • ADSP.HasMasterProcess
  • ADSP.HasPostProcess
  • ADSP.HasOutputResample
  • ADSP.MasterActive
  • System.HasModalDialog
v16 Skinning engine changes:
[New Infolabels] The following infolabels were added:
  • ADSP.ActiveStreamType
  • ADSP.DetectedStreamType
  • ADSP.MasterName
  • ADSP.MasterInfo
  • ADSP.MasterOwnIcon
  • ADSP.MasterOverrideIcon
v16 Skinning engine changes:
[Removed Boolean Conditions] The following infobols were removed:
  • System.Platform.ATV2

Kodi v15 (Isengard)


Kodi v14 (Helix)

v14 Skinning engine changes:
[New Infolabels] The following infolabels were added:
  • ListItem.SubChannelNumber
  • MusicPlayer.SubChannelNumber
  • VideoPlayer.SubChannelNumber

XBMC v13 (Gotham)

v13 Skinning engine changes:
[Removed Infolabels] The following infolabels were removed:
  • Network.SubnetAddress