InfoLabels: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
Hitcher (talk | contribs)
Hitcher (talk | contribs)
Update info labels from Doxygen
 
(22 intermediate revisions by 3 users not shown)
Line 5: Line 5:


=== Addon ===
=== Addon ===
{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
! InfoLabels
! InfoLabels
Line 17: Line 16:
:'''addon_id''' - The id of the addon
:'''addon_id''' - The id of the addon
:'''setting_id''' - The addon setting
:'''setting_id''' - The addon setting
{{highlight|'''Note'''
{{highlight|'''Note'''<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
The provided setting with <code>setting_id</code> must be an integer setting type.<br>
Otherwise it will return the integer info default value (which is 0).}}
Otherwise it will return the integer info default value (which is 0).}}
Line 32: Line 31:


=== Container ===
=== Container ===
{{highlight|'''Note'''
{{highlight|'''Note'''<br>
If no <code>id</code> is specified it grabs the current container.}}
If no <code>id</code> is specified it grabs the current container.}}
{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
! InfoLabels
! InfoLabels
Line 60: Line 58:
'''Parameters'''
'''Parameters'''
:'''offset''' - The offset for the listitem.
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
'''Example:''' <code>Container(50).Listitem(2).Label</code>}}
Line 70: Line 68:
'''Parameters'''
'''Parameters'''
:'''x''' - The absolute position in the container.
:'''x''' - The absolute position in the container.
{{highlight|'''Note'''
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|
Line 80: Line 78:
'''Parameters'''
'''Parameters'''
:'''offset''' - The offset for the listitem.
:'''offset''' - The offset for the listitem.
{{highlight|'''Note'''
{{highlight|'''Note'''<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
<code>Property</code> has to be replaced with <code>Label</code>, <code>Label2</code>, <code>Icon</code>, etc.<br>
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
'''Example''': <code>Container(50).ListitemNoWrap(1).Plot</code>}}
Line 90: Line 88:
'''Parameters'''
'''Parameters'''
:'''x''' - The position in the container relative to the cursor position.
:'''x''' - The position in the container relative to the cursor position.
{{highlight|'''Note'''
{{highlight|'''Note'''<br>
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
'''Example:''' <code>Container(50).ListItemAbsolute(4).Genre</code>}}
|
|
Line 123: Line 121:
:The row number of the focused position in a panel container.
:The row number of the focused position in a panel container.
|
|
|-
|  <code>Container(id).TotalUnWatched</code>
|  '''Returns'''
:The number of unwatched items in the container.
|  [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
|  <code>Container(id).TotalWatched</code>
|  '''Returns'''
:The number of watched items in the container.
|  [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
|-
|  <code>Container.Art(type)</code>
|  <code>Container.Art(type)</code>
Line 129: Line 137:
'''Parameters'''
'''Parameters'''
:'''type''' - The art type to request.
:'''type''' - The art type to request.
{{highlight|'''Todo'''
{{highlight|'''Todo'''<br>
List of all art types.}}
List of all art types.}}
|  [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
|  [https://forum.kodi.tv/showthread.php?tid=231270&pid=2095396#pid2095396 v16]
Line 188: Line 196:
:The current sort order (Ascending/Descending).
:The current sort order (Ascending/Descending).
|  [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|  [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052012#pid2052012 v16]
|-
|  <code>Container(id).TotalUnWatched</code>
|  '''Returns'''
:The number of unwatched items in the container.
|  [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
|  <code>Container(id).TotalWatched</code>
|  '''Returns'''
:The number of watched items in the container.
|  [https://forum.kodi.tv/showthread.php?tid=231270&pid=2052026#pid2052026 v16]
|-
|-
|  <code>Container.Totaltime</code>
|  <code>Container.Totaltime</code>
Line 216: Line 214:


=== Control ===
=== Control ===
{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
! InfoLabels
! InfoLabels
Line 232: Line 229:


=== Fanart ===
=== Fanart ===
{{highlight|'''Note'''
{{highlight|'''Note'''<br>
Colors are arranged Lightest to Darkest.}}
Colors are arranged Lightest to Darkest.}}
{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
! InfoLabels
! InfoLabels
Line 254: Line 250:


=== Game ===
=== Game ===
{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
! InfoLabels
! InfoLabels
Line 301: Line 296:
|}
|}


=== ListItem ===
=== Integer ===


{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
Line 308: Line 303:
! Version
! Version
|-
|-
|  <code>ListItem.AddonBroken</code>
|  <code>Integer.ValueOf(number)</code>
|  Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
|  <code>ListItem.AddonCreator</code>
|  '''Returns'''
|  '''Returns'''
:The name of the author the currently selected addon.
:An integer info label that represents the provided number
'''Parameters'''
:number - the number to compute
{{highlight|'''Note'''<br>Example: <code>Integer.ValueOf(4)</code> will be evaluated to 4.<br>Will return -1 if not able to convert the provided value to an integer. Example: <code>Integer.ValueOf(some string)</code> will evaluate to -1 as the provided argument is not an integer.}}
|
|}
 
=== ListItem ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|  <code>ListItem.AddonBroken</code>
|  Deprecated! use ListItem.AddonLifecycleDesc instead.
|
|-
|  <code>ListItem.AddonCreator</code>
|  '''Returns'''
:The name of the author the currently selected addon.
|
|
|-
|-
Line 360: Line 370:
|  '''Returns'''
|  '''Returns'''
:A brief changelog, taken from the addons' addon.xml file.
:A brief changelog, taken from the addons' addon.xml file.
|
|-
|  <code>ListItem.AddonOrigin</code>
|  '''Returns'''
:The name of the repository the add-on originates from.
|
|
|-
|-
Line 418: Line 433:
:*aac
:*aac
:*aac_latm
:*aac_latm
:*aac_lc*
:*aac_ltp*
:*aac_ssr*
:*ac3
:*ac3
:*aif
:*aif
Line 426: Line 444:
:*avc
:*avc
:*cdda
:*cdda
:*dca
:*dca**
:*dts***
:*dolbydigital
:*dolbydigital
:*dts
:*dtshd_hra
:*dtshd_hra
:*dtshd_ma
:*dtshd_ma
Line 437: Line 455:
:*eac3_ddp_atmos*
:*eac3_ddp_atmos*
:*flac
:*flac
:*he_aac*
:*he_aac_v2*
:*mp1
:*mp1
:*mp2
:*mp3
:*mp3
:*mp3float
:*mp3float
Line 453: Line 474:
:*wmapro
:*wmapro
:*wmav2
:*wmav2
:
: ** note: dca replaced dts in 2011. Deprecated in 2026 / v22.
: *** note: dts used before 2011 and reintroduced in 2026 / v22.
| *v22
| *v22
|-
|-
Line 474: Line 498:
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
|
|
|-
|  <code>ListItem.Cast(separator)</code>
|  '''Returns'''
:A list of cast members, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|-
| <code>ListItem.CastAndRole</code>
| <code>ListItem.CastAndRole</code>
|  '''Returns'''
|  '''Returns'''
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
:The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
|
|-
|  <code>ListItem.CastAndRole(separator)</code>
|  '''Returns'''
:A list of cast members and roles, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|  <code>ListItem.ChannelGroup</code>
|  '''Returns'''
:The channel group of the selected item ( PVR ).
|
|
|-
|-
Line 538: Line 577:
|  '''Returns'''
|  '''Returns'''
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
:The date the currently selected item was added to the library or date and time of an event in the EventLog window.
|
|-
|  <code>ListItem.DateTime</code>
|  '''Returns'''
:The date and time a certain event happened (event log).
|
|
|-
|-
Line 547: Line 591:
| <code>ListItem.DBTYPE</code>
| <code>ListItem.DBTYPE</code>
|  '''Returns'''
|  '''Returns'''
:The database type of the ListItem.DBID for videos (video, movie, set, TV show, season, episode, musicvideo) or for audio (music, song, album, artist).
:The database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist).
{{highlight|'''Note'''<br>
{{highlight|'''Note'''<br>
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.}}
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.}}
|
|-
| <code>ListItem.DecodedFileNameAndPath</code>
|  '''Returns'''
:The full path with filename of the currently selected song or movie in a container decoded.
|
|-
|  <code>ListItem.Developer</code>
|  '''Returns'''
:The game developer (e.g. "Square") (RETROPLAYER).
|
|
|-
|-
Line 556: Line 610:
:The director of the currently selected movie in a container.
:The director of the currently selected movie in a container.
|
|
|-
|  <code>ListItem.Director(separator)</code>
|  '''Returns'''
:A list of directors, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|-
| <code>ListItem.DiscNumber</code>
| <code>ListItem.DiscNumber</code>
Line 585: Line 644:
|  '''Returns'''
|  '''Returns'''
:The time a video will end if you resume it, instead of playing it from the beginning.
:The time a video will end if you resume it, instead of playing it from the beginning.
|
|-
|  <code>ListItem.EpgEventTitle</code>
|  '''Returns'''
:The title of the epg event associated with the item, if any.
|
|
|-
|-
Line 595: Line 659:
|  '''Returns'''
|  '''Returns'''
:The name of the episode if the selected EPG item is a TV Show (PVR).
:The name of the episode if the selected EPG item is a TV Show (PVR).
|
|-
|  <code>ListItem.EpisodePart</code>
|  '''Returns'''
:string containing the number of parts of a single episode - empty if no data provided
|
|-
|  <code>ListItem.ExpirationDate</code>
|  '''Returns'''
:The expiration date of the selected item in a container, empty string if not supported.
|
|-
|  <code>ListItem.ExpirationTime</code>
|  '''Returns'''
:The expiration time of the selected item in a container, empty string if not supported
|
|
|-
|-
Line 625: Line 704:
|  '''Returns'''
|  '''Returns'''
:The complete path of the currently selected song or movie in a container (without user details).
:The complete path of the currently selected song or movie in a container (without user details).
|
|-
|  <code>ListItem.GameClient</code>
|  '''Returns'''
:The add-on ID of the game client (a.k.a. emulator) to use for playing the game (e.g. game.libretro.fceumm) (RETROPLAYER).
|
|
|-
|-
Line 630: Line 714:
|  '''Returns'''
|  '''Returns'''
:The genre of the currently selected song, album, or movie in a container.
:The genre of the currently selected song, album, or movie in a container.
|
|-
|  <code>ListItem.Genre(separator)</code>
|  '''Returns'''
:A list of genres, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos or music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|  <code>ListItem.Genres</code>
|  '''Returns'''
:The game genres (e.g. "["Action","Strategy"]") (RETROPLAYER).
|
|-
|  <code>ListItem.HdrDetail</code>
|  '''Returns'''
:String containing details for the HDR type (currently only for DV - profile and EL type) or empty if not HDR. Prints eg 5, 7FEL, and compatibility ID for profile 8 eg 8.4.
|
|
|-
|-
Line 655: Line 754:
|  '''Returns'''
|  '''Returns'''
:The last play date of video in a container.
:The last play date of video in a container.
|
|-
|  <code>ListItem.MediaProviders</code>
|  '''Returns'''
:string containing the names of the media providers of the item, separated by commas if multiple are present.
|
|
|-
|-
Line 691: Line 795:
:The genre of the next item (PVR).
:The genre of the next item (PVR).
|
|
|-
|  <code>ListItem.NextGenre(separator)</code>
|  '''Returns'''
:A list of genres of the the next item (PVR), separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|-
| <code>ListItem.NextPlot</code>
| <code>ListItem.NextPlot</code>
Line 725: Line 834:
|  '''Returns'''
|  '''Returns'''
:The original title of the currently selected movie in a container.
:The original title of the currently selected movie in a container.
|
|-
|  <code>ListItem.Overview</code>
|  '''Returns'''
:The game overview/summary (RETROPLAYER).
|
|-
|  <code>ListItem.ParentalRating</code>
|  '''Returns'''
:The parental rating of the list item ( PVR ).
|
|
|-
|-
Line 1,020: Line 1,139:
|  '''Returns'''
|  '''Returns'''
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
:The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
|  <code>ListItem.Platform</code>
|  '''Returns'''
:The game platform (e.g. "Atari 2600") (RETROPLAYER).
|
|
|-
|-
Line 1,279: Line 1,403:
| <code>ListItem.Property(Stream.Bitrate)</code>
| <code>ListItem.Property(Stream.Bitrate)</code>
|  '''Returns'''
|  '''Returns'''
:The video bitrate of the currently playing video.
:The video bitrate (kbps) of the currently playing video.
| v22
| v22
|-
|-
Line 1,289: Line 1,413:
| <code>ListItem.Property(Stream.Codec)</code>
| <code>ListItem.Property(Stream.Codec)</code>
|  '''Returns'''
|  '''Returns'''
:The video codec of the currently playing video.
:The audio, video, or subtitle codec of the currently playing video.
| v22
| v22
|-
|-
| <code>ListItem.Property(Stream.CodecDesc)</code>
| <code>ListItem.Property(Stream.CodecDesc)</code>
|  '''Returns'''
|  '''Returns'''
:The audio codec of the currently playing video.
:The audio description of the currently playing video.
| v22
| v22
|-
|-
| <code>ListItem.Property(Stream.Description)</code>
| <code>ListItem.Property(Stream.Description)</code>
|  '''Returns'''
|  '''Returns'''
:The audio description of the currently playing video.
:The audio, video, or subtitle title/name of the currently playing video.
| v22
| v22
|-
|-
Line 1,324: Line 1,448:
| <code>ListItem.Property(Stream.StereoMode)</code>
| <code>ListItem.Property(Stream.StereoMode)</code>
|  '''Returns'''
|  '''Returns'''
:The stereomode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
:The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
| v22
| v22
|-
|-
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
| <code>ListItem.Property(SubtitleLanguage.[n])</code>
|  '''Returns'''
|  '''Returns'''
:The subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
|
|
|-
|-
Line 1,350: Line 1,474:
|  '''Returns'''
|  '''Returns'''
:The number of watched episodes for the currently selected TV show or season.
:The number of watched episodes for the currently selected TV show or season.
|
|-
|  <code>ListItem.Publisher</code>
|  '''Returns'''
:The game publisher (e.g. "Nintendo") (RETROPLAYER).
|
|
|-
|-
Line 1,357: Line 1,486:
| v22
| v22
|-
|-
| <code>ListItem.PVRInstanceName</code>
|  <code>ListItem.PVRGroupOrigin</code>
|  '''Returns'''
:If selected item is of type PVR channel group, the creator (user, system, client) of the group.
|
|-
| <code>ListItem.PVRInstanceName</code>
|  '''Returns'''
|  '''Returns'''
:The name of the instance of the PVR client addon for the selected PVR list item.
:The name of the instance of the PVR client addon for the selected PVR list item.
Line 1,400: Line 1,534:
|  '''Returns'''
|  '''Returns'''
:The file size of the currently selected song or movie in a container.
:The file size of the currently selected song or movie in a container.
|
|-
|  <code>ListItem.SongVideoURL</code>
|  '''Returns'''
:Link to a video of a song
|
|
|-
|-
Line 1,455: Line 1,594:
|  '''Returns'''
|  '''Returns'''
:The small summary of current video in a container.
:The small summary of current video in a container.
|
|-
|  <code>ListItem.TimerType</code>
|  '''Returns'''
:The type of the PVR timer / timer rule item as a human readable string.
|
|
|-
|-
Line 1,460: Line 1,604:
|  '''Returns'''
|  '''Returns'''
:The title of the currently selected song or movie in a container.
:The title of the currently selected song or movie in a container.
|
|-
|  <code>ListItem.TitleExtraInfo</code>
|  '''Returns'''
:string containing extra information, enriching the title of the item.
|
|
|-
|-
Line 1,562: Line 1,711:
:*wvc1
:*wvc1
:*xvid
:*xvid
|
|-
|  <code>ListItem.VideoHeight</code>
|  '''Returns'''
:String containing height of video in pixels - empty if unknown.
|
|
|-
|-
Line 1,583: Line 1,737:
:The name of the video version.
:The name of the video version.
| v21
| v21
|-
|  <code>ListItem.VideoWidth</code>
|  '''Returns'''
:String containing width of video in pixels - empty if unknown.
|
|-
|-
| <code>ListItem.Votes[(name)]</code>
| <code>ListItem.Votes[(name)]</code>
Line 1,593: Line 1,752:
:The name of Writer of current video in a container.
:The name of Writer of current video in a container.
|
|
|-
|  <code>ListItem.Writer(separator)</code>
|  '''Returns'''
:A list of writers, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|-
| <code>ListItem.Year</code>
| <code>ListItem.Year</code>
Line 1,599: Line 1,763:
|}
|}


=== MusicPartyMode labels ===
=== MusicPartyMode ===
 
{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
! InfoLabels
! InfoLabels
Line 1,606: Line 1,769:
! Version
! Version
|-
|-
|  <code>MusicPartyMode.SongsPlayed</code>
|  <code>MusicPartyMode.MatchingSongs</code>
|  '''Returns'''
|  '''Returns'''
:The number of songs played during Party Mode.
:The number of songs available to Party Mode.
|
|
|-
|-
|  <code>MusicPartyMode.MatchingSongs</code>
|  <code>MusicPartyMode.MatchingSongsLeft</code>
|  '''Returns'''
|  '''Returns'''
:The number of songs available to Party Mode.
:The number of songs left to be picked from for Party Mode.
|
|
|-
|-
Line 1,621: Line 1,784:
|
|
|-
|-
|  <code>MusicPartyMode.MatchingSongsLeft</code>
|  <code>MusicPartyMode.RandomSongsPicked</code>
|  '''Returns'''
|  '''Returns'''
:The number of songs left to be picked from for Party Mode.
:The number of unique random songs picked during Party Mode.
|
|
|-
|-
Line 1,631: Line 1,794:
|
|
|-
|-
|  <code>MusicPartyMode.RandomSongsPicked</code>
|  <code>MusicPartyMode.SongsPlayed</code>
|  '''Returns'''
|  '''Returns'''
:The number of unique random songs picked during Party Mode.
:The number of songs played during Party Mode.
|
|
|}
|}


=== Network labels ===
=== Network ===
 
{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
! InfoLabels
! InfoLabels
Line 1,644: Line 1,806:
! Version
! Version
|-
|-
|  <code>Network.IsDHCP</code>
|  <code>Network.DHCPAddress</code>
Network type is DHCP or FIXED
'''Returns'''
:The DHCP server ip address.
|
|
|-
|-
|  <code>Network.IPAddress</code>
|  <code>Network.DNS1Address</code>
|  The system's IP Address (<ipaddress> is returned as a string)
'''Returns'''
:The network dns server 1 address.
|
|
|-
|-
|  <code>Network.LinkState</code>
|  <code>Network.DNS2Address</code>
Network linkstate (e.g. 10mbit/100mbit etc).
'''Returns'''
:The network dns server 2 address.
|
|
|-
|-
|  <code>Network.MacAddress</code>
|  <code>Network.GatewayAddress</code>
|  The system's  mac address
'''Returns'''
:The network gateway address.
|
|
|-
|-
|  <code>Network.SubnetMask</code>
|  <code>Network.IPAddress</code>
Network subnet mask
'''Returns'''
:The system's IP Address. e.g. 192.168.1.15
|
|
|-
|-
|  <code>Network.GatewayAddress</code>
|  <code>Network.LinkState</code>
Network gateway address
'''Returns'''
:The network linkstate (e.g. 10mbit/100mbit etc).
|
|
|-
|-
|  <code>Network.DNS1Address</code>
|  <code>Network.MacAddress</code>
Network dns server 1 address
'''Returns'''
:The system's  mac address.
|
|
|-
|-
|  <code>Network.DNS2Address</code>
|  <code>Network.SubnetMask</code>
Network dns server 2 address
'''Returns'''
|
:The network subnet mask.
|-
|  <code>Network.DHCPAddress</code>
|  DHCP server ip address
|
|
|}
|}


=== Player labels ===
=== Player ===


{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
Line 1,688: Line 1,854:
! Version
! Version
|-
|-
|  <code>Player.FinishTime</code>
|  <code>Player.AudioDelay</code>
Time playing media will end
'''Returns'''
:The used audio delay with the format <code>%2.3f</code> s
|
|
|-
|-
|  <code>Player.FinishTime(format)</code>
|  <code>Player.Bookmarks</code>
Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
'''Returns'''
:The bookmarks of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
|
|
|-
|-
|  <code>Player.Chapter</code>
|  <code>Player.CacheLevel</code>
Current chapter of current playing media
'''Returns'''
:The used cache level as a string with an integer number.
|
|
|-
|-
|  <code>Player.ChapterCount</code>
|  <code>Player.ChapterName</code>
Total number of chapters of current playing media
'''Returns'''
:The name of currently used chapter if available.
|
|
|-
|-
|  <code>Player.Time</code>
|  <code>Player.Cuts</code>
Elapsed time of current playing media
'''Returns'''
:The EDL cut markers of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
|
|
|-
|-
|  <code>Player.Time(format)</code>
|  <code>Player.Editlist</code>
Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
'''Returns'''
:The editlist of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
{{highlight|'''Note'''<br>This infolabel does not contain EDL cuts. Edits start and end times are adjusted according to cuts defined for the media item.}}
|
|
|-
|-
|  <code>Player.TimeRemaining</code>
|  <code>Player.offset(number).Filename</code>
Remaining time of current playing media
'''Returns'''
:The filename of audio or video file which has an offset <code>number</code> with respect to the currently playing item.
|
|
|-
|-
|  <code>Player.TimeRemaining(format)</code>
|  <code>Player.offset(number).FilenameAndPath</code>
Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
'''Returns'''
:The full path with filename of audio or video file which has an offset <code>number</code> with respect to the currently playing item.
|
|
|-
|-
|  <code>Player.Duration</code>
|  <code>Player.offset(number).Folderpath</code>
Total duration of the current playing media
'''Returns'''
:The full path of the audio or video file which has an offset <code>number</code> with respect to the currently playing item.
|
|
|-
|-
|  <code>Player.Duration(format)</code>
|  <code>Player.offset(number).Title</code>
Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
'''Returns'''
:The title of audio or video which has an offset <code>number</code> with respect to the currently playing item.
|
|
|-
|-
|  <code>Player.SeekTime</code>
|  <code>Player.position(number).Filename</code>
Time to which the user is seeking
'''Returns'''
:The filename of the audio or video file which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>Player.SeekBar</code>
|  <code>Player.position(number).FilenameAndPath</code>
Time to which the user is seeking as a percentage (for use in slider controls)
'''Returns'''
:The full path with filename of the audio or video file which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>Player.SeekOffset</code>
|  <code>Player.position(number).Folderpath</code>
Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
'''Returns'''
:The full path of the audio or video file which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>Player.SeekOffset(format)</code>
|  <code>Player.position(number).Title</code>
Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
'''Returns'''
:The title of the audio or video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>Player.SeekStepSize</code>
|  <code>Player.SceneMarkers</code>
Displays the seek step size. (v15 addition)
'''Returns'''
:The EDL scene markers of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
|
|
|-
|-
|  <code>Player.Progress</code>
|  <code>Player.SeekNumeric([format])</code>
Shows how much (percentage) of the file has been played
'''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.
|
|
|-
|-
|  <code>Player.ProgressCache</code>
|  <code>Player.SubtitleDelay</code>
Shows how much of the file is cached above current play percentage
'''Returns'''
:The used subtitle delay with the format <code>%2.3f</code> s
|
|
|-
|-
|  <code>Player.Folderpath</code>
|  <code>Player.TimeSpeed</code>
Shows the full path of the currently playing song or movie. (supports .offset() and .position())
'''Returns'''
:The time and the playspeed formatted: "1:23 (2x)".
|
|
|}
=== Player labels ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>Player.Filenameandpath</code>
|  <code>Player.Chapter</code>
Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
Current chapter of current playing media
|
|
|-
|-
|  <code>Player.StartTime</code>
|  <code>Player.ChapterCount</code>
Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
Total number of chapters of current playing media
|
|
|-
|-
|  <code>Player.StartTime(format)</code>
|  <code>Player.Chapters</code>
Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
|  v19
|-
|  <code>Player.CutList</code>
|  this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
|  v19
|-
|  <code>Player.Duration</code>
|  Total duration of the current playing media
|
|
|-
|-
|  <code>Player.Title</code>
|  <code>Player.Duration(format)</code>
Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|
|-
|-
Line 1,780: Line 1,982:
|
|
|-
|-
|  <code>Player.Volume</code>
|  <code>Player.Filenameandpath</code>
Returns the volume level in dB
Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
|
|
|-
|-
|  <code>Player.PlaySpeed</code>
|  <code>Player.FinishTime</code>
|  Current playspeed. (range:0.8 to 1.5)
|  Time playing media will end
|
|-
|  <code>Player.FinishTime(format)</code>
|  Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|-
|  <code>Player.Folderpath</code>
|  Shows the full path of the currently playing song or movie. (supports .offset() and .position())
|
|-
|  <code>Player.PlaySpeed</code>
|  Current playspeed. (range:0.8 to 1.5)
|
|
|-
|-
Line 1,793: Line 2,007:
|-
|-
|  <code>Player.Process(AudioChannels)</code>
|  <code>Player.Process(AudioChannels)</code>
Number of audiochannels of the currently playing item
List of audio channels of the currently playing item (e.g. FL+FR)
|
|
|-
|-
Line 1,814: Line 2,028:
|  <code>Player.Process(VideoDAR)</code>
|  <code>Player.Process(VideoDAR)</code>
|  Display aspect ratio of the currently playing video
|  Display aspect ratio of the currently playing video
|
|-
|  <code>Player.Process(VideoDecoder)</code>
|  Videodecoder name of the currently playing video
|
|
|-
|-
Line 1,824: Line 2,042:
|
|
|-
|-
|  <code>Player.Process(VideoDecoder)</code>
|  <code>Player.Process(VideoScanType)</code>
Videodecoder name of the currently playing video
The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
|
| v20
|-
|-
|  <code>Player.Process(VideoWidth)</code>
|  <code>Player.Process(VideoWidth)</code>
Line 1,832: Line 2,050:
|
|
|-
|-
|  <code>Player.Process(VideoScanType)</code>
|  <code>Player.Progress</code>
The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced)
Shows how much (percentage) of the file has been played
| v20
|
|-
|-
|  <code>Player.CutList</code>
|  <code>Player.ProgressCache</code>
this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
Shows how much of the file is cached above current play percentage
| v19
|
|-
|-
|  <code>Player.Chapters</code>
|  <code>Player.SeekBar</code>
this infolabel can be used with the [[Ranges Control]], as EDL and chapter markers
Time to which the user is seeking as a percentage (for use in slider controls)
| v19
|
|}
 
==== Music player ====
 
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>MusicPlayer.ParentalRatingCode</code>
|  <code>Player.SeekOffset</code>
Shows the parental rating code
Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
| v22
|
|-
|-
|  <code>MusicPlayer.ParentalRatingIcon</code>
|  <code>Player.SeekOffset(format)</code>
|  Shows the parental rating icon
|  Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
| v22
|
|-
|-
|  <code>MusicPlayer.ParentalRatingSource</code>
|  <code>Player.SeekStepSize</code>
Shows the parental rating source
Displays the seek step size. (v15 addition)
|  v22
|-
|  <code>MusicPlayer.ChannelLogo</code>
|  Shows the logo of the currently selected radio or TV channel
|  v22
|-
|  <code>MusicPlayer.Title</code>
|  Title of the currently playing song,  also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.Album</code>
|  <code>Player.SeekTime</code>
Album from which the current song is from,  also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
Time to which the user is seeking
|
|
|-
|-
|  <code>MusicPlayer.Property(Album_Mood)</code>
|  <code>Player.StartTime</code>
Shows the moods of the currently playing Album
Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
|
|
|-
|-
|  <code>MusicPlayer.Property(Album_Style)</code>
|  <code>Player.StartTime(format)</code>
|  Shows the styles of the currently playing Album
|  Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|
|-
|-
|  <code>MusicPlayer.Property(Album_Theme)</code>
|  <code>Player.Time</code>
Shows the themes of the currently playing Album
Elapsed time of current playing media
|
|
|-
|-
|  <code>MusicPlayer.Property(Album_Type)</code>
|  <code>Player.Time(format)</code>
|  Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|  Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|
|-
|-
|  <code>MusicPlayer.Property(Album_Label)</code>
|  <code>Player.TimeRemaining</code>
Shows the record label of the currently playing Album
Remaining time of current playing media
|
|
|-
|-
|  <code>MusicPlayer.Property(Album_Description)</code>
|  <code>Player.TimeRemaining(format)</code>
|  Shows a review of the currently playing Album
|  Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
|
|
|-
|-
|  <code>MusicPlayer.Artist</code>
|  <code>Player.Title</code>
Artist(s) of current song,  also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Born)</code>
|  <code>Player.Volume</code>
Date of Birth of the currently playing Artist
Returns the volume level in dB
|
|
|}
==== Music player ====
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>MusicPlayer.Property(Artist_Died)</code>
|  <code>MusicPlayer.AlbumArtist</code>
Date of Death of the currently playing Artist
'''Returns'''
:The album artist of the currently playing song.
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Formed)</code>
|  <code>MusicPlayer.LastPlayed</code>
Formation date of the currently playing Artist/Band
'''Returns'''
:The last play date of currently playing song, if it's in the database.
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Disbanded)</code>
|  <code>MusicPlayer.MediaProviders</code>
Disbanding date of the currently playing Artist/Band
'''Returns'''
:string containing the names of the providers of the currently playing media, separated by commas if multiple are present.
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_YearsActive)</code>
|  <code>MusicPlayer.offset(number).Album</code>
Years the currently Playing artist has been active
'''Returns'''
:The album from which the song with offset <code>number</code> with respect to the current song is from.
'''Parameters'''
:number - the offset number with respect to the current playing song
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Instrument)</code>
|  <code>MusicPlayer.offset(number).Artist</code>
Instruments played by the currently playing artist
'''Returns'''
:Artist(s) of the song which has an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset of the song with respect to the current playing song
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Description)</code>
|  <code>MusicPlayer.offset(number).Comment</code>
Shows a biography of the currently playing artist
'''Returns'''
:The Comment of current song stored in ID tag info for the song with an offset <code>number</code> with respect to the playing song.
'''Parameters'''
:number - The offset value for the song with respect to the playing song.
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Mood)</code>
|  <code>MusicPlayer.offset(number).DiscNumber</code>
Shows the moods of the currently playing artist
'''Returns'''
:The Disc Number of current song stored in ID tag info for the song with an offset <code>number</code> with respect to the playing song.
'''Parameters'''
:number - The offset value for the song with respect to the playing song.
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Style)</code>
|  <code>MusicPlayer.offset(number).Duration</code>
Shows the styles of the currently playing artist
'''Returns'''
:The duration of the song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset number of the song with respect to the current playing song
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Genre)</code>
|  <code>MusicPlayer.offset(number).Genre</code>
Shows the genre of the currently playing artist
'''Returns'''
:The genre(s) of the song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset song number with respect to the current playing song.
|
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Sortname)</code>
|  <code>MusicPlayer.offset(number).Rating</code>
Sortname of the currently playing Artist
'''Returns'''
| v18
:The numeric Rating of song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset with respect to the current playing song
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Type)</code>
|  <code>MusicPlayer.offset(number).Title</code>
Type of the currently playing Artist - person, group, orchestra, choir, etc.
'''Returns'''
v18
:The title of the song which has an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset number with respect to the current playing song
|
|-
|  <code>MusicPlayer.offset(number).TrackNumber</code>
|  '''Returns'''
:The track number of the song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - The offset number of the song with respect to the playing song
|
|-
|  <code>MusicPlayer.offset(number).Year</code>
'''Returns'''
:The year of release of the song with an offset <code>number</code> with respect to the current playing song.
'''Parameters'''
:number - the offset number with respect to the current song.
|
|-
|-
|  <code>MusicPlayer.Property(Artist_Gender)</code>
|  <code>MusicPlayer.ParentalRatingCode</code>
Gender of the currently playing Artist - male, female, other
Shows the parental rating code
v18
v22
|-
|-
|  <code>MusicPlayer.Property(Artist_Disambiguation)</code>
|  <code>MusicPlayer.ParentalRatingIcon</code>
Brief description of the currently playing Artist that differentiates them from others with the same name
Shows the parental rating icon
v18
v22
|-
|-
|  <code>MusicPlayer.Genre</code>
|  <code>MusicPlayer.ParentalRatingSource</code>
Genre(s) of current song,  also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
Shows the parental rating source
|
| v22
|-
|-
|  <code>MusicPlayer.Lyrics</code>
|  <code>MusicPlayer.ChannelLogo</code>
Lyrics of current song stored in ID tag info
Shows the logo of the currently selected radio or TV channel
|
| v22
|-
|-
|  <code>MusicPlayer.Year</code>
|  <code>MusicPlayer.PlayCount</code>
Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
'''Returns'''
:The play count of currently playing song, if it's in the database.
|
|
|-
|-
|  <code>MusicPlayer.Rating</code>
|  <code>MusicPlayer.Position(number).Album</code>
Numeric Rating of current song,  also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
'''Returns'''
:The album from which the song with offset <code>number</code> with respect to the start of the playlist is from.
'''Parameters'''
:number - the offset number with respect to the start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.DiscNumber</code>
|  <code>MusicPlayer.Position(number).Artist</code>
Disc Number of current song stored in ID tag info,  also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
'''Returns'''
:Artist(s) of the song which has an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset of the song with respect to the start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.Comment</code>
|  <code>MusicPlayer.Position(number).Comment</code>
|  Comment of current song stored in ID tag info,  also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
'''Returns'''
:The Comment of current song stored in ID tag info for the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - The offset value for the song with respect to the start of the playlist.
|
|
|-
|-
|  <code>MusicPlayer.Time</code>
|  <code>MusicPlayer.Position(number).DiscNumber</code>
Current time in song
'''Returns'''
:The Disc Number of current song stored in ID tag info for the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - The offset value for the song with respect to the start of the playlist.
|
|
|-
|-
|  <code>MusicPlayer.TimeRemaining</code>
|  <code>MusicPlayer.Position(number).Duration</code>
Current remaining time in song
'''Returns'''
:The duration of the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset number of the song with respect to the start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.TimeSpeed</code>
|  <code>MusicPlayer.Position(number).Genre</code>
Both the time and the playspeed formatted up. e.g. 1:23 (2x)
'''Returns'''
:The genre(s) of the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset song number with respect to the start of the playlist song.
|
|
|-
|-
|  <code>MusicPlayer.TrackNumber</code>
|  <code>MusicPlayer.Position(number).Rating</code>
Track number of current song,  also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
'''Returns'''
:The numeric Rating of song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset with respect to the start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.Duration</code>
|  <code>MusicPlayer.Position(number).Title</code>
Duration of current song,  also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
'''Returns'''
:The title of the song which as an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset number with respect to the start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.BitRate</code>
|  <code>MusicPlayer.Position(number).TrackNumber</code>
Bitrate of current song
'''Returns'''
:The track number of the song with an offset <code>number</code> with respect to start of the playlist.
'''Parameters'''
:number - The offset number of the song with respect to start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.Channels</code>
|  <code>MusicPlayer.Position(number).Year</code>
Number of channels of current song
'''Returns'''
:The year of release of the song with an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset number with respect to the start of the playlist.
|
|
|-
|-
|  <code>MusicPlayer.BitsPerSample</code>
|  <code>MusicPlayer.RatingAndVotes</code>
Number of bits per sample of current song
'''Returns'''
:The scraped rating and votes of currently playing song, if it's in the database.
|
|
|-
|-
|  <code>MusicPlayer.SampleRate</code>
|  <code>MusicPlayer.Station</code>
Samplerate of current song
'''Returns'''
:The name of the radio station currently playing (if available).
|
|
|-
|-
|  <code>MusicPlayer.Codec</code>
|  <code>MusicPlayer.Title</code>
Codec of current song
Title of the currently playing song,  also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.PlaylistPosition</code>
|  <code>MusicPlayer.Album</code>
Position of the current song in the current music playlist
Album from which the current song is from,  also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.PlaylistLength</code>
|  <code>MusicPlayer.Property(Album_Mood)</code>
Total size of the current music playlist
Shows the moods of the currently playing Album
|
|
|-
|-
|  <code>MusicPlayer.ChannelName</code>
|  <code>MusicPlayer.Property(Album_Style)</code>
Channel name of the radio programme that's currently playing (PVR).
Shows the styles of the currently playing Album
|
|
|-
|-
|  <code>MusicPlayer.ChannelNumberLabel</code>
|  <code>MusicPlayer.Property(Album_Theme)</code>
Channel and subchannel number of the radio channel that's currently playing (PVR).
Shows the themes of the currently playing Album
|
|
|-
|-
|  <code>MusicPlayer.ChannelGroup</code>
|  <code>MusicPlayer.Property(Album_Type)</code>
Channel group of  of the radio programme that's currently playing (PVR).
Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
|
|
|-
|-
|  <code>MusicPlayer.Contributors</code>
|  <code>MusicPlayer.Property(Album_Label)</code>
List of all people who've contributed to the currently playing song
Shows the record label of the currently playing Album
|
|
|-
|-
|  <code>MusicPlayer.ContributorAndRole</code>
|  <code>MusicPlayer.Property(Album_Description)</code>
List of all people and their role who've contributed to the currently playing song
Shows a review of the currently playing Album
|
|
|-
|-
|  <code>MusicPlayer.Mood</code>
|  <code>MusicPlayer.Artist</code>
Mood of the currently playing song
Artist(s) of current song,  also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.Arranger)</code>
|  <code>MusicPlayer.Property(Artist_Born)</code>
Returns the name of the person who arranged the selected song
Date of Birth of the currently playing Artist
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.Composer)</code>
|  <code>MusicPlayer.Property(Artist_Died)</code>
Returns the name of the person who composed the selected song
Date of Death of the currently playing Artist
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.Conductor)</code>
|  <code>MusicPlayer.Property(Artist_Formed)</code>
Returns the name of the person who conducted the selected song
Formation date of the currently playing Artist/Band
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.DJMixer)</code>
|  <code>MusicPlayer.Property(Artist_Disbanded)</code>
Returns the name of the dj who remixed the selected song
Disbanding date of the currently playing Artist/Band
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.Engineer)</code>
|  <code>MusicPlayer.Property(Artist_YearsActive)</code>
Returns the name of the person who was the engineer of the selected song
Years the currently Playing artist has been active
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.Lyricist)</code>
|  <code>MusicPlayer.Property(Artist_Instrument)</code>
Returns the name of the person who wrote the lyrics of the selected song
Instruments played by the currently playing artist
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.Mixer)</code>
|  <code>MusicPlayer.Property(Artist_Description)</code>
Returns the name of the person who mixed the selected song
Shows a biography of the currently playing artist
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.Orchestra)</code>
|  <code>MusicPlayer.Property(Artist_Mood)</code>
Returns the name of the orchestra performing the selected song
Shows the moods of the currently playing artist
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.Producer)</code>
|  <code>MusicPlayer.Property(Artist_Style)</code>
Returns the name of the person who produced the selected song
Shows the styles of the currently playing artist
|
|
|-
|-
|  <code>MusicPlayer.Property(Role.Remixer)</code>
|  <code>MusicPlayer.Property(Artist_Genre)</code>
Returns the name of the person who remixed the selected song
Shows the genre of the currently playing artist
|
|
|-
|-
|  <code>MusicPlayer.UserRating</code>
|  <code>MusicPlayer.Property(Artist_Sortname)</code>
The rating the user gave to the currently playing song
Sortname of the currently playing Artist
|
|  v18
|-
|  <code>MusicPlayer.Property(Artist_Type)</code>
|  Type of the currently playing Artist - person, group, orchestra, choir, etc.
| v18
|-
|-
|  <code>MusicPlayer.DBID</code>
|  <code>MusicPlayer.Property(Artist_Gender)</code>
The database id of the currently playing song
Gender of the currently playing Artist - male, female, other
v17
v18
|-
|-
|  <code>MusicPlayer.DiscTitle</code>
|  <code>MusicPlayer.Property(Artist_Disambiguation)</code>
The title of the disc currently playing
Brief description of the currently playing Artist that differentiates them from others with the same name
v19
v18
|-
|-
|  <code>MusicPlayer.ReleaseDate</code>
|  <code>MusicPlayer.Genre</code>
Returns the release date of the song currently playing
Genre(s) of current song,  also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
| v19
|
|-
|-
|  <code>MusicPlayer.OriginalDate</code>
|  <code>MusicPlayer.Genre(separator)</code>
|  Returns the original release date of the song currently playing
'''Returns'''
| v19
: A list of genres of current song, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|-
|  <code>MusicPlayer.BPM</code>
|  <code>MusicPlayer.Lyrics</code>
Returns the Beats Per Minute of the currently playing song
Lyrics of current song stored in ID tag info
| v19
|
|-
|-
|  <code>MusicPlayer.TotalDiscs</code>
|  <code>MusicPlayer.Votes</code>
|  Returns the number of discs associated with the album of the currently playing song
'''Returns'''
| v19
:The scraped votes of currently playing song, if it's in the database.
|}
|
 
==== Video player ====
 
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>VideoPlayer.AudioStreamCount</code>
|  <code>MusicPlayer.Year</code>
Returns the number of audio streams of the currently playing video
Year of release of current song,  also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
| v21
|
|-
|-
|  <code>VideoPlayer.VideoStreamCount</code>
|  <code>MusicPlayer.Rating</code>
Returns the number of video streams of the currently playing video
Numeric Rating of current song,  also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
| v22
|
|-
|-
|  <code>VideoPlayer.ParentalRatingCode</code>
|  <code>MusicPlayer.DiscNumber</code>
Shows the parental rating code
Disc Number of current song stored in ID tag info,  also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
| v22
|
|-
|-
|  <code>VideoPlayer.ParentalRatingIcon</code>
|  <code>MusicPlayer.Comment</code>
Shows the parental rating icon
Comment of current song stored in ID tag info,  also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
| v22
|
|-
|-
|  <code>VideoPlayer.ParentalRatingSource</code>
|  <code>MusicPlayer.Time</code>
Shows the parental rating source
Current time in song
| v22
|
|-
|-
|  <code>VideoPlayer.ChannelLogo</code>
|  <code>MusicPlayer.TimeRemaining</code>
Shows the logo of the currently selected radio or TV channel
Current remaining time in song
| v22
|
|-
|-
|  <code>VideoPlayer.VideoVersionName</code>
|  <code>MusicPlayer.TimeSpeed</code>
Show the name of the video version
Both the time and the playspeed formatted up. e.g. 1:23 (2x)
| v21
|
|-
|-
|  <code>VideoPlayer.Time</code>
|  <code>MusicPlayer.TrackNumber</code>
Current time in movie
Track number of current song,  also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
|
|
|-
|-
|  <code>VideoPlayer.TimeRemaining</code>
|  <code>MusicPlayer.Duration</code>
Current remaining time in movie
Duration of current song,  also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
|
|
|-
|-
|  <code>VideoPlayer.TimeSpeed</code>
|  <code>MusicPlayer.BitRate</code>
Current time + playspeed. e.g. 1:23:14 (-4x)
Bitrate of current song
|
|
|-
|-
|  <code>VideoPlayer.Duration</code>
|  <code>MusicPlayer.Channels</code>
Length of current movie
Number of channels of current song
|
|
|-
|-
|  <code>VideoPlayer.Title</code>
|  <code>MusicPlayer.BitsPerSample</code>
Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
Number of bits per sample of current song
|
|
|-
|-
|  <code>VideoPlayer.OriginalTitle</code>
|  <code>MusicPlayer.SampleRate</code>
The original title of currently playing video. (supports .offset() and .position())
Samplerate of current song
|
|
|-
|-
|  <code>VideoPlayer.TVShowTitle</code>
|  <code>MusicPlayer.Codec</code>
Title of currently playing episode's tvshow name. (supports .offset() and .position())
Codec of current song
|
|
|-
|-
|  <code>VideoPlayer.Season</code>
|  <code>MusicPlayer.PlaylistPosition</code>
Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
Position of the current song in the current music playlist
|
|
|-
|-
|  <code>VideoPlayer.Episode</code>
|  <code>MusicPlayer.PlaylistLength</code>
Episode number of the currently playing episode. (supports .offset() and .position())
Total size of the current music playlist
|
|
|-
|-
|  <code>VideoPlayer.Genre</code>
|  <code>MusicPlayer.ChannelName</code>
Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
Channel name of the radio programme that's currently playing (PVR).
|
|
|-
|-
|  <code>VideoPlayer.Director</code>
|  <code>MusicPlayer.ChannelNumberLabel</code>
Director of current movie, if it's in the database. (supports .offset() and .position())
Channel and subchannel number of the radio channel that's currently playing (PVR).
|
|
|-
|-
|  <code>VideoPlayer.Country</code>
|  <code>MusicPlayer.ChannelGroup</code>
Production country of current movie, if it's in the database. (supports .offset() and .position())
Channel group of of the radio programme that's currently playing (PVR).
|
|
|-
|-
|  <code>VideoPlayer.Year</code>
|  <code>MusicPlayer.Contributors</code>
Year of release of current movie, if it's in the database. (supports .offset() and .position())
List of all people who've contributed to the currently playing song
|
|
|-
|-
|  <code>VideoPlayer.Premiered</code>
|  <code>MusicPlayer.ContributorAndRole</code>
The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
List of all people and their role who've contributed to the currently playing song
|
|
|-
|-
|  <code>VideoPlayer.Rating</code>
|  <code>MusicPlayer.Mood</code>
IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
Mood of the currently playing song
|
|
|-
|-
|  <code>VideoPlayer.UserRating</code>
|  <code>MusicPlayer.Property(Role.Arranger)</code>
Shows the user rating of the currently playing item. (supports .offset() and .position())
Returns the name of the person who arranged the selected song
|
|
|-
|-
|  <code>VideoPlayer.Votes</code>
|  <code>MusicPlayer.Property(Role.Composer)</code>
IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
Returns the name of the person who composed the selected song
|
|
|-
|-
|  <code>VideoPlayer.RatingAndVotes</code>
|  <code>MusicPlayer.Property(Role.Conductor)</code>
IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
Returns the name of the person who conducted the selected song
|
|
|-
|-
|  <code>VideoPlayer.mpaa</code>
|  <code>MusicPlayer.Property(Role.DJMixer)</code>
MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
Returns the name of the dj who remixed the selected song
|
|
|-
|-
|  <code>VideoPlayer.IMDBNumber</code>
|  <code>MusicPlayer.Property(Role.Engineer)</code>
The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
Returns the name of the person who was the engineer of the selected song
|
|
|-
|-
|  <code>VideoPlayer.EpisodeName</code>
|  <code>MusicPlayer.Property(Role.Lyricist)</code>
(PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
Returns the name of the person who wrote the lyrics of the selected song
|
|
|-
|-
|  <code>VideoPlayer.PlaylistPosition</code>
|  <code>MusicPlayer.Property(Role.Mixer)</code>
Position of the current song in the current video playlist
Returns the name of the person who mixed the selected song
|
|
|-
|-
|  <code>VideoPlayer.PlaylistLength</code>
|  <code>MusicPlayer.Property(Role.Orchestra)</code>
Total size of the current video playlist
Returns the name of the orchestra performing the selected song
|
|
|-
|-
|  <code>VideoPlayer.Cast</code>
|  <code>MusicPlayer.Property(Role.Producer)</code>
A list of cast members, separated by carriage returns, if it's in the database
Returns the name of the person who produced the selected song
|
|
|-
|-
|  <code>VideoPlayer.CastAndRole</code>
|  <code>MusicPlayer.Property(Role.Remixer)</code>
A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
Returns the name of the person who remixed the selected song
|
|
|-
|-
|  <code>VideoPlayer.Trailer</code>
|  <code>MusicPlayer.UserRating</code>
|  The trailer of the current movie. (supports .offset() and .position())
|  The rating the user gave to the currently playing song
|
|
|-
|-
|  <code>VideoPlayer.Album</code>
|  <code>MusicPlayer.DBID</code>
Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
The database id of the currently playing song
|
|  v17
|-
|  <code>MusicPlayer.DiscTitle</code>
|  The title of the disc currently playing
|  v19
|-
|  <code>MusicPlayer.ReleaseDate</code>
|  Returns the release date of the song currently playing
|  v19
|-
|  <code>MusicPlayer.OriginalDate</code>
|  Returns the original release date of the song currently playing
|  v19
|-
|  <code>MusicPlayer.BPM</code>
|  Returns the Beats Per Minute of the currently playing song
|  v19
|-
|  <code>MusicPlayer.TotalDiscs</code>
| Returns the number of discs associated with the album of the currently playing song
|  v19
|}
 
=== RetroPlayer ===
 
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>VideoPlayer.Artist</code>
|  <code>RetroPlayer.Developer</code>
Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
'''Returns'''
:The developer of the currently-playing game (e.g. "Square").
|
|
|-
|-
|  <code>VideoPlayer.Studio</code>
|  <code>RetroPlayer.DiscLabel</code>
Studio of current Music Video, if it's in the database. (supports .offset() and .position())
'''Returns'''
:The human-readable label of the currently inserted disc, or an empty string if no disc is in the tray/floppy drive or the game isn't disc-based.
|
|
|-
|-
|  <code>VideoPlayer.Writer</code>
|  <code>RetroPlayer.GameClient</code>
Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
'''Returns'''
:The add-on ID of the game client (a.k.a. emulator) used to play the currently-playing game (e.g. <code>game.libretro.beetle-psx</code> ).
|
|
|-
|-
|  <code>VideoPlayer.Tagline</code>
|  <code>RetroPlayer.GameClientName</code>
Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
'''Returns'''
:The emulator/core name parsed from the game client's add-on name (e.g. <code>bsnes-mercury Performance</code> ).
|
|
|-
|-
|  <code>VideoPlayer.PlotOutline</code>
|  <code>RetroPlayer.GameClientPlatforms</code>
Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|  '''Returns'''
:The platform or platform group supported by the game client (e.g. an emulator might report "Nintendo - SNES / SFC / Game Boy / Color").
|
|
|-
|-
|  <code>VideoPlayer.Plot</code>
|  <code>RetroPlayer.Genres</code>
Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
'''Returns'''
:The genres of the currently-playing game, joined by ", ".
|
|
|-
|-
|  <code>VideoPlayer.Top250</code>
|  <code>RetroPlayer.Overview</code>
Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
'''Returns'''
:The overview/summary of the currently-playing game.
|
|
|-
|-
|  <code>VideoPlayer.LastPlayed</code>
|  <code>RetroPlayer.Platform</code>
Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
'''Returns'''
:The platform of the currently-playing game, or an empty string if the platform is unknown.
|
|
|-
|-
|  <code>VideoPlayer.PlayCount</code>
|  <code>RetroPlayer.Publisher</code>
Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
'''Returns'''
:The publisher of the currently-playing game (e.g. "Nintendo").
|
|
|-
|-
|  <code>VideoPlayer.HdrType</code>
|  <code>RetroPlayer.StretchMode</code>
Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
'''Returns'''
|  v20
:The stretch mode of the currently-playing game. The following values are possible:
|-
:<code>normal</code> (Show the game normally)
<code>VideoPlayer.VideoCodec</code>
:<code>4:3</code> (Stretch to a 4:3 aspect ratio)
|  Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
:<code>fullscreen</code> (Stretch to the full viewing area)
:<code>original</code> (Shrink to the original resolution)
|
|
|-
|-
|  <code>VideoPlayer.VideoResolution</code>
|  <code>RetroPlayer.Title</code>
Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
'''Returns'''
:The title of the currently-playing game.
|
|
|-
|-
|  <code>VideoPlayer.VideoAspect</code>
|  <code>RetroPlayer.VideoFilter</code>
Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
'''Returns'''
:The video filter of the currently-playing game. The following values are possible:
:<code>nearest</code> (Nearest neighbor, i.e. pixelate)
:<code>linear</code> (Bilinear filtering, i.e. smooth blur)
|
|
|-
|-
|  <code>VideoPlayer.AudioCodec</code>
|  <code>RetroPlayer.VideoRotation</code>
Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
'''Returns'''
:The video rotation of the currently-playing game in degrees counter-clockwise. The following values are possible:
:<code>0</code>
:<code>90</code> (Shown in the GUI as 270 degrees)
:<code>180</code>
:<code>270</code> (Shown in the GUI as 90 degrees)
|
|
|}
==== Video player ====
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>VideoPlayer.AudioChannels</code>
|  <code>VideoPlayer.Art(type)</code>
Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
'''Returns'''
:The art path for the requested arttype and for the currently playing video.
'''Parameters'''
:type - can virtually be anything, refers to the art type keyword in the art map (poster, fanart, banner, thumb, etc)
|
|
|-
|-
|  <code>VideoPlayer.AudioLanguage</code>
|  <code>VideoPlayer.AudioLanguageEx</code>
Shows the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage)
'''Returns'''
:The English name of the language of the current audio stream of the currently playing item.
|
|
|-
|-
|  <code>VideoPlayer.SubtitlesLanguage</code>
|  <code>VideoPlayer.AudioName</code>
Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
'''Returns'''
:The name of the active audio stream of the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.StereoscopicMode</code>
|  <code>VideoPlayer.AudioStreamCount</code>
Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
Returns the number of audio streams of the currently playing video
|  v21
|-
|  <code>VideoPlayer.EpisodePart</code>
|  '''Returns'''
:string containing the number of parts of a single episode - empty if no data provided
:[Infolabel Updated] <code>VideoPlayer.EpisodePart</code> also supports EPG.
|
|
|-
|-
|  <code>VideoPlayer.EndTime</code>
|  <code>VideoPlayer.HdrDetail</code>
End date of the currently playing programme (PVR).
'''Returns'''
:String containing details for the HDR type (currently only for DV - profile and EL type) or empty if not HDR. Prints eg 5, 7FEL, and compatibility ID for profile 8 eg 8.4.
|
|
|-
|-
|  <code>VideoPlayer.NextTitle</code>
|  <code>VideoPlayer.MediaProviders</code>
Title of the programme that will be played next (PVR).
'''Returns'''
:string containing the names of the providers of the currently playing media, separated by commas if multiple are present.
|
|
|-
|-
|  <code>VideoPlayer.NextGenre</code>
|  <code>VideoPlayer.offset(number).Album</code>
Genre of the programme that will be played next (PVR).
'''Returns'''
:The album from which the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.NextPlot</code>
|  <code>VideoPlayer.offset(number).Art(type)</code>
Plot of the programme that will be played next (PVR).
'''Returns'''
:The art path for the requested arttype and for the video which has an offset <code>number</code> with respect to the currently playing video.
'''Parameters'''
:number - the offset with respect to the start of the playlist
:type - can virtually be anything, refers to the art type keyword in the art map (poster, fanart, banner, thumb, etc)
|
|
|-
|-
|  <code>VideoPlayer.NextPlotOutline</code>
|  <code>VideoPlayer.offset(number).Artist</code>
Plot outline of the programme that will be played next (PVR).
'''Returns'''
:The artist(s) of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.NextStartTime</code>
|  <code>VideoPlayer.offset(number).Country</code>
Start time of the programme that will be played next (PVR).
'''Returns'''
:The production country of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.NextEndTime</code>
|  <code>VideoPlayer.offset(number).Cover</code>
End time of the programme that will be played next (PVR).
'''Returns'''
:The cover of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.NextDuration</code>
|  <code>VideoPlayer.offset(number).DBID</code>
Duration of the programme that will be played next (PVR).
'''Returns'''
:The database id of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.ChannelName</code>
|  <code>VideoPlayer.offset(number).Director</code>
Name of the curently tuned channel (PVR).
'''Returns'''
:The director of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.ChannelNumberLabel</code>
|  <code>VideoPlayer.offset(number).Episode</code>
Channel and subchannel number of the tv channel that's currently playing (PVR).
'''Returns'''
:The episode number of the episode which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.ChannelGroup</code>
|  <code>VideoPlayer.offset(number).Genre</code>
Group of the curently tuned channel (PVR).
'''Returns'''
:The genre(s) of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.ParentalRating</code>
|  <code>VideoPlayer.offset(number).IMDBNumber</code>
Parental rating of the currently playing programme (PVR).
'''Returns'''
:The IMDb ID of the the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>VideoPlayer.DBID</code>
|  <code>VideoPlayer.offset(number).LastPlayed</code>
|  The database id of the currently playing video. (supports .offset() and .position())
'''Returns'''
| v17
:The last play date of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
|-
|  <code>VideoPlayer.UniqueID()</code>
|  <code>VideoPlayer.offset(number).mpaa</code>
|  Returns the UniqueID of the currently playing video
'''Returns'''
| v19
:The MPAA rating of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|-
|-
|  <code>VideoPlayer.TvShowDBID</code>
|  <code>VideoPlayer.offset(number).OriginalTitle</code>
|  Returns the tv show DBID of the currently playing episode
'''Returns'''
|  v19
:The original title of the video which has an offset <code>number</code> with respect to the currently playing video.
|}
 
=== Playlist ===
 
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
<code>Playlist.Length(media)</code>
|  Total size of the current playlist. optional parameter media is either video or music.
|
|
|-
|-
|  <code>Playlist.Position(media)</code>
|  <code>VideoPlayer.offset(number).PlayCount</code>
Position of the current item in the current playlist. optional parameter media is either video or music.
'''Returns'''
:The playcount of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>Playlist.Random</code>
|  <code>VideoPlayer.offset(number).Plot</code>
|  Returns 'On' or 'Off'
'''Returns'''
:The complete Text Summary of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>Playlist.Repeat</code>
|  <code>VideoPlayer.offset(number).PlotOutline</code>
|  Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
'''Returns'''
:The small Summary of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|}
=== PVR ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>PVR.NowRecordingTitle</code>
|  <code>VideoPlayer.offset(number).Premiered</code>
Title of the programme being recorded
'''Returns'''
:The release or aired date of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.NowRecordingDateTime</code>
|  <code>VideoPlayer.offset(number).Rating</code>
Start date and time of the current recording
'''Returns'''
:The scraped rating of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.NowRecordingChannel</code>
|  <code>VideoPlayer.offset(number).RatingAndVotes</code>
Channel number that's being recorded
'''Returns'''
:The scraped rating and votes of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.NextRecordingTitle</code>
|  <code>VideoPlayer.offset(number).Season</code>
Title of the next programme that will be recorded
'''Returns'''
:The season number of the episode which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.NextRecordingDateTime</code>
|  <code>VideoPlayer.offset(number).Studio</code>
Start date and time of the next recording
'''Returns'''
:The studio of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.NextRecordingChannel</code>
|  <code>VideoPlayer.offset(number).Tagline</code>
Channel name of the next recording
'''Returns'''
:The small Summary of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.BackendName</code>
|  <code>VideoPlayer.offset(number).Title</code>
Name of the backend being used
'''Returns'''
:The title of video which has an offset <code>number</code> with respect to the currently playing video.
{{highlight|'''Note'''<br>If it's in the database it will return the database title, else the filename.}}
|
|
|-
|-
|  <code>PVR.BackendVersion</code>
|  <code>VideoPlayer.offset(number).Top250</code>
version of the backend that's being used
'''Returns'''
:The IMDb Top250 position of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.BackendHost</code>
|  <code>VideoPlayer.offset(number).Trailer</code>
Backend hostname
'''Returns'''
:The path to the trailer of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.BackendDiskSpace</code>
|  <code>VideoPlayer.offset(number).TVShowTitle</code>
Available diskspace on the backend
'''Returns'''
:The title of the episode's tvshow name which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.BackendChannels</code>
|  <code>VideoPlayer.offset(number).UserRating</code>
Number of available channels the backend provides
'''Returns'''
:The user rating of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.BackendTimers</code>
|  <code>VideoPlayer.offset(number).Votes</code>
Number of timers set for the backend
'''Returns'''
:The scraped votes of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.BackendRecordings</code>
|  <code>VideoPlayer.offset(number).Writer</code>
Number of recording available on the backend
'''Returns'''
:The name of Writer of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.BackendDiskspace</code>
|  <code>VideoPlayer.offset(number).Year</code>
Free diskspace available for recordings on the backend
'''Returns'''
:The year of release of the video which has an offset <code>number</code> with respect to the currently playing video.
|
|
|-
|-
|  <code>PVR.BackendNumber</code>
|  <code>VideoPlayer.position(number).Album</code>
Backend number
'''Returns'''
:The album from which the music video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ClientCount</code>
|  <code>VideoPlayer.position(number).Art(type)</code>
Number of PVR clients enabled
'''Returns'''
| v22
:The art path for the requested arttype and for the video which has an offset <code>number</code> with respect to the start of the playlist.
'''Parameters'''
:number - the offset with respect to the start of the playlist
:type - can virtually be anything, refers to the art type keyword in the art map (poster, fanart, banner, thumb, etc)
|
|-
|-
|  <code>PVR.TotalDiscSpace</code>
|  <code>VideoPlayer.position(number).Artist</code>
Total diskspace available for recordings
'''Returns'''
:The artist(s) of the music video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.NextTimer</code>
|  <code>VideoPlayer.position(number).Country</code>
Next timer date
'''Returns'''
:The production country of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.EpgEventDuration[(format)]</code>
|  <code>VideoPlayer.position(number).Cover</code>
|  Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
'''Returns'''
:The cover of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.EpgEventElapsedTime[(format)]</code>
|  <code>VideoPlayer.position(number).DBID</code>
|  Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
'''Returns'''
:The database id of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.EpgEventRemainingTime[(format)]</code>
|  <code>VideoPlayer.position(number).Director</code>
|  Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
'''Returns'''
| v18
:The director of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
|-
|  <code>PVR.EpgEventFinishTime[(format)]</code>
|  <code>VideoPlayer.position(number).Episode</code>
|  Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
'''Returns'''
| v18
:The episode number of the episode which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
|-
|  <code>PVR.EpgEventSeekTime[(format)]</code>
|  <code>VideoPlayer.position(number).Genre</code>
|  Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
'''Returns'''
| v18
:The genre(s) of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
|-
|  <code>PVR.EpgEventProgress</code>
|  <code>VideoPlayer.position(number).IMDBNumber</code>
|  Returns the position of currently played title on TV as integer
'''Returns'''
:The IMDb ID of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.TimeShiftStart[(format)]</code>
|  <code>VideoPlayer.position(number).LastPlayed</code>
Start position of the timeshift. See ListItem.Duration for optinional formatting options
'''Returns'''
:The last play date of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.TimeShiftEnd[(format)]</code>
|  <code>VideoPlayer.position(number).mpaa</code>
End position of the timeshift. See ListItem.Duration for optinional formatting options
'''Returns'''
:The MPAA rating of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.TimeShiftCur[(format)]</code>
|  <code>VideoPlayer.position(number).OriginalTitle</code>
Current position of the timeshift. See ListItem.Duration for optinional formatting options
'''Returns'''
:The original title of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
|-
|  <code>PVR.TimeShiftOffset[(format)]</code>
|  <code>VideoPlayer.position(number).PlayCount</code>
Current offset of the timeshift. See ListItem.Duration for optinional formatting options
'''Returns'''
:The playcount of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.TimeShiftProgress</code>
|  <code>VideoPlayer.position(number).Plot</code>
|  Returns the position of currently timeshifted title on TV as interger
'''Returns'''
:The complete Text Summary of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamClient</code>
|  <code>VideoPlayer.position(number).PlotOutline</code>
Stream client name
'''Returns'''
:The small Summary of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamDevice</code>
|  <code>VideoPlayer.position(number).Premiered</code>
Stream device name
'''Returns'''
:The release or aired date of the video which has an offset <code>number</code> with respect to the start of the playlist. if it's in the database.
|
|
|-
|-
|  <code>PVR.ActStreamStatus</code>
|  <code>VideoPlayer.position(number).Rating</code>
Status of the stream
'''Returns'''
:The scraped rating of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamSignal</code>
|  <code>VideoPlayer.position(number).RatingAndVotes</code>
Signal quality of the stream
'''Returns'''
:The scraped rating and votes of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamSnr</code>
|  <code>VideoPlayer.position(number).Season</code>
Signal to noise ratio of the stream
'''Returns'''
:The season number of the episode which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamBer</code>
|  <code>VideoPlayer.position(number).Studio</code>
Bit error rate of the stream
'''Returns'''
:The studio of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamUnc</code>
|  <code>VideoPlayer.position(number).Tagline</code>
UNC value of the stream
'''Returns'''
:The small Summary of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamVideoBitRate</code>
|  <code>VideoPlayer.position(number).Title</code>
Video bitrate of the stream
'''Returns'''
:The title of the video which has an offset <code>number</code> with respect to the start of the playlist.
{{highlight|'''Note'''<br>If it's in the database it will return the database title, else the filename.}}
|
|
|-
|-
|  <code>PVR.ActStreamAudioBitRate</code>
|  <code>VideoPlayer.position(number).Top250</code>
Audio bitrate of the stream
'''Returns'''
:The IMDb Top250 position of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamDolbyBitRate</code>
|  <code>VideoPlayer.position(number).Trailer</code>
Dolby bitrate of the stream
'''Returns'''
:The path to the trailer of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamProgrSignal</code>
|  <code>VideoPlayer.position(number).TVShowTitle</code>
Signal quality of the programme
'''Returns'''
:The title of the episode's tvshow name which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamProgrSnr</code>
|  <code>VideoPlayer.position(number).UserRating</code>
Signal to noise ratio of the programme
'''Returns'''
:The user rating of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.ActStreamEncryptionName</code>
|  <code>VideoPlayer.position(number).Votes</code>
Encryption used on the stream
'''Returns'''
:The scraped votes of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|
|-
|-
|  <code>PVR.TVNowRecordingTitle</code>
|  <code>VideoPlayer.position(number).Writer</code>
Title of the tv programme being recorded
'''Returns'''
| v17
:The name of Writer of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
|-
|  <code>PVR.TVNowRecordingDateTime</code>
|  <code>VideoPlayer.position(number).Year</code>
Start date and time of the current tv recording
'''Returns'''
| v17
:The year of release of the video which has an offset <code>number</code> with respect to the start of the playlist.
|
|-
|-
|  <code>PVR.TVNowRecordingChannel</code>
|  <code>VideoPlayer.StartTime</code>
Channel name of the current tv recording
'''Returns'''
| v17
:The start date and time of the currently playing epg event or recording ( PVR ).
|
|-
|-
|  <code>PVR.TVNowRecordingChannelIcon</code>
|  <code>VideoPlayer.SubtitleCodec</code>
Icon of the current recording TV channel
'''Returns'''
| v17
:The codec of the current subtitles of the currently playing video. Possible values include:
:ass
:dvb_subtitle
:dvb_teletext
:dvd_subtitle
:hdmv_pgs_subtitle
:microdvd
:mov_text
:mpl2
:realtext
:sami
:srt
:ssa
:subrip
:text
:ttml
:vplayer
:webvtt
:xsub
{{highlight|'''Note'''<br><code>VideoPlayer.SubtitleCodec</code> holds the codec of the next available subtitles stream if subtitles are disabled in the player.}}
|
|-
|-
|  <code>PVR.TVNextRecordingTitle</code>
|  <code>VideoPlayer.SubtitleLanguageEx</code>
Title of the next tv programme that will be recorded
'''Returns'''
| v17
:The English name of the language of the current subtitle stream of the currently playing item.
|
|-
|-
|  <code>PVR.TVNextRecordingDateTime</code>
|  <code>VideoPlayer.SubtitleName</code>
Start date and time of the next tv recording
'''Returns'''
| v17
:The name of the active subtitle stream of the currently playing video.
|
|-
|-
|  <code>PVR.TVNextRecordingChannel</code>
|  <code>VideoPlayer.TitleExtraInfo</code>
Channel name of the next tv recording
'''Returns'''
| v17
:string containing extra information, enriching the title of the currently playing media, if any.
|
|-
|-
|  <code>PVR.TVNextRecordingChannelIcon</code>
|  <code>VideoPlayer.VideoStreamCount</code>
Icon of the next recording tv channel
Returns the number of video streams of the currently playing video
v17
v22
|-
|-
|  <code>PVR.RadioNowRecordingTitle</code>
|  <code>VideoPlayer.ParentalRatingCode</code>
Title of the radio programme being recorded
Shows the parental rating code
v17
v22
|-
|-
|  <code>PVR.RadioNowRecordingDateTime</code>
|  <code>VideoPlayer.ParentalRatingIcon</code>
Start date and time of the current radio recording
Shows the parental rating icon
v17
v22
|-
|-
|  <code>PVR.RadioNowRecordingChannel</code>
|  <code>VideoPlayer.ParentalRatingSource</code>
Channel name of the current radio recording
Shows the parental rating source
v17
v22
|-
|-
|  <code>PVR.RadioNowRecordingChannelIcon</code>
|  <code>VideoPlayer.ChannelLogo</code>
Icon of the current recording radio channel
Shows the logo of the currently selected radio or TV channel
v17
v22
|-
|-
|  <code>PVR.RadioNextRecordingTitle</code>
|  <code>VideoPlayer.VideoVersionName</code>
Title of the next radio programme that will be recorded
Show the name of the video version
v17
v21
|-
|-
|  <code>PVR.RadioNextRecordingDateTime</code>
|  <code>VideoPlayer.Time</code>
Start date and time of the next radio recording
Current time in movie
| v17
|
|-
|-
|  <code>PVR.RadioNextRecordingChannel</code>
|  <code>VideoPlayer.TimeRemaining</code>
Channel name of the next radio recording
Current remaining time in movie
| v17
|
|-
|-
|  <code>PVR.ChannelNumberInput</code>
|  <code>VideoPlayer.TimeSpeed</code>
Label displaying the number the user entered on remote or keyboard
Current time + playspeed. e.g. 1:23:14 (-4x)
| v18
|
|-
|-
|  <code>PVR.TimeshiftProgressDuration</code>
|  <code>VideoPlayer.Duration</code>
Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
Length of current movie
| v18
|
|-
|-
|  <code>PVR.TimeshiftProgressDuration(format)</code>
|  <code>VideoPlayer.Title</code>
Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
| v18
|
|-
|-
|  <code>PVR.TimeshiftProgressStartTime</code>
|  <code>VideoPlayer.OriginalTitle</code>
Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
The original title of currently playing video. (supports .offset() and .position())
| v18
|
|-
|-
|  <code>PVR.TimeshiftProgressStartTime(format)</code>
|  <code>VideoPlayer.TVShowTitle</code>
Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
Title of currently playing episode's tvshow name. (supports .offset() and .position())
| v18
|
|-
|-
|  <code>PVR.TimeshiftProgressEndTime</code>
|  <code>VideoPlayer.Season</code>
Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
| v18
|
|-
|-
|  <code>PVR.TimeshiftProgressEndTime(format)</code>
|  <code>VideoPlayer.Episode</code>
Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
Episode number of the currently playing episode. (supports .offset() and .position())
| v18
|
|-
|-
|  <code>PVR.TimeshiftProgressPlayPos</code>
|  <code>VideoPlayer.Genre</code>
Returns the percentage of the current play position within the PVR timeshift progress
Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
| v18
|
|-
|-
|  <code>PVR.TimeshiftProgressEpgStart</code>
|  <code>VideoPlayer.Genre(separator)</code>
|  Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
'''Returns'''
| v18
:A list of genres of current movie, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|-
|  <code>PVR.TimeshiftProgressEpgEnd</code>
|  <code>VideoPlayer.Director</code>
Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
Director of current movie, if it's in the database. (supports .offset() and .position())
| v18
|
|-
|-
|  <code>PVR.TimeshiftProgressBufferStart</code>
|  <code>VideoPlayer.Director(separator)</code>
|  Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
'''Returns'''
| v18
:A list of directors of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|-
|  <code>PVR.TimeshiftProgressBufferEnd</code>
|  <code>VideoPlayer.Country</code>
Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
Production country of current movie, if it's in the database. (supports .offset() and .position())
| v18
|
|-
|-
|  <code>PVR.TimeShiftSeekbar</code>
|  <code>VideoPlayer.Year</code>
This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
Year of release of current movie, if it's in the database. (supports .offset() and .position())
|  v19
|}
 
=== RDS ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|  <code>RDS.AudioLanguage</code>
|  The from RDS reported audio language of channel
|
|
|-
|-
|  <code>RDS.ChannelCountry</code>
|  <code>VideoPlayer.Premiered</code>
Country where the radio channel is sended
The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.GetLine(number)</code>
|  <code>VideoPlayer.Rating</code>
Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.Title</code>
|  <code>VideoPlayer.UserRating</code>
Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
Shows the user rating of the currently playing item. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.Artist</code>
|  <code>VideoPlayer.Votes</code>
A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.Band</code>
|  <code>VideoPlayer.RatingAndVotes</code>
Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.Composer</code>
|  <code>VideoPlayer.mpaa</code>
Name of the original composer/author (Only be available on RadiotextPlus)
MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.Conductor</code>
|  <code>VideoPlayer.IMDBNumber</code>
|  The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|  The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.Album</code>
|  <code>VideoPlayer.EpisodeName</code>
|  The collection name to which this track belongs (Only be available on RadiotextPlus)
(PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
|
|
|-
|-
|  <code>RDS.TrackNumber</code>
|  <code>VideoPlayer.PlaylistPosition</code>
The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
Position of the current song in the current video playlist
|
|
|-
|-
|  <code>RDS.RadioStyle</code>
|  <code>VideoPlayer.PlaylistLength</code>
The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
Total size of the current video playlist
|
|
|-
|-
|  <code>RDS.Comment</code>
|  <code>VideoPlayer.Cast</code>
Radio station comment string if available (Only be available on RadiotextPlus)
A list of cast members, separated by carriage returns, if it's in the database
|
|
|-
|-
|  <code>RDS.InfoNews</code>
|  <code>VideoPlayer.Cast(separator)</code>
Message / headline (if available) (Only be available on RadiotextPlus)
'''Returns'''
:A list of cast members of the currently playing video, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|  <code>VideoPlayer.CastAndRole</code>
|  A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
|
|
|-
|-
|  <code>RDS.InfoNewsLocal</code>
|  <code>VideoPlayer.CastAndRole(separator)</code>
Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|  '''Returns'''
:A list of cast members and roles of the currently playing video, pairs separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|  <code>VideoPlayer.Trailer</code>
The trailer of the current movie. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoStock</code>
|  <code>VideoPlayer.Album</code>
Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoStockSize</code>
|  <code>VideoPlayer.Artist</code>
Number of rows present in stock information (Only be available on RadiotextPlus)
Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoSport</code>
|  <code>VideoPlayer.Studio</code>
Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5"  (if available) (Only be available on RadiotextPlus)
Studio of current Music Video, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoSportSize</code>
|  <code>VideoPlayer.Writer</code>
Number of rows present in sport information (Only be available on RadiotextPlus)
Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoLottery</code>
|  <code>VideoPlayer.Writer(separator)</code>
Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
'''Returns'''
|
:A list of writers of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|-
|  <code>RDS.InfoLotterySize</code>
|  <code>VideoPlayer.Tagline</code>
Number of rows present in lottery information (Only be available on RadiotextPlus)
Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoWeather</code>
|  <code>VideoPlayer.PlotOutline</code>
Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoWeatherSize</code>
|  <code>VideoPlayer.Plot</code>
Number of rows present in weather information (Only be available on RadiotextPlus)
Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoCinema</code>
|  <code>VideoPlayer.Top250</code>
Information about movies in cinema (if available) (Only be available on RadiotextPlus)
Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoCinemaSize</code>
|  <code>VideoPlayer.LastPlayed</code>
Number of rows present in cinema information (Only be available on RadiotextPlus)
Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoHoroscope</code>
|  <code>VideoPlayer.PlayCount</code>
Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
|
|
|-
|-
|  <code>RDS.InfoHoroscopeSize</code>
|  <code>VideoPlayer.HdrType</code>
Number of rows present in horoscope information (Only be available on RadiotextPlus)
Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg)
|  v20
|-
|  <code>VideoPlayer.VideoCodec</code>
|  Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
|
|
|-
|-
|  <code>RDS.InfoOther</code>
|  <code>VideoPlayer.VideoResolution</code>
Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
|
|
|-
|-
|  <code>RDS.InfoOtherSize</code>
|  <code>VideoPlayer.VideoAspect</code>
Number of rows present with other informations (Only be available on RadiotextPlus)
Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
|
|
|-
|-
|  <code>RDS.ProgStation</code>
|  <code>VideoPlayer.AudioCodec</code>
Name of the radio channel@note becomes also be set from epg if from RDS not available
Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
|
|
|-
|-
|  <code>RDS.ProgNow</code>
|  <code>VideoPlayer.AudioChannels</code>
Now played program name@note becomes also be set from epg if from RDS not available
Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
|
|
|-
|-
|  <code>RDS.ProgNext</code>
|  <code>VideoPlayer.AudioLanguage</code>
Next played program name (if available)@note becomes also be set from epg if from RDS not available
Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage)
|
|
|-
|-
|  <code>RDS.ProgHost</code>
|  <code>VideoPlayer.SubtitlesLanguage</code>
Name of the host of the radio show
Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
|
|
|-
|-
|  <code>RDS.ProgEditStaff</code>
|  <code>VideoPlayer.StereoscopicMode</code>
Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
|
|
|-
|-
|  <code>RDS.ProgHomepage</code>
|  <code>VideoPlayer.EndTime</code>
Link to radio station homepage (Only be available on RadiotextPlus)
End date of the currently playing programme (PVR).
|
|
|-
|-
|  <code>RDS.ProgStyle</code>
|  <code>VideoPlayer.NextTitle</code>
Human readable string about radiostyle defined from RDS or RBDS
Title of the programme that will be played next (PVR).
|
|
|-
|-
|  <code>RDS.PhoneHotline</code>
|  <code>VideoPlayer.NextGenre</code>
The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
Genre of the programme that will be played next (PVR).
|
|
|-
|-
|  <code>RDS.PhoneStudio</code>
|  <code>VideoPlayer.NextGenre(separator)</code>
The telephone number of the radio station's studio (Only be available on RadiotextPlus)
'''Returns'''
:A list of genres of the programme that will be played next (PVR), separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22]
|-
|  <code>VideoPlayer.NextPlot</code>
|  Plot of the programme that will be played next (PVR).
|
|
|-
|-
|  <code>RDS.SmsStudio</code>
|  <code>VideoPlayer.NextPlotOutline</code>
The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
Plot outline of the programme that will be played next (PVR).
|
|
|-
|-
|  <code>RDS.EmailHotline</code>
|  <code>VideoPlayer.NextStartTime</code>
The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
Start time of the programme that will be played next (PVR).
|
|
|-
|-
|  <code>RDS.EmailStudio</code>
|  <code>VideoPlayer.NextEndTime</code>
The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
End time of the programme that will be played next (PVR).
|
|}
 
=== Skin ===
 
{| class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>Skin.CurrentTheme</code>
|  <code>VideoPlayer.NextDuration</code>
Returns the current selected skin theme.
Duration of the programme that will be played next (PVR).
|
|
|-
|-
|  <code>Skin.CurrentColourTheme</code>
|  <code>VideoPlayer.ChannelName</code>
Returns the current selected colour theme of the skin.
Name of the curently tuned channel (PVR).
|
|
|-
|-
|  <code>Skin.Font</code>
|  <code>VideoPlayer.ChannelNumberLabel</code>
Returns the current fontset from Font.xml.
Channel and subchannel number of the tv channel that's currently playing (PVR).
| v18 addition
|
|-
|-
|  <code>Skin.String(name)</code>
|  <code>VideoPlayer.ChannelGroup</code>
Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
Group of the curently tuned channel (PVR).
|
|
|-
|-
|  <code>Skin.AspectRatio</code>
|  <code>VideoPlayer.ParentalRating</code>
Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
Parental rating of the currently playing programme (PVR).
|
|
|}
=== Slideshow ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>Slideshow.Altitude</code>
|  <code>VideoPlayer.DBID</code>
Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
The database id of the currently playing video. (supports .offset() and .position())
|
| v17
|-
|-
|  <code>Slideshow.Aperture</code>
|  <code>VideoPlayer.UniqueID()</code>
Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
Returns the UniqueID of the currently playing video
|
| v19
|-
|-
|  <code>Slideshow.Author</code>
|  <code>VideoPlayer.TvShowDBID</code>
Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
Returns the tv show DBID of the currently playing episode
|
|  v19
|}
 
=== Playlist ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>Slideshow.Byline</code>
|  <code>Playlist.Length(media)</code>
Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50).
Total size of the current playlist. optional parameter media is either video or music.
|
|
|-
|-
|  <code>Slideshow.BylineTitle</code>
|  <code>Playlist.Position(media)</code>
Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
Position of the current item in the current playlist. optional parameter media is either video or music.
|
|
|-
|-
|  <code>Slideshow.CameraMake</code>
|  <code>Playlist.Random</code>
Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
Returns 'On' or 'Off'
|
|
|-
|-
|  <code>Slideshow.CameraModel</code>
|  <code>Playlist.Repeat</code>
Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|
|}
=== PVR ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>Slideshow.Caption</code>
|  <code>PVR.ActStreamAudioBitRate</code>
Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
Audio bitrate of the stream
|
|
|-
|-
|  <code>Slideshow.Category</code>
|  <code>PVR.ActStreamBer</code>
Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
Bit error rate of the stream
|
|
|-
|-
|  <code>Slideshow.CCDWidth</code>
|  <code>PVR.ActStreamClient</code>
Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
Stream client name
|
|
|-
|-
|  <code>Slideshow.City</code>
|  <code>PVR.ActStreamDevice</code>
Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
Stream device name
|
|
|-
|-
|  <code>Slideshow.Colour</code>
|  <code>PVR.ActStreamDolbyBitRate</code>
Shows whether the current picture is "Colour" or "Black and White".
Dolby bitrate of the stream
|
|
|-
|-
|  <code>Slideshow.CopyrightNotice</code>
|  <code>PVR.ActStreamEncryptionName</code>
Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
Encryption used on the stream
|
|
|-
|-
|  <code>Slideshow.Country</code>
|  <code>PVR.ActStreamMux</code>
Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
'''Returns'''
:The multiplex type of played channel if available.
|
|
|-
|-
|  <code>Slideshow.CountryCode</code>
|  <code>PVR.ActStreamProgrSignal</code>
Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
Signal quality of the programme
|
|
|-
|-
|  <code>Slideshow.Credit</code>
|  <code>PVR.ActStreamProgrSnr</code>
Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
Signal to noise ratio of the programme
|
|
|-
|-
|  <code>Slideshow.DigitalZoom</code>
|  <code>PVR.ActStreamProviderName</code>
Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
'''Returns'''
:The provider name of the played channel if available.
|
|
|-
|-
|  <code>Slideshow.EXIFComment</code>
|  <code>PVR.ActStreamServiceName</code>
Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
'''Returns'''
:The service name of played channel if available.
|
|
|-
|-
|  <code>Slideshow.EXIFDate</code>
|  <code>PVR.ActStreamSignal</code>
Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
Signal quality of the stream
|
|
|-
|-
|  <code>Slideshow.EXIFDescription</code>
|  <code>PVR.ActStreamSnr</code>
Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
Signal to noise ratio of the stream
|
|
|-
|-
|  <code>Slideshow.EXIFSoftware</code>
|  <code>PVR.ActStreamStatus</code>
Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
Status of the stream
|
|
|-
|-
|  <code>Slideshow.EXIFTime</code>
|  <code>PVR.ActStreamUnc</code>
Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
UNC value of the stream
|
|
|-
|-
|  <code>Slideshow.Exposure</code>
|  <code>PVR.ActStreamVideoBitRate</code>
Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
Video bitrate of the stream
|
|
|-
|-
|  <code>Slideshow.ExposureBias</code>
|  <code>PVR.BackendChannels</code>
Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
Number of available channels the backend provides
|
|
|-
|-
|  <code>Slideshow.ExposureMode</code>
|  <code>PVR.BackendDeletedRecordings</code>
Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
'''Returns'''
:The number of deleted recordings present on the backend.
|
|
|-
|-
|  <code>Slideshow.ExposureTime</code>
|  <code>PVR.BackendDiskSpace</code>
Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
Available diskspace on the backend
|
|
|-
|-
|  <code>Slideshow.Filedate</code>
|  <code>PVR.BackendDiskspace</code>
Shows the file date of the current picture
Free diskspace available for recordings on the backend
|
|
|-
|-
|  <code>Slideshow.Filename</code>
|  <code>PVR.BackendDiskSpaceProgr</code>
Shows the file name of the current picture
'''Returns'''
:The available diskspace on the backend as percent value.
|
|
|-
|-
|  <code>Slideshow.Filesize</code>
|  <code>PVR.BackendHost</code>
Shows the file size of the current picture
Backend hostname
|
|
|-
|-
|  <code>Slideshow.FlashUsed</code>
|  <code>PVR.BackendName</code>
Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209). 
Name of the backend being used
|
|
|-
|-
|  <code>Slideshow.FocalLength</code>
|  <code>PVR.BackendNumber</code>
Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
Backend number
|
|
|-
|-
|  <code>Slideshow.FocusDistance</code>
|  <code>PVR.BackendRecordings</code>
Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
Number of recording available on the backend
|
|
|-
|-
|  <code>Slideshow.Headline</code>
|  <code>PVR.BackendTimers</code>
Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
Number of timers set for the backend
|
|
|-
|-
|  <code>Slideshow.ImageType</code>
|  <code>PVR.BackendVersion</code>
Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
version of the backend that's being used
|
|
|-
|-
|  <code>Slideshow.IPTCDate</code>
|  <code>PVR.ChannelNumberInput</code>
Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
Label displaying the number the user entered on remote or keyboard
|
| v18
|-
|-
|  <code>Slideshow.ISOEquivalence</code>
|  <code>PVR.ClientCount</code>
Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
Number of PVR clients enabled
|  v22
|-
|  <code>PVR.ClientName</code>
|  '''Returns'''
:The name of the PVR client add-on, as specified by the add-on developer.
|
|
|-
|-
|  <code>Slideshow.Keywords</code>
|  <code>PVR.EpgEventDuration[(format)]</code>
Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|
|-
|-
|  <code>Slideshow.Latitude</code>
|  <code>PVR.EpgEventElapsedTime[(format)]</code>
Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
|
|
|-
|-
|  <code>Slideshow.LightSource</code>
|  <code>PVR.EpgEventFinishTime[(format)]</code>
Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options
|  v18
|-
|  <code>PVR.EpgEventProgress</code>
|  Returns the position of currently played title on TV as integer
|
|
|-
|-
|  <code>Slideshow.LongEXIFDate</code>
|  <code>PVR.EpgEventRemainingTime[(format)]</code>
Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options
|
| v18
|-
|-
|  <code>Slideshow.LongEXIFTime</code>
|  <code>PVR.EpgEventSeekTime[(format)]</code>
Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options
|
| v18
|-
|-
|  <code>Slideshow.Longitude</code>
|  <code>PVR.InstanceName</code>
Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
'''Returns'''
:The name of the instance of the PVR client add-on, as specified by the user in the add-on settings. Empty if the PVR client add-on does not support multiple instances.
|
|
|-
|-
|  <code>Slideshow.MeteringMode</code>
|  <code>PVR.NextRecordingChannel</code>
Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
Channel name of the next recording
|
|
|-
|-
|  <code>Slideshow.ObjectName</code>
|  <code>PVR.NextRecordingDateTime</code>
Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
Start date and time of the next recording
|
|
|-
|-
|  <code>Slideshow.Orientation</code>
|  <code>PVR.NextRecordingTitle</code>
Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
Title of the next programme that will be recorded
|
|
|-
|-
|  <code>Slideshow.Path</code>
|  <code>PVR.NextTimer</code>
Shows the file path of the current picture
Next timer date
|
|
|-
|-
|  <code>Slideshow.Process</code>
|  <code>PVR.NowRecordingChannel</code>
Shows the process used to compress the current picture
Channel number that's being recorded
|
|
|-
|-
|  <code>Slideshow.ReferenceService</code>
|  <code>PVR.NowRecordingDateTime</code>
Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
Start date and time of the current recording
|
|
|-
|-
|  <code>Slideshow.Resolution</code>
|  <code>PVR.NowRecordingTitle</code>
Shows the dimensions of the current picture (Width x Height)
Title of the programme being recorded
|
|
|-
|-
|  <code>Slideshow.SlideComment</code>
|  <code>PVR.RadioNextRecordingChannel</code>
Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
Channel name of the next radio recording
|
| v17
|-
|-
|  <code>Slideshow.SlideIndex</code>
|  <code>PVR.RadioNextRecordingChannelIcon</code>
Shows the slide index of the current picture
'''Returns'''
:The icon of the next recording radio channel.
|
|
|-
|-
|  <code>Slideshow.Source</code>
|  <code>PVR.RadioNextRecordingDateTime</code>
Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
Start date and time of the next radio recording
|
| v17
|-
|-
|  <code>Slideshow.SpecialInstructions</code>
|  <code>PVR.RadioNextRecordingTitle</code>
Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
Title of the next radio programme that will be recorded
|
|  v17
|-
|  <code>PVR.RadioNowRecordingChannel</code>
|  Channel name of the current radio recording
|  v17
|-
|  <code>PVR.RadioNowRecordingChannelIcon</code>
|  Icon of the current recording radio channel
|  v17
|-
|  <code>PVR.RadioNowRecordingDateTime</code>
| Start date and time of the current radio recording
|  v17
|-
|-
|  <code>Slideshow.State</code>
|  <code>PVR.RadioNowRecordingTitle</code>
Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
Title of the radio programme being recorded
|
| v17
|-
|-
|  <code>Slideshow.Sublocation</code>
|  <code>PVR.TimeShiftCur[(format)]</code>
Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
Current position of the timeshift. See ListItem.Duration for optinional formatting options
|
|-
|-
|  <code>Slideshow.SupplementalCategories</code>
|  <code>PVR.TimeShiftEnd[(format)]</code>
Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
End position of the timeshift. See ListItem.Duration for optinional formatting options
|
|
|-
|-
|  <code>Slideshow.TimeCreated</code>
|  <code>PVR.TimeShiftOffset[(format)]</code>
Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
Current offset of the timeshift. See ListItem.Duration for optinional formatting options
|
|
|-
|-
|  <code>Slideshow.TransmissionReference</code>
|  <code>PVR.TimeShiftProgress</code>
Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
Returns the position of currently timeshifted title on TV as interger
|
|
|-
|-
|  <code>Slideshow.Urgency</code>
|  <code>PVR.TimeshiftProgressBufferEnd</code>
Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress
|
| v18
|-
|-
|  <code>Slideshow.WhiteBalance</code>
|  <code>PVR.TimeshiftProgressBufferStart</code>
Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress
|
v18
|}
 
=== System ===
 
{class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>System.Time</code>
|  <code>PVR.TimeshiftProgressDuration</code>
Current time
Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
|
| v18
|-
|-
|  <code>System.Time(format)</code>
|  <code>PVR.TimeshiftProgressDuration(format)</code>
Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
|
| v18
|-
|-
|  <code>System.Date</code>
|  <code>PVR.TimeshiftProgressEndTime</code>
Current date
Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
|
| v18
|-
|-
|  <code>System.Date(format)</code>
|  <code>PVR.TimeshiftProgressEndTime(format)</code>
Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
|
|  v18
|-
|  <code>PVR.TimeshiftProgressEpgEnd</code>
|  Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress
|  v18
|-
|  <code>PVR.TimeshiftProgressEpgStart</code>
|  Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress
| v18
|-
|-
|  <code>System.AlarmPos</code>
|  <code>PVR.TimeshiftProgressPlayPos</code>
Shutdown Timer position
Returns the percentage of the current play position within the PVR timeshift progress
|
| v18
|-
|-
|  <code>System.BatteryLevel</code>
|  <code>PVR.TimeshiftProgressStartTime</code>
|  Returns the remaining battery level in range 0-100
|  Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero
|
| v18
|-
|-
|  <code>System.FreeSpace</code>
|  <code>PVR.TimeshiftProgressStartTime(format)</code>
Total Freespace on the drive
Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss)
|
| v18
|-
|-
|  <code>System.UsedSpace</code>
|  <code>PVR.TimeShiftSeekbar</code>
Total Usedspace on the drive
This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to)
|
| v19
|-
|-
|  <code>System.TotalSpace</code>
|  <code>PVR.TimeShiftStart[(format)]</code>
Totalspace on the drive
Start position of the timeshift. See ListItem.Duration for optinional formatting options
|
|
|-
|-
|  <code>System.UsedSpacePercent</code>
|  <code>PVR.TotalDiscSpace</code>
|  Total Usedspace Percent on the drive
|  Total diskspace available for recordings
|
|
|-
|-
|  <code>System.FreeSpacePercent</code>
|  <code>PVR.TVNextRecordingChannel</code>
Total Freespace Percent on the drive
Channel name of the next tv recording
|
| v17
|-
|-
|  <code>System.CPUTemperature</code>
|  <code>PVR.TVNextRecordingChannelIcon</code>
Current CPU temperature
Icon of the next recording tv channel
|
| v17
|-
|-
|  <code>System.CpuUsage</code>
|  <code>PVR.TVNextRecordingDateTime</code>
Displays the cpu usage for each individual cpu core.
Start date and time of the next tv recording
|
| v17
|-
|-
|  <code>System.CoreUsage(id)</code>
|  <code>PVR.TVNextRecordingTitle</code>
Displays the usage of the cpu core with the given 'id'
Title of the next tv programme that will be recorded
|
| v17
|-
|-
|  <code>System.GPUTemperature</code>
|  <code>PVR.TVNowRecordingChannel</code>
Current GPU temperature
Channel name of the current tv recording
|
| v17
|-
|-
|  <code>System.FanSpeed</code>
|  <code>PVR.TVNowRecordingChannelIcon</code>
Current fan speed
Icon of the current recording TV channel
|
| v17
|-
|-
|  <code>System.BuildVersion</code>
|  <code>PVR.TVNowRecordingDateTime</code>
version of build
Start date and time of the current tv recording
|
| v17
|-
|  <code>PVR.TVNowRecordingTitle</code>
|  Title of the tv programme being recorded
|  v17
|}
 
=== RDS ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>System.BuildDate</code>
|  <code>RDS.Album</code>
Date of build
The collection name to which this track belongs (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.FriendlyName</code>
|  <code>RDS.Artist</code>
Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.FPS</code>
|  <code>RDS.AudioLanguage</code>
Current rendering speed (frames per second)
The from RDS reported audio language of channel
|
|
|-
|-
|  <code>System.FreeMemory</code>
|  <code>RDS.Band</code>
Amount of free memory in Mb
Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.Memory(format)</code>
|  <code>RDS.ChannelCountry</code>
Available formats: used, used.percent, free, free.percent, total
Country where the radio channel is sended
|
|
|-
|-
|  <code>System.ScreenMode</code>
|  <code>RDS.Comment</code>
Screenmode (e.g. windowed / fullscreen)
Radio station comment string if available (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.ScreenWidth</code>
|  <code>RDS.Composer</code>
Width of screen in pixels
Name of the original composer/author (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.ScreenHeight</code>
|  <code>RDS.Conductor</code>
Height of screen in pixels
The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.StartupWindow</code>
|  <code>RDS.EmailHotline</code>
|  The Window Kodi will load on startup
|  The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.CurrentWindow</code>
|  <code>RDS.EmailStudio</code>
Current Window we are in
The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.CurrentControl</code>
|  <code>RDS.GetLine(number)</code>
Current focused control
Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|
|-
|-
|  <code>System.CurrentControlID</code>
|  <code>RDS.InfoCinema</code>
ID of the currently focused control.
Information about movies in cinema (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.DVDLabel</code>
|  <code>RDS.InfoCinemaSize</code>
Label of the disk in the <span class="nobr">DVD-ROM</span> drive
Number of rows present in cinema information (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.HddTemperature</code>
|  <code>RDS.InfoHoroscope</code>
Hdd temperature
Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.OSVersionInfo</code>
|  <code>RDS.InfoHoroscopeSize</code>
System name + kernel version
Number of rows present in horoscope information (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.KernelVersion (deprecated)</code>
|  <code>RDS.InfoLottery</code>
System name + kernel version
Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.Uptime</code>
|  <code>RDS.InfoLotterySize</code>
System current uptime
Number of rows present in lottery information (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.TotalUptime</code>
|  <code>RDS.InfoNews</code>
System total uptime
Message / headline (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.CpuFrequency</code>
|  <code>RDS.InfoNewsLocal</code>
System cpu frequency
Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.ScreenResolution</code>
|  <code>RDS.InfoOther</code>
Screen resolution
Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.VideoEncoderInfo</code>
|  <code>RDS.InfoOtherSize</code>
video encoder info
Number of rows present with other informations (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.InternetState</code>
|  <code>RDS.InfoSport</code>
Will return the internet state, 'connected' or 'not connected' (localized)
Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5"  (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.Language</code>
|  <code>RDS.InfoSportSize</code>
Shows the current language
Number of rows present in sport information (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.ProfileName</code>
|  <code>RDS.InfoStock</code>
Shows the User name of the currently logged in Kodi user
Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.ProfileCount</code>
|  <code>RDS.InfoStockSize</code>
Shows the number of defined profiles
Number of rows present in stock information (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.ProfileAutoLogin</code>
|  <code>RDS.InfoWeather</code>
The profile Kodi will auto login to
Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.Progressbar</code>
|  <code>RDS.InfoWeatherSize</code>
|  The percentage of the currently active progress.
|  Number of rows present in weather information (Only be available on RadiotextPlus)
|
|-
|  <code>RDS.PhoneHotline</code>
|  The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.StereoscopicMode</code>
|  <code>RDS.PhoneStudio</code>
|  The prefered stereoscopic mode (settings > video > playback)
|  The telephone number of the radio station's studio (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.TemperatureUnits</code>
|  <code>RDS.ProgEditStaff</code>
Shows Celsius or Fahrenheit symbol
Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.AddonTitle(id)</code>
|  <code>RDS.ProgHomepage</code>
Returns the title of the addon with the given id
Link to radio station homepage (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>System.AddonVersion(id)</code>
|  <code>RDS.ProgHost</code>
Returns the version of the addon with the given id
Name of the host of the radio show
|
|
|-
|-
|  <code>System.BuildVersionCode</code>
|  <code>RDS.ProgNext</code>
The internal version of the kodi build
Next played program name (if available)@note becomes also be set from epg if from RDS not available
| v19
|
|-
|-
|  <code>System.BuildVersionGit</code>
|  <code>RDS.ProgNow</code>
The git version (sha) of the kodi build
Now played program name@note becomes also be set from epg if from RDS not available
| v19
|
|-
|-
|  <code>System.AddonUpdateCount</code>
|  <code>RDS.ProgStation</code>
The number of available addon updates
Name of the radio channel@note becomes also be set from epg if from RDS not available
v19
|
|}
|-
 
<code>RDS.ProgStyle</code>
=== Visualisation ===
| Human readable string about radiostyle defined from RDS or RBDS
 
|
{class="wikitable sortable" width="100%"
|-
! InfoLabels
|  <code>RDS.RadioStyle</code>
! style="80%" | Description
The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
! Version
|
|-
|  <code>RDS.SmsStudio</code>
| The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
|
|-
|-
|  <code>Visualisation.Preset</code>
|  <code>RDS.Title</code>
Shows the current preset of the visualisation.
Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|
|-
|-
|  <code>Visualisation.Name</code>
|  <code>RDS.TrackNumber</code>
Shows the name of the visualisation.
The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)
|
|
|}
|}


=== Weather labels ===
=== Skin ===
 
{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
! InfoLabels
! InfoLabels
Line 3,390: Line 3,867:
! Version
! Version
|-
|-
|  <code>Weather.Conditions</code>
|  <code>Skin.AspectRatio</code>
Current weather conditions – this is looked up in a background process.
Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|
|
|-
|-
|  <code>Weather.Temperature</code>
|  <code>Skin.CurrentColourTheme</code>
Current weather temperature
Returns the current selected colour theme of the skin.
|
|-
|  <code>Skin.CurrentTheme</code>
|  Returns the current selected skin theme.
|
|
|-
|-
|  <code>Weather.Location</code>
|  <code>Skin.Font</code>
City/town which the above two items are for
Returns the current fontset from Font.xml.
|  v18 addition
|-
|  <code>Skin.Numeric(settingid)</code>
|  '''Returns'''
:return the setting value as an integer/numeric value.
'''See also'''
:<code>Skin.SetNumeric(settingid)</code>
|
|
|-
|-
|  <code>Weather.fanartcode</code>
|  <code>Skin.String(name)</code>
Current weather fanartcode.
Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) '''[[List of Built In Functions]]'''. Allows skinners to have <span class="nobr">user-customisable</span> labels.
|
|
|-
|-
|  <code>Weather.plugin</code>
|  <code>Skin.TimerElapsedSecs(timer)</code>
Current weather plugin.
'''Returns'''
:The elapsed time in seconds for the provided <code>timer</code>.
'''Parameters'''
:timer - the timer name
|
|
|}
|}


=== Window ===
=== Slideshow ===
 
{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
! InfoLabels
! InfoLabels
Line 3,418: Line 3,908:
! Version
! Version
|-
|-
|  <code>Window([window]).Property(key)</code>
|  <code>Slideshow.Altitude</code>
Window property. (key can be any value, optional window can be id or name)
Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|
|-
|-
|  <code>Window.Property(xmlfile)</code>
|  <code>Slideshow.Aperture</code>
Displays the name of the xml file currently shown
Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|
|-
|-
|  <code>Window.Property(IsRadio)</code>
|  <code>Slideshow.Author</code>
Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|
|-
|-
|  <code>Window(AddonBrowser).Property(Updated)</code>
|  <code>Slideshow.Byline</code>
|  Shows the date and time the addon repo was last checked for updates
|  Shows the name of the person who created the current picture.  This is the value of the IPTC Byline tag (hex code 0x50).
|
|
|-
|-
|  <code>Window.Property(Addon.ID)</code>
|  <code>Slideshow.BylineTitle</code>
Returns the id of the selected addon, in DialogAddonSettings.xml
Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|
|-
|-
|  <code>Window(Home).Property(key)</code>
|  <code>Slideshow.CameraMake</code>
The home window has the following info labels.
Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F).
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount
 
LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path
 
LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path
 
LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart
 
LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path
 
LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|
|-
|-
|  <code>Window(Weather).Property(key)</code>
|  <code>Slideshow.CameraModel</code>
The weather window has the following info labels.
Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110).
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider
 
 
Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|
|}
=== Images Available in Kodi ===
See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|-
|  <code>ListItem.Art(type)</code>
|  <code>Slideshow.Caption</code>
|  Artwork for the current listitem.
|  Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|
|-
|-
|  <code>Fanart.Image</code>
|  <code>Slideshow.Category</code>
|  Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|  Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|
|-
|-
|  <code>ListItem.Thumb</code>
|  <code>Slideshow.CCDWidth</code>
|  Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|  Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|
|-
|-
|  <code>ListItem.Icon</code>
|  <code>Slideshow.City</code>
Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|  Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|
|-
|-
|  <code>ListItem.ActualIcon</code>
|  <code>Slideshow.Colour</code>
|  Shows the default icon of the currently selected item in a list or thumb control.
|  Shows whether the current picture is "Colour" or "Black and White".
|
|
|-
|-
|  <code>ListItem.Overlay</code>
|  <code>Slideshow.CopyrightNotice</code>
|  Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|  Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|
|-
|-
|  <code>ListItem.EPGEventIcon</code>
|  <code>Slideshow.Country</code>
Returns the icon of the EPG programme (if available).
|  Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
| v18
|
|-
|-
|  <code>ListItem.Property(Fanart_Image)</code>
|  <code>Slideshow.CountryCode</code>
Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|  Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|
|-
|-
|  <code>MusicPlayer.Cover</code>
|  <code>Slideshow.Credit</code>
|  Cover of currently playing album
|  Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|
|-
|-
|  <code>MusicPlayer.Property(Fanart_Image)</code>
|  <code>Slideshow.DigitalZoom</code>
|  Fanart image of the currently playing artist
|  Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404). 
|
|
|-
|-
|  <code>Player.Art(type)</code>
|  <code>Slideshow.EXIFComment</code>
|  Artwork for the currently playing item.
|  Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
|  <code>Slideshow.EXIFDate</code>
|  Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
|  <code>Slideshow.EXIFDescription</code>
|  Shows a short description of the current picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
|  <code>Slideshow.EXIFSoftware</code>
|  Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131).
|
|-
|  <code>Slideshow.EXIFTime</code>
|  Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
|  <code>Slideshow.Exposure</code>
|  Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
|  <code>Slideshow.ExposureBias</code>
|  Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
|  <code>Slideshow.ExposureMode</code>
|  Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
|  <code>Slideshow.ExposureTime</code>
|  Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
|  <code>Slideshow.Filedate</code>
|  Shows the file date of the current picture
|
|-
|  <code>Slideshow.Filename</code>
|  Shows the file name of the current picture
|
|-
|  <code>Slideshow.Filesize</code>
|  Shows the file size of the current picture
|
|-
|  <code>Slideshow.FlashUsed</code>
|  Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209). 
|
|-
|  <code>Slideshow.FocalLength</code>
|  Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
|  <code>Slideshow.FocusDistance</code>
|  Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
|-
|  <code>Slideshow.Headline</code>
|  Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
|  <code>Slideshow.ImageType</code>
|  Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
|  <code>Slideshow.IPTCDate</code>
|  Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
|  <code>Slideshow.ISOEquivalence</code>
|  Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
|  <code>Slideshow.Keywords</code>
|  Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
|  <code>Slideshow.Latitude</code>
|  Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
|  <code>Slideshow.LightSource</code>
|  Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
|
|-
|  <code>Slideshow.LongEXIFDate</code>
|  Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
|  <code>Slideshow.LongEXIFTime</code>
|  Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
|  <code>Slideshow.Longitude</code>
|  Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
|  <code>Slideshow.MeteringMode</code>
|  Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
|  <code>Slideshow.ObjectName</code>
|  Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
|  <code>Slideshow.Orientation</code>
|  Shows the orientation of the current picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
|  <code>Slideshow.Path</code>
|  Shows the file path of the current picture
|
|-
|  <code>Slideshow.Process</code>
|  Shows the process used to compress the current picture
|
|-
|  <code>Slideshow.ReferenceService</code>
|  Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
|  <code>Slideshow.Resolution</code>
|  Shows the dimensions of the current picture (Width x Height)
|
|-
|  <code>Slideshow.SlideComment</code>
|  Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
|-
|  <code>Slideshow.SlideIndex</code>
|  Shows the slide index of the current picture
|
|-
|  <code>Slideshow.Source</code>
|  Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
|  <code>Slideshow.SpecialInstructions</code>
|  Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
|  <code>Slideshow.State</code>
|  Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
|  <code>Slideshow.Sublocation</code>
|  Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
|  <code>Slideshow.SupplementalCategories</code>
|  Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
|  <code>Slideshow.TimeCreated</code>
|  Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
|  <code>Slideshow.TransmissionReference</code>
|  Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
|  <code>Slideshow.Urgency</code>
|  Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
|  <code>Slideshow.WhiteBalance</code>
|  Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|}
 
=== System ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|  <code>System.AddonTitle(id)</code>
|  Returns the title of the addon with the given id
|
|-
|  <code>System.AddonUpdateCount</code>
|  The number of available addon updates
|  v19
|-
|  <code>System.AddonVersion(id)</code>
|  Returns the version of the addon with the given id
|
|-
|  <code>System.AlarmPos</code>
|  Shutdown Timer position
|
|-
|  <code>System.BatteryLevel</code>
|  Returns the remaining battery level in range 0-100
|
|-
|  <code>System.BuildDate</code>
|  Date of build
|
|-
|  <code>System.BuildVersion</code>
|  version of build
|
|-
|  <code>System.BuildVersionCode</code>
|  The internal version of the kodi build
|  v19
|-
|  <code>System.BuildVersionGit</code>
|  The git version (sha) of the kodi build
|  v19
|-
|  <code>System.BuildVersionShort</code>
|  '''Returns'''
:The shorter string with version of build.
|
|-
|  <code>System.CoreUsage(id)</code>
|  Displays the usage of the cpu core with the given 'id'
|
|-
|  <code>System.CpuFrequency</code>
|  System cpu frequency
|
|-
|  <code>System.CPUTemperature</code>
|  Current CPU temperature
|
|-
|  <code>System.CpuUsage</code>
|  Displays the cpu usage for each individual cpu core.
|
|-
|  <code>System.CurrentControl</code>
|  Current focused control
|
|-
|  <code>System.CurrentControlID</code>
|  ID of the currently focused control.
|
|-
|  <code>System.CurrentWindow</code>
|  Current Window we are in
|
|-
|  <code>System.Date</code>
|  Current date
|
|-
|  <code>System.Date(format)</code>
|  Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
|
|-
|  <code>System.DVDLabel</code>
|  Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
|  <code>System.FanSpeed</code>
|  Current fan speed
|
|-
|  <code>System.FPS</code>
|  Current rendering speed (frames per second)
|
|-
|  <code>System.FreeMemory</code>
|  Amount of free memory in Mb
|
|-
|  <code>System.FreeSpace</code>
|  Total Freespace on the drive
|
|-
|  <code>System.FreeSpacePercent</code>
|  Total Freespace Percent on the drive
|
|-
|  <code>System.FriendlyName</code>
|  Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
|
|-
|  <code>System.GetBool(boolean)</code>
|  '''Returns'''
:The value of any standard system boolean setting.
{{highlight|'''Note'''<br>Will not work with settings in advancedsettings.xml}}
|
|-
|  <code>System.GPUTemperature</code>
|  Current GPU temperature
|
|-
|  <code>System.HddTemperature</code>
|  Hdd temperature
|
|-
|  <code>System.InternetState</code>
|  Will return the internet state, 'connected' or 'not connected' (localized)
|
|-
|  <code>System.KernelVersion (deprecated)</code>
|  System name + kernel version
|
|-
|  <code>System.Language</code>
|  Shows the current language
|
|-
|  <code>System.Locale(type)</code>
|  '''Returns'''
:Locale-specific information depending on the requested type.
'''Parameters'''
:type - Can be one of the following:
:region The currently selected region name within the selected language ( <code>System.Language</code> ).
:iso The country code of the currently selected region as specified in langinfo.xml.
:[Removed options] <code>timezonecountry</code> and <code>timezone</code> from <code>System.Locale(type)</code>
|
|-
|  <code>System.Memory(format)</code>
|  Available formats: used, used.percent, free, free.percent, total
|
|-
|  <code>System.OSVersionInfo</code>
|  System name + kernel version
|
|-
|  <code>System.PrivacyPolicy</code>
|  '''Returns'''
:The official Kodi privacy policy.
|
|-
|  <code>System.ProfileAutoLogin</code>
|  The profile Kodi will auto login to
|
|-
|  <code>System.ProfileCount</code>
|  Shows the number of defined profiles
|
|-
|  <code>System.ProfileName</code>
|  Shows the User name of the currently logged in Kodi user
|
|-
|  <code>System.Progressbar</code>
|  The percentage of the currently active progress.
|
|-
|  <code>System.ScreenHeight</code>
|  Height of screen in pixels
|
|-
|  <code>System.ScreenMode</code>
|  Screenmode (e.g. windowed / fullscreen)
|
|-
|  <code>System.ScreenResolution</code>
|  Screen resolution
|
|-
|  <code>System.ScreenWidth</code>
|  Width of screen in pixels
|
|-
|  <code>System.StartupWindow</code>
|  The Window Kodi will load on startup
|
|-
|  <code>System.StereoscopicMode</code>
|  The prefered stereoscopic mode (settings > video > playback)
|
|-
|  <code>System.SupportedHDRTypes</code>
|  '''Returns'''
:The display's supported HDR types.
|
|-
|  <code>System.TemperatureUnits</code>
|  Shows Celsius or Fahrenheit symbol
|
|-
|  <code>System.Time</code>
|  Current time
|
|-
|  <code>System.Time(format)</code>
|  Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
|
|-
|  <code>System.TotalSpace</code>
|  Totalspace on the drive
|
|-
|  <code>System.TotalUptime</code>
|  System total uptime
|
|-
|  <code>System.Uptime</code>
|  System current uptime
|
|-
|  <code>System.UsedSpace</code>
|  Total Usedspace on the drive
|
|-
|  <code>System.UsedSpacePercent</code>
|  Total Usedspace Percent on the drive
|
|-
|  <code>System.VideoEncoderInfo</code>
|  video encoder info
|
|}
 
=== Visualisation ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|  <code>Visualisation.Name</code>
|  Shows the name of the visualisation.
|
|-
|  <code>Visualisation.Preset</code>
|  Shows the current preset of the visualisation.
|
|}
 
=== Weather ===
 
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|  <code>Weather.Data(property)</code>
|  '''Returns'''
:Weather data, as specified by the parameter.
|
|-
|  <code>Weather.LastUpdated</code>
|  '''Returns'''
:The localized date and time weather data were last updated, empty string if not available.
|
|}
 
=== Weather labels ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|  <code>Weather.Conditions</code>
Current weather conditions – this is looked up in a background process.
|
|-
|  <code>Weather.fanartcode</code>
|  Current weather fanartcode.
|
|-
|  <code>Weather.Location</code>
|  City/town which the above two items are for
|
|-
|  <code>Weather.plugin</code>
|  Current weather plugin.
|
|-
|  <code>Weather.Temperature</code>
|  Current weather temperature
|
|}
 
=== Window ===
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|  <code>Window(AddonBrowser).Property(Updated)</code>
|  Shows the date and time the addon repo was last checked for updates
|
|-
|  <code>Window(Home).Property(key)</code>
|  The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount
 
LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path
 
LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path
 
LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart
 
LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path
 
LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
|  <code>Window(Weather).Property(key)</code>
|  The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider
 
 
Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits
|
|-
|  <code>Window([window]).Property(key)</code>
|  Window property. (key can be any value, optional window can be id or name)
|
|-
|  <code>Window.Property(Addon.ID)</code>
|  Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
|  <code>Window.Property(IsRadio)</code>
|  Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
|
|-
|  <code>Window.Property(xmlfile)</code>
|  Displays the name of the xml file currently shown
|
|}
 
=== Images Available in Kodi ===
 
See '''[[Artwork/Accessing with skins and JSON-RPC]]''' for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.
{|  class="wikitable sortable" width="100%"
! InfoLabels
! style="80%" | Description
! Version
|-
|  <code>Fanart.Image</code>
|  Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
|
|-
|  <code>ListItem.ActualIcon</code>
|  Shows the default icon of the currently selected item in a list or thumb control.
|
|-
|  <code>ListItem.Art(type)</code>
|  Artwork for the current listitem.
|
|-
|  <code>ListItem.EPGEventIcon</code>
Returns the icon of the EPG programme (if available).
| v18
|-
|  <code>ListItem.Icon</code>
|  Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
|
|-
|  <code>ListItem.Overlay</code>
|  Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
|
|-
|  <code>ListItem.Property(Fanart_Image)</code>
Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
|
|-
|  <code>ListItem.Thumb</code>
Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
|
|-
|  <code>MusicPlayer.Cover</code>
|  Cover of currently playing album
|
|-
|  <code>MusicPlayer.Property(Fanart_Image)</code>
|  Fanart image of the currently playing artist
|
|-
|  <code>Player.Art(type)</code>
|  Artwork for the currently playing item.
|
|
|-
|-
Line 3,523: Line 4,561:
|
|
|-
|-
|  <code>Pvr.NowRecordingChannelIcon</code>
|  <code>Pvr.EPGEventIcon</code>
Channel icon of the programme currently being recorded.
Returns the icon of the currently playing EPG programme (if available).
|
| v18
|-
|-
|  <code>Pvr.NextRecordingChannelIcon</code>
|  <code>Pvr.NextRecordingChannelIcon</code>
Line 3,531: Line 4,569:
|
|
|-
|-
|  <code>Pvr.EPGEventIcon</code>
|  <code>Pvr.NowRecordingChannelIcon</code>
Returns the icon of the currently playing EPG programme (if available).
Channel icon of the programme currently being recorded.
| v18
|
|-
|-
|  <code>Skin.String(name)</code>
|  <code>Skin.String(name)</code>
Line 3,553: Line 4,591:
|  <code>Weather.ConditionsIcon</code>
|  <code>Weather.ConditionsIcon</code>
|  Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|  Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
|  <code>Window([window]).Property(key)</code>
|  Window property. (key can be any value, optional window can be id or name)
|
|
|-
|-
Line 3,562: Line 4,596:
|  The weather window has the following info images.
|  The weather window has the following info images.
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo
|
|-
|  <code>Window([window]).Property(key)</code>
|  Window property. (key can be any value, optional window can be id or name)
|
|
|}
|}

Latest revision as of 13:57, 22 June 2026

  ▶ Development ▶ Add-on development ▶ Skinning ▶ InfoLabels


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

Addon

InfoLabels Description Version
Addon.SettingInt(addon_id,setting_id) Returns
The integer value of the setting setting_id belonging to the addon with the id addon_id.

Parameters

addon_id - The id of the addon
setting_id - The addon setting

Note
The provided setting with setting_id must be an integer setting type.
Otherwise it will return the integer info default value (which is 0).

v20
Addon.SettingStr(addon_id,setting_id) Returns
The string value of the setting setting_id belonging to the addon with the id addon_id.

Parameters

addon_id - The id of the addon
setting_id - The addon setting
v20

Container

Note
If no id is specified it grabs the current container.

InfoLabels Description Version
Container(id).Column Returns
The column number of the focused position in a panel container.
Container(id).CurrentItem Returns
The current item in the container or grouplist with given id.
Container(id).CurrentPage Returns
The current page in the container with given id.
Container(id).ListItem(offset).Property 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).ListItemAbsolute(x).[infolabel] Returns
The infolabel for an item in a container.

Parameters

x - The absolute position in the container.

Note
Example: Container(50).ListItemAbsolute(4).Genre

Container(id).ListItemNoWrap(offset).Property Returns
The same as Container(id).ListItemNoWrap(offset).Property but it won't wrap.
This 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.

Parameters

offset - The offset for the listitem.

Note
Property has to be replaced with Label, Label2, Icon, etc.
Example: Container(50).ListitemNoWrap(1).Plot

Container(id).ListItemPosition(x).[infolabel] 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).ListItemAbsolute(4).Genre

Container(id).NumAllItems Returns
The number of all items in the container or grouplist with given id including parent folder item.
v18
Container(id).NumItems Returns
The number of items in the container or grouplist with given id excluding parent folder item.
Container(id).NumNonFolderItems Returns
The number of items in the container or grouplist with given id excluding all folder items (e.g. pvr recordings folders, parent ".." folder, "All albums", etc).
v18
Container(id).NumPages Returns
The number of pages in the container with given id.
Container(id).Position Returns
The current focused position of container / grouplist (id) as a numeric label.
Container(id).Row Returns
The row number of the focused position in a panel container.
Container(id).TotalUnWatched Returns
The number of unwatched items in the container.
v16
Container(id).TotalWatched Returns
The number of watched items in the container.
v16
Container.Art(type) 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

v15

Container.Content Returns
The content of the current container.
v16
Container.FolderName Returns
The top most folder in currently displayed folder.
Container.FolderPath Returns
The complete path of currently displayed folder.
Container.PluginCategory Returns
The current plugins category (set by the scripter).
v17
Container.PluginName Returns
The current plugins base folder name.
Container.Property(addoncategory) Returns
The current add-on category.
Container.Property(reponame) Returns
The current add-on repository name.
Container.ShowPlot Returns
The TV Show plot of the current container and can be used at season and episode level.
Container.ShowTitle Returns
The TV Show title of the current container and can be used at season and episode level.
v17
Container.SortMethod Returns
The current sort method (returns a localized value).
Container.SortOrder Returns
The current sort order (Ascending/Descending).
v16
Container.Totaltime Returns
The total time of all items in the current container.
Container.ViewCount Returns
The number of available skin view modes for the current container listing.
v17
Container.Viewmode Returns
The current viewmode (e.g. list, icons, etc).

Control

InfoLabels Description Version
Control.GetLabel(id)[.index()] 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

Fanart

Note
Colors are arranged Lightest to Darkest.

InfoLabels Description Version
Fanart.Color1 Returns the first of three colors included in the currently selected Fanart theme for the parent TV Show.
Fanart.Color2 Returns the second of three colors included in the currently selected Fanart theme for the parent TV Show.
Fanart.Color3 Returns the third of three colors included in the currently selected Fanart theme for the parent TV Show.

Game

InfoLabels Description Version
Game.Developer Returns
The developer of the game (e.g. Activision).
v18
Game.GameClient Returns
The add-on ID of the emulator used to play the game.
v18
Game.Genres Returns
The genre of the game (e.g. Action).
v18
Game.Overview Returns
The game description.
v18
Game.Platform Returns
The platform the game runs on (e.g. Atari 2600).
v18
Game.Publisher Returns
The publishing company of the game (e.g. Nintendo).
v18
Game.Title Returns
The name of the game.
v18
Game.Year Returns
The year the game was released.
v18

Integer

InfoLabels Description Version
Integer.ValueOf(number) Returns
An integer info label that represents the provided number

Parameters

number - the number to compute

Note
Example: Integer.ValueOf(4) will be evaluated to 4.
Will return -1 if not able to convert the provided value to an integer. Example: Integer.ValueOf(some string) will evaluate to -1 as the provided argument is not an integer.

ListItem

InfoLabels Description Version
ListItem.AddonBroken Deprecated! use ListItem.AddonLifecycleDesc instead.
ListItem.AddonCreator Returns
The name of the author the currently selected addon.
ListItem.AddonDescription Returns
The full description of the currently selected addon.
ListItem.AddonDisclaimer Returns
The disclaimer of the currently selected addon.
ListItem.AddonInstallDate Returns
The date the addon was installed.
ListItem.AddonLastUpdated Returns
The date the addon was last updated.
ListItem.AddonLastUsed Returns
The date the addon was used last.
ListItem.AddonLifecycleDesc Returns
The description of the lifecycle type (e.g. broken due to website changes).
v19
ListItem.AddonLifecycleType Returns
The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated).
v19
ListItem.AddonName Returns
The name of the currently selected addon.
ListItem.AddonNews Returns
A brief changelog, taken from the addons' addon.xml file.
ListItem.AddonOrigin Returns
The name of the repository the add-on originates from.
ListItem.AddonSize Returns
The filesize of the addon.
ListItem.AddonSummary Returns
A short description of the currently selected addon.
ListItem.AddonType Returns
The type of the currently selected addon (e.g. screensaver, script, skin, etc).
ListItem.AddonVersion Returns
The version of the currently selected addon.
ListItem.Album Returns
The album of the currently selected song in a container.
ListItem.AlbumArtist Returns
The artist of the currently selected album in a list.
ListItem.AlbumStatus Returns
The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc).
v19
ListItem.Appearances Returns
The number of movies featuring the selected actor or directed by the selected director.
v17
ListItem.Artist Returns
The artist of the currently selected song in a container.
ListItem.AudioChannels Returns
The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc).
ListItem.AudioCodec Returns
The audio codec of the currently selected video.
Possible values:
  • aac
  • aac_latm
  • aac_lc*
  • aac_ltp*
  • aac_ssr*
  • ac3
  • aif
  • aifc
  • aiff
  • alac
  • ape
  • avc
  • cdda
  • dca**
  • dts***
  • dolbydigital
  • dtshd_hra
  • dtshd_ma
  • dtshd_ma_x*
  • dtshd_ma_x_imax*
  • dtsma
  • eac3
  • eac3_ddp_atmos*
  • flac
  • he_aac*
  • he_aac_v2*
  • mp1
  • mp2
  • mp3
  • mp3float
  • ogg
  • opus
  • pcm
  • pcm_bluray
  • pcm_s16le
  • pcm_s24le
  • truehd
  • truehd_atmos*
  • vorbis
  • wav
  • wavpack
  • wmapro
  • wmav2
** note: dca replaced dts in 2011. Deprecated in 2026 / v22.
*** note: dts used before 2011 and reintroduced in 2026 / v22.
*v22
ListItem.AudioLanguage Returns
The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
ListItem.BitRate Returns
The actual bitrate for CBR or average bitrate for VBR of the currently selected song.
v19
ListItem.BPM Returns
The Beats Per Minute of the currently selected song.
v19
ListItem.Cast Returns
The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml.
ListItem.Cast(separator) Returns
A list of cast members, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
ListItem.CastAndRole Returns
The list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, for use in dialogvideoinfo.xml.
ListItem.CastAndRole(separator) Returns
A list of cast members and roles, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
ListItem.ChannelGroup Returns
The channel group of the selected item ( PVR ).
ListItem.ChannelLogo Returns
The logo of the currently selected radio or TV channel (PVR).
v22
ListItem.ChannelName Returns
The name of current selected TV channel in a container (PVR).
ListItem.ChannelName Returns
The channel name of the selected item (PVR).
ListItem.ChannelNumber Returns
The channel number of the selected item (PVR).
ListItem.ChannelNumberLabel Returns
The channel and subchannel number of the currently selected channel that's currently playing (PVR).
ListItem.Comment Returns
The comment assigned to the item (PVR/MUSIC).
ListItem.ContributorAndRole Returns
The list of all people and their role who've contributed to the selected song.
ListItem.Contributors Returns
The list of all people who've contributed to the selected song.
ListItem.Country Returns
The production country of the currently selected movie in a container.
ListItem.CurrentItem Returns
The current index of the item in a container starting at 1.
v19
ListItem.Date Returns
The file date of the currently selected song or movie in a container, the aired date of an episode, or the day, start time, and end time of the currently selected TV programme (PVR).
ListItem.DateAdded Returns
The date the currently selected item was added to the library or date and time of an event in the EventLog window.
ListItem.DateTime Returns
The date and time a certain event happened (event log).
ListItem.DBID Returns
The database id of the currently selected ListItem in a container.
ListItem.DBTYPE Returns
The database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist).

Note
With season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.

ListItem.DecodedFileNameAndPath Returns
The full path with filename of the currently selected song or movie in a container decoded.
ListItem.Developer Returns
The game developer (e.g. "Square") (RETROPLAYER).
ListItem.Director Returns
The director of the currently selected movie in a container.
ListItem.Director(separator) Returns
A list of directors, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
ListItem.DiscNumber Returns
The disc number of the currently selected song in a container.
ListItem.DiscTitle Returns
The disc title of the currently selected album or song.
v19
ListItem.Duration[(format)] Returns
The song or movie duration of the currently selected movie in a container. Optionally specify a time format, hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
ListItem.EndDate Returns
The end date of the selected item (PVR).
ListItem.EndTime Returns
The end time of current selected TV programme in a container (PVR).
ListItem.EndTimeResume Returns
The time a video will end if you resume it, instead of playing it from the beginning.
ListItem.EpgEventTitle Returns
The title of the epg event associated with the item, if any.
ListItem.Episode Returns
The episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
ListItem.EpisodeName Returns
The name of the episode if the selected EPG item is a TV Show (PVR).
ListItem.EpisodePart Returns
string containing the number of parts of a single episode - empty if no data provided
ListItem.ExpirationDate Returns
The expiration date of the selected item in a container, empty string if not supported.
ListItem.ExpirationTime Returns
The expiration time of the selected item in a container, empty string if not supported
ListItem.FileExtension Returns
The file extension (without leading dot) of the currently selected item in a container.
ListItem.FileName Returns
The filename of the currently selected song or movie in a container.
ListItem.FileNameAndPath Returns
The full path with filename of the currently selected song or movie in a container.
ListItem.FileNameNoExtension Returns
The filename without its extension.
v19
ListItem.FolderName Returns
The top most folder of the path of the currently selected song or movie in a container.
ListItem.FolderPath Returns
The complete path of the currently selected song or movie in a container (without user details).
ListItem.GameClient Returns
The add-on ID of the game client (a.k.a. emulator) to use for playing the game (e.g. game.libretro.fceumm) (RETROPLAYER).
ListItem.Genre Returns
The genre of the currently selected song, album, or movie in a container.
ListItem.Genre(separator) Returns
A list of genres, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos or music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
ListItem.Genres Returns
The game genres (e.g. "["Action","Strategy"]") (RETROPLAYER).
ListItem.HdrDetail Returns
String containing details for the HDR type (currently only for DV - profile and EL type) or empty if not HDR. Prints eg 5, 7FEL, and compatibility ID for profile 8 eg 8.4.
ListItem.HdrType Returns
The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg).
v20
ListItem.IMDBNumber Returns
The IMDB iD of the selected Video in a container.
ListItem.Label Returns
The left label of the currently selected item in a container.
ListItem.Label2 Returns
The right label of the currently selected item in a container.
ListItem.LastPlayed Returns
The last play date of video in a container.
ListItem.MediaProviders Returns
string containing the names of the media providers of the item, separated by commas if multiple are present.
ListItem.Mood Returns
The mood of the selected song.
ListItem.Mpaa Returns
The MPAA rating of the currently selected movie in a container.
ListItem.MusicChannels Returns
The number of audio channels for a song.
v19
ListItem.NextDuration Returns
The duration of the next item (PVR).
v18
ListItem.NextEndDate Returns
The end date of the next item (PVR).
ListItem.NextEndTime Returns
The end of the next item (PVR).
ListItem.NextGenre Returns
The genre of the next item (PVR).
ListItem.NextGenre(separator) Returns
A list of genres of the the next item (PVR), separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
ListItem.NextPlot Returns
The plot of the next item (PVR).
ListItem.NextPlotOutline Returns
The plot outline of the next item (PVR).
ListItem.NextStartDate Returns
The start date of the next item (PVR).
ListItem.NextStartTime Returns
The start time of the next item (PVR).
ListItem.NextTitle Returns
The title of the next item (PVR).
ListItem.OriginalDate Returns
The original release date of the item.
v19
ListItem.OriginalTitle Returns
The original title of the currently selected movie in a container.
ListItem.Overview Returns
The game overview/summary (RETROPLAYER).
ListItem.ParentalRating Returns
The parental rating of the list item ( PVR ).
ListItem.ParentalRatingCode Returns
The parental rating code.
v22
ListItem.ParentalRatingIcon Returns
The parental rating icon.
v22
ListItem.ParentalRatingSource Returns
The parental rating source.
v22
ListItem.Path Returns
The complete path of the currently selected song or movie in a container.
ListItem.PercentPlayed Returns
The returns percentage value [0-100] of how far the selected video has been played.
ListItem.PictureAperture Returns
The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
ListItem.PictureAuthor Returns
The name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
ListItem.PictureByline Returns
The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
ListItem.PictureBylineTitle Returns
The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
ListItem.PictureCamMake Returns
The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
ListItem.PictureCamModel Returns
The manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
ListItem.PictureCaption Returns
The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
ListItem.PictureCategory Returns
The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
ListItem.PictureCCDWidth Returns
The width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
ListItem.PictureCity Returns
The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
ListItem.PictureColour Returns
Whether the selected picture is "Colour" or "Black and White".
ListItem.PictureComment Returns
The description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
ListItem.PictureCopyrightNotice Returns
The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
ListItem.PictureCountry Returns
The full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
ListItem.PictureCountryCode Returns
The country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
ListItem.PictureCredit Returns
The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
ListItem.PictureDate Returns
The localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
ListItem.PictureDatetime Returns
The date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
ListItem.PictureDesc Returns
The short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
ListItem.PictureDigitalZoom Returns
The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
ListItem.PictureExpMode Returns
The exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
ListItem.PictureExposure 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. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
ListItem.PictureExposureBias Returns
The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
ListItem.PictureExpTime Returns
The exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
ListItem.PictureFlashUsed Returns
The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
ListItem.PictureFocalLen Returns
The lens focal length of the selected picture.
ListItem.PictureFocusDist Returns
The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
ListItem.PictureGPSAlt Returns
The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
ListItem.PictureGPSLat Returns
The latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
ListItem.PictureGPSLon Returns
The longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
ListItem.PictureHeadline Returns
The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
ListItem.PictureImageType Returns
The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
ListItem.PictureIPTCDate Returns
The date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
ListItem.PictureIPTCTime Returns
The time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
ListItem.PictureISO Returns
The ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
ListItem.PictureKeywords Returns
The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
ListItem.PictureLightSource Returns
The kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208).
ListItem.PictureLongDate Returns
The localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
ListItem.PictureLongDatetime Returns
The date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
ListItem.PictureMeteringMode Returns
The metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
ListItem.PictureObjectName Returns
The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
ListItem.PictureOrientation Returns
The orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
ListItem.PicturePath Returns
The filename and path of the selected picture.
ListItem.PictureProcess Returns
The process used to compress the selected picture.
ListItem.PictureReferenceService Returns
The service identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
ListItem.PictureResolution Returns
The dimensions of the selected picture.
ListItem.PictureSource Returns
The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
ListItem.PictureSpecialInstructions Returns
The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
ListItem.PictureState Returns
The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
ListItem.PictureSublocation Returns
The location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
ListItem.PictureSupplementalCategories Returns
The supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
ListItem.PictureTransmissionReference Returns
The code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
ListItem.PictureUrgency Returns
The urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
ListItem.PictureWhiteBalance Returns
The white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
ListItem.Platform Returns
The game platform (e.g. "Atari 2600") (RETROPLAYER).
ListItem.PlayCount Returns
The playcount of video in a container.
ListItem.Plot Returns
The complete text summary of video in a container.
ListItem.PlotOutline Returns
The small summary of current video in a container.
ListItem.Premiered Returns
The release/aired date of the currently selected episode, show, movie, or EPG item in a container.
ListItem.PrivacyPolicy Returns
The official Kodi privacy-policy.
v17
ListItem.ProgramCount Returns
The number of times an xbe has been run from "my programs".
ListItem.Progress Returns
The part of the programme that's being played (PVR).
ListItem.Property(Addon.Changelog) Returns
The changelog of the currently selected addon.
ListItem.Property(Addon.ID) Returns
The identifier of the currently selected addon.
ListItem.Property(Addon.Path) Returns
The path of the currently selected addon.
ListItem.Property(Addon.Status) Returns
The status of the currently selected addon.
ListItem.Property(Album_Description) Returns
The review of the currently selected album.
ListItem.Property(Album_Duration) Returns
The duration of an album in HH:MM:SS.
v19
ListItem.Property(Album_Label) Returns
The record label of the currently selected album.
ListItem.Property(Album_Mood) Returns
The moods of the currently selected album.
ListItem.Property(Album_Rating) Returns
The scraped rating of the currently selected album.
ListItem.Property(Album_Style) Returns
The styles of the currently selected album.
ListItem.Property(Album_Theme) Returns
The themes of the currently selected album.
ListItem.Property(Album_Type) Returns
The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics).
ListItem.Property(Album_UserRating) Returns
The user rating of the currently selected album.
ListItem.Property(Artist_Born) Returns
The Date of Birth of the currently selected artist.
ListItem.Property(Artist_Description) Returns
The biography of the currently selected artist.
ListItem.Property(Artist_Died) Returns
The Date of Death of the currently selected artist.
ListItem.Property(Artist_Disambiguation) Returns
The brief description of the currently selected artist that differentiates them from others with the same name.
v18
ListItem.Property(Artist_Disbanded) Returns
The disbanding date of the currently selected band.
ListItem.Property(Artist_Formed) Returns
The formation date of the currently selected band.
ListItem.Property(Artist_Gender) Returns
The gender of the currently selected artist (e.g.male, female, or other).
v18
ListItem.Property(Artist_Genre) Returns
The genre of the currently selected artist.
ListItem.Property(Artist_Instrument) Returns
The instruments played by the currently selected artist.
ListItem.Property(Artist_Mood) Returns
The moods of the currently selected artist.
ListItem.Property(Artist_Sortname) Returns
The sortname of the currently selected artist.
v18
ListItem.Property(Artist_Style) Returns
The styles of the currently selected artist.
ListItem.Property(Artist_Type) Returns
The type of the currently selected artist (person, group, orchestra, choir, etc).
v18
ListItem.Property(Artist_YearsActive) Returns
The years the currently selected artist has been active.
ListItem.Property(AudioChannels.[n]) Returns
The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels).
ListItem.Property(AudioCodec.[n]) Returns
The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec).
ListItem.Property(AudioLanguage.[n]) Returns
The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage).
ListItem.Property(game.stretchmode) Returns
The name of the stretch mode (e.g. Stretch 4:3).
v18
ListItem.Property(game.videofilter) Returns
The name of the video filter (e.g. Bilinear).
v18
ListItem.Property(game.videorotation) Returns
The angle of the rotation.
v18
ListItem.Property(NumEpisodes) Returns
The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter.
ListItem.Property(Role.Arranger) Returns
The name of the person who arranged the selected song.
ListItem.Property(Role.Composer) Returns
The name of the person who composed the selected song.
ListItem.Property(Role.Conductor) Returns
The name of the person who conducted the selected song.
ListItem.Property(Role.DJMixer) Returns
The name of the DJ who remixed the selected song.
ListItem.Property(Role.Engineer) Returns
The name of the person who was the engineer of the selected song.
ListItem.Property(Role.Lyricist) Returns
The name of the person who wrote the lyrics of the selected song.
ListItem.Property(Role.Mixer) Returns
The name of the person who mixed the selected song.
ListItem.Property(Role.Orchestra) Returns
The name of the orchestra performing the selected song.
ListItem.Property(Role.Producer) Returns
The name of the person who produced the selected song.
ListItem.Property(Role.Remixer) Returns
The name of the person who remixed the selected song.
ListItem.Property(Stream.Bitrate) Returns
The video bitrate (kbps) of the currently playing video.
v22
ListItem.Property(Stream.Channels) Returns
The number of audio channels of the currently playing video.
v22
ListItem.Property(Stream.Codec) Returns
The audio, video, or subtitle codec of the currently playing video.
v22
ListItem.Property(Stream.CodecDesc) Returns
The audio description of the currently playing video.
v22
ListItem.Property(Stream.Description) Returns
The audio, video, or subtitle title/name of the currently playing video.
v22
ListItem.Property(Stream.FPS) Returns
The Frames per Second of the currently playing video.
v22
ListItem.Property(Stream.HDRType) Returns
The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg).
v22
ListItem.Property(Stream.Language) Returns
The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc).
v22
ListItem.Property(Stream.Resolution) Returns
The video resolution of the currently playing video.
v22
ListItem.Property(Stream.StereoMode) Returns
The 3D stereo mode of the playing video (e.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
v22
ListItem.Property(SubtitleLanguage.[n]) Returns
The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage).
ListItem.Property(TotalEpisodes) Returns
The total number of episodes for the currently selected TV show or season.
ListItem.Property(TotalSeasons) Returns
The total number of seasons for the currently selected TV show.
ListItem.Property(UnWatchedEpisodes) Returns
The number of unwatched episodes for the currently selected TV show or season.
ListItem.Property(WatchedEpisodes) Returns
The number of watched episodes for the currently selected TV show or season.
ListItem.Publisher Returns
The game publisher (e.g. "Nintendo") (RETROPLAYER).
ListItem.PVRClientName Returns
The name of the PVR client addon for the selected PVR list item.
v22
ListItem.PVRGroupOrigin Returns
If selected item is of type PVR channel group, the creator (user, system, client) of the group.
ListItem.PVRInstanceName Returns
The name of the instance of the PVR client addon for the selected PVR list item.
v22
ListItem.Rating[(name)] Returns
The scraped rating of the currently selected item in a container. Optionally you can specify the name of the scraper to retrieve a specific rating, for use in dialogvideoinfo.xml.
ListItem.RatingAndVotes[(name)] Returns
The IMDB rating and votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve a specific rating and votes, for use in dialogvideoinfo.xml.
ListItem.ReleaseDate Returns
The release date of the current item.
v19
ListItem.SampleRate Returns
The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc).
v19
ListItem.Season Returns
The season value for the currently selected TV show.
ListItem.Set Returns
The name of the set the movie is part of.
ListItem.SetId Returns
The id of the set the movie is part of.
ListItem.Size Returns
The file size of the currently selected song or movie in a container.
ListItem.SongVideoURL Returns
Link to a video of a song
ListItem.SortLetter Returns
The first letter of the current file in a container.
ListItem.StartDate Returns
The start date of current selected TV programme in a container.
ListItem.StartDate Returns
The start date of the selected item (PVR).
ListItem.StartTime Returns
The start time of current selected TV programme in a container.
ListItem.StartTime Returns
The start time of the selected item (PVR).
ListItem.Status Returns
The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended').
ListItem.StereoscopicMode Returns
The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta).
ListItem.Studio Returns
The studio of current selected music video in a container.
ListItem.SubtitleLanguage Returns
The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu).
ListItem.Tag Returns
The name of the 'tag' this movie is part of.
ListItem.Tagline Returns
The small summary of current video in a container.
ListItem.TimerType Returns
The type of the PVR timer / timer rule item as a human readable string.
ListItem.Title Returns
The title of the currently selected song or movie in a container.
ListItem.TitleExtraInfo Returns
string containing extra information, enriching the title of the item.
ListItem.Top250 Returns
The IMDB top 250 position of the currently selected ListItem in a container.
ListItem.TotalDiscs Returns
The total amount of discs belonging to an album.
v19
ListItem.TrackNumber Returns
The track number of the currently selected song in a container.
ListItem.Trailer Returns
The full trailer path with filename of the currently selected movie in a container.
ListItem.TVShowDBID Returns
The TV show DBID of the selected season or episode a container.
v19
ListItem.TVShowTitle Returns
The name value for the currently selected TV show in the season and episode depth of the video library.
ListItem.UniqueID() Returns
The UniqueID of the selected item in a container.
v19
ListItem.UserRating Returns
The user rating of the currently selected item in a container.
ListItem.VideoAspect Returns
The aspect ratio of the currently selected video.
Possible values:
  • 1.00*
  • 1.19*
  • 1.33
  • 1.37
  • 1.66
  • 1.78
  • 1.85
  • 2.00*
  • 2.20
  • 2.35
  • 2.40
  • 2.55
  • 2.76
*v20
ListItem.VideoCodec Returns
The video codec of the currently selected video.
Possible values:
  • 3iv2
  • av1
  • avc1
  • div2
  • div3
  • divx
  • divx 4
  • dx50
  • flv
  • h264
  • hev1
  • hevc
  • hvc1
  • microsoft
  • mp42
  • mp43
  • mp4v
  • mpeg1
  • mpeg1video
  • mpeg2
  • mpeg2video
  • mpeg4
  • mpg4
  • rv40
  • svq1
  • svq3
  • theora
  • vc-1
  • vc1
  • vp6f
  • vp8
  • vp9
  • wmv
  • wmv2
  • wmv3
  • wvc1
  • xvid
ListItem.VideoHeight Returns
String containing height of video in pixels - empty if unknown.
ListItem.VideoResolution Returns
The resolution of the currently selected video.
Possible values:
  • 480
  • 576
  • 540
  • 720
  • 1080
  • 4K
  • 8K*

Note
That 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.

*v18
ListItem.VideoVersionName Returns
The name of the video version.
v21
ListItem.VideoWidth Returns
String containing width of video in pixels - empty if unknown.
ListItem.Votes[(name)] Returns
The IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes, for use in dialogvideoinfo.xml.
ListItem.Writer Returns
The name of Writer of current video in a container.
ListItem.Writer(separator) Returns
A list of writers, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
ListItem.Year Returns
The year of the currently selected song, album, or movie in a container.

MusicPartyMode

InfoLabels Description Version
MusicPartyMode.MatchingSongs Returns
The number of songs available to Party Mode.
MusicPartyMode.MatchingSongsLeft Returns
The number of songs left to be picked from for Party Mode.
MusicPartyMode.MatchingSongsPicked Returns
The number of songs picked already for Party Mode.
MusicPartyMode.RandomSongsPicked Returns
The number of unique random songs picked during Party Mode.
MusicPartyMode.RelaxedSongsPicked Returns
The number of relaxed songs picked during Party Mode.
MusicPartyMode.SongsPlayed Returns
The number of songs played during Party Mode.

Network

InfoLabels Description Version
Network.DHCPAddress Returns
The DHCP server ip address.
Network.DNS1Address Returns
The network dns server 1 address.
Network.DNS2Address Returns
The network dns server 2 address.
Network.GatewayAddress Returns
The network gateway address.
Network.IPAddress Returns
The system's IP Address. e.g. 192.168.1.15
Network.LinkState Returns
The network linkstate (e.g. 10mbit/100mbit etc).
Network.MacAddress Returns
The system's mac address.
Network.SubnetMask Returns
The network subnet mask.

Player

InfoLabels Description Version
Player.AudioDelay Returns
The used audio delay with the format %2.3f s
Player.Bookmarks Returns
The bookmarks of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
Player.CacheLevel Returns
The used cache level as a string with an integer number.
Player.ChapterName Returns
The name of currently used chapter if available.
Player.Cuts Returns
The EDL cut markers of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
Player.Editlist Returns
The editlist of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.

Note
This infolabel does not contain EDL cuts. Edits start and end times are adjusted according to cuts defined for the media item.

Player.offset(number).Filename Returns
The filename of audio or video file which has an offset number with respect to the currently playing item.
Player.offset(number).FilenameAndPath Returns
The full path with filename of audio or video file which has an offset number with respect to the currently playing item.
Player.offset(number).Folderpath Returns
The full path of the audio or video file which has an offset number with respect to the currently playing item.
Player.offset(number).Title Returns
The title of audio or video which has an offset number with respect to the currently playing item.
Player.position(number).Filename Returns
The filename of the audio or video file which has an offset number with respect to the start of the playlist.
Player.position(number).FilenameAndPath 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.
Player.position(number).Folderpath Returns
The full path of the audio or video file which has an offset number with respect to the start of the playlist.
Player.position(number).Title Returns
The title of the audio or video which has an offset number with respect to the start of the playlist.
Player.SceneMarkers Returns
The EDL scene markers of the currently playing item as csv in the format start1,end1,start2,end2,... Tokens have values in the range from 0.0 to 100.0. end token is greater or equal to the start token.
Player.SeekNumeric([format]) 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.SubtitleDelay Returns
The used subtitle delay with the format %2.3f s
Player.TimeSpeed Returns
The time and the playspeed formatted: "1:23 (2x)".

Player labels

InfoLabels Description Version
Player.Chapter Current chapter of current playing media
Player.ChapterCount Total number of chapters of current playing media
Player.Chapters this infolabel can be used with the Ranges Control, as EDL and chapter markers v19
Player.CutList this infolabel can be used with the Ranges Control, as EDL and chapter markers v19
Player.Duration Total duration of the current playing media
Player.Duration(format) Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.Filename Returns the filename of the currently playing media. (supports .offset() and .position())
Player.Filenameandpath Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position())
Player.FinishTime Time playing media will end
Player.FinishTime(format) Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.Folderpath Shows the full path of the currently playing song or movie. (supports .offset() and .position())
Player.PlaySpeed Current playspeed. (range:0.8 to 1.5)
Player.Process(AudioBitsPerSample) Bits per sample of the currently playing item
Player.Process(AudioChannels) List of audio channels of the currently playing item (e.g. FL+FR)
Player.Process(AudioDecoder) Audiodecoder name of the currently playing item
Player.Process(AudioSamplerate) Samplerate f the currently playing item
Player.Process(DeintMethod) Deinterlace method of the currently playing video
Player.Process(PixFormat) Pixel format of the currently playing video
Player.Process(VideoDAR) Display aspect ratio of the currently playing video
Player.Process(VideoDecoder) Videodecoder name of the currently playing video
Player.Process(VideoFPS) Video framerate of the currently playing video
Player.Process(VideoHeight) Height of the currently playing video
Player.Process(VideoScanType) The scan type identifier of the currently playing video p (for progressive) or i (for interlaced) v20
Player.Process(VideoWidth) Width of the currently playing video
Player.Progress Shows how much (percentage) of the file has been played
Player.ProgressCache Shows how much of the file is cached above current play percentage
Player.SeekBar Time to which the user is seeking as a percentage (for use in slider controls)
Player.SeekOffset Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00)
Player.SeekOffset(format) Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.SeekStepSize Displays the seek step size. (v15 addition)
Player.SeekTime Time to which the user is seeking
Player.StartTime Returns the starttime (from the epg) of a tv program, for all other videos it will return the time you started watching this video.
Player.StartTime(format) Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.Time Elapsed time of current playing media
Player.Time(format) Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.TimeRemaining Remaining time of current playing media
Player.TimeRemaining(format) Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss).
Player.Title Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position())
Player.Volume Returns the volume level in dB

Music player

InfoLabels Description Version
MusicPlayer.AlbumArtist Returns
The album artist of the currently playing song.
MusicPlayer.LastPlayed Returns
The last play date of currently playing song, if it's in the database.
MusicPlayer.MediaProviders Returns
string containing the names of the providers of the currently playing media, separated by commas if multiple are present.
MusicPlayer.offset(number).Album 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.offset(number).Artist 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.offset(number).Comment 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.offset(number).DiscNumber 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.offset(number).Duration 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.offset(number).Genre 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.offset(number).Rating 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.offset(number).Title 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.offset(number).TrackNumber 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.offset(number).Year Returns
The year of release of the song with an offset number with respect to the current playing song.

Parameters

number - the offset number with respect to the current song.
MusicPlayer.ParentalRatingCode Shows the parental rating code v22
MusicPlayer.ParentalRatingIcon Shows the parental rating icon v22
MusicPlayer.ParentalRatingSource Shows the parental rating source v22
MusicPlayer.ChannelLogo Shows the logo of the currently selected radio or TV channel v22
MusicPlayer.PlayCount Returns
The play count of currently playing song, if it's in the database.
MusicPlayer.Position(number).Album 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.Position(number).Artist 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.Position(number).Comment 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.Position(number).DiscNumber 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.Position(number).Duration 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.Position(number).Genre 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.Position(number).Rating 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.Position(number).Title 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.Position(number).TrackNumber 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.Position(number).Year Returns
The year of release of the song with 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.RatingAndVotes Returns
The scraped rating and votes of currently playing song, if it's in the database.
MusicPlayer.Station Returns
The name of the radio station currently playing (if available).
MusicPlayer.Title Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist
MusicPlayer.Album Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist
MusicPlayer.Property(Album_Mood) Shows the moods of the currently playing Album
MusicPlayer.Property(Album_Style) Shows the styles of the currently playing Album
MusicPlayer.Property(Album_Theme) Shows the themes of the currently playing Album
MusicPlayer.Property(Album_Type) Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album
MusicPlayer.Property(Album_Label) Shows the record label of the currently playing Album
MusicPlayer.Property(Album_Description) Shows a review of the currently playing Album
MusicPlayer.Artist Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist
MusicPlayer.Property(Artist_Born) Date of Birth of the currently playing Artist
MusicPlayer.Property(Artist_Died) Date of Death of the currently playing Artist
MusicPlayer.Property(Artist_Formed) Formation date of the currently playing Artist/Band
MusicPlayer.Property(Artist_Disbanded) Disbanding date of the currently playing Artist/Band
MusicPlayer.Property(Artist_YearsActive) Years the currently Playing artist has been active
MusicPlayer.Property(Artist_Instrument) Instruments played by the currently playing artist
MusicPlayer.Property(Artist_Description) Shows a biography of the currently playing artist
MusicPlayer.Property(Artist_Mood) Shows the moods of the currently playing artist
MusicPlayer.Property(Artist_Style) Shows the styles of the currently playing artist
MusicPlayer.Property(Artist_Genre) Shows the genre of the currently playing artist
MusicPlayer.Property(Artist_Sortname) Sortname of the currently playing Artist v18
MusicPlayer.Property(Artist_Type) Type of the currently playing Artist - person, group, orchestra, choir, etc. v18
MusicPlayer.Property(Artist_Gender) Gender of the currently playing Artist - male, female, other v18
MusicPlayer.Property(Artist_Disambiguation) Brief description of the currently playing Artist that differentiates them from others with the same name v18
MusicPlayer.Genre Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist
MusicPlayer.Genre(separator) Returns
A list of genres of current song, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for music. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
MusicPlayer.Lyrics Lyrics of current song stored in ID tag info
MusicPlayer.Votes Returns
The scraped votes of currently playing song, if it's in the database.
MusicPlayer.Year Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist
MusicPlayer.Rating Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist
MusicPlayer.DiscNumber Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist
MusicPlayer.Comment Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist
MusicPlayer.Time Current time in song
MusicPlayer.TimeRemaining Current remaining time in song
MusicPlayer.TimeSpeed Both the time and the playspeed formatted up. e.g. 1:23 (2x)
MusicPlayer.TrackNumber Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist
MusicPlayer.Duration Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist
MusicPlayer.BitRate Bitrate of current song
MusicPlayer.Channels Number of channels of current song
MusicPlayer.BitsPerSample Number of bits per sample of current song
MusicPlayer.SampleRate Samplerate of current song
MusicPlayer.Codec Codec of current song
MusicPlayer.PlaylistPosition Position of the current song in the current music playlist
MusicPlayer.PlaylistLength Total size of the current music playlist
MusicPlayer.ChannelName Channel name of the radio programme that's currently playing (PVR).
MusicPlayer.ChannelNumberLabel Channel and subchannel number of the radio channel that's currently playing (PVR).
MusicPlayer.ChannelGroup Channel group of of the radio programme that's currently playing (PVR).
MusicPlayer.Contributors List of all people who've contributed to the currently playing song
MusicPlayer.ContributorAndRole List of all people and their role who've contributed to the currently playing song
MusicPlayer.Mood Mood of the currently playing song
MusicPlayer.Property(Role.Arranger) Returns the name of the person who arranged the selected song
MusicPlayer.Property(Role.Composer) Returns the name of the person who composed the selected song
MusicPlayer.Property(Role.Conductor) Returns the name of the person who conducted the selected song
MusicPlayer.Property(Role.DJMixer) Returns the name of the dj who remixed the selected song
MusicPlayer.Property(Role.Engineer) Returns the name of the person who was the engineer of the selected song
MusicPlayer.Property(Role.Lyricist) Returns the name of the person who wrote the lyrics of the selected song
MusicPlayer.Property(Role.Mixer) Returns the name of the person who mixed the selected song
MusicPlayer.Property(Role.Orchestra) Returns the name of the orchestra performing the selected song
MusicPlayer.Property(Role.Producer) Returns the name of the person who produced the selected song
MusicPlayer.Property(Role.Remixer) Returns the name of the person who remixed the selected song
MusicPlayer.UserRating The rating the user gave to the currently playing song
MusicPlayer.DBID The database id of the currently playing song v17
MusicPlayer.DiscTitle The title of the disc currently playing v19
MusicPlayer.ReleaseDate Returns the release date of the song currently playing v19
MusicPlayer.OriginalDate Returns the original release date of the song currently playing v19
MusicPlayer.BPM Returns the Beats Per Minute of the currently playing song v19
MusicPlayer.TotalDiscs Returns the number of discs associated with the album of the currently playing song v19

RetroPlayer

InfoLabels Description Version
RetroPlayer.Developer Returns
The developer of the currently-playing game (e.g. "Square").
RetroPlayer.DiscLabel Returns
The human-readable label of the currently inserted disc, or an empty string if no disc is in the tray/floppy drive or the game isn't disc-based.
RetroPlayer.GameClient Returns
The add-on ID of the game client (a.k.a. emulator) used to play the currently-playing game (e.g. game.libretro.beetle-psx ).
RetroPlayer.GameClientName Returns
The emulator/core name parsed from the game client's add-on name (e.g. bsnes-mercury Performance ).
RetroPlayer.GameClientPlatforms Returns
The platform or platform group supported by the game client (e.g. an emulator might report "Nintendo - SNES / SFC / Game Boy / Color").
RetroPlayer.Genres Returns
The genres of the currently-playing game, joined by ", ".
RetroPlayer.Overview Returns
The overview/summary of the currently-playing game.
RetroPlayer.Platform Returns
The platform of the currently-playing game, or an empty string if the platform is unknown.
RetroPlayer.Publisher Returns
The publisher of the currently-playing game (e.g. "Nintendo").
RetroPlayer.StretchMode 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)
RetroPlayer.Title Returns
The title of the currently-playing game.
RetroPlayer.VideoFilter 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)
RetroPlayer.VideoRotation 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)

Video player

InfoLabels Description Version
VideoPlayer.Art(type) Returns
The art path for the requested arttype and for the currently playing video.

Parameters

type - can virtually be anything, refers to the art type keyword in the art map (poster, fanart, banner, thumb, etc)
VideoPlayer.AudioLanguageEx Returns
The English name of the language of the current audio stream of the currently playing item.
VideoPlayer.AudioName Returns
The name of the active audio stream of the currently playing video.
VideoPlayer.AudioStreamCount Returns the number of audio streams of the currently playing video v21
VideoPlayer.EpisodePart Returns
string containing the number of parts of a single episode - empty if no data provided
[Infolabel Updated] VideoPlayer.EpisodePart also supports EPG.
VideoPlayer.HdrDetail Returns
String containing details for the HDR type (currently only for DV - profile and EL type) or empty if not HDR. Prints eg 5, 7FEL, and compatibility ID for profile 8 eg 8.4.
VideoPlayer.MediaProviders Returns
string containing the names of the providers of the currently playing media, separated by commas if multiple are present.
VideoPlayer.offset(number).Album Returns
The album from which the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Art(type) Returns
The art path for the requested arttype and for the video which has an offset number with respect to the currently playing video.

Parameters

number - the offset with respect to the start of the playlist
type - can virtually be anything, refers to the art type keyword in the art map (poster, fanart, banner, thumb, etc)
VideoPlayer.offset(number).Artist Returns
The artist(s) of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Country Returns
The production country of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Cover Returns
The cover of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).DBID Returns
The database id of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Director Returns
The director of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Episode Returns
The episode number of the episode which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Genre Returns
The genre(s) of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).IMDBNumber Returns
The IMDb ID of the the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).LastPlayed Returns
The last play date of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).mpaa Returns
The MPAA rating of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).OriginalTitle Returns
The original title of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).PlayCount Returns
The playcount of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Plot Returns
The complete Text Summary of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).PlotOutline Returns
The small Summary of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Premiered Returns
The release or aired date of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Rating Returns
The scraped rating of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).RatingAndVotes Returns
The scraped rating and votes of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Season Returns
The season number of the episode which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Studio Returns
The studio of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Tagline Returns
The small Summary of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Title 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.

VideoPlayer.offset(number).Top250 Returns
The IMDb Top250 position of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Trailer Returns
The path to the trailer of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).TVShowTitle Returns
The title of the episode's tvshow name which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).UserRating Returns
The user rating of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Votes Returns
The scraped votes of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Writer Returns
The name of Writer of the video which has an offset number with respect to the currently playing video.
VideoPlayer.offset(number).Year Returns
The year of release of the video which has an offset number with respect to the currently playing video.
VideoPlayer.position(number).Album Returns
The album from which the music video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Art(type) Returns
The art path for the requested arttype and for the video which has an offset number with respect to the start of the playlist.

Parameters

number - the offset with respect to the start of the playlist
type - can virtually be anything, refers to the art type keyword in the art map (poster, fanart, banner, thumb, etc)
VideoPlayer.position(number).Artist Returns
The artist(s) of the music video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Country Returns
The production country of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Cover Returns
The cover of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).DBID Returns
The database id of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Director Returns
The director of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Episode Returns
The episode number of the episode which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Genre Returns
The genre(s) of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).IMDBNumber Returns
The IMDb ID of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).LastPlayed Returns
The last play date of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).mpaa Returns
The MPAA rating of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).OriginalTitle Returns
The original title of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).PlayCount Returns
The playcount of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Plot Returns
The complete Text Summary of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).PlotOutline Returns
The small Summary of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Premiered 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.
VideoPlayer.position(number).Rating Returns
The scraped rating of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).RatingAndVotes Returns
The scraped rating and votes of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Season Returns
The season number of the episode which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Studio Returns
The studio of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Tagline Returns
The small Summary of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Title 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.

VideoPlayer.position(number).Top250 Returns
The IMDb Top250 position of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Trailer Returns
The path to the trailer of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).TVShowTitle Returns
The title of the episode's tvshow name which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).UserRating Returns
The user rating of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Votes Returns
The scraped votes of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Writer Returns
The name of Writer of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.position(number).Year Returns
The year of release of the video which has an offset number with respect to the start of the playlist.
VideoPlayer.StartTime Returns
The start date and time of the currently playing epg event or recording ( PVR ).
VideoPlayer.SubtitleCodec Returns
The codec of the current subtitles of the currently playing video. Possible values include:
ass
dvb_subtitle
dvb_teletext
dvd_subtitle
hdmv_pgs_subtitle
microdvd
mov_text
mpl2
realtext
sami
srt
ssa
subrip
text
ttml
vplayer
webvtt
xsub

Note
VideoPlayer.SubtitleCodec holds the codec of the next available subtitles stream if subtitles are disabled in the player.

VideoPlayer.SubtitleLanguageEx Returns
The English name of the language of the current subtitle stream of the currently playing item.
VideoPlayer.SubtitleName Returns
The name of the active subtitle stream of the currently playing video.
VideoPlayer.TitleExtraInfo Returns
string containing extra information, enriching the title of the currently playing media, if any.
VideoPlayer.VideoStreamCount Returns the number of video streams of the currently playing video v22
VideoPlayer.ParentalRatingCode Shows the parental rating code v22
VideoPlayer.ParentalRatingIcon Shows the parental rating icon v22
VideoPlayer.ParentalRatingSource Shows the parental rating source v22
VideoPlayer.ChannelLogo Shows the logo of the currently selected radio or TV channel v22
VideoPlayer.VideoVersionName Show the name of the video version v21
VideoPlayer.Time Current time in movie
VideoPlayer.TimeRemaining Current remaining time in movie
VideoPlayer.TimeSpeed Current time + playspeed. e.g. 1:23:14 (-4x)
VideoPlayer.Duration Length of current movie
VideoPlayer.Title Title of currently playing video. If it's in the database it will return the database title, else the filename. (supports .offset() and .position())
VideoPlayer.OriginalTitle The original title of currently playing video. (supports .offset() and .position())
VideoPlayer.TVShowTitle Title of currently playing episode's tvshow name. (supports .offset() and .position())
VideoPlayer.Season Season number of the currently playing episode, if it's in the database. (supports .offset() and .position())
VideoPlayer.Episode Episode number of the currently playing episode. (supports .offset() and .position())
VideoPlayer.Genre Genre(s) of current movie, if it's in the database. (supports .offset() and .position())
VideoPlayer.Genre(separator) Returns
A list of genres of current movie, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
VideoPlayer.Director Director of current movie, if it's in the database. (supports .offset() and .position())
VideoPlayer.Director(separator) Returns
A list of directors of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
VideoPlayer.Country Production country of current movie, if it's in the database. (supports .offset() and .position())
VideoPlayer.Year Year of release of current movie, if it's in the database. (supports .offset() and .position())
VideoPlayer.Premiered The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position())
VideoPlayer.Rating IMDb user rating of current movie, if it's in the database. (supports .offset() and .position())
VideoPlayer.UserRating Shows the user rating of the currently playing item. (supports .offset() and .position())
VideoPlayer.Votes IMDb votes of current movie, if it's in the database. (supports .offset() and .position())
VideoPlayer.RatingAndVotes IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position())
VideoPlayer.mpaa MPAA rating of current movie, if it's in the database. (supports .offset() and .position())
VideoPlayer.IMDBNumber The IMDB iD of the current video, if it's in the database. (supports .offset() and .position())
VideoPlayer.EpisodeName (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database
VideoPlayer.PlaylistPosition Position of the current song in the current video playlist
VideoPlayer.PlaylistLength Total size of the current video playlist
VideoPlayer.Cast A list of cast members, separated by carriage returns, if it's in the database
VideoPlayer.Cast(separator) Returns
A list of cast members of the currently playing video, separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
VideoPlayer.CastAndRole A list of cast members and roles, separated by carriage returns. Every cast/role combination is formatted 'cast' as 'role' where 'as' is localised, if it's in the database
VideoPlayer.CastAndRole(separator) Returns
A list of cast members and roles of the currently playing video, pairs separated by given separator, or if no separator was given separated by carriage returns. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
VideoPlayer.Trailer The trailer of the current movie. (supports .offset() and .position())
VideoPlayer.Album Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position())
VideoPlayer.Artist Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position())
VideoPlayer.Studio Studio of current Music Video, if it's in the database. (supports .offset() and .position())
VideoPlayer.Writer Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position())
VideoPlayer.Writer(separator) Returns
A list of writers of the currently playing video, separated by given separator, or if no separator was given separated by the advanced settings value “itemseparator” for video items. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
VideoPlayer.Tagline Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
VideoPlayer.PlotOutline Small Summary of current playing Video, if it's in the database. (supports .offset() and .position())
VideoPlayer.Plot Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position())
VideoPlayer.Top250 Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position())
VideoPlayer.LastPlayed Last play date of current playing Video, if it's in the database. (supports .offset() and .position())
VideoPlayer.PlayCount Playcount of current playing Video, if it's in the database. (supports .offset() and .position())
VideoPlayer.HdrType Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg) v20
VideoPlayer.VideoCodec Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec)
VideoPlayer.VideoResolution Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution)
VideoPlayer.VideoAspect Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect)
VideoPlayer.AudioCodec Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec)
VideoPlayer.AudioChannels Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels)
VideoPlayer.AudioLanguage Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage)
VideoPlayer.SubtitlesLanguage Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage)
VideoPlayer.StereoscopicMode Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode)
VideoPlayer.EndTime End date of the currently playing programme (PVR).
VideoPlayer.NextTitle Title of the programme that will be played next (PVR).
VideoPlayer.NextGenre Genre of the programme that will be played next (PVR).
VideoPlayer.NextGenre(separator) Returns
A list of genres of the programme that will be played next (PVR), separated by given separator, or if no separator was given separated by the advanced settings value \“itemseparator\” for videos. Possible values for separator: comma, pipe, slash, cr, dash, colon, semicolon, fullstop.
v22
VideoPlayer.NextPlot Plot of the programme that will be played next (PVR).
VideoPlayer.NextPlotOutline Plot outline of the programme that will be played next (PVR).
VideoPlayer.NextStartTime Start time of the programme that will be played next (PVR).
VideoPlayer.NextEndTime End time of the programme that will be played next (PVR).
VideoPlayer.NextDuration Duration of the programme that will be played next (PVR).
VideoPlayer.ChannelName Name of the curently tuned channel (PVR).
VideoPlayer.ChannelNumberLabel Channel and subchannel number of the tv channel that's currently playing (PVR).
VideoPlayer.ChannelGroup Group of the curently tuned channel (PVR).
VideoPlayer.ParentalRating Parental rating of the currently playing programme (PVR).
VideoPlayer.DBID The database id of the currently playing video. (supports .offset() and .position()) v17
VideoPlayer.UniqueID() Returns the UniqueID of the currently playing video v19
VideoPlayer.TvShowDBID Returns the tv show DBID of the currently playing episode v19

Playlist

InfoLabels Description Version
Playlist.Length(media) Total size of the current playlist. optional parameter media is either video or music.
Playlist.Position(media) Position of the current item in the current playlist. optional parameter media is either video or music.
Playlist.Random Returns 'On' or 'Off'
Playlist.Repeat Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)

PVR

InfoLabels Description Version
PVR.ActStreamAudioBitRate Audio bitrate of the stream
PVR.ActStreamBer Bit error rate of the stream
PVR.ActStreamClient Stream client name
PVR.ActStreamDevice Stream device name
PVR.ActStreamDolbyBitRate Dolby bitrate of the stream
PVR.ActStreamEncryptionName Encryption used on the stream
PVR.ActStreamMux Returns
The multiplex type of played channel if available.
PVR.ActStreamProgrSignal Signal quality of the programme
PVR.ActStreamProgrSnr Signal to noise ratio of the programme
PVR.ActStreamProviderName Returns
The provider name of the played channel if available.
PVR.ActStreamServiceName Returns
The service name of played channel if available.
PVR.ActStreamSignal Signal quality of the stream
PVR.ActStreamSnr Signal to noise ratio of the stream
PVR.ActStreamStatus Status of the stream
PVR.ActStreamUnc UNC value of the stream
PVR.ActStreamVideoBitRate Video bitrate of the stream
PVR.BackendChannels Number of available channels the backend provides
PVR.BackendDeletedRecordings Returns
The number of deleted recordings present on the backend.
PVR.BackendDiskSpace Available diskspace on the backend
PVR.BackendDiskspace Free diskspace available for recordings on the backend
PVR.BackendDiskSpaceProgr Returns
The available diskspace on the backend as percent value.
PVR.BackendHost Backend hostname
PVR.BackendName Name of the backend being used
PVR.BackendNumber Backend number
PVR.BackendRecordings Number of recording available on the backend
PVR.BackendTimers Number of timers set for the backend
PVR.BackendVersion version of the backend that's being used
PVR.ChannelNumberInput Label displaying the number the user entered on remote or keyboard v18
PVR.ClientCount Number of PVR clients enabled v22
PVR.ClientName Returns
The name of the PVR client add-on, as specified by the add-on developer.
PVR.EpgEventDuration[(format)] Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options
PVR.EpgEventElapsedTime[(format)] Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options
PVR.EpgEventFinishTime[(format)] Returns the time the currently playing epg event will end. See ListItem.Duration for optinional formatting options v18
PVR.EpgEventProgress Returns the position of currently played title on TV as integer
PVR.EpgEventRemainingTime[(format)] Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options v18
PVR.EpgEventSeekTime[(format)] Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options v18
PVR.InstanceName Returns
The name of the instance of the PVR client add-on, as specified by the user in the add-on settings. Empty if the PVR client add-on does not support multiple instances.
PVR.NextRecordingChannel Channel name of the next recording
PVR.NextRecordingDateTime Start date and time of the next recording
PVR.NextRecordingTitle Title of the next programme that will be recorded
PVR.NextTimer Next timer date
PVR.NowRecordingChannel Channel number that's being recorded
PVR.NowRecordingDateTime Start date and time of the current recording
PVR.NowRecordingTitle Title of the programme being recorded
PVR.RadioNextRecordingChannel Channel name of the next radio recording v17
PVR.RadioNextRecordingChannelIcon Returns
The icon of the next recording radio channel.
PVR.RadioNextRecordingDateTime Start date and time of the next radio recording v17
PVR.RadioNextRecordingTitle Title of the next radio programme that will be recorded v17
PVR.RadioNowRecordingChannel Channel name of the current radio recording v17
PVR.RadioNowRecordingChannelIcon Icon of the current recording radio channel v17
PVR.RadioNowRecordingDateTime Start date and time of the current radio recording v17
PVR.RadioNowRecordingTitle Title of the radio programme being recorded v17
PVR.TimeShiftCur[(format)] Current position of the timeshift. See ListItem.Duration for optinional formatting options
PVR.TimeShiftEnd[(format)] End position of the timeshift. See ListItem.Duration for optinional formatting options
PVR.TimeShiftOffset[(format)] Current offset of the timeshift. See ListItem.Duration for optinional formatting options
PVR.TimeShiftProgress Returns the position of currently timeshifted title on TV as interger
PVR.TimeshiftProgressBufferEnd Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress v18
PVR.TimeshiftProgressBufferStart Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress v18
PVR.TimeshiftProgressDuration Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero v18
PVR.TimeshiftProgressDuration(format) Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss) v18
PVR.TimeshiftProgressEndTime Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero v18
PVR.TimeshiftProgressEndTime(format) Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss) v18
PVR.TimeshiftProgressEpgEnd Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress v18
PVR.TimeshiftProgressEpgStart Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress v18
PVR.TimeshiftProgressPlayPos Returns the percentage of the current play position within the PVR timeshift progress v18
PVR.TimeshiftProgressStartTime Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero v18
PVR.TimeshiftProgressStartTime(format) Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss) v18
PVR.TimeShiftSeekbar This is the equivalent of Player.Seekbar, but for LiveTV (can be used in a slider control and indicates the position being seeked to) v19
PVR.TimeShiftStart[(format)] Start position of the timeshift. See ListItem.Duration for optinional formatting options
PVR.TotalDiscSpace Total diskspace available for recordings
PVR.TVNextRecordingChannel Channel name of the next tv recording v17
PVR.TVNextRecordingChannelIcon Icon of the next recording tv channel v17
PVR.TVNextRecordingDateTime Start date and time of the next tv recording v17
PVR.TVNextRecordingTitle Title of the next tv programme that will be recorded v17
PVR.TVNowRecordingChannel Channel name of the current tv recording v17
PVR.TVNowRecordingChannelIcon Icon of the current recording TV channel v17
PVR.TVNowRecordingDateTime Start date and time of the current tv recording v17
PVR.TVNowRecordingTitle Title of the tv programme being recorded v17

RDS

InfoLabels Description Version
RDS.Album The collection name to which this track belongs (Only be available on RadiotextPlus)
RDS.Artist A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
RDS.AudioLanguage The from RDS reported audio language of channel
RDS.Band Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus)
RDS.ChannelCountry Country where the radio channel is sended
RDS.Comment Radio station comment string if available (Only be available on RadiotextPlus)
RDS.Composer Name of the original composer/author (Only be available on RadiotextPlus)
RDS.Conductor The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus)
RDS.EmailHotline The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus)
RDS.EmailStudio The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus)
RDS.GetLine(number) Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
RDS.InfoCinema Information about movies in cinema (if available) (Only be available on RadiotextPlus)
RDS.InfoCinemaSize Number of rows present in cinema information (Only be available on RadiotextPlus)
RDS.InfoHoroscope Horoscope; either as one part or as two distinct parts:"key word 99text", e.g. "sign of the zodiac 99blablabla" (if available) (Only be available on RadiotextPlus)
RDS.InfoHoroscopeSize Number of rows present in horoscope information (Only be available on RadiotextPlus)
RDS.InfoLottery Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus)
RDS.InfoLotterySize Number of rows present in lottery information (Only be available on RadiotextPlus)
RDS.InfoNews Message / headline (if available) (Only be available on RadiotextPlus)
RDS.InfoNewsLocal Local information news sended from radio channel (if available) (Only be available on RadiotextPlus)
RDS.InfoOther Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus)
RDS.InfoOtherSize Number of rows present with other informations (Only be available on RadiotextPlus)
RDS.InfoSport Result of a game; either as one part or as several distinct parts:"match 99result", e.g. "Bayern München : Borussia 995:5" (if available) (Only be available on RadiotextPlus)
RDS.InfoSportSize Number of rows present in sport information (Only be available on RadiotextPlus)
RDS.InfoStock Quote information; either as one part or as several distinct parts:"name 99latest value 99change 99high 99low 99volume" (if available) (Only be available on RadiotextPlus)
RDS.InfoStockSize Number of rows present in stock information (Only be available on RadiotextPlus)
RDS.InfoWeather Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus)
RDS.InfoWeatherSize Number of rows present in weather information (Only be available on RadiotextPlus)
RDS.PhoneHotline The telephone number of the radio station's hotline (Only be available on RadiotextPlus)
RDS.PhoneStudio The telephone number of the radio station's studio (Only be available on RadiotextPlus)
RDS.ProgEditStaff Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus)
RDS.ProgHomepage Link to radio station homepage (Only be available on RadiotextPlus)
RDS.ProgHost Name of the host of the radio show
RDS.ProgNext Next played program name (if available)@note becomes also be set from epg if from RDS not available
RDS.ProgNow Now played program name@note becomes also be set from epg if from RDS not available
RDS.ProgStation Name of the radio channel@note becomes also be set from epg if from RDS not available
RDS.ProgStyle Human readable string about radiostyle defined from RDS or RBDS
RDS.RadioStyle The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
RDS.SmsStudio The sms number of the radio stations studio (to send directly a sms to the studio) (if available) (Only be available on RadiotextPlus)
RDS.Title Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
RDS.TrackNumber The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus)

Skin

InfoLabels Description Version
Skin.AspectRatio Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
Skin.CurrentColourTheme Returns the current selected colour theme of the skin.
Skin.CurrentTheme Returns the current selected skin theme.
Skin.Font Returns the current fontset from Font.xml. v18 addition
Skin.Numeric(settingid) Returns
return the setting value as an integer/numeric value.

See also

Skin.SetNumeric(settingid)
Skin.String(name) Returns the user-set skin string, set via the Skin.SetString(name) List of Built In Functions. Allows skinners to have user-customisable labels.
Skin.TimerElapsedSecs(timer) Returns
The elapsed time in seconds for the provided timer.

Parameters

timer - the timer name

Slideshow

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

System

InfoLabels Description Version
System.AddonTitle(id) Returns the title of the addon with the given id
System.AddonUpdateCount The number of available addon updates v19
System.AddonVersion(id) Returns the version of the addon with the given id
System.AlarmPos Shutdown Timer position
System.BatteryLevel Returns the remaining battery level in range 0-100
System.BuildDate Date of build
System.BuildVersion version of build
System.BuildVersionCode The internal version of the kodi build v19
System.BuildVersionGit The git version (sha) of the kodi build v19
System.BuildVersionShort Returns
The shorter string with version of build.
System.CoreUsage(id) Displays the usage of the cpu core with the given 'id'
System.CpuFrequency System cpu frequency
System.CPUTemperature Current CPU temperature
System.CpuUsage Displays the cpu usage for each individual cpu core.
System.CurrentControl Current focused control
System.CurrentControlID ID of the currently focused control.
System.CurrentWindow Current Window we are in
System.Date Current date
System.Date(format) Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January-December), yy (2-digit year), yyyy (4-digit year). Added after dharma.
System.DVDLabel Label of the disk in the DVD-ROM drive
System.FanSpeed Current fan speed
System.FPS Current rendering speed (frames per second)
System.FreeMemory Amount of free memory in Mb
System.FreeSpace Total Freespace on the drive
System.FreeSpacePercent Total Freespace Percent on the drive
System.FriendlyName Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. e.g. "Kodi (htpc)"
System.GetBool(boolean) Returns
The value of any standard system boolean setting.

Note
Will not work with settings in advancedsettings.xml

System.GPUTemperature Current GPU temperature
System.HddTemperature Hdd temperature
System.InternetState Will return the internet state, 'connected' or 'not connected' (localized)
System.KernelVersion (deprecated) System name + kernel version
System.Language Shows the current language
System.Locale(type) Returns
Locale-specific information depending on the requested type.

Parameters

type - Can be one of the following:
region The currently selected region name within the selected language ( System.Language ).
iso The country code of the currently selected region as specified in langinfo.xml.
[Removed options] timezonecountry and timezone from System.Locale(type)
System.Memory(format) Available formats: used, used.percent, free, free.percent, total
System.OSVersionInfo System name + kernel version
System.PrivacyPolicy Returns
The official Kodi privacy policy.
System.ProfileAutoLogin The profile Kodi will auto login to
System.ProfileCount Shows the number of defined profiles
System.ProfileName Shows the User name of the currently logged in Kodi user
System.Progressbar The percentage of the currently active progress.
System.ScreenHeight Height of screen in pixels
System.ScreenMode Screenmode (e.g. windowed / fullscreen)
System.ScreenResolution Screen resolution
System.ScreenWidth Width of screen in pixels
System.StartupWindow The Window Kodi will load on startup
System.StereoscopicMode The prefered stereoscopic mode (settings > video > playback)
System.SupportedHDRTypes Returns
The display's supported HDR types.
System.TemperatureUnits Shows Celsius or Fahrenheit symbol
System.Time Current time
System.Time(format) Shows hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). (xx) option added after dharma
System.TotalSpace Totalspace on the drive
System.TotalUptime System total uptime
System.Uptime System current uptime
System.UsedSpace Total Usedspace on the drive
System.UsedSpacePercent Total Usedspace Percent on the drive
System.VideoEncoderInfo video encoder info

Visualisation

InfoLabels Description Version
Visualisation.Name Shows the name of the visualisation.
Visualisation.Preset Shows the current preset of the visualisation.

Weather

InfoLabels Description Version
Weather.Data(property) Returns
Weather data, as specified by the parameter.
Weather.LastUpdated Returns
The localized date and time weather data were last updated, empty string if not available.

Weather labels

InfoLabels Description Version
Weather.Conditions Current weather conditions – this is looked up in a background process.
Weather.fanartcode Current weather fanartcode.
Weather.Location City/town which the above two items are for
Weather.plugin Current weather plugin.
Weather.Temperature Current weather temperature

Window

InfoLabels Description Version
Window(AddonBrowser).Property(Updated) Shows the date and time the addon repo was last checked for updates
Window(Home).Property(key) The home window has the following info labels.

Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

LatestMovie.[1-10].Title, LatestMovie.[1-10].Year, LatestMovie.[1-10].RunningTime, LatestMovie.[1-10].Rating, LatestMovie.[1-10].Plot, LatestMovie.[1-10].Trailer, LatestMovie.[1-10].Thumb, LatestMovie.[1-10].Fanart, LatestMovie.[1-10].Path

LatestEpisode.[1-10].ShowTitle, LatestEpisode.[1-10].EpisodeTitle, LatestEpisode.[1-10].EpisodeNo, LatestEpisode.[1-10].EpisodeSeason, LatestEpisode.[1-10].EpisodeNumber, LatestEpisode.[1-10].Rating, LatestEpisode.[1-10].Plot, LatestEpisode.[1-10].Thumb, LatestEpisode.[1-10].ShowThumb, LatestEpisode.[1-10].SeasonThumb, LatestEpisode.[1-10].Fanart, LatestEpisode.[1-10].Path

LatestMusicVideo.[1-10].Title, LatestMusicVideo.[1-10].Thumb, LatestMusicVideo.[1-10].Year, LatestMusicVideo.[1-10].Plot, LatestMusicVideo.[1-10].RunningTime, LatestMusicVideo.[1-10].Path, LatestMusicVideo.[1-10].Artist, LatestMusicVideo.[1-10].Fanart

LatestSong.[1-10].Title, LatestSong.[1-10].Artist, LatestSong.[1-10].Album, LatestSong.[1-10].Year, LatestSong.[1-10].Rating, LatestSong.[1-10].Thumb, LatestSong.[1-10].Fanart, LatestSong.[1-10].Path

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path

Window(Weather).Property(key) The weather window has the following info labels.

Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider


Data set in Current.Temperature, Current.FeelsLike, Day[0-6].HighTemp, Day[0-6].LowTemp should be provided in Celsius, and will be autoconverted according to System.TemperatureUnits

Window([window]).Property(key) Window property. (key can be any value, optional window can be id or name)
Window.Property(Addon.ID) Returns the id of the selected addon, in DialogAddonSettings.xml
Window.Property(IsRadio) Returns "true" if the window is a radio window, empty string otherwise (for use in the PVR windows)
Window.Property(xmlfile) Displays the name of the xml file currently shown

Images Available in Kodi

See Artwork/Accessing with skins and JSON-RPC for the general pattern of accessing artwork for media items. Below is a list of other possible images available as InfoLabels.

InfoLabels Description Version
Fanart.Image Fanart image for the parent TV Show. Note: Deprecated, use ListItem.Art(tvshow.fanart) instead.
ListItem.ActualIcon Shows the default icon of the currently selected item in a list or thumb control.
ListItem.Art(type) Artwork for the current listitem.
ListItem.EPGEventIcon Returns the icon of the EPG programme (if available). v18
ListItem.Icon Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the default icon.
ListItem.Overlay Shows the Overlay Icon status (compressed file [OverlayRAR.png], watched [OverlayWatched.png], unwatched [OverlayUnwatched.png], locked [OverlayLocked.png]) of the currently selected item in a list or thumb control.
ListItem.Property(Fanart_Image) Fanart Image currently selected item or of the parent TV show. Note: Deprecated, use ListItem.Art(fanart) or ListItem.Art(tvshow.fanart) instead.
ListItem.Thumb Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. Note: Deprecated but still available, returns the same as ListItem.Art(thumb).
MusicPlayer.Cover Cover of currently playing album
MusicPlayer.Property(Fanart_Image) Fanart image of the currently playing artist
Player.Art(type) Artwork for the currently playing item.
Player.Icon Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon. v18
Player.StarRating Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin
Pvr.EPGEventIcon Returns the icon of the currently playing EPG programme (if available). v18
Pvr.NextRecordingChannelIcon Channel icon of the programme that will be recorded next.
Pvr.NowRecordingChannelIcon Channel icon of the programme currently being recorded.
Skin.String(name) Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) List of Built In Functions. Allows skinners to have user-customisable images and multiimages.
System.AddonIcon(id) Returns the Icon of the specified addon. Instead of specifying the id directly, one can also use an infolabel (e.g. $INFO[Skin.String(Foo)])
System.ProfileThumb Shows the Thumbnail image of the currently logged in Kodi user
VideoPlayer.Cover Cover of currently playing movie. Note: Deprecated, use Player.Art(type) instead.
Weather.ConditionsIcon Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
Window(Weather).Property(key) The weather window has the following info images.

Current.ConditionIcon, Day[0-6].OutlookIcon, Current.FanartCode, Day[0-6].FanartCode, WeatherProviderLogo

Window([window]).Property(key) Window property. (key can be any value, optional window can be id or name)



Return to top