Official Kodi Wiki - User contributions [en]

Google Summer of Code/2021

2021-06-01T05:54:00Z

Tadly: /* Other ideas */

{{GSOC_nav}}
{{mininav| [[Google Summer of Code]] }}
[[File:GSOC_2016_logo.png|left|150px]]Welcome to the Kodi [http://summerofcode.withgoogle.com Google Summer of Code] ideas page. We are pleased to announce that we have been accepted as an official GSoC mentor organization this year.



We encourage interested students of all ethnicities and genders to review some of the ideas on this page, and then feel free to provide input on any ideas you may have in the '''[https://forum.kodi.tv/forumdisplay.php?fid=315 Kodi GSoC 2021 forum]''' and chat about any project you’d love to cover. To propose a project, see '''[[#Students project proposal ideas]]'''.

From the 29th March to the 13th of April, any interested students may apply at the [https://summerofcode.withgoogle.com/ GSoC home page] to work with Kodi. After that, Google will notify applicants whether we get to work with each other according to the [https://developers.google.com/open-source/gsoc/timeline GSoC schedule].

== About Us ==
As there may be many students who have landed here as a result of GSoC, but are unfamiliar with the project, here are a few resources that may help explain what we are about.

:Kodi (formerly known as XBMC) is an award-winning free and open source (GPL) software media player and entertainment hub for digital media, designed around the 10-foot interface (living room) environment. Created in 2003 by a group of like minded programmers, Kodi is a non-profit project run and developed by volunteers located around the world. More than 500 software developers have contributed to Kodi, and 100-plus translators have worked to expand its reach, making it available in more than 60 languages. For more information, see the page '''[[Kodi]]'''.

<br />
To get an idea of what Kodi is truly capable of, it really must be seen. Check out a few other user-created videos:<br />
[http://www.youtube.com/watch?v=NcogPuSo-DU Kodi with the default Confluence skin]<br />
[http://www.youtube.com/watch?v=4asUCtE0ONU Kodi with Aeon Nox skin]<br />
[http://www.youtube.com/watch?v=4NR57ELY28s Kodi on Raspberry Pi]<br />
[http://www.youtube.com/watch?v=e_0PB5hfz_k Kodi's new PVR functionality]<br />
<br />

Kodi is written primarily in c++ and runs on a variety of platforms including Android, iOS, Linux, OS X, and Windows. It has been ported to work on several low-power platforms including the Raspberry Pi and Android.

Kodi was a mentoring organization in 2008, 2012, 2013, 2015, 2017, 2018, 2019 and 2020 and had team members involved in GSoC for other projects during 2011.

If Kodi is selected as a mentoring organization for 2021, students will need to review the Overview of a good project proposal, follow the outline for proposals when applying, and review the list of project ideas detailed below. Students are welcome to propose ideas outside the list and are encouraged to be as creative as they like.

=== Mentors ===
All mentors and backup mentors are extremely experienced in the Kodi codebase and will thus be able to assist students in getting to know the codebase and in quickly identifying projects that are both achievable for someone unfamiliar with the internal workings of Kodi and desirable to the wider Kodi community.

==Prerequisites==
Some coding skills, basic familiarity with Git, solid understanding and interest in programming. Ability to quickly understand existing code is beneficial.

== Project Proposals ==
=== Overview ===
Qualifications for a good Summer of Code proposal:
* Discrete, well-defined, modular
* Comprised of a series of measurable sub-goals
* Based on open specs that are available free of charge
* Based on complete specs
An example of a good proposal is the implementation of a new feature or function that is not yet available in Kodi.

An example of a less desirable proposal is one that's not as measurable, such as refactoring an existing API. Bad proposals tend to be ones that would require touching a lot of core code.

To re-iterate:
* Localized/isolated code projects = ''good''
* Global code refactoring = ''bad''
* A project should have a set of subgoals, so even if the end goal turns out to be too big some of the parts will be of benefit.
* Not too big! This is an important problem when choosing a project, while it is fun to think about solving a grand project its not always realistic. It's better to finish a smaller project than to start a grand one.

{{Warning |1='''GSoC 2021 is different from the years before. All projects should have a workload of ~175 hours (previously: 350 hours). Project applications that do not fit this scope will be rejected.'''|title= }}

=== Where to submit proposals ===
In addition to submitting to the [https://g.go/gsoc Google Summer of Code] website, you are highly encouraged to submit your idea/proposal to the [https://forum.kodi.tv/forumdisplay.php?fid=315 Kodi forum] for discussion. Any proposal not submitted to the forum for discussion will likely not be considered.

=== Outline for proposals ===
{{divbox|blue||
PROJECT TITLE GOES HERE

* '''Name:'''
* '''forum/e-mail:'''
* '''Summary:''' A somewhat small but explanatory walk through of the project. It should not be overly detailed just enough to understand the problem trying to be fixed and how this project opt to solve it.
* '''How will I achieve this:''' Explain how the project will be done, what technologies are needed and how to implement them.
* '''What will the project focus on:''' Explain what the project will focus on, what is the important parts of the project.
* '''Benefits:''' Who will benefit and why from this project. Think about what a user or developer may need or do to benefit from it. Why does it benefit many users.
* '''Goals:''' What is the goal of the project, a project may not always solve the problem entirely as it may take to much time. Think hard about what can be accomplished during a summer with your skill and deduct that quite a bit. If the project can't be done after this perhaps its better to opt for a smaller one or one with subgoals.
* '''What does it touch in Kodi:''' Think about what parts of the code this may touch, Kodi is a big application and a lot of the code is spread out and very complex. If a project touches to much it may be impossible to complete.
* '''Requirements:''' What is needed to complete the project, what code language knowledge what hardware etc.
* '''Possible mentors:''' Place to add possible mentors (Team-Kodi will add this).
}}

== Team-Kodi proposal ideas up for discussion ==

=== Explore building binary addons in rust ===
'''Description:''' While Kodi has python addons, it can also handle binary addons. But these need to be build one by one for each platform and also might fail on errors. Rust might help with both of those problems and more. The idea is to use the api we have but via rust ffi and see where that leads us.

'''Expected outcome:''' Documentation and templates on how to use rust with kodi. In the best case also one or two example addons.

'''Skills preferred:''' C++, Rust, C

'''Possible mentors:''' spiff, Razze

'''Difficulty:''' Hard

'''Type:''' Binary addon development

=== Finish the new web interface ===
'''Description:''' Kodi has a in development webinterface by the name of elm-chorus (https://github.com/xbmc/elm-chorus) which is written in Elm and is still missing some features of Chorus2 (the old interface). So the idea would be to bring it up to speed and do some additional styling and packaging work.

'''Expected outcome:''' Finished shipable version of the webinterface

'''Skills preferred:''' HTML, CSS, Elm

'''Possible mentors:''' Razze

'''Difficulty:''' Medium

'''Type:''' Webinterface development



===Achievements in RetroPlayer===

'''Description''': Retroarch has developed support for achievements in certain select libretro cores. This project would consist of porting whatever work might be portable and otherwise integrating the existing libretro achievement system into Kodi's RetroPlayer implemented using Kodi's UI system. Could be tackled a few different ways, including simply linking the user to the retroachievements.org or creating a full achievement database in Kodi.

'''Expected Outcome''': Users should be able to see their achievements in Kodi. Player manager and Player profile support may be in development concurrently, so thought should be given to those systems.

'''Skills preferred''': C++, python, possibly php

'''Possible mentor''': gusandrianos, NikosSiak

'''Difficulty''': medium

'''Type''': Fun/Peripheral

'''Notes''': Garbear has broken down the Retroplayer project into manageable pieces including input, core, game add-ons, peripheral add-ons, netplay, a game library implementation, and shaders to do things like emulate a CRT monitor. This is one example, but many pieces are currently being worked on or are near completion, and many more could use help from a student familiar with the area. Visit the retroplayer section of the Kodi forum to see all the major projects still to do.

===Add-ons===
====Automatic add-on checker for binary add-ons====
'''Description:''' Kodis add-on checker checks each Kodi add-on PR on GitHub for certain problems, which ultimately makes reviewing Python add-ons easier for the team. But the other type of add-ons, binary add-ons is not being checked so far, which makes reviews and coding guidelines hard to handle. Thus it would be nice to also check those add-ons, either via the current checker written in Python or a new binary add-on specific checker. Goals would include checking the addon.xml, the C++ code and a check for potentially malicious code.

'''Expected outcome:''' Being able to run the checker against all binary repo PRs on GitHub.

'''Skills preferred:''' Python, C++

'''Possible mentors:''' Razze

'''Difficulty:''' Hard

'''Type:''' Low-hanging fruit

===Using fuzz testing to fuzz test Kodi===
'''Description:''' Adding fuzz testing to Kodi would be very valuable to find problems in the current code base. Especially security problems. First step would be choosing a framework either American fuzzy lop, libFuzzer or other similar projects. After we decided on that it would be time to start to fuzz different methods that are widely used in Kodi and try to expose flaws in those. If this leads to success, it should be documented and made repeatable.

'''Expected outcome:''' Being able to easily add more fuzz tests and having the process to do this documented.

'''Skills preferred:''' C++, CMake

'''Possible mentors:''' Razze

'''Difficulty:''' Medium

'''Type:''' Risky/Exploratory



===Other ideas===
These ideas still need expanding and/or assigned a potential mentor. If one of these ideas interests you, feel free to ask for more info in the GSoC 2020 forum area. We may be able to assign a mentor if enough interest is shown
*Improvements to Retroplayer (retro gaming integrated in Kodi core)
*Visual Studio Code addon to validate/syntax highlight Kodi Addons

*High quality scalers for OpenGL(GLSL). Scale Y and UV plane separately (possible mentors: velocity)


*Implementing a performance critical element of kodi in rust
*Add multiroom audio support where each kodi instance can act as client or server. Maybe snapcast could be used somehow.

=== More ===
We feel it is important to note that, while we are interested in a focus on the listed ideas, we would like to stress passion, expertise, and creativity above all else. If you would like to do something completely different, definitely send in that proposal. The ideas listed above are, as always, merely suggestions. We will be interested in any idea, so long as you can communicate your interest, your background, and your solution the problem.

== Students project proposal ideas ==

Submit your own proposals on the '''[https://forum.kodi.tv/forumdisplay.php?fid=315 Kodi GSoC forum]'''. They can be as big or as small as you feel you can comfortably accomplish between '''June 7''' and '''August 23'''. In the end, it's better to have a smaller, completed project, rather than a larger, incomplete project.

To submit a proposal idea:
# Copy the text from '''[[#Outline for proposals]]'''.
# Create a new forum post '''[https://forum.kodi.tv/forumdisplay.php?fid=315 HERE]''' and paste the text.
# Fill out everything using your specific proposal.

[[Category:Google Summer of Code]]

Add-on rules

2019-10-22T07:20:35Z

Tadly: Adds reference to python 2/3 compatibility

{{mininav|[[Development]]|[[Add-on development]]}}

=== Repository Submission Guidelines - Please Read Before Submitting Your Addon ===

Inclusion in the Kodi.org repository is at the sole discretion of Team Kodi. Because maintaining such a large repository is a large task, we have set some guidelines for inclusion. Please ensure that these guidelines are met before submitting request to be added.
In order to be considered for the official repository, the following guidelines must be met:
* All add-ons must be developed as described on the [[Add-on development]] page.
* All add-ons must be compatible with both Python 2 and 3. Python 3-only addons will be accepted to the repositories for Kodi 19 (M*) and above. For more details see: [https://kodi.tv/article/attention-addon-developers-migration-python-3 Attention to Addon Developers: Migration to Python 3!]
* You ''must'' include a license file (named LICENSE.txt). We recommend the [http://creativecommons.org/choose/non-web-popup?license_code=by-sa&jurisdiction=&version=3.0&lang=en CC-BY-SA 3.0] for skins and the [http://www.gnu.org/licenses/gpl-howto.html GPL v2+] for others, but most copy left licenses will suffice. Please investigate which license suits your needs and you fully understand the contents.
* All files must be free and legal to distribute.
* The add-on must not violate any known copyright laws - if in doubt, let us know and we'll look into it for you.
* All source files must be included. No pre-compiled files will be allowed.
* You acknowledge that you are the maintainer of your add-on.
* Team-Kodi reserves the right to update or remove it at any time as we deem necessary.
* If a new stable Kodi is going to be released no new submissions are accepted to the repository for the previous version. This will start from when the first [http://en.wikipedia.org/wiki/Release_candidate#Release_candidate release candidate (RC)] of the new version is released. Only fixes and updates will be accepted and processed for the previous version (e.g. if the current stable is 13.x, no updates are allowed for 11.x any more). See: [[Submitting Add-ons#Allowed submissions|Allowed submissions]]
* Monetization of add-ons (for instance advertising or paid subscriptions) will not be allowed. We can make an exception in case you own the copyright for the content the add-on provides. Please contact us on the forum (or add-on mailing list) if you believe such an exception may apply to your add-on.
* All xbmc.python.module addons must be used by at least one other add-on in official repository.

=== Updates ===
Keep in mind that add-ons in the official repository should be considered ''stable''. This means that they should be well-tested before you submit them for inclusion.
Because they are for stable users, they should avoid being updated too often. Too often is of course subjective. If your add-on is in rapid development, and features are constantly being added, hold off until you have hit a good stopping point and ''tested'' the current version.

This means that you should ''not'' submit a request every time you change your code. If you are submitting updates more than once per week something is wrong. Once or twice per month is probably a better goal, barring unforeseen conditions (like a content source changing its paths). With good reasons provided we will of course make exceptions as we strive to prove the best user experience.

=== General requirements ===
Here's a list of what basic sanity checks are done by repository maintainer on each submission.

'''Basic file checks:'''

* all strings used by add-ons must be localized, no hard-coded language strings should ever be used
* all paths should be treated as case-sensitive, so that they work on all OSs and file systems.
* all paths and files should be lower-case due to the previous point
** exceptions are README, COPYING, LICENSE.txt that should be upper-case and the "Default" directory in <tt>resources/skins</tt>, for add-ons that need it.
* exception are the translation language folders which should be first letter capitalized.
* the following file-types are not allowed: .so .dll .pyo .exe .xbt .xpr Thumbs.db and so on<any binary files>
* all text files should use UNIX end-of-line
* all .xml files must pass xml validation
* all .xml files must have xml declaration as header
* all .xml/.txt must have unix style EOL's
* don't use a BOM at the start of your files
* file permissions: files should not be marked as executable
* filenames must have correct encoding (for skins: check your studio logos for corrupt filenames)

'''Things that must be included:'''

* [[Add-on structure#addon.xml|addon.xml]] must contain correct and valid info / version
* [[Add-on structure#icon.png|icon.png]] must be present (256x256) or (512x512)
* [[Add-on structure#fanart.jpg|fanart.jpg]] must be present (1280x720 or 1920x1080 or 3840x2160)
* [[Add-on structure#LICENSE.txt|LICENSE.txt]] must be present
{{See also|Add-on_structure}}

'''Things that can't be included:'''

* no .xbt files (these will be generated by our repository)
* no other add-ons included (skinners: if you need a script, submit it separately and depend on it)
* don't include unneeded files (.pdf, .doc, thumbs.db, etc...)
* no licensed fonts / background images / anything

=== Requirements for skins ===

'''Basic checks:'''

* The file size must be sane. There is no hard limit, but a 100mb skin is pushing it.
* No mods. Mods are great, and pop up frequently in the forums. But we would rather not have several versions of the same skin in our repo. But if your mod is substantial different enough from the original (and by giving it a different name), we will of course take it in consideration. Also if the original skin is no longer available through our repo, we would have no problem replacing it with a mod.
* In order to compile your images with TexturePacker, all graphics files should have a resolution of at least 4x4.
* themes must be in a subfolder of the themes/ folder in the skin root (eg. skin.foo/themes/blue/<files>). The .xbt file will be created by our repo backend.
* If you want to have some images outside of Textures.xbt, then make sure you place those images outside of the media/ folder and reference them using special://skin/backdrops/* or similar. This is most useful for backgrounds - it keeps the size of the packed textures down. Any images you have in the media/ folder will be placed in Textures.xbt in the official repository.
* Please be careful with addon dependencies. Only add dependencies that are needed for the skin to function properly.

'''Code checks:'''

* all labels must be localized
* code should be case-sensitive
* skins should not create warning/errors in the logfile, this can be a lot of things:
:* invalid includes
:* undefined actions
:* unable to evaluate condition
:* undefined vars
:* can't focus 'id'

{{Note|This of course also applies to script add-ons that use skin files}}

==== Optional support ====

This is optional and should not block inclusion in official repo.

* Mouse support
* Touchscreen support
* Peripheral dialogs
* PVR support
* ADSP support
* RDS support
* Game support

=== Requirements for scripts and plugins ===

* all special:// paths should be translated using xbmc.translatePath("special://foo/bar")
* xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('path')).decode('utf-8') should be used for files included with the add-on
* xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('profile')).decode('utf-8') should be used for storing add-on related files
* direct access to the Kodi database is '''not''' allowed. You must use [[JSON RPC]] for this.
* directly using analytics (Google Analytics for example) from within add-ons is not allowed. This should be handled server side by using user-agent.
* addons should use the xbmc.log() method to write to the logfile and use the debug logging level only. print statements should not be used.
* Plugins should '''not''' force certain skin viewtypes on their own. They should set the correct media content from which the correct skin view type is automatically provided.
* add-ons should store all their data in their own subfolder inside the addon_data directory. Access (read/write/delete) to any other files / folders is not allowed by default.
''Exceptions to this rule may be granted in specific cases only. Please contact Team XBMC's add-on repository maintainers on github if your add-on needs access to such files.''
In case we grant such an exception for your addon, access (read/write/delete) to other files/directories must be opt-in by the user, and be clear for the user to understand what is being accessed.

=== Requirements for scrapers ===
* scraper must return the following minimum information: movie title, year, plot, cast, poster, fanart
* use 'chain function' for calling functions in common scrapers
* remove the deprecated XML tags from the scraper header in case you use a scraper editor made for pre-Dharma versions of XBMC

[[Category:Add-on development]]
[[Category:Team Kodi specific notes]]

Archive:HOW-TO compile Kodi for Linux on Arch/Manjaro

2019-05-14T09:52:41Z

Tadly: /* Installing the required packages */

The recommended method to build/install Kodi on Arch Linux or Manjaro (and other Arch clones), is to build from a PKGBUILD rather than building/installing by hand. The primary reason to build this way is that it allows all files to be managed by pacman which is adventitious for numerous reasons.

One can download a PKGBUILD for Kodi from the [https://wiki.archlinux.org/index.php/Arch_User_Repository AUR] which hosts [https://aur.archlinux.org/packages/kodi-devel/ kodi-devel]. The remainder of this article shows steps to manually build and install.

== Getting the source code ==
First, we are going to install git, which is needed to download the Kodi source-code. Enter the following into the command line.

<syntaxhighlight lang="bash">
sudo pacman -S git
</syntaxhighlight>

Once git is installed, we can now get the Kodi source-code

<syntaxhighlight lang="bash">
cd $HOME
git clone git://github.com/xbmc/xbmc.git kodi
</syntaxhighlight>

== Installing the required packages ==
Kodi needs several third party packages, most of them can be installed from the official Arch/Manjaro repository

<syntaxhighlight lang="bash">
sudo pacman --needed --asdeps -S alsa-lib autoconf automake avahi bluez-libs bzip2 cmake curl cwiid dbus ffmpeg \
flatbuffers fmt fontconfig freetype2 fribidi fstrcmp gawk giflib glu gperf jre8-openjdk libao libass libbluray \
libcap libcdio libcec libcrossguid libjpeg-turbo libltdl libmariadbclient libmicrohttpd libmpcdec libnfs libplist \
libpng libpulse libssh libsystemd libtool libusb libva libvdpau libxml2 libxmu libxrandr libxslt libxt lsb-release \
lzo mesa nasm openssl pcre python2 python2-pillow rapidjson shairplay smbclient sqlite swig taglib tinyxml yasm zlib
</syntaxhighlight>

In addition to those, Kodi needs a few packages that are currently unavailable in the official repo, but they can be installed from the AUR (Arch User Repo)[https://aur.archlinux.org/].
<syntaxhighlight lang="bash">
cwiid fstrcmp
</syntaxhighlight>

Those can either be installed manually[https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages] or by using a AUR Helpers[https://wiki.archlinux.org/index.php/AUR_helpers].

''Optional:'' For developers and anyone else who compiles frequently it is recommended to use ccache
<syntaxhighlight lang="bash">
sudo pacman -S ccache
</syntaxhighlight>

== How to compile ==
To create the Kodi executable manually perform these steps:

;Notes
* By adding -j<number> to the 'cmake --build' command, you describe how many concurrent jobs will be used. So for dualcore the command is: <code>make -j2</code>
* You may need to run the 'make install' command with sudo if your user doesn't have write permissions to the prefix you have provided.

<syntaxhighlight lang="bash">
cd $HOME/kodi/
mkdir kodi-build
cd kodi-build
cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local
cmake --build . -- VERBOSE=1 -j4
sudo make install
</syntaxhighlight>

This will install Kodi in the prefix provided (/usr/local).

== How to run ==
How to run xbmc depends on the type of installation you have done.
If you chose to install Kodi using the '/usr' or '/usr/local' prefix, you can just issue 'kodi' in a teminal session.

<syntaxhighlight lang="bash">
kodi
</syntaxhighlight>

You can also simply run from the application menu ofcourse.

In case you've overridden the prefix to install Kodi into some non-standard location, you will have to run kodi from a terminal, specifying the full path

<syntaxhighlight lang="bash">
/opt/kodi/bin/kodi
</syntaxhighlight>

== Uninstalling ==
If you ever need to uninstall Kodi, you can use the following command

<syntaxhighlight lang="bash">
cd $HOME/kodi/kodi-build
sudo make uninstall
</syntaxhighlight>

== See also ==
* https://github.com/xbmc/xbmc/blob/master/docs/README.linux

[[Category:Linux]]
[[Category:Compiling]]

Action IDs

2018-12-04T09:43:43Z

Tadly: Adds PlayNext action description

<section begin="Action IDs" />
;Main actions
{| class="prettytable"
|-
! Action
! Description
|-
| <code>Left</code> || Move left off a control.
|-
| <code>Right</code> || Move right off a control.
|-
| <code>Up</code> || Move up off a control.
|-
| <code>Down</code> || Move down off a control.
|-
| <code>Select</code> || Select a button, or an item from a list of thumb view.
|-
| <code>Enter</code> || '''?''' (ACTION_ENTER) Not sure about all areas, but on some windows this will be the same as the "done" on screen button.
|-
| <code>PageUp</code> || Scroll up on page in a list, thumb, or text view.
|-
| <code>PageDown</code> || Scroll down on page in a list, thumb, or text view.
|-
| <code>Highlight</code> || Highlight an item in a list or thumb view.
|-
| <code>ParentDir</code> || Go up a folder to the parent folder.
|-
| <code>PreviousMenu</code> || Go back to the previous menu screen.
|-
| <code>Back</code> || Go back in navigation.
|-
| <code>Info</code> || Show the information about the currently highlighted item, or currently playing item.
|-
| <code>Pause</code> || Pause the currently playing item.
|-
| <code>Stop</code> || Stop the currently playing item.
|-
| <code>SkipNext</code> || Skip to next video in playlist. If no playlist, then skip to next chapter in video.
|-
| <code>SkipPrevious</code> || Skip to previous video in playlist. If no playlist, then skip to previous chapter in video.
|-
| <code>FullScreen</code> || Toggles full-screen content playback (either visualisation or video playback)
|-
| <code>togglefullscreen</code> || Changes whether the app is displayed full-screen or windowed (on windowing OSs)
|-
| <code>AspectRatio</code> || Toggle through the various aspect ratio modes (Normal is the preferred option).
|-
| <code>StepForward</code> || Step forward 30 seconds in a video.
|-
| <code>StepBack</code> || Step back 30 seconds in a video.
|-
| <code>BigStepForward</code> || Step forward 10 minutes in video.
|-
| <code>BigStepBack</code> || Step back 10 minutes in video.
|-
| <code>SmallStepBack</code> || Step back 7 seconds in the current video.
|-
| <code>Seek(''##'')</code> || A definable seek action, where <code>''##''</code> is a number of seconds. For example, to make a seek action that goes forward 25 seconds use <code>Seek(25)</code>, and to make a seek action that goes back 36 seconds use <code>Seek(-36)</code>. '''(v15 Isengard addition)'''
|-
| <code>ChapterOrBigStepForward</code> || Go to to next chapter in video. If no chapters, then step forward 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>ChapterOrBigStepBack</code> || Go to previous chapter in video, If no chapters, then step back 10 minutes in video. '''(v13 Gotham addition)'''
|-
| <code>NextScene</code> || Go to next scene that is marked in an [[EDL]] file.
|-
| <code>PreviousScene</code> || Go to previous scene that is marked in an [[EDL]] file.
|-
| <code>OSD</code> || Toggles the OSD while playing an item.
|-
| <code>PlayDVD</code> || Start playing a DVD (goes to the DVD menu)
|-
| <code>ShowVideoMenu</code> || Go to the DVD Video menu when playing a DVD.
|-
| <code>ShowSubtitles</code> || Toggles whether subtitles are shown or not.
|-
| <code>NextSubtitle</code> || Change to the next subtitle language, if there is more than one.
|-
| <code>SubtitleShiftUp</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_UP)
|-
| <code>SubtitleShiftDown</code> || '''?''' (ACTION_SUBTITLE_VSHIFT_DOWN)
|-
| <code>SubtitleAlign</code> || '''?''' (ACTION_SUBTITLE_ALIGN)
|-
| <code>CodecInfo</code> || Show codec information about the currently playing item (during video or visualisation playback)
|-
| <code>NextPicture</code> || Move to the next picture in a slideshow.
|-
| <code>PreviousPicture</code> || Move to the previous picture in a slideshow.
|-
| <code>ZoomOut</code> || Used in picture, slideshow or video fullscreen to zoom out of the current image/video.
|-
| <code>ZoomIn</code> || Used in picture, slideshow or video fullscreen to zoom in to the current image/video.
|-
| <code>IncreasePAR</code> || Used in video fullscreen to increase the pixel aspect ratio (stretch).
|-
| <code>DecreasePAR</code> || Used in video fullscreen to decrease the pixel aspect ratio (stretch).
|-
| <code>Queue</code> || Queue the item to the current playlist
|-
| <code>PlayNext</code> || Queue the item to the next position in the current playlist
|-
| <code>Filter</code> || Opens the mediafilter dialog in the video and musiclibrary. {{editor note|seems to only use the [[advanced filter]] for the video library?}}
|-
| <code>Playlist</code> || Toggle to playlist view from My Music or My Videos
|-
| <code>ZoomNormal</code> || Normal (fullscreen) viewing in My Pictures
|-
| <code>ZoomLevel1</code> || Zoom to 120% in My Pictures
|-
| <code>ZoomLevel2</code> || Zoom to 150% in My Pictures
|-
| <code>ZoomLevel3</code> || Zoom to 200% in My Pictures
|-
| <code>ZoomLevel4</code> || Zoom to 280% in My Pictures
|-
| <code>ZoomLevel5</code> || Zoom to 400% in My Pictures
|-
| <code>ZoomLevel6</code> || Zoom to 600% in My Pictures
|-
| <code>ZoomLevel7</code> || Zoom to 900% in My Pictures
|-
| <code>ZoomLevel8</code> || Zoom to 1350% in My Pictures
|-
| <code>ZoomLevel9</code> || Zoom to 2000% in My Pictures
|-
| <code>NextCalibration</code> || Used in Video + GUI calibration
|-
| <code>ResetCalibration</code> || Used in Video + GUI calibration
|-
| <code>AnalogMove</code> || Move in the calibration screens, and while zoomed in My Pictures.
|-
| <code>Rotate</code> || Rotate a picture in My Pictures
|-
| <code>rotateccw</code> || '''?''' (ACTION_ROTATE_PICTURE_CCW)
|-
| <code>Close</code> || Used to close a dialog
|-
| <code>subtitledelay</code> || '''?''' (ACTION_SUBTITLE_DELAY)
|-
| <code>SubtitleDelayMinus</code> || Decrease the delay amount of subtitles (use if subtitles are displaying too late)
|-
| <code>SubtitleDelayPlus</code> || Increase the delay amount of subtitles (use if subtitles are displaying too early)
|-
| <code>audiodelay</code> || '''?''' (ACTION_AUDIO_DELAY)
|-
| <code>AudioDelayMinus</code> || Decrease the delay amount of audio (use if audio is being heard too early)
|-
| <code>AudioDelayPlus</code> || Increase the delay amount of audio (use if audio is being heard too late)
|-
| <code>AudioNextLanguage</code> || Change to the next audio track in a video with multiple audio tracks.
|-
| <code>NextResolution</code> || Used in Video calibration
|-
| <code>Number''<0-9>''</code> || Used to input the number 0 through 9
|-
| <code>FastForward</code> || Toggle the fastforward speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Rewind</code> || Toggle the rewind speed between normal play, 2x, 4x, 8x, 16x, and 32x.
|-
| <code>Play</code> || Play the selected item (or folder of items). {{note|You may want to use <code>playpause</code> instead of just "play", since it will no longer pause media already being played.}}
|-
| <code>PlayPause</code> || Play the selected item (or folder of items). Will also pause media when something is already playing.
|-
| <code>Delete</code> || Used in My Files to delete a file.
|-
| <code>Copy</code> || Used in My Files to copy a file.
|-
| <code>Move</code> || Used in My Files to move a file.
|-
| <code>Rename</code> || Used in My Files to rename a file.
|-
| <code>HideSubmenu</code> || <depreciated>
|-
| <code>Screenshot</code> || Take a screenshot of the current screen.
|-
| <code>ShutDown()</code> || Shutdown and power off
|-
| <code>VolumeUp</code> || Increase the volume of playback.
|-
| <code>VolumeDown</code> || Decrease the volume of playback.
|-
| <code>Mute</code> || Mute the volume.
|-
| <code>volampup</code> || '''?''' (ACTION_VOLAMP_UP)
|-
| <code>volampdown</code> || '''?''' (ACTION_VOLAMP_DOWN)
|-
| <code>audiotoggledigital</code> || '''?''' (ACTION_TOGGLE_DIGITAL_ANALOG)
|-
| <code>BackSpace</code> || Used in the virtual keyboards to delete one letter.
|-
| <code>ScrollUp</code> || Variable speed scroll up for analog keys (stick or triggers)
|-
| <code>ScrollDown</code> || Variable speed scroll down for analog keys (stick or triggers)
|-
| <code>AnalogFastForward</code> || Variable speed fast forward for analog keys (stick or triggers)
|-
| <code>AnalogRewind</code> || Variable speed rewind for analog keys (stick or triggers)
|-
| <code>AnalogSeekForward</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>AnalogSeekBack</code> || Variable speed seeking for analog keys (stick or triggers)
|-
| <code>MoveItemUp</code> || Used to rearrange playlists
|-
| <code>MoveItemDown</code> || Used to rearrange playlists
|-
| <code>Menu</code> || Focus the menu control (e.g. sidebar in confluence) which is specified by the skin in different windows (e.g. Movies, Music, PVR etc.) '''(v16 Jarvis addition)'''
|-
| <code>ContextMenu</code> || Pops up a contextual menu
|-
| <code>Shift</code> || Used in Virtual Keyboard to switch to upper or lower case letters
|-
| <code>Symbols</code> || Used in Virtual Keyboard to switch to or from symbols mode
|-
| <code>CursorLeft</code> || Used in Virtual Keyboard to move the current cursor point to the left
|-
| <code>CursorRight</code> || Used in Virtual Keyboard to move the current cursor point to the right
|-
| <code>ShowTime</code> || Used to show the current play time in music + video playback
|-
| <code>visualisationpresetlist</code> || Shows the visualisation preset list
|-
| <code>ShowPreset</code> || Shows the current visualisation preset (milkdrop/spectrum)
|-
| <code>NextPreset</code> || Next visualisation preset
|-
| <code>PreviousPreset</code> || Previous visualisation preset
|-
| <code>LockPreset</code> || Lock the current visualisation preset
|-
| <code>RandomPreset</code> || Switch to a new random preset
|-
| <code>IncreaseRating</code> || Used to increase track rating in full screen playback (press info on track and use pageplus on keyboard/remote
|-
| <code>DecreaseRating</code> || Used to decrease track rating in full screen playback (press info on track and use pageminus on keyboard/remote
|-
| <code>ToggleWatched</code> || Toggles watched/unwatched status for Videos
|-
| <code>NextLetter</code> || Move to the next letter in a list or thumb panel. Note that SHIFT-B on the keyboard will take you to the B's.
|-
| <code>PrevLetter</code> || Move to the previous letter in a list or thumb panel. Note that SHIFT-Z on the keyboard will take you to the Z's.
|-
| <code>JumpSMS''<2-9>''</code> || Jump through a list using SMS-style input (eg press 2 twice to jump to the B's.)
|-
| <code>FilterSMS''<2-9>''</code> || Filter a list in music or videos using SMS-style input.
|-
| <code>verticalshiftup</code> || '''?''' (ACTION_VSHIFT_UP)
|-
| <code>verticalshiftdown</code> || '''?''' (ACTION_VSHIFT_DOWN)
|-
| <code>scanitem</code> || '''?''' (ACTION_SCAN_ITEM)
|-
| <code>reloadkeymaps</code> || Reload keymap, loading any changes made to the keymap since started up.
|-
| <code>increasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_PLUS)
|-
| <code>decreasevisrating</code> || '''?''' (ACTION_VIS_RATE_PRESET_MINUS)
|-
| <code>firstpage</code> || '''?''' (ACTION_FIRST_PAGE)
|-
| <code>lastpage</code> || '''?''' (ACTION_LAST_PAGE)
|-
| <code>guiprofile</code> || '''?''' (ACTION_GUIPROFILE_BEGIN)
|-
| <code>red</code> || '''?''' (ACTION_TELETEXT_RED)
|-
| <code>green</code> || '''?''' (ACTION_TELETEXT_GREEN)
|-
| <code>yellow</code> || '''?''' (ACTION_TELETEXT_YELLOW)
|-
| <code>blue</code> || '''?''' (ACTION_TELETEXT_BLUE)
|-
| <code>CreateBookmark</code> || Creates a bookmark of the currently playing Video '''(v13 Gotham addition)'''
|-
| <code>CreatEpisodeBookmark</code> || Creates an episode bookmark of the currently playing multi-episode file (e.g. S01E01E02). An episode bookmark specifies the end of the one and the begin of the other episode '''(v13 Gotham addition)'''
|-
| <code>NextChannelGroup</code> || [[PVR]] Goes to the next channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>PreviousChannelGroup</code> || [[PVR]] Goes to the previous channel group when using live TV. Works only within PVR windows + channel osd. '''(v13 Gotham addition)'''
|-
| <code>ChannelUp</code> || [[PVR]] Used to switch up to the next channel. Works only if you playback TV or radio '''(v13 Gotham addition)'''
|-
| <code>ChannelDown</code> || [[PVR]] Used to switch down to the previous channel. Works only if you playback TV or radio'''(v13 Gotham addition)'''
|-
| <code>PlayPvr</code> || [[PVR]] Starts playback a TV or radio channel depends on the last played channel. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrTV</code> || [[PVR]] Starts playback a TV channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>PlayPvrRadio</code> || [[PVR]] Starts playback a radio channel. Will playback the last played channel if available. '''(v13 Gotham addition)'''
|-
| <code>Record</code> || [[PVR]] record current playing channel or selected item in windows like EPG '''(v13 Gotham addition)'''
|-
| <code>StereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>ToggleStereoMode</code> || Toggle 3D/Stereoscopic mode '''(v13 Gotham addition)'''
|-
| <code>SwitchPlayer</code> || Select player to use, such as internal (DVDPlayer/PAPlayer), UPnP "play using" targets, external players (defined in [[playercorefactory.xml]]). '''(v13 Gotham addition)'''
|-
| <code>UpdateLibrary(video)</code> || Update Movie/TV-Show library (only tested with v13 Gotham addition).
|-
| <code>SetRatring</code> || For use in the MusicOSD.xml window. Will pop-up a 1-10 userrating select dialog, to rate the currently playing song. '''(v17 Krypton addition)'''
|-
|}

;Other
{| class="prettytable"
! Action
! Description
|-
| <code>noop</code> || No action. Used to specifically disable a key.
|}
<section end="Action IDs" />

== Removed action IDs ==
* <code>PresetList</code> - replaced with <code>visualisationpresetlist</code> in a previous version (unknown?)

== See also ==
* [[Keymaps]]
* [[Window IDs]]
* [[Built-in scripting]]

{{Isengard updated}}

[[Category:Remotes]]
[[Category:Skin development]]

InfoLabels

2016-12-11T16:32:47Z

Tadly: /* Container */

{{mininav|[[Development]]|[[Add-on development]]|[[Skinning]]}}
<section begin="main content" />
Skins can use infolabels with $INFO[infolabel] or the <info> tag. Scripts can read infolabels with <code>xbmc.getInfoLabel('infolabel')</code>.

An up-to-date list can be found here [https://github.com/xbmc/xbmc/blob/master/xbmc/GUIInfoManager.cpp GUIInfoManager.cpp]

=== ADSP ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| ADSP.ActiveStreamType
| User selected stream type, e.g. music or video
|
|-
| ADSP.DetectedStreamType
| Detected stream type by Kodi
|
|-
| ADSP.MasterName
| Name of the curently selected and used master dsp mode
|
|-
| ADSP.MasterInfo
| Continuously updated information label of master mode (if available)
|
|-
| ADSP.MasterOwnIcon
| Icon to use for selected master mode
|
|-
| ADSP.MasterOverrideIcon
| Icon to overrite Kodi's codec icon with one of add-on, e.g. Dolby Digital EX on Dolby Digital
|
|}

=== Container ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Container.Content
| Shows content of the current container
|
|-
| Container.FolderPath
| Shows complete path of currently displayed folder
|
|-
| Container.FolderName
| Shows top most folder in currently displayed folder
|
|-
| Container.Viewmode
| Returns the current viewmode (list, icons etc.)
|
|-
| Container.SortMethod
| Returns the current sort method (name, year, rating, etc.)
|
|-
| Container.SortOrder
| Returns the current sort order (Ascending/Descending)
|
|-
| Container.PluginName
| Returns the current plugins base folder name
|
|-
| Container.PluginCategory
| Returns the current plugins category (set by the scripter)
|
|-
| Container.ShowPlot
| Returns the TV Show plot of the current container and can be used at season and episode level
|
|-
| Container.ShowTitle
| Returns the TV Show title of the current container and can be used at season and episode level
| v17 addition
|-
| Container(id).NumPages
| Number of pages in the container with given id. If no id is specified it grabs the current container.
|
|-
| Container(id).NumItems
| Number of items in the container or grouplist with given id. If no id is specified it grabs the current container.
|
|-
| Container(id).CurrentPage
| Current page in the container with given id. If no id is specified it grabs the current container.
|
|-
| Container(id).CurrentItem
| Current item in the container or grouplist with given id. If no id is specified it grabs the current container.
|
|-
| Container(id).Position
| Returns the current focused position of container / grouplist (id) as a numeric label.
|
|-
| Container(id).Column
| Returns the column number of the focused position in a panel container.
|
|-
| Container(id).Row
| Returns the row number of the focused position in a panel container.
|
|-
| Container(id).Totaltime
| Returns the total time of all items in the current container
|
|-
| Container(id).TotalWatched
| Returns the number of watched items in the current container
|
|-
| Container(id).TotalUnWatched
| Returns the number of unwatched items in the current container
|
|-
| Container(id).ListItem(offset).Label
| Shows ListItem.Label for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(2).Label )''
|
|-
| Container(id).ListItem(offset).Label2
| Shows ListItem.Label2 for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(-2).Label2 )''
|
|-
| Container(id).ListItem(offset).Icon
| Shows ListItem.Icon for a specific List or Panel Container with a offset ''( eg: Container(52).Listitem(1).Icon)''
|
|-
| Container(id).ListItem(offset).ActualIcon
| Shows ListItem.ActualIcon for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).ActualIcon )''
|
|-
| Container(id).ListItem(offset).Thumb
| Shows ListItem.Thumb for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).Thumb )''
|
|-
| Container(id).ListItemNoWrap(offset).Property
| Basically returns the same as ListItem(offset) but it won't wrap. That means if the last item of a list is focused, ListItemNoWrap(1) will be empty while ListItem(1) will return the first item of the list. ''Property'' has to be replaced with Label, Label2, Icon etc. ''( eg: Container(50).ListitemNoWrap(1).Plot )''
|
|-
| Container(id).ListItemPosition(id).[infolabel]
| Shows the infolabel for an item in a Container. the item id is the position in the container relative to the cursor position. ''( eg: Container(50).ListItemPosition(4).Genre )''
|
|-
| Container(id).ListItemAbsolute(id).[infolabel]
| Shows the infolabel for an item in a Container. the item id is the absolute position in the container. ''( eg: Container(50).ListItemAbsolute(4).Genre )''
|
|-
| Container.Property(addoncategory)
| Returns the current add-on category
|
|-
| Container.Property(reponame)
| Returns the current add-on repository name
|
|-
| Container.ViewCount
| The number of available skin view modes for the current container listing.
|
|}

=== Control ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Control.GetLabel(id)[.index()]
| Returns the label value or texture name of the control with the given id. Optionally you can specify index(1) to retrieve label2 from an Edit control.
|
|}

=== Fanart ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Fanart.Color1
| Returns the first of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.
|
|-
| Fanart.Color2
| Returns the second of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.
|
|-
| Fanart.Color3
| Returns the third of three colors included in the currently selected '''[[Fanart]]''' theme for the parent TV Show. Colors are arranged Lightest to Darkest.
|
|}

=== ListItem ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| ListItem.Label
| Shows the left label of the currently selected item in a container
|
|-
| ListItem.Label2
| Shows the right label of the currently selected item in a container
|
|-
| ListItem.Title
| Shows the title of the currently selected song or movie in a container
|
|-
| ListItem.OriginalTitle
| Shows the original title of the currently selected movie in a container
|
|-
| ListItem.SortLetter
| Shows the first letter of the current file in a container
|
|-
| ListItem.TrackNumber
| Shows the track number of the currently selected song in a container
|
|-
| ListItem.Artist
| Shows the artist of the currently selected song in a container
|
|-
| ListItem.AlbumArtist
| Shows the artist of the currently selected album in a list
|
|-
| ListItem.Property(Artist_Born)
| Date of Birth of the currently selected Artist
|
|-
| ListItem.Property(Artist_Died)
| Date of Death of the currently selected Artist
|
|-
| ListItem.Property(Artist_Formed)
| Formation date of the currently selected Band
|
|-
| ListItem.Property(Artist_Disbanded)
| Disbanding date of the currently selected Band
|
|-
| ListItem.Property(Artist_YearsActive)
| Years the currently selected artist has been active
|
|-
| ListItem.Property(Artist_Instrument)
| Instruments played by the currently selected artist
|
|-
| ListItem.Property(Artist_Description)
| Shows a biography of the currently selected artist
|
|-
| ListItem.Property(Artist_Mood)
| Shows the moods of the currently selected artist
|
|-
| ListItem.Property(Artist_Style)
| Shows the styles of the currently selected artist
|
|-
| ListItem.Property(Artist_Genre)
| Shows the genre of the currently selected artist
|
|-
| ListItem.Album
| Shows the album of the currently selected song in a container
|
|-
| ListItem.Property(Album_Mood)
| Shows the moods of the currently selected Album
|
|-
| ListItem.Property(Album_Style)
| Shows the styles of the currently selected Album
|
|-
| ListItem.Property(Album_Theme)
| Shows the themes of the currently selected Album
|
|-
| ListItem.Property(Album_Type)
| Shows the Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album
|
|-
| ListItem.Property(Album_Label)
| Shows the record label of the currently selected Album
|
|-
| ListItem.Property(Album_Description)
| Shows a review of the currently selected Album
|
|-
| ListItem.DiscNumber
| Shows the disc number of the currently selected song in a container
|
|-
| ListItem.Year
| Shows the year of the currently selected song, album or movie in a container
|
|-
| ListItem.Premiered
| Shows the release/aired date of the currently selected episode, show, movie or EPG item in a container
|
|-
| ListItem.Genre
| Shows the genre of the currently selected song, album or movie in a container
|
|-
| ListItem.Director
| Shows the director of the currently selected movie in a container
|
|-
| ListItem.Country
| Shows the production country of the currently selected movie in a container
|
|-
| ListItem.Episode
| Shows the episode number value for the currently selected episode. It also shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.Season
| Shows the season value for the currently selected tvshow
|
|-
| ListItem.TVShowTitle
| Shows the name value for the currently selected tvshow in the season and episode depth of the video library
|
|-
| ListItem.Property(TotalSeasons)
| Shows the total number of seasons for the currently selected tvshow
|
|-
| ListItem.Property(TotalEpisodes)
| Shows the total number of episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(WatchedEpisodes)
| Shows the number of watched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(UnWatchedEpisodes)
| Shows the number of unwatched episodes for the currently selected tvshow or season
|
|-
| ListItem.Property(NumEpisodes)
| Shows the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
|-
| ListItem.PictureAperture
| Shows the F-stop used to take the selected picture. This is the value of the EXIF FNumber tag (hex code 0x829D).
|
|-
| ListItem.PictureAuthor
| Shows the name of the person involved in writing about the selected picture. This is the value of the IPTC Writer tag (hex code 0x7A).
|
|-
| ListItem.PictureByline
| Shows the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50).
|
|-
| ListItem.PictureBylineTitle
| Shows the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55).
|
|-
| ListItem.PictureCamMake
| Shows the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F).
|
|-
| ListItem.PictureCamModel
| Shows the manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110).
|
|-
| ListItem.PictureCaption
| Shows a description of the selected picture. This is the value of the IPTC Caption tag (hex code 0x78).
|
|-
| ListItem.PictureCategory
| Shows the subject of the selected picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F).
|
|-
| ListItem.PictureCCDWidth
| Shows the width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
|
|-
| ListItem.PictureCity
| Shows the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A).
|
|-
| ListItem.PictureColour
| Shows whether the selected picture is "Colour" or "Black and White".
|
|-
| ListItem.PictureComment
| Shows a description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
|-
| ListItem.PictureCopyrightNotice
| Shows the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74).
|
|-
| ListItem.PictureCountry
| Shows the full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65).
|
|-
| ListItem.PictureCountryCode
| Shows the country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64).
|
|-
| ListItem.PictureCredit
| Shows who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E).
|
|-
| ListItem.PictureDate
| Shows the localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDatetime
| Shows the date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureDesc
| Shows a short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
|-
| ListItem.PictureDigitalZoom
| Shows the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
|
|-
| ListItem.PictureExpMode
| Shows the exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
|-
| ListItem.PictureExposure
| Shows the class of the program used by the camera to set exposure when the selected picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority (semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
|
|-
| ListItem.PictureExposureBias
| Shows the exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
|
|-
| ListItem.PictureExpTime
| Shows the exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
|-
| ListItem.PictureFlashUsed
| Shows the status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209).
|
|-
| ListItem.PictureFocalLen
| Shows the lens focal length of the selected picture
|
|-
| ListItem.PictureFocusDist
| Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
|-
| ListItem.PictureGPSLat
| Shows the latitude where the selected picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
|-
| ListItem.PictureGPSLon
| Shows the longitude where the selected picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
|-
| ListItem.PictureGPSAlt
| Shows the altitude in meters where the selected picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
|-
| ListItem.PictureHeadline
| Shows a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69).
|
|-
| ListItem.PictureImageType
| Shows the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82).
|
|-
| ListItem.PictureIPTCDate
| Shows the date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37).
|
|-
| ListItem.PictureIPTCTime
| Shows the time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C).
|
|-
| ListItem.PictureISO
| Shows the ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
|-
| ListItem.PictureKeywords
| Shows keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19).
|
|-
| ListItem.PictureLightSource
| 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).
|
|-
| ListItem.PictureLongDate
| Shows only the localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureLongDatetime
| Shows the date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
|-
| ListItem.PictureMeteringMode
| Shows the metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207).
|
|-
| ListItem.PictureObjectName
| Shows a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05).
|
|-
| ListItem.PictureOrientation
| Shows the orientation of the selected picture. Possible values are "Top Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112).
|
|-
| ListItem.PicturePath
| Shows the filename and path of the selected picture
|
|-
| ListItem.PictureProcess
| Shows the process used to compress the selected picture
|
|-
| ListItem.PictureReferenceService
| Shows the Service Identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D).
|
|-
| ListItem.PictureResolution
| Shows the dimensions of the selected picture
|
|-
| ListItem.PictureSource
| Shows the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73).
|
|-
| ListItem.PictureSpecialInstructions
| Shows other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
|
|-
| ListItem.PictureState
| Shows the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F).
|
|-
| ListItem.PictureSublocation
| Shows the location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C).
|
|-
| ListItem.PictureSupplementalCategories
| Shows supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14).
|
|-
| ListItem.PictureTransmissionReference
| Shows a code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67).
|
|-
| ListItem.PictureUrgency
| Shows the urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
|
|-
| ListItem.PictureWhiteBalance
| Shows the white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
|
|-
| ListItem.FileName
| Shows the filename of the currently selected song or movie in a container
|
|-
| ListItem.Path
| Shows the complete path of the currently selected song or movie in a container
|
|-
| ListItem.FolderName
| Shows top most folder of the path of the currently selected song or movie in a container
|
|-
| ListItem.FolderPath
| Shows the complete path of the currently selected song or movie in a container (without user details).
|
|-
| ListItem.FileNameAndPath
| Shows the full path with filename of the currently selected song or movie in a container
|
|-
| ListItem.FileExtension
| Shows the file extension (without leading dot) of the currently selected item in a container
|
|-
| ListItem.Date
| Shows the file date of the currently selected song or movie in a container / Aired date of an episode / Day, start time and end time of current selected TV programme (PVR)
|
|-
| ListItem.DateAdded
| Shows the date the currently selected item was added to the library / Date and time of an event in the EventLog window.
|
|-
| ListItem.Size
| Shows the file size of the currently selected song or movie in a container
|
|-
| ListItem.Rating[(name)]
| Shows 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.
|
|-
| ListItem.Set
| Shows the name of the set the movie is part of
|
|-
| ListItem.SetId
| Shows the id of the set the movie is part of
|
|-
| ListItem.UserRating
| Shows the user rating of the currently selected item in a container
|
|-
| ListItem.Votes[(name)]
| Shows the IMDB votes of the currently selected movie in a container. Optionally you can specify the name of the scraper to retrieve specific votes.
|
|-
| ListItem.RatingAndVotes[(name)]
| Shows 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.
|
|-
| ListItem.Mpaa
| Show the MPAA rating of the currently selected movie in a container
|
|-
| ListItem.ProgramCount
| Shows the number of times an xbe has been run from "my programs"
|
|-
| ListItem.Duration
| Shows the song or movie duration of the currently selected movie in a container
|
|-
| ListItem.DBTYPE
| Shows the database type of the ListItem.DBID for videos (video, movie, set, tvshow, season, episode, musicvideo) or for audio (music, song, album, artist). Beware with season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library.
|
|-
| ListItem.DBID
| Shows the database id of the currently selected listitem in a container
|
|-
| ListItem.Cast
| Shows a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.CastAndRole
| Shows a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml
|
|-
| ListItem.Studio
| Studio of current selected Music Video in a container
|
|-
| ListItem.Top250
| Shows the IMDb top250 position of the currently selected listitem in a container.
|
|-
| ListItem.Trailer
| Shows the full trailer path with filename of the currently selected movie in a container
|
|-
| ListItem.Writer
| Name of Writer of current Video in a container
|
|-
| ListItem.Tagline
| Small Summary of current Video in a container
|
|-
| ListItem.PlotOutline
| Small Summary of current Video in a container
|
|-
| ListItem.Plot
| Complete Text Summary of Video in a container
|
|-
| ListItem.IMDBNumber
| The IMDB iD of the selected Video in a container
|
|-
| ListItem.EpisodeName
| (PVR only) The name of the episode if the selected EPG item is a TV Show
|
|-
| ListItem.PercentPlayed
| Returns percentage value [0-100] of how far the selected video has been played
|
|-
| ListItem.LastPlayed
| Last play date of Video in a container
|
|-
| ListItem.PlayCount
| Playcount of Video in a container
|
|-
| ListItem.StartTime
| Start time of current selected TV programme in a container
|
|-
| ListItem.EndTime
| End time of current selected TV programme in a container
|
|-
| ListItem.StartDate
| Start date of current selected TV programme in a container
|
|-
| ListItem.ChannelNumber
| Number of current selected TV channel in a container
|
|-
| ListItem.ChannelName
| Name of current selected TV channel in a container
|
|-
| ListItem.VideoCodec
| Shows the video codec of the currently selected video (common values: 3iv2, avc1, div2, div3, divx, divx 4, dx50, flv, h264, microsoft, mp42, mp43, mp4v, mpeg1video, mpeg2video, mpg4, rv40, svq1, svq3, theora, vp6f, wmv2, wmv3, wvc1, xvid)
|
|-
| ListItem.VideoResolution
| Shows the resolution of the currently selected video (possible values: 480, 576, 540, 720, 1080, 4K). Note that 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576.
|
|-
| ListItem.VideoAspect
| Shows the aspect ratio of the currently selected video (possible values: 1.33, 1.37, 1.66, 1.78, 1.85, 2.20, 2.35, 2.40, 2.55, 2.76)
|
|-
| ListItem.AudioCodec
| Shows the audio codec of the currently selected video (common values: aac, ac3, cook, dca, dtshd_hra, dtshd_ma, eac3, mp1, mp2, mp3, pcm_s16be, pcm_s16le, pcm_u8, truehd, vorbis, wmapro, wmav2)
|
|-
| ListItem.AudioChannels
| Shows the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 8, 10)
|
|-
| ListItem.AudioLanguage
| Shows the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.SubtitleLanguage
| Shows the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu)
|
|-
| ListItem.Property(AudioCodec.[n])
| Shows the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec)
|
|-
| ListItem.Property(AudioChannels.[n])
| Shows the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels)
|
|-
| ListItem.Property(AudioLanguage.[n])
| Shows the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage)
|
|-
| ListItem.Property(SubtitleLanguage.[n])
| Shows the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage)
|
|-
| ListItem.AddonName
| Shows the name of the currently selected addon
|
|-
| ListItem.AddonVersion
| Shows the version of the currently selected addon
|
|-
| ListItem.AddonSummary
| Shows a short description of the currently selected addon
|
|-
| ListItem.AddonDescription
| Shows the full description of the currently selected addon
|
|-
| ListItem.AddonType
| Shows the type (screensaver, script, skin, etc...) of the currently selected addon
|
|-
| ListItem.AddonCreator
| Shows the name of the author the currently selected addon
|
|-
| ListItem.AddonDisclaimer
| Shows the disclaimer of the currently selected addon
|
|-
| ListItem.AddonBroken
| Shows a message when the addon is marked as broken in the repo
|
|-
| ListItem.Property(Addon.Changelog)
| Shows the changelog of the currently selected addon
|
|-
| ListItem.Property(Addon.ID)
| Shows the identifier of the currently selected addon
|
|-
| ListItem.Property(Addon.Status)
| Shows the status of the currently selected addon
|
|-
| ListItem.Property(Addon.Path)
| Shows the path of the currently selected addon
|
|-
| ListItem.StartTime
| Start time of the selected item (PVR).
|
|-
| ListItem.EndTime
| End time of the selected item (PVR).
|
|-
| ListItem.StartDate
| Start date of the selected item (PVR).
|
|-
| ListItem.EndDate
| End date of the selected item (PVR).
|
|-
| ListItem.NextTitle
| Title of the next item (PVR).
|
|-
| ListItem.NextGenre
| Genre of the next item (PVR).
|
|-
| ListItem.NextPlot
| Plot of the next item (PVR).
|
|-
| ListItem.NextPlotOutline
| Plot outline of the next item (PVR).
|
|-
| ListItem.NextStartTime
| Start time of the next item (PVR).
|
|-
| ListItem.NextEndTime
| End of the next item (PVR).
|
|-
| ListItem.NextStartDate
| Start date of the next item (PVR).
|
|-
| ListItem.NextEndDate
| End date of the next item (PVR).
|
|-
| ListItem.ChannelName
| Channelname of the selected item (PVR).
|
|-
| ListItem.ChannelNumber
| Channel number of the selected item (PVR).
|
|-
| ListItem.ChannelGroup
| Channel group of the selected item (PVR).
|
|-
| ListItem.SubChannelNumber
| Subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| ListItem.ChannelNumberLabel
| Channel and subchannel number of the currently selected channel that's currently playing (PVR).
|
|-
| ListItem.Progress
| Part of the programme that's been played (PVR).
|
|-
| ListItem.StereoscopicMode
| Returns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta)
|
|-
| ListItem.Comment
| Comment assigned to the item (PVR/MUSIC).
|
|-
| ListItem.AddonInstallDate
| Date the addon was installed
|
|-
| ListItem.AddonLastUpdated
| Date the addon was last updated
|
|-
| ListItem.AddonLastUsed
| Date the addon was used last
|
|-
| ListItem.AddonNews
| Returns a brief changelog, taken from the addons' addon.xml file
|
|-
| ListItem.AddonSize
| Filesize of the addon
|
|-
| ListItem.Contributors
| List of all people who've contributed to the selected song
|
|-
| ListItem.ContributorAndRole
| List of all people and their role who've contributed to the selected song
|
|-
| ListItem.EndTimeResume
| Returns the time a video will end if you resume it, instead of playing it from the beginning.
|
|-
| ListItem.Mood
| Mood of the selected song
|
|-
| ListItem.Status
| For use with tv shows. It can return one of the following: 'returning series','in production','planned','cancelled' or 'ended'
|
|-
| ListItem.Tag
| Will return the name of the 'tag' this movie is part of.
|
|-
| ListItem.Property(Role.Arranger)
| Returns the name of the person who arranged the selected song
|
|-
| ListItem.Property(Role.Composer)
| Returns the name of the person who composed the selected song
|
|-
| ListItem.Property(Role.Conductor)
| Returns the name of the person who conducted the selected song
|
|-
| ListItem.Property(Role.DJMixer)
| Returns the name of the dj who remixed the selected song
|
|-
| ListItem.Property(Role.Engineer)
| Returns the name of the person who was the engineer of the selected song
|
|-
| ListItem.Property(Role.Lyricist)
| Returns the name of the person who wrote the lyrics of the selected song
|
|-
| ListItem.Property(Role.Mixer)
| Returns the name of the person who mixed the selected song
|
|-
| ListItem.Property(Role.Orchestra)
| Returns the name of the orchestra performing the selected song
|
|-
| ListItem.Property(Role.Producer)
| Returns the name of the person who produced the selected song
|
|-
| ListItem.Property(Role.Remixer)
| Returns the name of the person who remixed the selected song
|
|-
| ListItem.Appearances
| Returns the number of movies featuring the selected actor / directed by the selected director
| v17 addition
|-
| ListItem.PrivacyPolicy
| Returns the official Kodi privacy-policy
| v17 addition
|}

