InfoLabels: Difference between revisions
Update info labels from Doxygen |
|||
| (31 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.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'''<br> | |||
Colors are arranged Lightest to Darkest.}} | |||
{| class="wikitable sortable" width="100%" | {| class="wikitable sortable" width="100%" | ||
! InfoLabels | ! InfoLabels | ||
| Line 240: | Line 238: | ||
| <code>Fanart.Color1</code> | | <code>Fanart.Color1</code> | ||
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. | | Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. | ||
| | | | ||
|- | |- | ||
| <code>Fanart.Color2</code> | | <code>Fanart.Color2</code> | ||
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. | | Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. | ||
| | | | ||
|- | |- | ||
| <code>Fanart.Color3</code> | | <code>Fanart.Color3</code> | ||
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show | | Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. | ||
| | | | ||
|} | |} | ||
=== Game === | === Game === | ||
{| class="wikitable sortable" width="100%" | {| class="wikitable sortable" width="100%" | ||
! InfoLabels | ! InfoLabels | ||
| Line 264: | Line 255: | ||
! Version | ! Version | ||
|- | |- | ||
| <code>Game. | | <code>Game.Developer</code> | ||
| '''Returns''' | | '''Returns''' | ||
: | : The developer of the game (e.g. Activision). | ||
| v18 | | v18 | ||
|- | |- | ||
| <code>Game. | | <code>Game.GameClient</code> | ||
| '''Returns''' | | '''Returns''' | ||
: the | : The add-on ID of the emulator used to play the game. | ||
| v18 | | v18 | ||
|- | |- | ||
| <code>Game.Genres</code> | | <code>Game.Genres</code> | ||
| '''Returns''' | | '''Returns''' | ||
: | : The genre of the game (e.g. Action). | ||
| v18 | | v18 | ||
|- | |- | ||
| <code>Game. | | <code>Game.Overview</code> | ||
| '''Returns''' | | '''Returns''' | ||
: | : The game description. | ||
| v18 | | v18 | ||
|- | |- | ||
| <code>Game. | | <code>Game.Platform</code> | ||
| '''Returns''' | | '''Returns''' | ||
: | : The platform the game runs on (e.g. Atari 2600). | ||
| v18 | | v18 | ||
|- | |- | ||
| <code>Game. | | <code>Game.Publisher</code> | ||
| '''Returns''' | |||
: The publishing company of the game (e.g. Nintendo). | |||
| v18 | |||
|- | |||
| <code>Game.Title</code> | |||
| '''Returns''' | | '''Returns''' | ||
: the game | : The name of the game. | ||
| v18 | | v18 | ||
|- | |- | ||
| <code>Game.Year</code> | | <code>Game.Year</code> | ||
| '''Returns''' | | '''Returns''' | ||
: | : The year the game was released. | ||
| v18 | | v18 | ||
|} | |||
=== Integer === | |||
{| class="wikitable sortable" width="100%" | |||
! InfoLabels | |||
! style="80%" | Description | |||
! Version | |||
|- | |- | ||
| <code> | | <code>Integer.ValueOf(number)</code> | ||
| '''Returns''' | | '''Returns''' | ||
: | :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 === | === ListItem === | ||
{| class="wikitable sortable" width="100%" | {| class="wikitable sortable" width="100%" | ||
! InfoLabels | ! InfoLabels | ||
| Line 313: | Line 319: | ||
|- | |- | ||
| <code>ListItem.AddonBroken</code> | | <code>ListItem.AddonBroken</code> | ||
| Deprecated! use ListItem.AddonLifecycleDesc instead | | Deprecated! use ListItem.AddonLifecycleDesc instead. | ||
| | | | ||
|- | |- | ||
| <code>ListItem.AddonCreator</code> | | <code>ListItem.AddonCreator</code> | ||
| | | '''Returns''' | ||
:The name of the author the currently selected addon. | |||
| | | | ||
|- | |- | ||
| <code>ListItem.AddonDescription</code> | | <code>ListItem.AddonDescription</code> | ||
| | | '''Returns''' | ||
:The full description of the currently selected addon. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonDisclaimer</code> | ||
| | | '''Returns''' | ||
:The disclaimer of the currently selected addon. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonInstallDate</code> | ||
| | | '''Returns''' | ||
:The date the addon was installed. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonLastUpdated</code> | ||
| | | '''Returns''' | ||
:The date the addon was last updated. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonLastUsed</code> | ||
| | | '''Returns''' | ||
:The date the addon was used last. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonLifecycleDesc</code> | ||
| | | '''Returns''' | ||
| | :The description of the lifecycle type (e.g. broken due to website changes). | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.AddonLifecycleType</code> | ||
| The | | '''Returns''' | ||
| | :The lifecycle type of the addon as a localized string (e.g. normal, broken, or deprecated). | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.AddonName</code> | ||
| | | '''Returns''' | ||
:The name of the currently selected addon. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonNews</code> | ||
| Returns | | '''Returns''' | ||
:A brief changelog, taken from the addons' addon.xml file. | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.AddonOrigin</code> | ||
| | | '''Returns''' | ||
:The name of the repository the add-on originates from. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonSize</code> | ||
| | | '''Returns''' | ||
:The filesize of the addon. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonSummary</code> | ||
| | | '''Returns''' | ||
:A short description of the currently selected addon. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonType</code> | ||
| | | '''Returns''' | ||
:The type of the currently selected addon (e.g. screensaver, script, skin, etc). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AddonVersion</code> | ||
| | | '''Returns''' | ||
:The version of the currently selected addon. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Album</code> | ||
| | | '''Returns''' | ||
:The album of the currently selected song in a container. | |||
| | | | ||
|- | |- | ||
| <code>ListItem.AlbumStatus</code> | | <code>ListItem.AlbumArtist</code> | ||
| Returns | | '''Returns''' | ||
| | :The artist of the currently selected album in a list. | ||
| | |||
|- | |||
| <code>ListItem.AlbumStatus</code> | |||
| '''Returns''' | |||
:The Musicbrainz release status of the album (e.g. offical, bootleg, promotion, etc). | |||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.Appearances</code> | ||
| Returns | | '''Returns''' | ||
| | :The number of movies featuring the selected actor or directed by the selected director. | ||
| v17 | |||
|- | |- | ||
| | | <code>ListItem.Artist</code> | ||
| | | '''Returns''' | ||
:The artist of the currently selected song in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AudioChannels</code> | ||
| | | '''Returns''' | ||
:The number of audio channels of the currently selected video (e.g. 1, 2, 4, 5, 6, 7, 8, 10, etc). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.AudioCodec</code> | ||
| | | '''Returns''' | ||
| | :The audio codec of the currently selected video.<br> | ||
: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 | |||
|- | |- | ||
| | | <code>ListItem.AudioLanguage</code> | ||
| | | '''Returns''' | ||
:The audio language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.BitRate</code> | ||
| Returns | | '''Returns''' | ||
| | :The actual bitrate for CBR or average bitrate for VBR of the currently selected song. | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.BPM</code> | ||
| Returns | | '''Returns''' | ||
| | :The Beats Per Minute of the currently selected song. | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.Cast</code> | ||
| | | '''Returns''' | ||
:The list of cast members, separated by carriage returns, for use in dialogvideoinfo.xml. | |||
| | | | ||
|- | |- | ||
| <code>ListItem.CastAndRole</code> | | <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> | |||
| '''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. | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <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. | | <code>ListItem.ChannelGroup</code> | ||
| | | '''Returns''' | ||
:The channel group of the selected item ( PVR ). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.ChannelLogo</code> | ||
| | | '''Returns''' | ||
| | :The logo of the currently selected radio or TV channel (PVR). | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.ChannelName</code> | ||
| | | '''Returns''' | ||
:The name of current selected TV channel in a container (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.ChannelName</code> | ||
| | | '''Returns''' | ||
:The channel name of the selected item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.ChannelNumber</code> | ||
| | | '''Returns''' | ||
:The channel number of the selected item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.ChannelNumberLabel</code> | ||
| | | '''Returns''' | ||
:The channel and subchannel number of the currently selected channel that's currently playing (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Comment</code> | ||
| | | '''Returns''' | ||
:The comment assigned to the item (PVR/MUSIC). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.ContributorAndRole</code> | ||
| | | '''Returns''' | ||
:The list of all people and their role who've contributed to the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Contributors</code> | ||
| | | '''Returns''' | ||
:The list of all people who've contributed to the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Country</code> | ||
| | | '''Returns''' | ||
:The production country of the currently selected movie in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.CurrentItem</code> | ||
| | | '''Returns''' | ||
| | :The current index of the item in a container starting at 1. | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.Date</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.DateAdded</code> | ||
| | | '''Returns''' | ||
:The date the currently selected item was added to the library or date and time of an event in the EventLog window. | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.DateTime</code> | ||
| | | '''Returns''' | ||
:The date and time a certain event happened (event log). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.DBID</code> | ||
| The | | '''Returns''' | ||
| | :The database id of the currently selected ListItem in a container. | ||
| | |||
|- | |- | ||
| | | <code>ListItem.DBTYPE</code> | ||
| | | '''Returns''' | ||
: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> | |||
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. | | <code>ListItem.Developer</code> | ||
| | | '''Returns''' | ||
:The game developer (e.g. "Square") (RETROPLAYER). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Director</code> | ||
| | | '''Returns''' | ||
:The director of the currently selected movie in a container. | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.Director(separator)</code> | ||
| Returns the | | '''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> | |||
| '''Returns''' | |||
:The disc number of the currently selected song in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.DiscTitle</code> | ||
| | | '''Returns''' | ||
:The disc title of the currently selected album or song. | |||
| v19 | |||
|- | |||
| <code>ListItem.Duration[(format)]</code> | |||
| '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.EndDate</code> | ||
| | | '''Returns''' | ||
:The end date of the selected item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.EndTime</code> | ||
| | | '''Returns''' | ||
:The end time of current selected TV programme in a container (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.EndTimeResume</code> | ||
| | | '''Returns''' | ||
:The time a video will end if you resume it, instead of playing it from the beginning. | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.EpgEventTitle</code> | ||
| | | '''Returns''' | ||
:The title of the epg event associated with the item, if any. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Episode</code> | ||
| Returns the | | '''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. | ||
| | |||
|- | |- | ||
| | | <code>ListItem.EpisodeName</code> | ||
| | | '''Returns''' | ||
:The name of the episode if the selected EPG item is a TV Show (PVR). | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.EpisodePart</code> | ||
| | | '''Returns''' | ||
:string containing the number of parts of a single episode - empty if no data provided | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.ExpirationDate</code> | ||
| | | '''Returns''' | ||
:The expiration date of the selected item in a container, empty string if not supported. | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.ExpirationTime</code> | ||
| | | '''Returns''' | ||
| | :The expiration time of the selected item in a container, empty string if not supported | ||
| | |||
|- | |- | ||
| | | <code>ListItem.FileExtension</code> | ||
| The | | '''Returns''' | ||
:The file extension (without leading dot) of the currently selected item in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.FileName</code> | ||
| Returns | | '''Returns''' | ||
:The filename of the currently selected song or movie in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.FileNameAndPath</code> | ||
| | | '''Returns''' | ||
:The full path with filename of the currently selected song or movie in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.FileNameNoExtension</code> | ||
| | | '''Returns''' | ||
| | :The filename without its extension. | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.FolderName</code> | ||
| | | '''Returns''' | ||
:The top most folder of the path of the currently selected song or movie in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.FolderPath</code> | ||
| | | '''Returns''' | ||
:The complete path of the currently selected song or movie in a container (without user details). | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.GameClient</code> | ||
| Returns the | | '''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). | ||
| | |||
|- | |||
| <code>ListItem.Genre</code> | |||
| '''Returns''' | |||
:The genre of the currently selected song, album, or movie in a container. | |||
| | |||
|- | |- | ||
| <code>ListItem. | | <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. | | <code>ListItem.Genres</code> | ||
| | | '''Returns''' | ||
:The game genres (e.g. "["Action","Strategy"]") (RETROPLAYER). | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.HdrType</code> | ||
| | | '''Returns''' | ||
:The HDR type of the currently selected video (e.g. hdr10, dolbyvision, or hlg). | |||
| v20 | |||
|- | |||
| <code>ListItem.IMDBNumber</code> | |||
| '''Returns''' | |||
:The IMDB iD of the selected Video in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Label</code> | ||
| | | '''Returns''' | ||
:The left label of the currently selected item in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Label2</code> | ||
| | | '''Returns''' | ||
:The right label of the currently selected item in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.LastPlayed</code> | ||
| | | '''Returns''' | ||
:The last play date of video in a container. | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.MediaProviders</code> | ||
| | | '''Returns''' | ||
:string containing the names of the media providers of the item, separated by commas if multiple are present. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Mood</code> | ||
| | | '''Returns''' | ||
:The mood of the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Mpaa</code> | ||
| Returns | | '''Returns''' | ||
:The MPAA rating of the currently selected movie in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.MusicChannels</code> | ||
| | | '''Returns''' | ||
| | :The number of audio channels for a song. | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.NextDuration</code> | ||
| | | '''Returns''' | ||
| | :The duration of the next item (PVR). | ||
| v18 | |||
|- | |- | ||
| | | <code>ListItem.NextEndDate</code> | ||
| | | '''Returns''' | ||
:The end date of the next item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.NextEndTime</code> | ||
| Returns | | '''Returns''' | ||
:The end of the next item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.NextGenre</code> | ||
| | | '''Returns''' | ||
:The genre of the next item (PVR). | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <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> | ||
| | | '''Returns''' | ||
:The plot of the next item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.NextPlotOutline</code> | ||
| | | '''Returns''' | ||
:The plot outline of the next item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.NextStartDate</code> | ||
| | | '''Returns''' | ||
:The start date of the next item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.NextStartTime</code> | ||
| | | '''Returns''' | ||
:The start time of the next item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.NextTitle</code> | ||
| | | '''Returns''' | ||
:The title of the next item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.OriginalDate</code> | ||
| | | '''Returns''' | ||
| | :The original release date of the item. | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.OriginalTitle</code> | ||
| | | '''Returns''' | ||
:The original title of the currently selected movie in a container. | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.Overview</code> | ||
| | | '''Returns''' | ||
:The game overview/summary (RETROPLAYER). | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.ParentalRating</code> | ||
| | | '''Returns''' | ||
:The parental rating of the list item ( PVR ). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.ParentalRatingCode</code> | ||
| | | '''Returns''' | ||
| | :The parental rating code. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.ParentalRatingIcon</code> | ||
| | | '''Returns''' | ||
| | :The parental rating icon. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.ParentalRatingSource</code> | ||
| | | '''Returns''' | ||
| | :The parental rating source. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Path</code> | ||
| | | '''Returns''' | ||
:The complete path of the currently selected song or movie in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PercentPlayed</code> | ||
| | | '''Returns''' | ||
:The returns percentage value [0-100] of how far the selected video has been played. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureAperture</code> | ||
| | | '''Returns''' | ||
:The f-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureAuthor</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureByline</code> | ||
| | | '''Returns''' | ||
:The name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureBylineTitle</code> | ||
| | | '''Returns''' | ||
:The title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCamMake</code> | ||
| | | '''Returns''' | ||
:The manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCamModel</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCaption</code> | ||
| | | '''Returns''' | ||
:The description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCategory</code> | ||
| | | '''Returns''' | ||
:The subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCCDWidth</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCity</code> | ||
| | | '''Returns''' | ||
:The city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureColour</code> | ||
| | | '''Returns''' | ||
:Whether the selected picture is "Colour" or "Black and White". | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureComment</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCopyrightNotice</code> | ||
| | | '''Returns''' | ||
:The copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCountry</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCountryCode</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureCredit</code> | ||
| | | '''Returns''' | ||
:The provider of the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureDate</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureDatetime</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureDesc</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureDigitalZoom</code> | ||
| | | '''Returns''' | ||
:The digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureExpMode</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureExposure</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureExposureBias</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureExpTime</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureFlashUsed</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureFocalLen</code> | ||
| | | '''Returns''' | ||
:The lens focal length of the selected picture. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureFocusDist</code> | ||
| | | '''Returns''' | ||
:The focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureGPSAlt</code> | ||
| | | '''Returns''' | ||
:The altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureGPSLat</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureGPSLon</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureHeadline</code> | ||
| | | '''Returns''' | ||
:The synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureImageType</code> | ||
| | | '''Returns''' | ||
:The color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureIPTCDate</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureIPTCTime</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureISO</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureKeywords</code> | ||
| | | '''Returns''' | ||
:The keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureLightSource</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureLongDate</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureLongDatetime</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureMeteringMode</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureObjectName</code> | ||
| | | '''Returns''' | ||
:The shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureOrientation</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PicturePath</code> | ||
| Returns the | | '''Returns''' | ||
:The filename and path of the selected picture. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureProcess</code> | ||
| | | '''Returns''' | ||
:The process used to compress the selected picture. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureReferenceService</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureResolution</code> | ||
| | | '''Returns''' | ||
:The dimensions of the selected picture. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureSource</code> | ||
| | | '''Returns''' | ||
:The original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureSpecialInstructions</code> | ||
| | | '''Returns''' | ||
:The editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureState</code> | ||
| | | '''Returns''' | ||
:The State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureSublocation</code> | ||
| Returns the | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureSupplementalCategories</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureTransmissionReference</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureUrgency</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PictureWhiteBalance</code> | ||
| | | '''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). | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.Platform</code> | ||
| | | '''Returns''' | ||
:The game platform (e.g. "Atari 2600") (RETROPLAYER). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PlayCount</code> | ||
| | | '''Returns''' | ||
:The playcount of video in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Plot</code> | ||
| | | '''Returns''' | ||
:The complete text summary of video in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PlotOutline</code> | ||
| | | '''Returns''' | ||
:The small summary of current video in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Premiered</code> | ||
| | | '''Returns''' | ||
:The release/aired date of the currently selected episode, show, movie, or EPG item in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PrivacyPolicy</code> | ||
| | | '''Returns''' | ||
| | :The official Kodi privacy-policy. | ||
| v17 | |||
|- | |- | ||
| | | <code>ListItem.ProgramCount</code> | ||
| | | '''Returns''' | ||
:The number of times an xbe has been run from "my programs". | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Progress</code> | ||
| | | '''Returns''' | ||
:The part of the programme that's being played (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Addon.Changelog)</code> | ||
| | | '''Returns''' | ||
| | :The changelog of the currently selected addon. | ||
| | |||
|- | |- | ||
| | | <code>ListItem.Property(Addon.ID)</code> | ||
| | | '''Returns''' | ||
:The identifier of the currently selected addon. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Addon.Path)</code> | ||
| | | '''Returns''' | ||
:The path of the currently selected addon. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Addon.Status)</code> | ||
| | | '''Returns''' | ||
:The status of the currently selected addon. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Album_Description)</code> | ||
| | | '''Returns''' | ||
:The review of the currently selected album. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Album_Duration)</code> | ||
| | | '''Returns''' | ||
| | :The duration of an album in HH:MM:SS. | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.Property(Album_Label)</code> | ||
| | | '''Returns''' | ||
:The record label of the currently selected album. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Album_Mood)</code> | ||
| | | '''Returns''' | ||
:The moods of the currently selected album. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Album_Rating)</code> | ||
| | | '''Returns''' | ||
:The scraped rating of the currently selected album. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Album_Style)</code> | ||
| | | '''Returns''' | ||
:The styles of the currently selected album. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Album_Theme)</code> | ||
| | | '''Returns''' | ||
:The themes of the currently selected album. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Album_Type)</code> | ||
| Returns | | '''Returns''' | ||
:The album type of the currently selected album (e.g. compilation, enhanced, or explicit lyrics). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Album_UserRating)</code> | ||
| Returns | | '''Returns''' | ||
:The user rating of the currently selected album. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Artist_Born)</code> | ||
| Returns | | '''Returns''' | ||
:The Date of Birth of the currently selected artist. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Artist_Description)</code> | ||
| Returns | | '''Returns''' | ||
:The biography of the currently selected artist. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Artist_Died)</code> | ||
| Returns | | '''Returns''' | ||
:The Date of Death of the currently selected artist. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Artist_Disambiguation)</code> | ||
| Returns | | '''Returns''' | ||
:The brief description of the currently selected artist that differentiates them from others with the same name. | |||
| v18 | |||
|- | |||
| <code>ListItem.Property(Artist_Disbanded)</code> | |||
| '''Returns''' | |||
:The disbanding date of the currently selected band. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Artist_Formed)</code> | ||
| Returns | | '''Returns''' | ||
:The formation date of the currently selected band. | |||
| | | | ||
|- | |- | ||
| <code>ListItem.Property( | | <code>ListItem.Property(Artist_Gender)</code> | ||
| Returns | | '''Returns''' | ||
:The gender of the currently selected artist (e.g.male, female, or other). | |||
| v18 | |||
|- | |||
| <code>ListItem.Property(Artist_Genre)</code> | |||
| '''Returns''' | |||
:The genre of the currently selected artist. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Artist_Instrument)</code> | ||
| Returns the | | '''Returns''' | ||
:The instruments played by the currently selected artist. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Artist_Mood)</code> | ||
| Returns | | '''Returns''' | ||
:The moods of the currently selected artist. | |||
| | | | ||
|- | |- | ||
| <code>ListItem.Property(Artist_Sortname)</code> | |||
| '''Returns''' | |||
:The sortname of the currently selected artist. | |||
| v18 | |||
|- | |- | ||
| | | <code>ListItem.Property(Artist_Style)</code> | ||
| | | '''Returns''' | ||
| | :The styles of the currently selected artist. | ||
| | |||
|- | |- | ||
| | | <code>ListItem.Property(Artist_Type)</code> | ||
| | | '''Returns''' | ||
| | :The type of the currently selected artist (person, group, orchestra, choir, etc). | ||
| v18 | |||
|- | |- | ||
| | | <code>ListItem.Property(Artist_YearsActive)</code> | ||
| | | '''Returns''' | ||
| | :The years the currently selected artist has been active. | ||
| | |||
|- | |- | ||
| | | <code>ListItem.Property(AudioChannels.[n])</code> | ||
| | | '''Returns''' | ||
| | :The number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels). | ||
| | |||
|- | |- | ||
| | | <code>ListItem.Property(AudioCodec.[n])</code> | ||
| | | '''Returns''' | ||
| | :The audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec). | ||
| | |||
|- | |- | ||
| | | <code>ListItem.Property(AudioLanguage.[n])</code> | ||
| | | '''Returns''' | ||
| | :The audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage). | ||
| | |||
|- | |- | ||
| | | <code>ListItem.Property(game.stretchmode)</code> | ||
| | | '''Returns''' | ||
| | :The name of the stretch mode (e.g. Stretch 4:3). | ||
| v18 | |||
|- | |- | ||
| | | <code>ListItem.Property(game.videofilter)</code> | ||
| | | '''Returns''' | ||
| | :The name of the video filter (e.g. Bilinear). | ||
| v18 | |||
|- | |- | ||
| | | <code>ListItem.Property(game.videorotation)</code> | ||
| | | '''Returns''' | ||
| | :The angle of the rotation. | ||
| v18 | |||
|- | |- | ||
| | | <code>ListItem.Property(NumEpisodes)</code> | ||
| Returns | | '''Returns''' | ||
:The number of total, watched, or unwatched episodes for the currently selected TV show or season, based on the the current watched filter. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.Arranger)</code> | ||
| | | '''Returns''' | ||
:The name of the person who arranged the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.Composer)</code> | ||
| | | '''Returns''' | ||
:The name of the person who composed the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.Conductor)</code> | ||
| | | '''Returns''' | ||
:The name of the person who conducted the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.DJMixer)</code> | ||
| | | '''Returns''' | ||
:The name of the DJ who remixed the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.Engineer)</code> | ||
| Returns | | '''Returns''' | ||
:The name of the person who was the engineer of the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.Lyricist)</code> | ||
| | | '''Returns''' | ||
:The name of the person who wrote the lyrics of the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.Mixer)</code> | ||
| Returns | | '''Returns''' | ||
:The name of the person who mixed the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.Orchestra)</code> | ||
| | | '''Returns''' | ||
:The name of the orchestra performing the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.Producer)</code> | ||
| | | '''Returns''' | ||
:The name of the person who produced the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Role.Remixer)</code> | ||
| | | '''Returns''' | ||
:The name of the person who remixed the selected song. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(Stream.Bitrate)</code> | ||
| | | '''Returns''' | ||
| | :The video bitrate (kbps) of the currently playing video. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Property(Stream.Channels)</code> | ||
| | | '''Returns''' | ||
| | :The number of audio channels of the currently playing video. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Property(Stream.Codec)</code> | ||
| | | '''Returns''' | ||
| | :The audio, video, or subtitle codec of the currently playing video. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Property(Stream.CodecDesc)</code> | ||
| | | '''Returns''' | ||
| | :The audio description of the currently playing video. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Property(Stream.Description)</code> | ||
| | | '''Returns''' | ||
| | :The audio, video, or subtitle title/name of the currently playing video. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Property(Stream.FPS)</code> | ||
| | | '''Returns''' | ||
| | :The Frames per Second of the currently playing video. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Property(Stream.HDRType)</code> | ||
| Returns | | '''Returns''' | ||
| | :The HDR type of the currently playing video (e.g. hdr10, dolbyvision, or hlg). | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Property(Stream.Language)</code> | ||
| | | '''Returns''' | ||
| | :The audio language of the currently playing video as an ISO 639-2 three character code (e.g. eng, epo, deu, etc). | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Property(Stream.Resolution)</code> | ||
| | | '''Returns''' | ||
| | :The video resolution of the currently playing video. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Property(Stream.StereoMode)</code> | ||
| | | '''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 | |||
|- | |- | ||
| | | <code>ListItem.Property(SubtitleLanguage.[n])</code> | ||
| | | '''Returns''' | ||
:The subtitle language of the currently selected stream, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(TotalEpisodes)</code> | ||
| | | '''Returns''' | ||
:The total number of episodes for the currently selected TV show or season. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(TotalSeasons)</code> | ||
| | | '''Returns''' | ||
:The total number of seasons for the currently selected TV show. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Property(UnWatchedEpisodes)</code> | ||
| The | | '''Returns''' | ||
| | :The number of unwatched episodes for the currently selected TV show or season. | ||
| | |||
|- | |- | ||
| | | <code>ListItem.Property(WatchedEpisodes)</code> | ||
| | | '''Returns''' | ||
:The number of watched episodes for the currently selected TV show or season. | |||
| | | | ||
|- | |- | ||
| <code>ListItem. | | <code>ListItem.Publisher</code> | ||
| | | '''Returns''' | ||
:The game publisher (e.g. "Nintendo") (RETROPLAYER). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.PVRClientName</code> | ||
| Returns the | | '''Returns''' | ||
| | :The name of the PVR client addon for the selected PVR list item. | ||
| v22 | |||
|- | |- | ||
| <code>ListItem. | | <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 the | | '''Returns''' | ||
| | :The name of the instance of the PVR client addon for the selected PVR list item. | ||
| v22 | |||
|- | |- | ||
| | | <code>ListItem.Rating[(name)]</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.RatingAndVotes[(name)]</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.ReleaseDate</code> | ||
| | | '''Returns''' | ||
| | :The release date of the current item. | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.SampleRate</code> | ||
| | | '''Returns''' | ||
| | :The sample rate of a song / 1000.0 (e.g. 44.1, 48, 96 etc). | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.Season</code> | ||
| | | '''Returns''' | ||
| | :The season value for the currently selected TV show. | ||
| | |||
|- | |- | ||
| | | <code>ListItem.Set</code> | ||
| | | '''Returns''' | ||
:The name of the set the movie is part of. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.SetId</code> | ||
| | | '''Returns''' | ||
:The id of the set the movie is part of. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Size</code> | ||
| | | '''Returns''' | ||
:The file size of the currently selected song or movie in a container. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>ListItem.SongVideoURL</code> | ||
| | | '''Returns''' | ||
:Link to a video of a song | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.SortLetter</code> | ||
| | | '''Returns''' | ||
:The first letter of the current file in a container. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>ListItem.StartDate</code> | ||
| | | '''Returns''' | ||
:The start date of current selected TV programme in a container. | |||
| | |||
|- | |||
| <code>ListItem.StartDate</code> | |||
| '''Returns''' | |||
:The start date of the selected item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.StartTime</code> | ||
| | | '''Returns''' | ||
:The start time of current selected TV programme in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.StartTime</code> | ||
| | | '''Returns''' | ||
:The start time of the selected item (PVR). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Status</code> | ||
| | | '''Returns''' | ||
:The status of the selected TV show (e.g. 'returning series','in production','planned','cancelled' or 'ended'). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.StereoscopicMode</code> | ||
| The | | '''Returns''' | ||
:The stereomode of the selected video (ie.g. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, or anaglyph_green_magenta). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Studio</code> | ||
| | | '''Returns''' | ||
:The studio of current selected music video in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.SubtitleLanguage</code> | ||
| The | | '''Returns''' | ||
:The subtitle language of the currently selected video as an ISO 639-2 three character code (e.g. eng, epo, deu). | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Tag</code> | ||
| | | '''Returns''' | ||
:The name of the 'tag' this movie is part of. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Tagline</code> | ||
| | | '''Returns''' | ||
:The small summary of current video in a container. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>ListItem.TimerType</code> | ||
| | | '''Returns''' | ||
:The type of the PVR timer / timer rule item as a human readable string. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Title</code> | ||
| | | '''Returns''' | ||
:The title of the currently selected song or movie in a container. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>ListItem.TitleExtraInfo</code> | ||
| | | '''Returns''' | ||
:string containing extra information, enriching the title of the item. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>ListItem.Top250</code> | ||
| | | '''Returns''' | ||
:The IMDB top 250 position of the currently selected ListItem in a container. | |||
| | |||
|- | |||
| <code>ListItem.TotalDiscs</code> | |||
| '''Returns''' | |||
:The total amount of discs belonging to an album. | |||
| v19 | |||
|- | |||
| <code>ListItem.TrackNumber</code> | |||
| '''Returns''' | |||
:The track number of the currently selected song in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Trailer</code> | ||
| | | '''Returns''' | ||
:The full trailer path with filename of the currently selected movie in a container. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>ListItem.TVShowDBID</code> | ||
| | | '''Returns''' | ||
:The TV show DBID of the selected season or episode a container. | |||
| v19 | |||
|- | |||
| <code>ListItem.TVShowTitle</code> | |||
| '''Returns''' | |||
:The name value for the currently selected TV show in the season and episode depth of the video library. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.UniqueID()</code> | ||
| | | '''Returns''' | ||
| | :The UniqueID of the selected item in a container. | ||
| v19 | |||
|- | |- | ||
| | | <code>ListItem.UserRating</code> | ||
| | | '''Returns''' | ||
:The user rating of the currently selected item in a container. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.VideoAspect</code> | ||
| | | '''Returns''' | ||
| | :The aspect ratio of the currently selected video.<br> | ||
: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 | |||
|- | |- | ||
| | | <code>ListItem.VideoCodec</code> | ||
| | | '''Returns''' | ||
:The video codec of the currently selected video.<br> | |||
: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 | |||
| | | | ||
|- | |- | ||
| <code> | | <code>ListItem.VideoHeight</code> | ||
| | | '''Returns''' | ||
:String containing height of video in pixels - empty if unknown. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>ListItem.VideoResolution</code> | ||
| | | '''Returns''' | ||
:The resolution of the currently selected video.<br> | |||
:Possible values: | |||
:*480 | |||
:*576 | |||
:*540 | |||
:*720 | |||
:*1080 | |||
:*4K | |||
:*8K* | |||
{{highlight|'''Note'''<br> | |||
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 | |||
|- | |||
| <code>ListItem.VideoVersionName</code> | |||
| '''Returns''' | |||
:The name of the video version. | |||
| v21 | |||
|- | |||
| <code>ListItem.VideoWidth</code> | |||
| '''Returns''' | |||
:String containing width of video in pixels - empty if unknown. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Votes[(name)]</code> | ||
| | | '''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. | |||
| | | | ||
|- | |- | ||
| | | <code>ListItem.Writer</code> | ||
| | | '''Returns''' | ||
:The name of Writer of current video in a container. | |||
| | | | ||
|- | |- | ||
| <code> | | <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> | |||
| '''Returns''' | |||
:The year of the currently selected song, album, or movie in a container. | |||
|} | |||
=== MusicPartyMode === | |||
{| class="wikitable sortable" width="100%" | |||
! InfoLabels | |||
! style="80%" | Description | |||
! Version | |||
|- | |- | ||
| <code> | | <code>MusicPartyMode.MatchingSongs</code> | ||
| | | '''Returns''' | ||
:The number of songs available to Party Mode. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPartyMode.MatchingSongsLeft</code> | ||
| | | '''Returns''' | ||
:The number of songs left to be picked from for Party Mode. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPartyMode.MatchingSongsPicked</code> | ||
| | | '''Returns''' | ||
:The number of songs picked already for Party Mode. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPartyMode.RandomSongsPicked</code> | ||
| | | '''Returns''' | ||
:The number of unique random songs picked during Party Mode. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPartyMode.RelaxedSongsPicked</code> | ||
| | | '''Returns''' | ||
:The number of relaxed songs picked during Party Mode. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPartyMode.SongsPlayed</code> | ||
| | | '''Returns''' | ||
:The number of songs played during Party Mode. | |||
| | | | ||
|} | |||
=== Network === | |||
{| class="wikitable sortable" width="100%" | |||
! InfoLabels | |||
! style="80%" | Description | |||
! Version | |||
|- | |- | ||
| <code> | | <code>Network.DHCPAddress</code> | ||
| | | '''Returns''' | ||
:The DHCP server ip address. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>Network.DNS1Address</code> | ||
| Returns | | '''Returns''' | ||
:The network dns server 1 address. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>Network.DNS2Address</code> | ||
| | | '''Returns''' | ||
:The network dns server 2 address. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>Network.GatewayAddress</code> | ||
| Returns | | '''Returns''' | ||
:The network gateway address. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>Network.IPAddress</code> | ||
| Returns | | '''Returns''' | ||
:The system's IP Address. e.g. 192.168.1.15 | |||
| | | | ||
|- | |- | ||
| <code> | | <code>Network.LinkState</code> | ||
| Returns | | '''Returns''' | ||
:The network linkstate (e.g. 10mbit/100mbit etc). | |||
| | | | ||
|- | |- | ||
| <code> | | <code>Network.MacAddress</code> | ||
| | | '''Returns''' | ||
:The system's mac address. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>Network.SubnetMask</code> | ||
| | | '''Returns''' | ||
:The network subnet mask. | |||
| | | | ||
|} | |||
=== Player === | |||
{| class="wikitable sortable" width="100%" | |||
! InfoLabels | |||
! style="80%" | Description | |||
! Version | |||
|- | |- | ||
| <code>Player. | | <code>Player.AudioDelay</code> | ||
| | | '''Returns''' | ||
:The used audio delay with the format <code>%2.3f</code> s | |||
| | | | ||
|- | |- | ||
| <code>Player. | | <code>Player.Bookmarks</code> | ||
| | | '''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. | | <code>Player.CacheLevel</code> | ||
| | | '''Returns''' | ||
:The used cache level as a string with an integer number. | |||
| | | | ||
|- | |- | ||
| <code>Player. | | <code>Player.ChapterName</code> | ||
| | | '''Returns''' | ||
:The name of currently used chapter if available. | |||
| | | | ||
|- | |- | ||
| <code>Player. | | <code>Player.Cuts</code> | ||
| | | '''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. | | <code>Player.Editlist</code> | ||
| | | '''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. | | <code>Player.offset(number).Filename</code> | ||
| | | '''Returns''' | ||
:The filename of audio or video file which has an offset <code>number</code> with respect to the currently playing item. | |||
| | | | ||
|- | |- | ||
| <code>Player. | | <code>Player.offset(number).FilenameAndPath</code> | ||
| | | '''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. | | <code>Player.offset(number).Folderpath</code> | ||
| | | '''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. | | <code>Player.offset(number).Title</code> | ||
| | | '''Returns''' | ||
:The title of audio or video which has an offset <code>number</code> with respect to the currently playing item. | |||
| | | | ||
|- | |- | ||
| <code>Player. | | <code>Player.position(number).Filename</code> | ||
| | | '''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. | | <code>Player.position(number).FilenameAndPath</code> | ||
| | | '''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. | | <code>Player.position(number).Folderpath</code> | ||
| | | '''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> | | <code>Player.position(number).Title</code> | ||
| | | '''Returns''' | ||
| | :The title of the audio or video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>Player.SceneMarkers</code> | ||
| | | '''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> | | <code>Player.SeekNumeric([format])</code> | ||
| | | '''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> | | <code>Player.SubtitleDelay</code> | ||
| | | '''Returns''' | ||
:The used subtitle delay with the format <code>%2.3f</code> s | |||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.TimeSpeed</code> | ||
| | | '''Returns''' | ||
:The time and the playspeed formatted: "1:23 (2x)". | |||
| | | | ||
|} | |||
=== Player labels === | |||
{| class="wikitable sortable" width="100%" | |||
! InfoLabels | |||
! style="80%" | Description | |||
! Version | |||
|- | |- | ||
| <code> | | <code>Player.Chapter</code> | ||
| | | Current chapter of current playing media | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.ChapterCount</code> | ||
| | | Total number of chapters of current playing media | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Chapters</code> | ||
| | | 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> | | <code>Player.Duration(format)</code> | ||
| Shows | | 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> | | <code>Player.Filename</code> | ||
| | | Returns the filename of the currently playing media. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Filenameandpath</code> | ||
| | | Shows the full path with filename of the currently playing song or movie. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.FinishTime</code> | ||
| | | Time playing media will end | ||
| | | | ||
|- | |- | ||
| <code> | | <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> | | <code>Player.Folderpath</code> | ||
| | | Shows the full path of the currently playing song or movie. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.PlaySpeed</code> | ||
| | | Current playspeed. (range:0.8 to 1.5) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(AudioBitsPerSample)</code> | ||
| | | Bits per sample of the currently playing item | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(AudioChannels)</code> | ||
| | | List of audio channels of the currently playing item (e.g. FL+FR) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(AudioDecoder)</code> | ||
| | | Audiodecoder name of the currently playing item | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(AudioSamplerate)</code> | ||
| | | Samplerate f the currently playing item | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(DeintMethod)</code> | ||
| | | Deinterlace method of the currently playing video | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(PixFormat)</code> | ||
| | | Pixel format of the currently playing video | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(VideoDAR)</code> | ||
| | | Display aspect ratio of the currently playing video | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(VideoDecoder)</code> | ||
| | | Videodecoder name of the currently playing video | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(VideoFPS)</code> | ||
| | | Video framerate of the currently playing video | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(VideoHeight)</code> | ||
| | | Height of the currently playing video | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Process(VideoScanType)</code> | ||
| | | The scan type identifier of the currently playing video '''p''' (for progressive) or '''i''' (for interlaced) | ||
| | | v20 | ||
|- | |- | ||
| <code> | | <code>Player.Process(VideoWidth)</code> | ||
| | | Width of the currently playing video | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Progress</code> | ||
| | | Shows how much (percentage) of the file has been played | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.ProgressCache</code> | ||
| | | Shows how much of the file is cached above current play percentage | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.SeekBar</code> | ||
| | | Time to which the user is seeking as a percentage (for use in slider controls) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.SeekOffset</code> | ||
| | | Indicates the seek offset after a seek press (e.g. user presses BigStepForward, player.seekoffset returns +10:00) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.SeekOffset(format)</code> | ||
| | | Shows hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (hh:mm:ss). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.SeekStepSize</code> | ||
| | | Displays the seek step size. (v15 addition) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.SeekTime</code> | ||
| | | Time to which the user is seeking | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.StartTime</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. | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.StartTime(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> | | <code>Player.Time</code> | ||
| | | Elapsed time of current playing media | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.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). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.TimeRemaining</code> | ||
| | | Remaining time of current playing media | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.TimeRemaining(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> | | <code>Player.Title</code> | ||
| | | Returns the musicplayer title for audio and the videoplayer title for videos. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Player.Volume</code> | ||
| | | Returns the volume level in dB | ||
| | | | ||
|} | |||
==== Music player ==== | |||
{| class="wikitable sortable" width="100%" | |||
! InfoLabels | |||
! style="80%" | Description | |||
! Version | |||
|- | |- | ||
| <code>MusicPlayer. | | <code>MusicPlayer.AlbumArtist</code> | ||
| | | '''Returns''' | ||
:The album artist of the currently playing song. | |||
| | | | ||
|- | |- | ||
| <code>MusicPlayer. | | <code>MusicPlayer.LastPlayed</code> | ||
| | | '''Returns''' | ||
:The last play date of currently playing song, if it's in the database. | |||
| | | | ||
|- | |- | ||
| <code>MusicPlayer. | | <code>MusicPlayer.MediaProviders</code> | ||
| | | '''Returns''' | ||
:string containing the names of the providers of the currently playing media, separated by commas if multiple are present. | |||
| | | | ||
|- | |- | ||
| <code>MusicPlayer. | | <code>MusicPlayer.offset(number).Album</code> | ||
| | | '''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. | | <code>MusicPlayer.offset(number).Artist</code> | ||
| | | '''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. | | <code>MusicPlayer.offset(number).Comment</code> | ||
| | | '''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. | | <code>MusicPlayer.offset(number).DiscNumber</code> | ||
| Returns the | | '''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. | | <code>MusicPlayer.offset(number).Duration</code> | ||
| Returns the | | '''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. | | <code>MusicPlayer.offset(number).Genre</code> | ||
| Returns the | | '''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. | | <code>MusicPlayer.offset(number).Rating</code> | ||
| Returns the | | '''Returns''' | ||
: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. | | <code>MusicPlayer.offset(number).Title</code> | ||
| Returns the | | '''Returns''' | ||
: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. | | <code>MusicPlayer.offset(number).TrackNumber</code> | ||
| Returns | | '''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. | | <code>MusicPlayer.offset(number).Year</code> | ||
| Returns the | | '''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. | | <code>MusicPlayer.ParentalRatingCode</code> | ||
| | | Shows the parental rating code | ||
| v22 | |||
|- | |||
| <code>MusicPlayer.ParentalRatingIcon</code> | |||
| Shows the parental rating icon | |||
| v22 | |||
|- | |||
| <code>MusicPlayer.ParentalRatingSource</code> | |||
| Shows the parental rating source | |||
| v22 | |||
|- | |||
| <code>MusicPlayer.ChannelLogo</code> | |||
| Shows the logo of the currently selected radio or TV channel | |||
| v22 | |||
|- | |||
| <code>MusicPlayer.PlayCount</code> | |||
| '''Returns''' | |||
:The play count of currently playing song, if it's in the database. | |||
| | | | ||
|- | |- | ||
| <code>MusicPlayer. | | <code>MusicPlayer.Position(number).Album</code> | ||
| Returns the | | '''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. | | <code>MusicPlayer.Position(number).Artist</code> | ||
| Returns the | | '''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. | | <code>MusicPlayer.Position(number).Comment</code> | ||
| The | | '''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. | | <code>MusicPlayer.Position(number).DiscNumber</code> | ||
| The | | '''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. | | <code>MusicPlayer.Position(number).Duration</code> | ||
| The | | '''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. | | <code>MusicPlayer.Position(number).Genre</code> | ||
| Returns the | | '''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. | | <code>MusicPlayer.Position(number).Rating</code> | ||
| Returns the | | '''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. | | <code>MusicPlayer.Position(number).Title</code> | ||
| Returns the | | '''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. | | <code>MusicPlayer.Position(number).TrackNumber</code> | ||
| Returns the number of | | '''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> | | <code>MusicPlayer.Position(number).Year</code> | ||
| Returns the number of | | '''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> | | <code>MusicPlayer.RatingAndVotes</code> | ||
| Returns | | '''Returns''' | ||
| | :The scraped rating and votes of currently playing song, if it's in the database. | ||
| | |||
|- | |- | ||
| <code> | | <code>MusicPlayer.Station</code> | ||
| | | '''Returns''' | ||
| | :The name of the radio station currently playing (if available). | ||
| | |||
|- | |- | ||
| <code> | | <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> | | <code>MusicPlayer.Album</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 | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Album_Mood)</code> | ||
| Shows the | | Shows the moods of the currently playing Album | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Album_Style)</code> | ||
| | | Shows the styles of the currently playing Album | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Album_Theme)</code> | ||
| | | Shows the themes of the currently playing Album | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Album_Type)</code> | ||
| | | Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently playing Album | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Album_Label)</code> | ||
| | | Shows the record label of the currently playing Album | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Album_Description)</code> | ||
| | | Shows a review of the currently playing Album | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Artist</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 | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Born)</code> | ||
| | | Date of Birth of the currently playing Artist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Died)</code> | ||
| | | Date of Death of the currently playing Artist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Formed)</code> | ||
| | | Formation date of the currently playing Artist/Band | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Disbanded)</code> | ||
| | | Disbanding date of the currently playing Artist/Band | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_YearsActive)</code> | ||
| | | Years the currently Playing artist has been active | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Instrument)</code> | ||
| | | Instruments played by the currently playing artist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Description)</code> | ||
| | | Shows a biography of the currently playing artist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Mood)</code> | ||
| | | Shows the moods of the currently playing artist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Style)</code> | ||
| | | Shows the styles of the currently playing artist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Genre)</code> | ||
| Shows the | | Shows the genre of the currently playing artist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Sortname)</code> | ||
| | | Sortname of the currently playing Artist | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Artist_Type)</code> | ||
| | | Type of the currently playing Artist - person, group, orchestra, choir, etc. | ||
| | | v18 | ||
|- | |||
| <code>MusicPlayer.Property(Artist_Gender)</code> | |||
| Gender of the currently playing Artist - male, female, other | |||
| v18 | |||
|- | |||
| <code>MusicPlayer.Property(Artist_Disambiguation)</code> | |||
| Brief description of the currently playing Artist that differentiates them from others with the same name | |||
| v18 | |||
|- | |- | ||
| <code> | | <code>MusicPlayer.Genre</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 | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Genre(separator)</code> | ||
| | | '''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. | ||
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22] | |||
|- | |- | ||
| <code> | | <code>MusicPlayer.Lyrics</code> | ||
| | | Lyrics of current song stored in ID tag info | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Votes</code> | ||
| | | '''Returns''' | ||
:The scraped votes of currently playing song, if it's in the database. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Year</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 | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Rating</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 | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.DiscNumber</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 | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.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 | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Time</code> | ||
| | | Current time in song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.TimeRemaining</code> | ||
| | | Current remaining time in song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.TimeSpeed</code> | ||
| | | Both the time and the playspeed formatted up. e.g. 1:23 (2x) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.TrackNumber</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 | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Duration</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 | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.BitRate</code> | ||
| | | Bitrate of current song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Channels</code> | ||
| | | Number of channels of current song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.BitsPerSample</code> | ||
| | | Number of bits per sample of current song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.SampleRate</code> | ||
| | | Samplerate of current song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Codec</code> | ||
| | | Codec of current song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.PlaylistPosition</code> | ||
| | | Position of the current song in the current music playlist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.PlaylistLength</code> | ||
| | | Total size of the current music playlist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.ChannelName</code> | ||
| | | Channel name of the radio programme that's currently playing (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.ChannelNumberLabel</code> | ||
| | | Channel and subchannel number of the radio channel that's currently playing (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.ChannelGroup</code> | ||
| | | Channel group of of the radio programme that's currently playing (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Contributors</code> | ||
| | | List of all people who've contributed to the currently playing song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.ContributorAndRole</code> | ||
| | | List of all people and their role who've contributed to the currently playing song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Mood</code> | ||
| | | Mood of the currently playing song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.Arranger)</code> | ||
| | | Returns the name of the person who arranged the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.Composer)</code> | ||
| | | Returns the name of the person who composed the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.Conductor)</code> | ||
| | | Returns the name of the person who conducted the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.DJMixer)</code> | ||
| | | Returns the name of the dj who remixed the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.Engineer)</code> | ||
| | | Returns the name of the person who was the engineer of the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.Lyricist)</code> | ||
| | | Returns the name of the person who wrote the lyrics of the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.Mixer)</code> | ||
| | | Returns the name of the person who mixed the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.Orchestra)</code> | ||
| | | Returns the name of the orchestra performing the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.Producer)</code> | ||
| | | Returns the name of the person who produced the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.Property(Role.Remixer)</code> | ||
| | | Returns the name of the person who remixed the selected song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.UserRating</code> | ||
| | | The rating the user gave to the currently playing song | ||
| | | | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.DBID</code> | ||
| | | The database id of the currently playing song | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.DiscTitle</code> | ||
| | | The title of the disc currently playing | ||
| | | v19 | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.ReleaseDate</code> | ||
| | | Returns the release date of the song currently playing | ||
| | | v19 | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.OriginalDate</code> | ||
| Returns the | | Returns the original release date of the song currently playing | ||
| v19 | | v19 | ||
|- | |- | ||
| <code> | | <code>MusicPlayer.BPM</code> | ||
| Returns the | | 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 | | v19 | ||
|} | |} | ||
=== | === RetroPlayer === | ||
{| class="wikitable sortable" width="100%" | {| class="wikitable sortable" width="100%" | ||
| Line 2,076: | Line 2,578: | ||
! Version | ! Version | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.Developer</code> | ||
| | | '''Returns''' | ||
:The developer of the currently-playing game (e.g. "Square"). | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.DiscLabel</code> | ||
| | | '''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> | | <code>RetroPlayer.GameClient</code> | ||
| Returns ' | | '''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> | | <code>RetroPlayer.GameClientName</code> | ||
| Returns | | '''Returns''' | ||
:The emulator/core name parsed from the game client's add-on name (e.g. <code>bsnes-mercury Performance</code> ). | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.GameClientPlatforms</code> | ||
| | | '''Returns''' | ||
:The platform or platform group supported by the game client (e.g. an emulator might report "Nintendo - SNES / SFC / Game Boy / Color"). | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.Genres</code> | ||
| | | '''Returns''' | ||
:The genres of the currently-playing game, joined by ", ". | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.Overview</code> | ||
| | | '''Returns''' | ||
:The overview/summary of the currently-playing game. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.Platform</code> | ||
| | | '''Returns''' | ||
:The platform of the currently-playing game, or an empty string if the platform is unknown. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.Publisher</code> | ||
| | | '''Returns''' | ||
:The publisher of the currently-playing game (e.g. "Nintendo"). | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.StretchMode</code> | ||
| | | '''Returns''' | ||
:The stretch mode of the currently-playing game. The following values are possible: | |||
:<code>normal</code> (Show the game normally) | |||
:<code>4:3</code> (Stretch to a 4:3 aspect ratio) | |||
:<code>fullscreen</code> (Stretch to the full viewing area) | |||
:<code>original</code> (Shrink to the original resolution) | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.Title</code> | ||
| | | '''Returns''' | ||
:The title of the currently-playing game. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RetroPlayer.VideoFilter</code> | ||
| | | '''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> | | <code>RetroPlayer.VideoRotation</code> | ||
| | | '''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> | | <code>VideoPlayer.Art(type)</code> | ||
| | | '''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> | | <code>VideoPlayer.AudioLanguageEx</code> | ||
| | | '''Returns''' | ||
:The English name of the language of the current audio stream of the currently playing item. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.AudioName</code> | ||
| | | '''Returns''' | ||
:The name of the active audio stream of the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.AudioStreamCount</code> | ||
| | | 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> | | <code>VideoPlayer.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. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.MediaProviders</code> | ||
| | | '''Returns''' | ||
:string containing the names of the providers of the currently playing media, separated by commas if multiple are present. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Album</code> | ||
| | | '''Returns''' | ||
| | :The album from which the video which has an offset <code>number</code> with respect to the currently playing video. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Art(type)</code> | ||
| | | '''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> | | <code>VideoPlayer.offset(number).Artist</code> | ||
| | | '''Returns''' | ||
:The artist(s) of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Country</code> | ||
| Returns the | | '''Returns''' | ||
:The production country of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Cover</code> | ||
| Returns the | | '''Returns''' | ||
:The cover of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).DBID</code> | ||
| Returns the | | '''Returns''' | ||
| | :The database id of the video which has an offset <code>number</code> with respect to the currently playing video. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Director</code> | ||
| Returns the | | '''Returns''' | ||
| | :The director of the video which has an offset <code>number</code> with respect to the currently playing video. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Episode</code> | ||
| Returns the | | '''Returns''' | ||
| | :The episode number of the episode which has an offset <code>number</code> with respect to the currently playing video. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Genre</code> | ||
| Returns the | | '''Returns''' | ||
:The genre(s) of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).IMDBNumber</code> | ||
| | | '''Returns''' | ||
:The IMDb ID of the the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).LastPlayed</code> | ||
| | | '''Returns''' | ||
:The last play date of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).mpaa</code> | ||
| | | '''Returns''' | ||
:The MPAA rating of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).OriginalTitle</code> | ||
| Returns the | | '''Returns''' | ||
:The original title of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).PlayCount</code> | ||
| | | '''Returns''' | ||
:The playcount of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Plot</code> | ||
| | | '''Returns''' | ||
:The complete Text Summary of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).PlotOutline</code> | ||
| | | '''Returns''' | ||
:The small Summary of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Premiered</code> | ||
| | | '''Returns''' | ||
:The release or aired date of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Rating</code> | ||
| | | '''Returns''' | ||
:The scraped rating of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).RatingAndVotes</code> | ||
| | | '''Returns''' | ||
:The scraped rating and votes of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Season</code> | ||
| | | '''Returns''' | ||
:The season number of the episode which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Studio</code> | ||
| | | '''Returns''' | ||
:The studio of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Tagline</code> | ||
| | | '''Returns''' | ||
:The small Summary of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Title</code> | ||
| | | '''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> | | <code>VideoPlayer.offset(number).Top250</code> | ||
| | | '''Returns''' | ||
:The IMDb Top250 position of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Trailer</code> | ||
| | | '''Returns''' | ||
:The path to the trailer of the video which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).TVShowTitle</code> | ||
| | | '''Returns''' | ||
:The title of the episode's tvshow name which has an offset <code>number</code> with respect to the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).UserRating</code> | ||
| | | '''Returns''' | ||
| | :The user rating of the video which has an offset <code>number</code> with respect to the currently playing video. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Votes</code> | ||
| | | '''Returns''' | ||
| | :The scraped votes of the video which has an offset <code>number</code> with respect to the currently playing video. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Writer</code> | ||
| | | '''Returns''' | ||
| | :The name of Writer of the video which has an offset <code>number</code> with respect to the currently playing video. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.offset(number).Year</code> | ||
| | | '''Returns''' | ||
| | :The year of release of the video which has an offset <code>number</code> with respect to the currently playing video. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Album</code> | ||
| | | '''Returns''' | ||
| | :The album from which the music video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Art(type)</code> | ||
| | | '''Returns''' | ||
| | :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> | | <code>VideoPlayer.position(number).Artist</code> | ||
| | | '''Returns''' | ||
| | :The artist(s) of the music video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Country</code> | ||
| | | '''Returns''' | ||
| | :The production country of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Cover</code> | ||
| | | '''Returns''' | ||
| | :The cover of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).DBID</code> | ||
| | | '''Returns''' | ||
| | :The database id of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Director</code> | ||
| | | '''Returns''' | ||
| | :The director of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Episode</code> | ||
| | | '''Returns''' | ||
| | :The episode number of the episode which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Genre</code> | ||
| | | '''Returns''' | ||
| | :The genre(s) of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).IMDBNumber</code> | ||
| | | '''Returns''' | ||
| | :The IMDb ID of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).LastPlayed</code> | ||
| | | '''Returns''' | ||
| | :The last play date of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).mpaa</code> | ||
| | | '''Returns''' | ||
| | :The MPAA rating of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).OriginalTitle</code> | ||
| Returns the | | '''Returns''' | ||
| | :The original title of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).PlayCount</code> | ||
| Returns the | | '''Returns''' | ||
| | :The playcount of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Plot</code> | ||
| Returns the start | | '''Returns''' | ||
| | :The complete Text Summary of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).PlotOutline</code> | ||
| Returns the start | | '''Returns''' | ||
| | :The small Summary of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Premiered</code> | ||
| Returns the | | '''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> | | <code>VideoPlayer.position(number).Rating</code> | ||
| Returns the | | '''Returns''' | ||
| | :The scraped rating of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).RatingAndVotes</code> | ||
| Returns the | | '''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> | | <code>VideoPlayer.position(number).Season</code> | ||
| Returns the | | '''Returns''' | ||
| | :The season number of the episode which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Studio</code> | ||
| Returns the | | '''Returns''' | ||
| | :The studio of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Tagline</code> | ||
| Returns the | | '''Returns''' | ||
| | :The small Summary of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Title</code> | ||
| Returns the | | '''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> | | <code>VideoPlayer.position(number).Top250</code> | ||
| | | '''Returns''' | ||
| | :The IMDb Top250 position of the video which has an offset <code>number</code> with respect to the start of the playlist. | ||
| | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Trailer</code> | ||
| The | | '''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> | | <code>VideoPlayer.position(number).TVShowTitle</code> | ||
| | | '''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> | | <code>VideoPlayer.position(number).UserRating</code> | ||
| Returns the | | '''Returns''' | ||
:The user rating of the video which has an offset <code>number</code> with respect to the start of the playlist. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Votes</code> | ||
| | | '''Returns''' | ||
:The scraped votes of the video which has an offset <code>number</code> with respect to the start of the playlist. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Writer</code> | ||
| | | '''Returns''' | ||
:The name of Writer of the video which has an offset <code>number</code> with respect to the start of the playlist. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.position(number).Year</code> | ||
| | | '''Returns''' | ||
:The year of release of the video which has an offset <code>number</code> with respect to the start of the playlist. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.StartTime</code> | ||
| | | '''Returns''' | ||
:The start date and time of the currently playing epg event or recording ( PVR ). | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.SubtitleCodec</code> | ||
| The | | '''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 | |||
{{highlight|'''Note'''<br><code>VideoPlayer.SubtitleCodec</code> holds the codec of the next available subtitles stream if subtitles are disabled in the player.}} | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.SubtitleLanguageEx</code> | ||
| The | | '''Returns''' | ||
:The English name of the language of the current subtitle stream of the currently playing item. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.SubtitleName</code> | ||
| The | | '''Returns''' | ||
:The name of the active subtitle stream of the currently playing video. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.TitleExtraInfo</code> | ||
| | | '''Returns''' | ||
:string containing extra information, enriching the title of the currently playing media, if any. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.VideoStreamCount</code> | ||
| | | Returns the number of video streams of the currently playing video | ||
| | | v22 | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.ParentalRatingCode</code> | ||
| | | Shows the parental rating code | ||
| | | v22 | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.ParentalRatingIcon</code> | ||
| | | Shows the parental rating icon | ||
| | | v22 | ||
|- | |||
| <code>VideoPlayer.ParentalRatingSource</code> | |||
| Shows the parental rating source | |||
| v22 | |||
|- | |||
| <code>VideoPlayer.ChannelLogo</code> | |||
| Shows the logo of the currently selected radio or TV channel | |||
| v22 | |||
|- | |||
| <code>VideoPlayer.VideoVersionName</code> | |||
| Show the name of the video version | |||
| v21 | |||
|- | |- | ||
| <code> | | <code>VideoPlayer.Time</code> | ||
| | | Current time in movie | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.TimeRemaining</code> | ||
| | | Current remaining time in movie | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.TimeSpeed</code> | ||
| | | Current time + playspeed. e.g. 1:23:14 (-4x) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Duration</code> | ||
| | | Length of current movie | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Title</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()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.OriginalTitle</code> | ||
| | | The original title of currently playing video. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.TVShowTitle</code> | ||
| | | Title of currently playing episode's tvshow name. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Season</code> | ||
| | | Season number of the currently playing episode, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Episode</code> | ||
| | | Episode number of the currently playing episode. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Genre</code> | ||
| | | Genre(s) of current movie, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Genre(separator)</code> | ||
| | | '''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. | |||
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22] | |||
|- | |||
| <code>VideoPlayer.Director</code> | |||
| Director of current movie, if it's in the database. (supports .offset() and .position()) | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Director(separator)</code> | ||
| | | '''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. | |||
| [https://forum.kodi.tv/showthread.php?tid=377306&pid=3230987#pid3230987 v22] | |||
|- | |||
| <code>VideoPlayer.Country</code> | |||
| Production country of current movie, if it's in the database. (supports .offset() and .position()) | |||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Year</code> | ||
| | | Year of release of current movie, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Premiered</code> | ||
| | | The release/aired date of the currently selected episode, show, movie or EPG item. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Rating</code> | ||
| | | IMDb user rating of current movie, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.UserRating</code> | ||
| | | Shows the user rating of the currently playing item. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Votes</code> | ||
| | | IMDb votes of current movie, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.RatingAndVotes</code> | ||
| | | IMDb user rating and votes of current movie, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.mpaa</code> | ||
| | | MPAA rating of current movie, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.IMDBNumber</code> | ||
| | | The IMDB iD of the current video, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.EpisodeName</code> | ||
| | | (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.PlaylistPosition</code> | ||
| | | Position of the current song in the current video playlist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.PlaylistLength</code> | ||
| | | Total size of the current video playlist | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Cast</code> | ||
| | | A list of cast members, separated by carriage returns, if it's in the database | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Cast(separator)</code> | ||
| | | '''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> | | <code>VideoPlayer.CastAndRole(separator)</code> | ||
| | | '''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> | | <code>VideoPlayer.Trailer</code> | ||
| | | The trailer of the current movie. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Album</code> | ||
| | | Album from which the current Music Video is from, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Artist</code> | ||
| | | Artist(s) of current Music Video, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Studio</code> | ||
| | | Studio of current Music Video, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Writer</code> | ||
| | | Name of Writer of current playing Video, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Writer(separator)</code> | ||
| | | '''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> | | <code>VideoPlayer.Tagline</code> | ||
| | | Small Summary of current playing Video, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.PlotOutline</code> | ||
| | | Small Summary of current playing Video, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Plot</code> | ||
| | | Complete Text Summary of current playing Video, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.Top250</code> | ||
| Shows the | | Shows the IMDb top250 position of the current playing Video. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.LastPlayed</code> | ||
| | | Last play date of current playing Video, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.PlayCount</code> | ||
| | | Playcount of current playing Video, if it's in the database. (supports .offset() and .position()) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.HdrType</code> | ||
| Shows | | Shows the HDR type of the currently playing video (possible values: hdr10, dolbyvision and hlg) | ||
| | | v20 | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.VideoCodec</code> | ||
| Shows the | | Shows the video codec of the currently playing video (common values: see ListItem.VideoCodec) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.VideoResolution</code> | ||
| Shows the | | Shows the video resolution of the currently playing video (possible values: see ListItem.VideoResolution) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.VideoAspect</code> | ||
| Shows the | | Shows the aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.AudioCodec</code> | ||
| Shows | | Shows the audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.AudioChannels</code> | ||
| Shows the | | Shows the number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.AudioLanguage</code> | ||
| Shows the | | Shows the language of the audio of the currently playing video (possible values: see ListItem.AudioLanguage) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.SubtitlesLanguage</code> | ||
| Shows the | | Shows the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitlesLanguage) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.StereoscopicMode</code> | ||
| Shows | | Shows the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.EndTime</code> | ||
| | | End date of the currently playing programme (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.NextTitle</code> | ||
| | | Title of the programme that will be played next (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.NextGenre</code> | ||
| | | Genre of the programme that will be played next (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.NextGenre(separator)</code> | ||
| | | '''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> | | <code>VideoPlayer.NextPlotOutline</code> | ||
| | | Plot outline of the programme that will be played next (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.NextStartTime</code> | ||
| | | Start time of the programme that will be played next (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.NextEndTime</code> | ||
| | | End time of the programme that will be played next (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.NextDuration</code> | ||
| | | Duration of the programme that will be played next (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.ChannelName</code> | ||
| | | Name of the curently tuned channel (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.ChannelNumberLabel</code> | ||
| | | Channel and subchannel number of the tv channel that's currently playing (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.ChannelGroup</code> | ||
| | | Group of the curently tuned channel (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.ParentalRating</code> | ||
| | | Parental rating of the currently playing programme (PVR). | ||
| | | | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.DBID</code> | ||
| | | The database id of the currently playing video. (supports .offset() and .position()) | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.UniqueID()</code> | ||
| | | Returns the UniqueID of the currently playing video | ||
| | | v19 | ||
|- | |- | ||
| <code> | | <code>VideoPlayer.TvShowDBID</code> | ||
| | | Returns the tv show DBID of the currently playing episode | ||
| | | v19 | ||
|- | |} | ||
| <code> | |||
| | === 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> | | <code>Playlist.Position(media)</code> | ||
| | | Position of the current item in the current playlist. optional parameter media is either video or music. | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Playlist.Random</code> | ||
| | | Returns 'On' or 'Off' | ||
| | | | ||
|- | |- | ||
| <code> | | <code>Playlist.Repeat</code> | ||
| | | 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> | | <code>PVR.ActStreamAudioBitRate</code> | ||
| | | Audio bitrate of the stream | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamBer</code> | ||
| | | Bit error rate of the stream | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamClient</code> | ||
| | | Stream client name | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamDevice</code> | ||
| | | Stream device name | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamDolbyBitRate</code> | ||
| | | Dolby bitrate of the stream | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamEncryptionName</code> | ||
| | | Encryption used on the stream | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamMux</code> | ||
| | | '''Returns''' | ||
:The multiplex type of played channel if available. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamProgrSignal</code> | ||
| | | Signal quality of the programme | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamProgrSnr</code> | ||
| | | Signal to noise ratio of the programme | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamProviderName</code> | ||
| | | '''Returns''' | ||
:The provider name of the played channel if available. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamServiceName</code> | ||
| | | '''Returns''' | ||
:The service name of played channel if available. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamSignal</code> | ||
| | | Signal quality of the stream | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamSnr</code> | ||
| | | Signal to noise ratio of the stream | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamStatus</code> | ||
| | | Status of the stream | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamUnc</code> | ||
| | | UNC value of the stream | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ActStreamVideoBitRate</code> | ||
| | | Video bitrate of the stream | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendChannels</code> | ||
| | | Number of available channels the backend provides | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendDeletedRecordings</code> | ||
| | | '''Returns''' | ||
:The number of deleted recordings present on the backend. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendDiskSpace</code> | ||
| | | Available diskspace on the backend | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendDiskspace</code> | ||
| | | Free diskspace available for recordings on the backend | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendDiskSpaceProgr</code> | ||
| | | '''Returns''' | ||
:The available diskspace on the backend as percent value. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendHost</code> | ||
| | | Backend hostname | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendName</code> | ||
| | | Name of the backend being used | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendNumber</code> | ||
| | | Backend number | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendRecordings</code> | ||
| | | Number of recording available on the backend | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendTimers</code> | ||
| | | Number of timers set for the backend | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.BackendVersion</code> | ||
| | | version of the backend that's being used | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.ChannelNumberInput</code> | ||
| | | Label displaying the number the user entered on remote or keyboard | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.ClientCount</code> | ||
| | | 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> | | <code>PVR.EpgEventDuration[(format)]</code> | ||
| | | Returns the duration of the currently played title on TV. See ListItem.Duration for optinional formatting options | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.EpgEventElapsedTime[(format)]</code> | ||
| Returns the | | Returns the time position of the currently played title on TV. See ListItem.Duration for optinional formatting options | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.EpgEventFinishTime[(format)]</code> | ||
| | | 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> | | <code>PVR.EpgEventRemainingTime[(format)]</code> | ||
| | | Returns the remaining time for currently playing epg event. See ListItem.Duration for optinional formatting options | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.EpgEventSeekTime[(format)]</code> | ||
| | | Returns the seek time of the currently playing epg event. See ListItem.Duration for optinional formatting options | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.InstanceName</code> | ||
| | | '''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> | | <code>PVR.NextRecordingChannel</code> | ||
| | | Channel name of the next recording | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.NextRecordingDateTime</code> | ||
| | | Start date and time of the next recording | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.NextRecordingTitle</code> | ||
| | | Title of the next programme that will be recorded | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.NextTimer</code> | ||
| | | Next timer date | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.NowRecordingChannel</code> | ||
| | | Channel number that's being recorded | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.NowRecordingDateTime</code> | ||
| | | Start date and time of the current recording | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.NowRecordingTitle</code> | ||
| | | Title of the programme being recorded | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.RadioNextRecordingChannel</code> | ||
| | | Channel name of the next radio recording | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.RadioNextRecordingChannelIcon</code> | ||
| Returns the | | '''Returns''' | ||
:The icon of the next recording radio channel. | |||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.RadioNextRecordingDateTime</code> | ||
| | | Start date and time of the next radio recording | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.RadioNextRecordingTitle</code> | ||
| | | Title of the next radio programme that will be recorded | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.RadioNowRecordingChannel</code> | ||
| | | Channel name of the current radio recording | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.RadioNowRecordingChannelIcon</code> | ||
| | | Icon of the current recording radio channel | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.RadioNowRecordingDateTime</code> | ||
| | | Start date and time of the current radio recording | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.RadioNowRecordingTitle</code> | ||
| | | Title of the radio programme being recorded | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeShiftCur[(format)]</code> | ||
| | | Current position of the timeshift. See ListItem.Duration for optinional formatting options | ||
|- | |- | ||
| <code> | | <code>PVR.TimeShiftEnd[(format)]</code> | ||
| | | End position of the timeshift. See ListItem.Duration for optinional formatting options | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.TimeShiftOffset[(format)]</code> | ||
| Current | | Current offset of the timeshift. See ListItem.Duration for optinional formatting options | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.TimeShiftProgress</code> | ||
| | | Returns the position of currently timeshifted title on TV as interger | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressBufferEnd</code> | ||
| | | Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressBufferStart</code> | ||
| | | Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressDuration</code> | ||
| | | 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> | | <code>PVR.TimeshiftProgressDuration(format)</code> | ||
| | | Returns the duration of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss) | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressEndTime</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 | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressEndTime(format)</code> | ||
| | | Returns the end time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss) | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressEpgEnd</code> | ||
| | | Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressEpgStart</code> | ||
| | | Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressPlayPos</code> | ||
| | | Returns the percentage of the current play position within the PVR timeshift progress | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressStartTime</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 | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeshiftProgressStartTime(format)</code> | ||
| | | Returns the start time of the PVR timeshift progress in different formats, hours (hh), minutes (mm) or seconds (ss) | ||
| | | v18 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeShiftSeekbar</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) | ||
| | | v19 | ||
|- | |- | ||
| <code> | | <code>PVR.TimeShiftStart[(format)]</code> | ||
| | | Start position of the timeshift. See ListItem.Duration for optinional formatting options | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.TotalDiscSpace</code> | ||
| | | Total diskspace available for recordings | ||
| | | | ||
|- | |- | ||
| <code> | | <code>PVR.TVNextRecordingChannel</code> | ||
| | | Channel name of the next tv recording | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.TVNextRecordingChannelIcon</code> | ||
| | | Icon of the next recording tv channel | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.TVNextRecordingDateTime</code> | ||
| | | Start date and time of the next tv recording | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.TVNextRecordingTitle</code> | ||
| | | Title of the next tv programme that will be recorded | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.TVNowRecordingChannel</code> | ||
| | | Channel name of the current tv recording | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.TVNowRecordingChannelIcon</code> | ||
| | | Icon of the current recording TV channel | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.TVNowRecordingDateTime</code> | ||
| | | Start date and time of the current tv recording | ||
| | | v17 | ||
|- | |- | ||
| <code> | | <code>PVR.TVNowRecordingTitle</code> | ||
| | | Title of the tv programme being recorded | ||
| | | v17 | ||
|} | |} | ||
=== | === RDS === | ||
{| class="wikitable sortable" width="100%" | {| class="wikitable sortable" width="100%" | ||
! InfoLabels | ! InfoLabels | ||
| Line 3,042: | Line 3,700: | ||
! Version | ! Version | ||
|- | |- | ||
| <code> | | <code>RDS.Album</code> | ||
| | | The collection name to which this track belongs (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.Artist</code> | ||
| | | A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.AudioLanguage</code> | ||
| | | The from RDS reported audio language of channel | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.Band</code> | ||
| | | Band/orchestra/accompaniment/musician (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.ChannelCountry</code> | ||
| | | Country where the radio channel is sended | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.Comment</code> | ||
| | | Radio station comment string if available (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.Composer</code> | ||
| | | Name of the original composer/author (Only be available on RadiotextPlus) | ||
| | |||
|- | |||
| <code>RDS.Conductor</code> | |||
| The artist(s) who performed the work. In classical music this would bethe conductor (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.EmailHotline</code> | |||
| The email adress of the radio stations hotline (if available) (Only be available on RadiotextPlus) | |||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.EmailStudio</code> | ||
| | | The email adress of the radio stations studio (if available) (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.GetLine(number)</code> | ||
| | | Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.InfoCinema</code> | ||
| | | Information about movies in cinema (if available) (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.InfoCinemaSize</code> | ||
| | | Number of rows present in cinema information (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.InfoHoroscope</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) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.InfoHoroscopeSize</code> | ||
| | | Number of rows present in horoscope information (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.InfoLottery</code> | ||
| | | Raffle / lottery: "key word 99values" (if available) (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.InfoLotterySize</code> | ||
| | | Number of rows present in lottery information (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.InfoNews</code> | ||
| | | Message / headline (if available) (Only be available on RadiotextPlus) | ||
| | | | ||
|- | |- | ||
| <code> | | <code>RDS.InfoNewsLocal</code> | ||
| | | Local information news sended from radio channel (if available) (Only be available on RadiotextPlus) | ||
| | |||
|- | |||
| <code>RDS.InfoOther</code> | |||
| Other information, not especially specified: "key word 99info" (if available) (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.InfoOtherSize</code> | |||
| Number of rows present with other informations (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.InfoSport</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) | |||
| | |||
|- | |||
| <code>RDS.InfoSportSize</code> | |||
| Number of rows present in sport information (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.InfoStock</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) | |||
| | |||
|- | |||
| <code>RDS.InfoStockSize</code> | |||
| Number of rows present in stock information (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.InfoWeather</code> | |||
| Weather informations sended from radio channel (if available) (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.InfoWeatherSize</code> | |||
| Number of rows present in weather information (Only be available on RadiotextPlus) | |||
| | | | ||
|- | |- | ||
| <code>ListItem.Icon</code> | | <code>RDS.PhoneHotline</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. | | The telephone number of the radio station's hotline (Only be available on RadiotextPlus) | ||
| | |||
|- | |||
| <code>RDS.PhoneStudio</code> | |||
| The telephone number of the radio station's studio (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.ProgEditStaff</code> | |||
| Name of the editorial staff; e.g. name of editorial journalist (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.ProgHomepage</code> | |||
| Link to radio station homepage (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.ProgHost</code> | |||
| Name of the host of the radio show | |||
| | |||
|- | |||
| <code>RDS.ProgNext</code> | |||
| Next played program name (if available)@note becomes also be set from epg if from RDS not available | |||
| | |||
|- | |||
| <code>RDS.ProgNow</code> | |||
| Now played program name@note becomes also be set from epg if from RDS not available | |||
| | |||
|- | |||
| <code>RDS.ProgStation</code> | |||
| Name of the radio channel@note becomes also be set from epg if from RDS not available | |||
| | |||
|- | |||
| <code>RDS.ProgStyle</code> | |||
| Human readable string about radiostyle defined from RDS or RBDS | |||
| | |||
|- | |||
| <code>RDS.RadioStyle</code> | |||
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather" | |||
| | |||
|- | |||
| <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>RDS.Title</code> | |||
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus) | |||
| | |||
|- | |||
| <code>RDS.TrackNumber</code> | |||
| The track number of the item on the album on which it was originallyreleased. (Only be available on RadiotextPlus) | |||
| | |||
|} | |||
=== Skin === | |||
{| class="wikitable sortable" width="100%" | |||
! InfoLabels | |||
! style="80%" | Description | |||
! Version | |||
|- | |||
| <code>Skin.AspectRatio</code> | |||
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file. | |||
| | |||
|- | |||
| <code>Skin.CurrentColourTheme</code> | |||
| Returns the current selected colour theme of the skin. | |||
| | |||
|- | |||
| <code>Skin.CurrentTheme</code> | |||
| Returns the current selected skin theme. | |||
| | |||
|- | |||
| <code>Skin.Font</code> | |||
| 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>Skin.String(name)</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. | |||
| | |||
|- | |||
| <code>Skin.TimerElapsedSecs(timer)</code> | |||
| '''Returns''' | |||
:The elapsed time in seconds for the provided <code>timer</code>. | |||
'''Parameters''' | |||
:timer - the timer name | |||
| | |||
|} | |||
=== Slideshow === | |||
{| class="wikitable sortable" width="100%" | |||
! InfoLabels | |||
! style="80%" | Description | |||
! Version | |||
|- | |||
| <code>Slideshow.Altitude</code> | |||
| Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag. | |||
| | |||
|- | |||
| <code>Slideshow.Aperture</code> | |||
| Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D). | |||
| | |||
|- | |||
| <code>Slideshow.Author</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). | |||
| | |||
|- | |||
| <code>Slideshow.Byline</code> | |||
| Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50). | |||
| | |||
|- | |||
| <code>Slideshow.BylineTitle</code> | |||
| Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55). | |||
| | |||
|- | |||
| <code>Slideshow.CameraMake</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). | |||
| | |||
|- | |||
| <code>Slideshow.CameraModel</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). | |||
| | |||
|- | |||
| <code>Slideshow.Caption</code> | |||
| Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78). | |||
| | |||
|- | |||
| <code>Slideshow.Category</code> | |||
| Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F). | |||
| | |||
|- | |||
| <code>Slideshow.CCDWidth</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). | |||
| | |||
|- | |||
| <code>Slideshow.City</code> | |||
| Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A). | |||
| | |||
|- | |||
| <code>Slideshow.Colour</code> | |||
| Shows whether the current picture is "Colour" or "Black and White". | |||
| | |||
|- | |||
| <code>Slideshow.CopyrightNotice</code> | |||
| Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74). | |||
| | |||
|- | |||
| <code>Slideshow.Country</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). | |||
| | |||
|- | |||
| <code>Slideshow.CountryCode</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). | |||
| | |||
|- | |||
| <code>Slideshow.Credit</code> | |||
| Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E). | |||
| | |||
|- | |||
| <code>Slideshow.DigitalZoom</code> | |||
| Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404). | |||
| | |||
|- | |||
| <code>Slideshow.EXIFComment</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. | |||
| | |||
|- | |||
| <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. | |||
| | |||
|- | |||
| <code>Player.Icon</code> | |||
| Shows the thumbnail (if it exists) of the currently playing item. If no thumbnail image exists, it will show the icon. | |||
| v18 | |||
|- | |||
| <code>Player.StarRating</code> | |||
| Returns a value of 0 to 5 as a graphical display from images named rating0.png to rating5.png of the skin | |||
| | | | ||
|- | |- | ||
| <code> | | <code>Pvr.EPGEventIcon</code> | ||
| Returns the icon of the currently playing EPG programme (if available). | |||
| Returns the icon of the EPG programme (if available). | |||
| v18 | | v18 | ||
|- | |- | ||
| <code> | | <code>Pvr.NextRecordingChannelIcon</code> | ||
| | | Channel icon of the programme that will be recorded next. | ||
| | | | ||
|- | |- | ||
| Line 3,194: | Line 4,572: | ||
| Channel icon of the programme currently being recorded. | | Channel icon of the programme currently being recorded. | ||
| | | | ||
|- | |- | ||
| <code>Skin.String(name)</code> | | <code>Skin.String(name)</code> | ||
| Line 3,221: | 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) | ||
| | | | ||
|- | |- | ||
| Line 3,230: | 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
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
Parameters
Note |
v20 |
Addon.SettingStr(addon_id,setting_id)
|
Returns
Parameters
|
v20 |
Container
Note
If no id is specified it grabs the current container.
| InfoLabels | Description | Version |
|---|---|---|
Container(id).Column
|
Returns
|
|
Container(id).CurrentItem
|
Returns
|
|
Container(id).CurrentPage
|
Returns
|
|
Container(id).ListItem(offset).Property
|
Returns
Parameters
Note |
|
Container(id).ListItemAbsolute(x).[infolabel]
|
Returns
Parameters
Note |
|
Container(id).ListItemNoWrap(offset).Property
|
Returns
Parameters
Note |
|
Container(id).ListItemPosition(x).[infolabel]
|
Returns
Parameters
Note |
|
Container(id).NumAllItems
|
Returns
|
v18 |
Container(id).NumItems
|
Returns
|
|
Container(id).NumNonFolderItems
|
Returns
|
v18 |
Container(id).NumPages
|
Returns
|
|
Container(id).Position
|
Returns
|
|
Container(id).Row
|
Returns
|
|
Container(id).TotalUnWatched
|
Returns
|
v16 |
Container(id).TotalWatched
|
Returns
|
v16 |
Container.Art(type)
|
Returns
Parameters
Todo |
v16 |
Container.Content
|
Returns
|
v16 |
Container.FolderName
|
Returns
|
|
Container.FolderPath
|
Returns
|
|
Container.PluginCategory
|
Returns
|
v17 |
Container.PluginName
|
Returns
|
|
Container.Property(addoncategory)
|
Returns
|
|
Container.Property(reponame)
|
Returns
|
|
Container.ShowPlot
|
Returns
|
|
Container.ShowTitle
|
Returns
|
v17 |
Container.SortMethod
|
Returns
|
|
Container.SortOrder
|
Returns
|
v16 |
Container.Totaltime
|
Returns
|
|
Container.ViewCount
|
Returns
|
v17 |
Container.Viewmode
|
Returns
|
Control
| InfoLabels | Description | Version |
|---|---|---|
Control.GetLabel(id)[.index()]
|
Returns
Parameters
|
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
|
v18 |
Game.GameClient
|
Returns
|
v18 |
Game.Genres
|
Returns
|
v18 |
Game.Overview
|
Returns
|
v18 |
Game.Platform
|
Returns
|
v18 |
Game.Publisher
|
Returns
|
v18 |
Game.Title
|
Returns
|
v18 |
Game.Year
|
Returns
|
v18 |
Integer
| InfoLabels | Description | Version |
|---|---|---|
Integer.ValueOf(number)
|
Returns
Parameters
Note |
ListItem
| InfoLabels | Description | Version |
|---|---|---|
ListItem.AddonBroken
|
Deprecated! use ListItem.AddonLifecycleDesc instead. | |
ListItem.AddonCreator
|
Returns
|
|
ListItem.AddonDescription
|
Returns
|
|
ListItem.AddonDisclaimer
|
Returns
|
|
ListItem.AddonInstallDate
|
Returns
|
|
ListItem.AddonLastUpdated
|
Returns
|
|
ListItem.AddonLastUsed
|
Returns
|
|
ListItem.AddonLifecycleDesc
|
Returns
|
v19 |
ListItem.AddonLifecycleType
|
Returns
|
v19 |
ListItem.AddonName
|
Returns
|
|
ListItem.AddonNews
|
Returns
|
|
ListItem.AddonOrigin
|
Returns
|
|
ListItem.AddonSize
|
Returns
|
|
ListItem.AddonSummary
|
Returns
|
|
ListItem.AddonType
|
Returns
|
|
ListItem.AddonVersion
|
Returns
|
|
ListItem.Album
|
Returns
|
|
ListItem.AlbumArtist
|
Returns
|
|
ListItem.AlbumStatus
|
Returns
|
v19 |
ListItem.Appearances
|
Returns
|
v17 |
ListItem.Artist
|
Returns
|
|
ListItem.AudioChannels
|
Returns
|
|
ListItem.AudioCodec
|
Returns
|
*v22 |
ListItem.AudioLanguage
|
Returns
|
|
ListItem.BitRate
|
Returns
|
v19 |
ListItem.BPM
|
Returns
|
v19 |
ListItem.Cast
|
Returns
|
|
ListItem.Cast(separator)
|
Returns
|
v22 |
ListItem.CastAndRole
|
Returns
|
|
ListItem.CastAndRole(separator)
|
Returns
|
v22 |
ListItem.ChannelGroup
|
Returns
|
|
ListItem.ChannelLogo
|
Returns
|
v22 |
ListItem.ChannelName
|
Returns
|
|
ListItem.ChannelName
|
Returns
|
|
ListItem.ChannelNumber
|
Returns
|
|
ListItem.ChannelNumberLabel
|
Returns
|
|
ListItem.Comment
|
Returns
|
|
ListItem.ContributorAndRole
|
Returns
|
|
ListItem.Contributors
|
Returns
|
|
ListItem.Country
|
Returns
|
|
ListItem.CurrentItem
|
Returns
|
v19 |
ListItem.Date
|
Returns
|
|
ListItem.DateAdded
|
Returns
|
|
ListItem.DateTime
|
Returns
|
|
ListItem.DBID
|
Returns
|
|
ListItem.DBTYPE
|
Returns
Note |
|
ListItem.DecodedFileNameAndPath
|
Returns
|
|
ListItem.Developer
|
Returns
|
|
ListItem.Director
|
Returns
|
|
ListItem.Director(separator)
|
Returns
|
v22 |
ListItem.DiscNumber
|
Returns
|
|
ListItem.DiscTitle
|
Returns
|
v19 |
ListItem.Duration[(format)]
|
Returns
|
|
ListItem.EndDate
|
Returns
|
|
ListItem.EndTime
|
Returns
|
|
ListItem.EndTimeResume
|
Returns
|
|
ListItem.EpgEventTitle
|
Returns
|
|
ListItem.Episode
|
Returns
|
|
ListItem.EpisodeName
|
Returns
|
|
ListItem.EpisodePart
|
Returns
|
|
ListItem.ExpirationDate
|
Returns
|
|
ListItem.ExpirationTime
|
Returns
|
|
ListItem.FileExtension
|
Returns
|
|
ListItem.FileName
|
Returns
|
|
ListItem.FileNameAndPath
|
Returns
|
|
ListItem.FileNameNoExtension
|
Returns
|
v19 |
ListItem.FolderName
|
Returns
|
|
ListItem.FolderPath
|
Returns
|
|
ListItem.GameClient
|
Returns
|
|
ListItem.Genre
|
Returns
|
|
ListItem.Genre(separator)
|
Returns
|
v22 |
ListItem.Genres
|
Returns
|
|
ListItem.HdrDetail
|
Returns
|
|
ListItem.HdrType
|
Returns
|
v20 |
ListItem.IMDBNumber
|
Returns
|
|
ListItem.Label
|
Returns
|
|
ListItem.Label2
|
Returns
|
|
ListItem.LastPlayed
|
Returns
|
|
ListItem.MediaProviders
|
Returns
|
|
ListItem.Mood
|
Returns
|
|
ListItem.Mpaa
|
Returns
|
|
ListItem.MusicChannels
|
Returns
|
v19 |
ListItem.NextDuration
|
Returns
|
v18 |
ListItem.NextEndDate
|
Returns
|
|
ListItem.NextEndTime
|
Returns
|
|
ListItem.NextGenre
|
Returns
|
|
ListItem.NextGenre(separator)
|
Returns
|
v22 |
ListItem.NextPlot
|
Returns
|
|
ListItem.NextPlotOutline
|
Returns
|
|
ListItem.NextStartDate
|
Returns
|
|
ListItem.NextStartTime
|
Returns
|
|
ListItem.NextTitle
|
Returns
|
|
ListItem.OriginalDate
|
Returns
|
v19 |
ListItem.OriginalTitle
|
Returns
|
|
ListItem.Overview
|
Returns
|
|
ListItem.ParentalRating
|
Returns
|
|
ListItem.ParentalRatingCode
|
Returns
|
v22 |
ListItem.ParentalRatingIcon
|
Returns
|
v22 |
ListItem.ParentalRatingSource
|
Returns
|
v22 |
ListItem.Path
|
Returns
|
|
ListItem.PercentPlayed
|
Returns
|
|
ListItem.PictureAperture
|
Returns
|
|
ListItem.PictureAuthor
|
Returns
|
|
ListItem.PictureByline
|
Returns
|
|
ListItem.PictureBylineTitle
|
Returns
|
|
ListItem.PictureCamMake
|
Returns
|
|
ListItem.PictureCamModel
|
Returns
|
|
ListItem.PictureCaption
|
Returns
|
|
ListItem.PictureCategory
|
Returns
|
|
ListItem.PictureCCDWidth
|
Returns
|
|
ListItem.PictureCity
|
Returns
|
|
ListItem.PictureColour
|
Returns
|
|
ListItem.PictureComment
|
Returns
|
|
ListItem.PictureCopyrightNotice
|
Returns
|
|
ListItem.PictureCountry
|
Returns
|
|
ListItem.PictureCountryCode
|
Returns
|
|
ListItem.PictureCredit
|
Returns
|
|
ListItem.PictureDate
|
Returns
|
|
ListItem.PictureDatetime
|
Returns
|
|
ListItem.PictureDesc
|
Returns
|
|
ListItem.PictureDigitalZoom
|
Returns
|
|
ListItem.PictureExpMode
|
Returns
|
|
ListItem.PictureExposure
|
Returns
|
|
ListItem.PictureExposureBias
|
Returns
|
|
ListItem.PictureExpTime
|
Returns
|
|
ListItem.PictureFlashUsed
|
Returns
|
|
ListItem.PictureFocalLen
|
Returns
|
|
ListItem.PictureFocusDist
|
Returns
|
|
ListItem.PictureGPSAlt
|
Returns
|
|
ListItem.PictureGPSLat
|
Returns
|
|
ListItem.PictureGPSLon
|
Returns
|
|
ListItem.PictureHeadline
|
Returns
|
|
ListItem.PictureImageType
|
Returns
|
|
ListItem.PictureIPTCDate
|
Returns
|
|
ListItem.PictureIPTCTime
|
Returns
|
|
ListItem.PictureISO
|
Returns
|
|
ListItem.PictureKeywords
|
Returns
|
|
ListItem.PictureLightSource
|
Returns
|
|
ListItem.PictureLongDate
|
Returns
|
|
ListItem.PictureLongDatetime
|
Returns
|
|
ListItem.PictureMeteringMode
|
Returns
|
|
ListItem.PictureObjectName
|
Returns
|
|
ListItem.PictureOrientation
|
Returns
|
|
ListItem.PicturePath
|
Returns
|
|
ListItem.PictureProcess
|
Returns
|
|
ListItem.PictureReferenceService
|
Returns
|
|
ListItem.PictureResolution
|
Returns
|
|
ListItem.PictureSource
|
Returns
|
|
ListItem.PictureSpecialInstructions
|
Returns
|
|
ListItem.PictureState
|
Returns
|
|
ListItem.PictureSublocation
|
Returns
|
|
ListItem.PictureSupplementalCategories
|
Returns
|
|
ListItem.PictureTransmissionReference
|
Returns
|
|
ListItem.PictureUrgency
|
Returns
|
|
ListItem.PictureWhiteBalance
|
Returns
|
|
ListItem.Platform
|
Returns
|
|
ListItem.PlayCount
|
Returns
|
|
ListItem.Plot
|
Returns
|
|
ListItem.PlotOutline
|
Returns
|
|
ListItem.Premiered
|
Returns
|
|
ListItem.PrivacyPolicy
|
Returns
|
v17 |
ListItem.ProgramCount
|
Returns
|
|
ListItem.Progress
|
Returns
|
|
ListItem.Property(Addon.Changelog)
|
Returns
|
|
ListItem.Property(Addon.ID)
|
Returns
|
|
ListItem.Property(Addon.Path)
|
Returns
|
|
ListItem.Property(Addon.Status)
|
Returns
|
|
ListItem.Property(Album_Description)
|
Returns
|
|
ListItem.Property(Album_Duration)
|
Returns
|
v19 |
ListItem.Property(Album_Label)
|
Returns
|
|
ListItem.Property(Album_Mood)
|
Returns
|
|
ListItem.Property(Album_Rating)
|
Returns
|
|
ListItem.Property(Album_Style)
|
Returns
|
|
ListItem.Property(Album_Theme)
|
Returns
|
|
ListItem.Property(Album_Type)
|
Returns
|
|
ListItem.Property(Album_UserRating)
|
Returns
|
|
ListItem.Property(Artist_Born)
|
Returns
|
|
ListItem.Property(Artist_Description)
|
Returns
|
|
ListItem.Property(Artist_Died)
|
Returns
|
|
ListItem.Property(Artist_Disambiguation)
|
Returns
|
v18 |
ListItem.Property(Artist_Disbanded)
|
Returns
|
|
ListItem.Property(Artist_Formed)
|
Returns
|
|
ListItem.Property(Artist_Gender)
|
Returns
|
v18 |
ListItem.Property(Artist_Genre)
|
Returns
|
|
ListItem.Property(Artist_Instrument)
|
Returns
|
|
ListItem.Property(Artist_Mood)
|
Returns
|
|
ListItem.Property(Artist_Sortname)
|
Returns
|
v18 |
ListItem.Property(Artist_Style)
|
Returns
|
|
ListItem.Property(Artist_Type)
|
Returns
|
v18 |
ListItem.Property(Artist_YearsActive)
|
Returns
|
|
ListItem.Property(AudioChannels.[n])
|
Returns
|
|
ListItem.Property(AudioCodec.[n])
|
Returns
|
|
ListItem.Property(AudioLanguage.[n])
|
Returns
|
|
ListItem.Property(game.stretchmode)
|
Returns
|
v18 |
ListItem.Property(game.videofilter)
|
Returns
|
v18 |
ListItem.Property(game.videorotation)
|
Returns
|
v18 |
ListItem.Property(NumEpisodes)
|
Returns
|
|
ListItem.Property(Role.Arranger)
|
Returns
|
|
ListItem.Property(Role.Composer)
|
Returns
|
|
ListItem.Property(Role.Conductor)
|
Returns
|
|
ListItem.Property(Role.DJMixer)
|
Returns
|
|
ListItem.Property(Role.Engineer)
|
Returns
|
|
ListItem.Property(Role.Lyricist)
|
Returns
|
|
ListItem.Property(Role.Mixer)
|
Returns
|
|
ListItem.Property(Role.Orchestra)
|
Returns
|
|
ListItem.Property(Role.Producer)
|
Returns
|
|
ListItem.Property(Role.Remixer)
|
Returns
|
|
ListItem.Property(Stream.Bitrate)
|
Returns
|
v22 |
ListItem.Property(Stream.Channels)
|
Returns
|
v22 |
ListItem.Property(Stream.Codec)
|
Returns
|
v22 |
ListItem.Property(Stream.CodecDesc)
|
Returns
|
v22 |
ListItem.Property(Stream.Description)
|
Returns
|
v22 |
ListItem.Property(Stream.FPS)
|
Returns
|
v22 |
ListItem.Property(Stream.HDRType)
|
Returns
|
v22 |
ListItem.Property(Stream.Language)
|
Returns
|
v22 |
ListItem.Property(Stream.Resolution)
|
Returns
|
v22 |
ListItem.Property(Stream.StereoMode)
|
Returns
|
v22 |
ListItem.Property(SubtitleLanguage.[n])
|
Returns
|
|
ListItem.Property(TotalEpisodes)
|
Returns
|
|
ListItem.Property(TotalSeasons)
|
Returns
|
|
ListItem.Property(UnWatchedEpisodes)
|
Returns
|
|
ListItem.Property(WatchedEpisodes)
|
Returns
|
|
ListItem.Publisher
|
Returns
|
|
ListItem.PVRClientName
|
Returns
|
v22 |
ListItem.PVRGroupOrigin
|
Returns
|
|
ListItem.PVRInstanceName
|
Returns
|
v22 |
ListItem.Rating[(name)]
|
Returns
|
|
ListItem.RatingAndVotes[(name)]
|
Returns
|
|
ListItem.ReleaseDate
|
Returns
|
v19 |
ListItem.SampleRate
|
Returns
|
v19 |
ListItem.Season
|
Returns
|
|
ListItem.Set
|
Returns
|
|
ListItem.SetId
|
Returns
|
|
ListItem.Size
|
Returns
|
|
ListItem.SongVideoURL
|
Returns
|
|
ListItem.SortLetter
|
Returns
|
|
ListItem.StartDate
|
Returns
|
|
ListItem.StartDate
|
Returns
|
|
ListItem.StartTime
|
Returns
|
|
ListItem.StartTime
|
Returns
|
|
ListItem.Status
|
Returns
|
|
ListItem.StereoscopicMode
|
Returns
|
|
ListItem.Studio
|
Returns
|
|
ListItem.SubtitleLanguage
|
Returns
|
|
ListItem.Tag
|
Returns
|
|
ListItem.Tagline
|
Returns
|
|
ListItem.TimerType
|
Returns
|
|
ListItem.Title
|
Returns
|
|
ListItem.TitleExtraInfo
|
Returns
|
|
ListItem.Top250
|
Returns
|
|
ListItem.TotalDiscs
|
Returns
|
v19 |
ListItem.TrackNumber
|
Returns
|
|
ListItem.Trailer
|
Returns
|
|
ListItem.TVShowDBID
|
Returns
|
v19 |
ListItem.TVShowTitle
|
Returns
|
|
ListItem.UniqueID()
|
Returns
|
v19 |
ListItem.UserRating
|
Returns
|
|
ListItem.VideoAspect
|
Returns
|
*v20 |
ListItem.VideoCodec
|
Returns
|
|
ListItem.VideoHeight
|
Returns
|
|
ListItem.VideoResolution
|
Returns
Note |
*v18 |
ListItem.VideoVersionName
|
Returns
|
v21 |
ListItem.VideoWidth
|
Returns
|
|
ListItem.Votes[(name)]
|
Returns
|
|
ListItem.Writer
|
Returns
|
|
ListItem.Writer(separator)
|
Returns
|
v22 |
ListItem.Year
|
Returns
|
MusicPartyMode
| InfoLabels | Description | Version |
|---|---|---|
MusicPartyMode.MatchingSongs
|
Returns
|
|
MusicPartyMode.MatchingSongsLeft
|
Returns
|
|
MusicPartyMode.MatchingSongsPicked
|
Returns
|
|
MusicPartyMode.RandomSongsPicked
|
Returns
|
|
MusicPartyMode.RelaxedSongsPicked
|
Returns
|
|
MusicPartyMode.SongsPlayed
|
Returns
|
Network
| InfoLabels | Description | Version |
|---|---|---|
Network.DHCPAddress
|
Returns
|
|
Network.DNS1Address
|
Returns
|
|
Network.DNS2Address
|
Returns
|
|
Network.GatewayAddress
|
Returns
|
|
Network.IPAddress
|
Returns
|
|
Network.LinkState
|
Returns
|
|
Network.MacAddress
|
Returns
|
|
Network.SubnetMask
|
Returns
|
Player
| InfoLabels | Description | Version |
|---|---|---|
Player.AudioDelay
|
Returns
|
|
Player.Bookmarks
|
Returns
|
|
Player.CacheLevel
|
Returns
|
|
Player.ChapterName
|
Returns
|
|
Player.Cuts
|
Returns
|
|
Player.Editlist
|
Returns
Note |
|
Player.offset(number).Filename
|
Returns
|
|
Player.offset(number).FilenameAndPath
|
Returns
|
|
Player.offset(number).Folderpath
|
Returns
|
|
Player.offset(number).Title
|
Returns
|
|
Player.position(number).Filename
|
Returns
|
|
Player.position(number).FilenameAndPath
|
Returns
|
|
Player.position(number).Folderpath
|
Returns
|
|
Player.position(number).Title
|
Returns
|
|
Player.SceneMarkers
|
Returns
|
|
Player.SeekNumeric([format])
|
Returns
Parameters
|
|
Player.SubtitleDelay
|
Returns
|
|
Player.TimeSpeed
|
Returns
|
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
|
|
MusicPlayer.LastPlayed
|
Returns
|
|
MusicPlayer.MediaProviders
|
Returns
|
|
MusicPlayer.offset(number).Album
|
Returns
Parameters
|
|
MusicPlayer.offset(number).Artist
|
Returns
Parameters
|
|
MusicPlayer.offset(number).Comment
|
Returns
Parameters
|
|
MusicPlayer.offset(number).DiscNumber
|
Returns
Parameters
|
|
MusicPlayer.offset(number).Duration
|
Returns
Parameters
|
|
MusicPlayer.offset(number).Genre
|
Returns
Parameters
|
|
MusicPlayer.offset(number).Rating
|
Returns
Parameters
|
|
MusicPlayer.offset(number).Title
|
Returns
Parameters
|
|
MusicPlayer.offset(number).TrackNumber
|
Returns
Parameters
|
|
MusicPlayer.offset(number).Year
|
Returns
Parameters
|
|
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
|
|
MusicPlayer.Position(number).Album
|
Returns
Parameters
|
|
MusicPlayer.Position(number).Artist
|
Returns
Parameters
|
|
MusicPlayer.Position(number).Comment
|
Returns
Parameters
|
|
MusicPlayer.Position(number).DiscNumber
|
Returns
Parameters
|
|
MusicPlayer.Position(number).Duration
|
Returns
Parameters
|
|
MusicPlayer.Position(number).Genre
|
Returns
Parameters
|
|
MusicPlayer.Position(number).Rating
|
Returns
Parameters
|
|
MusicPlayer.Position(number).Title
|
Returns
Parameters
|
|
MusicPlayer.Position(number).TrackNumber
|
Returns
Parameters
|
|
MusicPlayer.Position(number).Year
|
Returns
Parameters
|
|
MusicPlayer.RatingAndVotes
|
Returns
|
|
MusicPlayer.Station
|
Returns
|
|
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
|
v22 |
MusicPlayer.Lyrics
|
Lyrics of current song stored in ID tag info | |
MusicPlayer.Votes
|
Returns
|
|
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
|
|
RetroPlayer.DiscLabel
|
Returns
|
|
RetroPlayer.GameClient
|
Returns
|
|
RetroPlayer.GameClientName
|
Returns
|
|
RetroPlayer.GameClientPlatforms
|
Returns
|
|
RetroPlayer.Genres
|
Returns
|
|
RetroPlayer.Overview
|
Returns
|
|
RetroPlayer.Platform
|
Returns
|
|
RetroPlayer.Publisher
|
Returns
|
|
RetroPlayer.StretchMode
|
Returns
|
|
RetroPlayer.Title
|
Returns
|
|
RetroPlayer.VideoFilter
|
Returns
|
|
RetroPlayer.VideoRotation
|
Returns
|
Video player
| InfoLabels | Description | Version |
|---|---|---|
VideoPlayer.Art(type)
|
Returns
Parameters
|
|
VideoPlayer.AudioLanguageEx
|
Returns
|
|
VideoPlayer.AudioName
|
Returns
|
|
VideoPlayer.AudioStreamCount
|
Returns the number of audio streams of the currently playing video | v21 |
VideoPlayer.EpisodePart
|
Returns
|
|
VideoPlayer.HdrDetail
|
Returns
|
|
VideoPlayer.MediaProviders
|
Returns
|
|
VideoPlayer.offset(number).Album
|
Returns
|
|
VideoPlayer.offset(number).Art(type)
|
Returns
Parameters
|
|
VideoPlayer.offset(number).Artist
|
Returns
|
|
VideoPlayer.offset(number).Country
|
Returns
|
|
VideoPlayer.offset(number).Cover
|
Returns
|
|
VideoPlayer.offset(number).DBID
|
Returns
|
|
VideoPlayer.offset(number).Director
|
Returns
|
|
VideoPlayer.offset(number).Episode
|
Returns
|
|
VideoPlayer.offset(number).Genre
|
Returns
|
|
VideoPlayer.offset(number).IMDBNumber
|
Returns
|
|
VideoPlayer.offset(number).LastPlayed
|
Returns
|
|
VideoPlayer.offset(number).mpaa
|
Returns
|
|
VideoPlayer.offset(number).OriginalTitle
|
Returns
|
|
VideoPlayer.offset(number).PlayCount
|
Returns
|
|
VideoPlayer.offset(number).Plot
|
Returns
|
|
VideoPlayer.offset(number).PlotOutline
|
Returns
|
|
VideoPlayer.offset(number).Premiered
|
Returns
|
|
VideoPlayer.offset(number).Rating
|
Returns
|
|
VideoPlayer.offset(number).RatingAndVotes
|
Returns
|
|
VideoPlayer.offset(number).Season
|
Returns
|
|
VideoPlayer.offset(number).Studio
|
Returns
|
|
VideoPlayer.offset(number).Tagline
|
Returns
|
|
VideoPlayer.offset(number).Title
|
Returns
Note |
|
VideoPlayer.offset(number).Top250
|
Returns
|
|
VideoPlayer.offset(number).Trailer
|
Returns
|
|
VideoPlayer.offset(number).TVShowTitle
|
Returns
|
|
VideoPlayer.offset(number).UserRating
|
Returns
|
|
VideoPlayer.offset(number).Votes
|
Returns
|
|
VideoPlayer.offset(number).Writer
|
Returns
|
|
VideoPlayer.offset(number).Year
|
Returns
|
|
VideoPlayer.position(number).Album
|
Returns
|
|
VideoPlayer.position(number).Art(type)
|
Returns
Parameters
|
|
VideoPlayer.position(number).Artist
|
Returns
|
|
VideoPlayer.position(number).Country
|
Returns
|
|
VideoPlayer.position(number).Cover
|
Returns
|
|
VideoPlayer.position(number).DBID
|
Returns
|
|
VideoPlayer.position(number).Director
|
Returns
|
|
VideoPlayer.position(number).Episode
|
Returns
|
|
VideoPlayer.position(number).Genre
|
Returns
|
|
VideoPlayer.position(number).IMDBNumber
|
Returns
|
|
VideoPlayer.position(number).LastPlayed
|
Returns
|
|
VideoPlayer.position(number).mpaa
|
Returns
|
|
VideoPlayer.position(number).OriginalTitle
|
Returns
|
|
VideoPlayer.position(number).PlayCount
|
Returns
|
|
VideoPlayer.position(number).Plot
|
Returns
|
|
VideoPlayer.position(number).PlotOutline
|
Returns
|
|
VideoPlayer.position(number).Premiered
|
Returns
|
|
VideoPlayer.position(number).Rating
|
Returns
|
|
VideoPlayer.position(number).RatingAndVotes
|
Returns
|
|
VideoPlayer.position(number).Season
|
Returns
|
|
VideoPlayer.position(number).Studio
|
Returns
|
|
VideoPlayer.position(number).Tagline
|
Returns
|
|
VideoPlayer.position(number).Title
|
Returns
Note |
|
VideoPlayer.position(number).Top250
|
Returns
|
|
VideoPlayer.position(number).Trailer
|
Returns
|
|
VideoPlayer.position(number).TVShowTitle
|
Returns
|
|
VideoPlayer.position(number).UserRating
|
Returns
|
|
VideoPlayer.position(number).Votes
|
Returns
|
|
VideoPlayer.position(number).Writer
|
Returns
|
|
VideoPlayer.position(number).Year
|
Returns
|
|
VideoPlayer.StartTime
|
Returns
|
|
VideoPlayer.SubtitleCodec
|
Returns
Note |
|
VideoPlayer.SubtitleLanguageEx
|
Returns
|
|
VideoPlayer.SubtitleName
|
Returns
|
|
VideoPlayer.TitleExtraInfo
|
Returns
|
|
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
|
v22 |
VideoPlayer.Director
|
Director of current movie, if it's in the database. (supports .offset() and .position()) | |
VideoPlayer.Director(separator)
|
Returns
|
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
|
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
|
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
|
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
|
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
|
|
PVR.ActStreamProgrSignal
|
Signal quality of the programme | |
PVR.ActStreamProgrSnr
|
Signal to noise ratio of the programme | |
PVR.ActStreamProviderName
|
Returns
|
|
PVR.ActStreamServiceName
|
Returns
|
|
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
|
|
PVR.BackendDiskSpace
|
Available diskspace on the backend | |
PVR.BackendDiskspace
|
Free diskspace available for recordings on the backend | |
PVR.BackendDiskSpaceProgr
|
Returns
|
|
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
|
|
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
|
|
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
|
|
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
See also
|
|
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
Parameters
|
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
|
|
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
Note |
|
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
Parameters
|
|
System.Memory(format)
|
Available formats: used, used.percent, free, free.percent, total | |
System.OSVersionInfo
|
System name + kernel version | |
System.PrivacyPolicy
|
Returns
|
|
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
|
|
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.LastUpdated
|
Returns
|
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
|
|
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 |
|---|