=== Musicpartymode labels ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| MusicPartyMode.SongsPlayed
| Number of songs played during Party Mode
|
|-
| MusicPartyMode.MatchingSongs
| Number of songs available to Party Mode
|
|-
| MusicPartyMode.MatchingSongsPicked
| Number of songs picked already for Party Mode
|
|-
| MusicPartyMode.MatchingSongsLeft
| Number of songs left to be picked from for Party Mode
|
|-
| MusicPartyMode.RelaxedSongsPicked
| Not currently used
|
|-
| MusicPartyMode.RandomSongsPicked
| Number of unique random songs picked during Party Mode
|
|}

=== Network labels ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Network.IsDHCP
| Network type is DHCP or FIXED
|
|-
| Network.IPAddress
| The system's IP Address (formatted as IP: <ipaddress>)
|
|-
| Network.LinkState
| Network linkstate e.g. 10mbit/100mbit etc.
|
|-
| Network.MacAddress
| The system's mac address
|
|-
| Network.SubnetMask
| Network subnet mask
|
|-
| Network.GatewayAddress
| Network gateway address
|
|-
| Network.DNS1Address
| Network dns 1 address
|
|-
| Network.DNS2Address
| Network dns 2 address
|
|-
| Network.DHCPAddress
| DHCP ip address
|
|}

=== Player labels ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| 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.Chapter
| Current chapter of current playing media
|
|-
| Player.ChapterCount
| Total number of chapters of current playing media
|
|-
| 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.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.SeekTime
| Time to which the user is seeking
|
|-
| Player.SeekOffset
| Indicates the seek offset after a seek press (eg 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.ProgressCache
| Shows how much of the file is cached above current play percentage
|
|-
| Player.Folderpath
| Shows the full path of the currently playing song or movie
|
|-
| Player.Filenameandpath
| Shows the full path with filename of the currently playing song or movie
|
|-
| 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.Title
| Returns the musicplayer title for audio and the videoplayer title for videos.
|
|-
| Player.Filename
| Returns the filename of the currently playing media.
|
|-
| Player.Process(AudioBitsPerSample)
| Bits per sample of the currently playing item
|
|-
| Player.Process(AudioChannels)
| Number of audiochannels of the currently playing item
|
|-
| 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(VideoFPS)
| Video framerate of the currently playing video
|
|-
| Player.Process(VideoHeight)
| Height of the currently playing video
|
|-
| Player.Process(VideoDecoder)
| Videodecoder name of the currently playing video
|
|-
| Player.Process(VideoWidth)
| Width of the currently playing video
|
|}

==== Music player ====

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| 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.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.Lyrics
| Lyrics of current song stored in ID tag info
|
|-
| 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. eg 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.ChannelNumber
| Channel number of the radio programme that's currently playing (PVR).
|
|-
| MusicPlayer.SubChannelNumber
| Subchannel number of the radio channel 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 Addition
|}

==== Video player ====

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| VideoPlayer.Time
| Current time in movie
|
|-
| VideoPlayer.TimeRemaining
| Current remaining time in movie
|
|-
| VideoPlayer.TimeSpeed
| Current time + playspeed. eg 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
|
|-
| VideoPlayer.TVShowTitle
| Title of currently playing episode's tvshow name
|
|-
| VideoPlayer.Season
| Season number of the currently playing episode, if it's in the database
|
|-
| VideoPlayer.Episode
| Episode number of the currently playing episode
|
|-
| VideoPlayer.Genre
| Genre(s) of current movie, if it's in the database
|
|-
| VideoPlayer.Director
| Director of current movie, if it's in the database
|
|-
| VideoPlayer.Country
| Production country of current movie, if it's in the database
|
|-
| VideoPlayer.Year
| Year of release of current movie, if it's in the database
|
|-
| VideoPlayer.Rating
| IMDb user rating of current movie, if it's in the database
|
|-
| VideoPlayer.UserRating
| Shows the user rating of the currently playing item
|
|-
| VideoPlayer.Votes
| IMDb votes of current movie, if it's in the database
|
|-
| VideoPlayer.RatingAndVotes
| IMDb user rating and votes of current movie, if it's in the database
|
|-
| VideoPlayer.mpaa
| MPAA rating of current movie, if it's in the database
|
|-
| VideoPlayer.IMDBNumber
| The IMDB iD of the current video, if it's in the database
|
|-
| 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 concatenated string of cast members of the current movie, if it's in the database
|
|-
| VideoPlayer.CastAndRole
| A concatenated string of cast members and roles of the current movie, if it's in the database
|
|-
| VideoPlayer.Album
| Album from which the current Music Video is from, if it's in the database
|
|-
| VideoPlayer.Artist
| Artist(s) of current Music Video, if it's in the database
|
|-
| VideoPlayer.Studio
| Studio of current Music Video, if it's in the database
|
|-
| VideoPlayer.Writer
| Name of Writer of current playing Video, if it's in the database
|
|-
| VideoPlayer.Tagline
| Small Summary of current playing Video, if it's in the database
|
|-
| VideoPlayer.PlotOutline
| Small Summary of current playing Video, if it's in the database
|
|-
| VideoPlayer.Plot
| Complete Text Summary of current playing Video, if it's in the database
|
|-
| VideoPlayer.LastPlayed
| Last play date of current playing Video, if it's in the database
|
|- class="userrow
| VideoPlayer.PlayCount
| Playcount of current playing Video, if it's in the database
|
|- class="userrow
| 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.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.ChannelNumber
| Number of the curently tuned channel (PVR).
|
|-
| VideoPlayer.SubChannelNumber
| Subchannel number of the tv channel that's currently playing (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
| v17 Addition
|}

=== Playlist ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! 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 string ID's 590 (Randomize Play Enabled) or 591 (Disabled)
|
|-
| Playlist.Repeat
| Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
|
|}

=== PVR ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Pvr.NowRecordingTitle
| Title of the programme being recorded
|
|-
| Pvr.NowRecordingDateTime
| Start date and time of the current recording
|
|-
| Pvr.NowRecordingChannel
| Channel number that's being recorded
|
|-
| Pvr.NextRecordingTitle
| Title of the next programme that will be recorded
|
|-
| Pvr.NextRecordingDateTime
| Start date and time of the next recording
|
|-
| Pvr.NextRecordingChannel
| Channel name of the next recording
|
|-
| Pvr.BackendName
| Name of the backend being used
|
|-
| Pvr.BackendVersion
| Version of the backend that's being used
|
|-
| Pvr.BackendHost
| Backend hostname
|
|-
| Pvr.BackendDiskSpace
| Available diskspace on the backend
|
|-
| Pvr.BackendChannels
| Number of available channels the backend provides
|
|-
| Pvr.BackendTimers
| Number of timers set for the backend
|
|-
| Pvr.BackendRecordings
| Number of recording available on the backend
|
|-
| Pvr.BackendDiskspace
| Free diskspace available for recordings on the backend
|
|-
| Pvr.BackendNumber
| Backend number
|
|-
| Pvr.TotalDiscSpace
| Total diskspace available for recordings
|
|-
| Pvr.NextTimer
| Next timer date
|
|-
| Pvr.Duration
| Returns the duration of the currently played title on TV
|
|-
| Pvr.Time
| Returns the time position of the currently played title on TV
|
|-
| Pvr.Progress
| Returns the position of currently played title on TV as integer
|
|-
| Pvr.TimeShiftStart
| Start position of the timeshift
|
|-
| Pvr.TimeShiftEnd
| End position of the timeshift
|
|-
| Pvr.TimeShiftCur
| Current position of the timeshift
|
|-
| Pvr.TimeShiftProgress
| Returns the position of currently timeshifted title on TV as interger
|
|-
| Pvr.ActStreamClient
| Stream client name
|
|-
| Pvr.ActStreamDevice
| Stream device name
|
|-
| Pvr.ActStreamStatus
| Status of the stream
|
|-
| Pvr.ActStreamSignal
| Signal quality of the stream
|
|-
| Pvr.ActStreamSnr
| Signal to noise ratio of the stream
|
|-
| Pvr.ActStreamBer
| Bit error rate of the stream
|
|-
| Pvr.ActStreamUnc
| UNC value of the stream
|
|-
| Pvr.ActStreamVideoBitRate
| Video bitrate of the stream
|
|-
| Pvr.ActStreamAudioBitRate
| Audio bitrate of the stream
|
|-
| Pvr.ActStreamDolbyBitRate
| Dolby bitrate of the stream
|
|-
| Pvr.ActStreamProgrSignal
| Signal quality of the programme
|
|-
| Pvr.ActStreamProgrSnr
| Signal to noise ratio of the programme
|
|-
| Pvr.ActStreamEncryptionName
| Encryption used on the stream
|
|-
| Pvr.TVNowRecordingTitle
| Title of the tv programme being recorded
| {{nowrap|v17 Addition}}
|-
| Pvr.TVNowRecordingDateTime
| Start date and time of the current tv recording
| {{nowrap|v17 Addition}}
|-
| Pvr.TVNowRecordingChannel
| Channel name of the current tv recording
| {{nowrap|v17 Addition}}
|-
| Pvr.TVNowRecordingChannelIcon
| Icon of the current recording TV channel
| {{nowrap|v17 Addition}}
|-
| Pvr.TVNextRecordingTitle
| Title of the next tv programme that will be recorded
| {{nowrap|v17 Addition}}
|-
| Pvr.TVNextRecordingDateTime
| Start date and time of the next tv recording
| {{nowrap|v17 Addition}}
|-
| Pvr.TVNextRecordingChannel
| Channel name of the next tv recording
| {{nowrap|v17 Addition}}
|-
| Pvr.TVNextRecordingChannelIcon
| Icon of the next recording tv channel
| {{nowrap|v17 Addition}}
|-
| Pvr.RadioNowRecordingTitle
| Title of the radio programme being recorded
| {{nowrap|v17 Addition}}
|-
| Pvr.RadioNowRecordingDateTime
| Start date and time of the current radio recording
| {{nowrap|v17 Addition}}
|-
| Pvr.RadioNowRecordingChannel
| Channel name of the current radio recording
| {{nowrap|v17 Addition}}
|-
| Pvr.RadioNowRecordingChannelIcon
| Icon of the current recording radio channel
| {{nowrap|v17 Addition}}
|-
| Pvr.RadioNextRecordingTitle
| Title of the next radio programme that will be recorded
| {{nowrap|v17 Addition}}
|-
| Pvr.RadioNextRecordingDateTime
| Start date and time of the next radio recording
| {{nowrap|v17 Addition}}
|-
| Pvr.RadioNextRecordingChannel
| Channel name of the next radio recording
| {{nowrap|v17 Addition}}
|}

=== RDS ===
{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| RDS.AudioLanguage
| The from RDS reported audio language of channel
|
|-
| RDS.ChannelCountry
| Country where the radio channel is sended
|
|-
| RDS.GetLine(number)
| Returns the last sended RDS text messages on givern number, 0 is thelast and 4 rows are supported (0-3)
|
|-
| RDS.Title
| Title of item; e.g. track title of an album (Only be available on RadiotextPlus)
|
|-
| RDS.Artist
| A person or band/collective generally considered responsible for the work (Only be available on RadiotextPlus)
|
|-
| RDS.Band
| Band/orchestra/accompaniment/musician (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.Album
| The collection name to which this track belongs (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)
|
|-
| RDS.RadioStyle
| The from radio channel used style of currently played part, e.g "popmusic", "news" or "weather"
|
|-
| RDS.Comment
| Radio station comment string if available (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.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.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.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.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.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.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.ProgStation
| Name of the radio channel@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.ProgNext
| Next played program name (if available)@note becomes also be set from epg if from RDS not available
|
|-
| RDS.ProgHost
| Name of the host of the radio show
|
|-
| 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.ProgStyle
| Human readable string about radiostyle defined from RDS or RBDS
|
|-
| 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.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.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)
|
|}

=== Skin ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Skin.CurrentTheme
| Returns the current selected skin theme.
|
|-
| Skin.CurrentColourTheme
| Returns the current selected colour theme of the skin.
|
|-
| Skin.String(name)
| 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.
|
|-
| Skin.AspectRatio
| Returns the closest aspect ratio match using the resolution info from the skin's addon.xml file.
|}

=== Slideshow ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! 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 ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| 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.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.AlarmPos
| Shutdown Timer position
|
|-
| System.BatteryLevel
| Returns the remaining battery level in range 0-100
|
|-
| System.FreeSpace
| Total Freespace on the drive
|
|-
| System.UsedSpace
| Total Usedspace on the drive
|
|-
| System.TotalSpace
| Totalspace on the drive
|
|-
| System.UsedSpacePercent
| Total Usedspace Percent on the drive
|
|-
| System.FreeSpacePercent
| Total Freespace Percent on the drive
|
|-
| System.CPUTemperature
| Current CPU temperature
|
|-
| System.CpuUsage
| Displays the cpu usage for each individual cpu core.
|
|-
| System.CoreUsage(id)
| Displays the usage of the cpu core with the given 'id'
|
|-
| System.GPUTemperature
| Current GPU temperature
|
|-
| System.FanSpeed
| Current fan speed
|
|-
| System.BuildVersion
| Version of build
|
|-
| System.BuildDate
| Date of build
|
|-
| System.FriendlyName
| Returns the Kodi instance name. It will auto append (%hostname%) in case the device name was not changed. eg. "Kodi (htpc)"
|
|-
| System.FPS
| Current rendering speed (frames per second)
|
|-
| System.FreeMemory
| Amount of free memory in Mb
|
|-
| System.Memory(format)
| Available formats: used, used.percent, free, free.percent, total
|
|-
| System.ScreenMode
| Screenmode (eg windowed / fullscreen)
|
|-
| System.ScreenWidth
| Width of screen in pixels
|
|-
| System.ScreenHeight
| Height of screen in pixels
|
|-
| System.StartupWindow
| The Window Kodi will load on startup
|
|-
| System.CurrentWindow
| Current Window we are in
|
|-
| System.CurrentControl
| Current focused control
|
|-
| System.DVDLabel
| Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|
|-
| System.HddTemperature
| Hdd temperature
|
|-
| System.KernelVersion
| System kernel version
|
|-
| System.Uptime
| System current uptime
|
|-
| System.TotalUptime
| System total uptime
|
|-
| System.CpuFrequency
| System cpu frequency
|
|-
| System.ScreenResolution
| Screen resolution
|
|-
| System.VideoEncoderInfo
| Video encoder info
|
|-
| System.InternetState
| Will return the internet state, connected or not connected
and for Conditional use: Connected->TRUE, not Connected->FALSE, do not use to check status in a pythonscript since it is threaded.
|
|-
| System.Language
| Shows the current language
|
|-
| System.GetBool(boolean)
| Returns the value of any standard system boolean setting. Will not work with settings in advancedsettings.xml
|
|-
| System.ProfileName
| Shows the User name of the currently logged in Kodi user
|
|-
| System.ProfileCount
| Shows the number of defined profiles
|
|-
| System.ProfileAutoLogin
| The profile Kodi will auto login to
|
|-
| System.StereoscopicMode
| The prefered stereoscopic mode (settings > video > playback)
|
|-
| System.TemperatureUnits
| Shows Celsius or Fahrenheit symbol
|
|-
| System.AddonTitle(id)
| Returns the title of the addon with the given id
|
|-
| System.AddonVersion(id)
| Returns the version of the addon with the given id
|}

=== Visualisation ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Visualisation.Preset
| Shows the current preset of the visualisation.
|
|-
| Visualisation.Name
| Shows the name of the visualisation.
|
|}

=== Weather labels ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Weather.Conditions
| Current weather conditions – this is looked up in a background process.
|
|-
| Weather.Temperature
| Current weather temperature
|
|-
| Weather.Location
| City/town which the above two items are for
|
|-
| Weather.fanartcode
| Current weather fanartcode.
|
|-
| Weather.plugin
| Current weather plugin.
|
|}

=== Window ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Window([window]).Property(key)
| Window property. (key can be any value, optional window can be id or name)
|
|-
| Window.Property(xmlfile)
| Displays the name of the xml file currently shown
|
|-
| Window(AddonBrowser).Property(Updated)
| Shows the date and time the addon repo was last checked for updates
|
|-
| Window.Property(Addon.ID)
| Returns the id of the selected addon, in DialogAddonSettings.xml
|
|-
| Window(Home).Property(key)
| The home window has the following info labels.
Movies.Count, Movies.Watched, Movies.UnWatched, TVShows.Count, TVShows.Watched, TVShows.UnWatched, Episodes.Count, Episodes.Watched, Episodes.UnWatched, MusicVideos.Count, MusicVideos.Watched, MusicVideos.UnWatched, Music.SongsCount, Music.AlbumsCount, Music.ArtistsCount

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

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

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

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

LatestAlbum.[1-10].Title, LatestAlbum.[1-10].Artist, LatestAlbum.[1-10].Year, LatestAlbum.[1-10].Rating, LatestAlbum.[1-10].Thumb, LatestAlbum.[1-10].Fanart, LatestAlbum.[1-10].Path
|
|-
| Window(Weather).Property(key)
| The weather window has the following info labels.
Location, Updated, Current.Condition, Current.Temperature, Current.FeelsLike, Current.UVIndex, Current.Wind (From <wind dir.> at <speed> <unit>), Current.WindSpeed, Current.WindDirection, Current.DewPoint, Current.Humidity, Day[0-6].Title, Day[0-6].HighTemp, Day[0-6].LowTemp, Day[0-6].Outlook, WeatherProvider

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

=== Images Available in Kodi ===

{| class="prettytable" width="100%"
! InfoLabels
! style="80%" | Definition
! Version
|-
| Container.Art(tvshow.fanart)
| Fanart Image of the parent TV show
|
|-
| Container.Art(season.poster)
| Thumbnail Image of the parent season
|
|-
| Container.Art(artist.fanart)
| Fanart Image of the parent album artist
|
|-
| Container.Art(artist.thumb)
| Thumbnail Image of the parent album artist
|
|-
| Fanart.Image
| Fanart image for the parent TV Show
|
|-
| 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).
|
|-
| 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 icon.
|
|-
| ListItem.ActualIcon
| Shows the icon of the currently selected item in a list or thumb control.
|
|-
| ListItem.Art(clearart)
| Returns the clearart (if it exists) of the currently selected movie or tv show.
|
|-
| ListItem.Art(clearlogo)
| Returns the clearlogo (if it exists) of the currently selected movie or tv show.
|
|-
| ListItem.Art(thumb)
| Returns the thumbnail of the currently selected item.
|
|-
| ListItem.Art(poster)
| Returns the poster of the currently selected movie or tv show.
|
|-
| ListItem.Art(banner)
| Returns the banner of the currently selected tv show.
|
|-
| ListItem.Art(fanart)
| Returns the fanart image of the currently selected item.
|
|-
| ListItem.Art(set.fanart)
| Returns the fanart image of the currently selected movieset.
|
|-
| ListItem.Art(landscape)
| Returns the landscape art of the currently selected item.
|
|-
| ListItem.Art(tvshow.poster)
| Returns the tv show poster of the parent container.
|
|-
| ListItem.Art(tvshow.banner)
| Returns the tv show banner of the parent container.
|
|-
| ListItem.Art(season.poster)
| Returns the season poster of the currently selected season. (Only available in DialogVideoInfo.xml)
|
|-
| ListItem.Art(season.banner)
| Returns the season banner of the currently selected season. (Only available in DialogVideoInfo.xml)
|
|-
| ListItem.Art(season.fanart)
| Returns the fanart image of the currently selected season. (Only available in DialogVideoInfo.xml)
|
|-
| 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(ArtistThumb)
| Thumbnail Image of the parent artist, for use in dialogalbuminfo.xml and dialogsonginfo.xml
|
|-
| ListItem.Property(Addon.StarRating)
| Returns a value of rating0.png to rating5.png for the currently selected addon
|
|-
| ListItem.Property(Fanart_Image)
| Fanart Image currently selected item or of the parent TV show
|
|-
| ListItem.Property(SeasonThumb)
| Thumbnail Image of the parent TV show season, for use in dialogvideoinfo.xml
|
|-
| ListItem.Property(TVShowThumb)
| Thumbnail Image of the parent TV show, for use in dialogvideoinfo.xml (available anywhere)
|
|-
| MusicPlayer.Cover
| Cover of currently playing album
|
|-
| MusicPlayer.Property(Fanart_Image)
| Fanart image of the currently playing artist
|
|-
| Player.Art(fanart)
| Fanart Image of the currently playing episode's parent TV show
|
|-
| Player.Art(thumb)
| Returns the thumbnail image of the currently playing item.
|
|-
| Player.Art(poster)
| Returns the poster of the currently playing movie.
|
|-
| Player.Art(tvshow.poster)
| Returns the tv show poster of the currently playing episode's parent TV show.
|
|-
| Player.Art(tvshow.banner)
| Returns the tv show banner of the currently playing episode's parent TV show.
|
|-
| 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.NowRecordingChannelIcon
| Channel icon of the programme currently being recorded.
|
|-
| Pvr.NextRecordingChannelIcon
| Channel icon of the programme that will be recorded next.
|
|-
| 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 <span class="nobr">user-customisable</span> 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 (eg. $INFO[Skin.String(Foo)])
|
|-
| System.ProfileThumb
| Shows the Thumbnail image of the currently logged in Kodi user
|
|-
| VideoPlayer.Cover
| Cover of currently playing movie
|
|-
| Weather.Conditions
| Image of current weather conditions (NOTE: Can be used to load/refresh weather conditions)
|
|-
| Window([window]).Property(key)
| Window property. (key can be any value, optional window can be id or name)
|
|-
| 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
|
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]
[[Category:Add-on development]]