Labels | Type | Description |
Player.HasAudio | boolean | - Returns
- True if the player has an audio file.
|
Player.HasGame | boolean | - Returns
- True if the player has a game file (RETROPLAYER).
- v18 Skinning engine changes:
- [New Boolean Condition]
Player.HasGame
|
Player.HasMedia | boolean | - Returns
- True if the player has an audio or video file.
|
Player.HasVideo | boolean | - Returns
- True if the player has a video file.
|
Player.Paused | boolean | - Returns
- True if the player is paused.
|
Player.Playing | boolean | - Returns
- True if the player is currently playing (i.e. not ffwding, rewinding or paused.)
|
Player.Rewinding | boolean | - Returns
- True if the player is rewinding.
|
Player.Rewinding2x | boolean | - Returns
- True if the player is rewinding at 2x.
|
Player.Rewinding4x | boolean | - Returns
- True if the player is rewinding at 4x.
|
Player.Rewinding8x | boolean | - Returns
- True if the player is rewinding at 8x.
|
Player.Rewinding16x | boolean | - Returns
- True if the player is rewinding at 16x.
|
Player.Rewinding32x | boolean | - Returns
- True if the player is rewinding at 32x.
|
Player.Forwarding | boolean | - Returns
- True if the player is fast forwarding.
|
Player.Forwarding2x | boolean | - Returns
- True if the player is fast forwarding at 2x.
|
Player.Forwarding4x | boolean | - Returns
- True if the player is fast forwarding at 4x.
|
Player.Forwarding8x | boolean | - Returns
- True if the player is fast forwarding at 8x.
|
Player.Forwarding16x | boolean | - Returns
- True if the player is fast forwarding at 16x.
|
Player.Forwarding32x | boolean | - Returns
- True if the player is fast forwarding at 32x.
|
Player.Caching | boolean | - Returns
- True if the player is current re-caching data (internet based video playback).
|
Player.DisplayAfterSeek | boolean | - Returns
- True for the first 2.5 seconds after a seek.
|
Player.Seekbar | integer | - Returns
- The percentage of one seek to other position.
|
Player.Seeking | boolean | - Returns
- True if a seek is in progress.
|
Player.ShowTime | boolean | - Returns
- True if the user has requested the time to show (occurs in video fullscreen).
|
Player.ShowInfo | boolean | - Returns
- True if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow).
|
Player.Title | string | - Returns
- The Musicplayer title for audio and the Videoplayer title for video.
|
Player.Muted | boolean | - Returns
- True if the volume is muted.
|
Player.HasDuration | boolean | - Returns
- True if Media is not a true stream.
|
Player.Passthrough | boolean | - Returns
- True if the player is using audio passthrough.
|
Player.CacheLevel | string | - Returns
- The used cache level as a string with an integer number.
|
Player.Progress | integer | - Returns
- The progress position as percentage.
|
Player.ProgressCache | integer | - Returns
- How much of the file is cached above current play percentage
|
Player.Volume | string | - Returns
- The current player volume with the format
%2.1f dB
|
Player.SubtitleDelay | string | - Returns
- The used subtitle delay with the format
%2.3f s
|
Player.AudioDelay | string | - Returns
- The used audio delay with the format
%2.3f s
|
Player.Chapter | integer | - Returns
- The current chapter of current playing media.
|
Player.ChapterCount | integer | - Returns
- The total number of chapters of current playing media.
|
Player.ChapterName | string | - Returns
- The name of currently used chapter if available.
|
Player.Folderpath | string | - Returns
- The full path of the currently playing song or movie
|
Player.FilenameAndPath | string | - Returns
- The full path with filename of the currently playing song or movie
|
Player.Filename | string | - Returns
- The filename of the currently playing media.
- v13 Skinning engine changes:
- [New Infolabel]
Player.Filename
|
Player.IsInternetStream | boolean | - Returns
- True if the player is playing an internet stream.
|
Player.PauseEnabled | boolean | - Returns
- True if played stream is paused.
|
Player.SeekEnabled | boolean | - Returns
- True if seek on playing is enabled.
|
Player.ChannelPreviewActive | boolean | - Returns
- True if PVR channel preview is active (used channel tag different from played tag)
|
Player.TempoEnabled | boolean | - Returns
- True if player supports tempo (i.e. speed up/down normal playback speed)
- v17 Skinning engine changes:
- [New Boolean Condition]
Player.TempoEnabled
|
Player.IsTempo | boolean | - Returns
- True if player has tempo (i.e. is playing with a playback speed higher or lower than normal playback speed)
- v17 Skinning engine changes:
- [New Boolean Condition]
Player.IsTempo
|
Player.PlaySpeed | string | - Returns
- The player playback speed with the format
%1.2f (1.00 means normal playback speed).
- Note
- For Tempo, the default range is 0.80 - 1.50 (it can be changed in advanced settings). If Player.PlaySpeed returns a value different from 1.00 and Player.IsTempo is false it means the player is in ff/rw mode.
|
Player.HasResolutions | boolean | - Returns
- True if the player is allowed to switch resolution and refresh rate (i.e. if whitelist modes are configured in Kodi's System/Display settings)
- v18 Skinning engine changes:
- [New Boolean Condition]
Player.HasResolutions
|
Player.HasPrograms | boolean | - Returns
- True if the media file being played has programs, i.e. groups of streams.
- Note
- Ex: if a media file has multiple streams (quality, channels, etc) a program represents a particular stream combo.
|
Player.FrameAdvance | boolean | - Returns
- True if player is in frame advance mode.
- Note
- Skins should hide seek bar in this mode
- v18 Skinning engine changes:
- [New Boolean Condition]
Player.FrameAdvance
|
Player.Icon | string | - Returns
- The thumbnail of the currently playing item. If no thumbnail image exists, the icon will be returned, if available.
- v18 Skinning engine changes:
- [New Infolabel]
Player.Icon
|
Player.Art(type) | string | - Returns
- The Image for the defined art type for the current playing ListItem.
- Parameters
-
type | - The art type. The type is defined by scripts and scrappers and can have any value. Common example values for type are:
- fanart
- thumb
- poster
- banner
- clearlogo
- tvshow.poster
- tvshow.banner
- etc
|
- Todo:
- get a way of centralize all random art strings used in core so we can point users to them while still making it clear they can have any value.
|
Player.SeekTime | string | - Returns
- The time to which the user is seeking.
|
Player.SeekOffset([format]) | string | - Returns
- The seek offset after a seek press in a given format.
- Parameters
-
format | [opt] The format of the return time value. See TIME_FORMAT for the list of possible values. |
- Note
- Example: user presses BigStepForward, player.seekoffset returns +10:00
|
Player.SeekStepSize | string | - Returns
- The seek step size.
- v15 Skinning engine changes:
- [New Infolabel]
Player.SeekStepSize
|
Player.TimeRemaining([format]) | string | - Returns
- The remaining time of current playing media in a given format.
- Parameters
-
format | [opt] The format of the return time value. See TIME_FORMAT for the list of possible values. |
|
Player.TimeSpeed | string | - Returns
- The time and the playspeed formatted: "1:23 (2x)".
|
Player.Time([format]) | string | - Returns
- The elapsed time of current playing media in a given format.
- Parameters
-
format | [opt] The format of the return time value. See TIME_FORMAT for the list of possible values. |
|
Player.Duration([format]) | string | - Returns
- The total duration of the current playing media in a given format.
- Parameters
-
format | [opt] The format of the return time value. See TIME_FORMAT for the list of possible values. |
|
Player.FinishTime([format]) | string | - Returns
- The time at which the playing media will end (in a specified format).
- Parameters
-
format | [opt] The format of the return time value. See TIME_FORMAT for the list of possible values. |
|
Player.StartTime([format]) | string | - Returns
- The time at which the playing media began (in a specified format).
- Parameters
-
format | [opt] The format of the return time value. See TIME_FORMAT for the list of possible values. |
|
Player.SeekNumeric([format]) | string | - Returns
- The time at which the playing media began (in a specified format).
- Parameters
-
format | [opt] The format of the return time value. See TIME_FORMAT for the list of possible values. |
|
Player.Process(videohwdecoder) | boolean | - Returns
- True if the currently playing video is decoded in hardware.
- v17 Skinning engine changes:
- [New Boolean Condition]
Player.Process(videohwdecoder)
|
Player.Process(videodecoder) | string | - Returns
- The videodecoder name of the currently playing video.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(videodecoder)
|
Player.Process(deintmethod) | string | - Returns
- The deinterlace method of the currently playing video.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(deintmethod)
|
Player.Process(pixformat) | string | - Returns
- The pixel format of the currently playing video.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(pixformat)
|
Player.Process(videowidth) | string | - Returns
- The width of the currently playing video.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(videowidth)
|
Player.Process(videoheight) | string | - Returns
- The width of the currently playing video.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(videoheight)
|
Player.Process(videofps) | string | - Returns
- The video framerate of the currently playing video.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(videofps)
|
Player.Process(videodar) | string | - Returns
- The display aspect ratio of the currently playing video.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(videodar)
|
Player.Process(audiodecoder) | string | - Returns
- The audiodecoder name of the currently playing item.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(audiodecoder)
|
Player.Process(audiochannels) | string | - Returns
- The audiodecoder name of the currently playing item.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(audiochannels)
|
Player.Process(audiosamplerate) | string | - Returns
- The samplerate of the currently playing item.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(audiosamplerate)
|
Player.Process(audiobitspersample) | string | - Returns
- The bits per sample of the currently playing item.
- v17 Skinning engine changes:
- [New Infolabel]
Player.Process(audiobitspersample)
|
Labels | Type | Description |
System.AlarmLessOrEqual(alarmname,seconds) | boolean | - Returns
- True if the alarm with
alarmname has less or equal to seconds left.
- Parameters
-
alarmname | - The name of the alarm. It can be one of the following:
|
seconds | - Time in seconds to compare with the alarm trigger event |
- Note
- Example:
System.Alarmlessorequal(shutdowntimer,119) , will return true when the shutdowntimer has less then 2 minutes left.
|
System.HasNetwork | boolean | - Returns
- True if the Kodi host has a network available.
|
System.HasMediadvd | boolean | - Returns
- True if there is a CD or DVD in the DVD-ROM drive.
|
System.HasMediaAudioCD | boolean | - Returns
- True if there is an audio CD in the optical drive. False if no drive available, empty drive or other medium.
- v18 Skinning engine changes:
- [New Boolean Condition]
System.HasMediaAudioCD
|
System.DVDReady | boolean | - Returns
- True if the disc is ready to use.
|
System.TrayOpen | boolean | - Returns
- True if the disc tray is open.
|
System.HasLocks | boolean | - Returns
- True if the system has an active lock mode.
|
System.IsMaster | boolean | - Returns
- True if the system is in master mode.
|
System.ShowExitButton | boolean | - Returns
- True if the exit button should be shown (configurable via advanced settings).
|
System.DPMSActive | boolean | - Returns
- True if DPMS (VESA Display Power Management Signaling) mode is active.
|
System.IsStandalone | boolean | - Returns
- True if Kodi is running in standalone mode.
|
System.IsFullscreen | boolean | - Returns
- True if Kodi is running fullscreen.
|
System.LoggedOn | boolean | - Returns
- True if a user is currently logged on under a profile.
|
System.HasLoginScreen | boolean | - Returns
- True if the profile login screen is enabled.
|
System.HasPVR | boolean | - Returns
- True if PVR is supported from Kodi.
- Note
- normally always true
|
System.HasPVRAddon | boolean | - Returns
- True if at least one pvr client addon is installed and enabled.
- Parameters
-
id | - addon id of the PVR addon |
- v17 Skinning engine changes:
- [New Boolean Condition]
System.HasPVRAddon
|
System.HasCMS | boolean | - Returns
- True if colour management is supported from Kodi.
- Note
- currently only supported for OpenGL
- v17 Skinning engine changes:
- [New Boolean Condition]
System.HasCMS
|
System.HasActiveModalDialog | boolean | - Returns
- True if a modal dialog is active.
- v18 Skinning engine changes:
- [New Boolean Condition]
System.HasActiveModalDialog
|
System.HasVisibleModalDialog | boolean | - Returns
- True if a modal dialog is visible.
- v18 Skinning engine changes:
- [New Boolean Condition]
System.HasVisibleModalDialog
|
System.Platform.Linux | boolean | - Returns
- True if Kodi is running on a linux/unix based computer.
|
System.Platform.Linux.RaspberryPi | boolean | - Returns
- True if Kodi is running on a Raspberry Pi.
- v13 Skinning engine changes:
- [New Boolean Condition]
System.Platform.Linux.RaspberryPi
|
System.Platform.Windows | boolean | - Returns
- True if Kodi is running on a windows based computer.
|
System.Platform.UWP | boolean | - Returns
- True if Kodi is running on Universal Windows Platform (UWP).
- v18 Skinning engine changes:
- [New Boolean Condition]
System.Platform.UWP
|
System.Platform.OSX | boolean | - Returns
- True if Kodi is running on an OSX based computer.
|
System.Platform.IOS | boolean | - Returns
- True if Kodi is running on an IOS device.
|
System.Platform.Darwin | boolean | - Returns
- True if Kodi is running on an OSX or IOS system.
|
System.Platform.Android | boolean | - Returns
- True if Kodi is running on an android device.
|
System.CanPowerDown | boolean | - Returns
- True if Kodi can powerdown the system.
|
System.CanSuspend | boolean | - Returns
- True if Kodi can suspend the system.
|
System.CanHibernate | boolean | - Returns
- True if Kodi can hibernate the system.
|
System.HasHiddenInput | boolean | - Returns
- True when to osd keyboard/numeric dialog requests a password/pincode.
- v16 Skinning engine changes:
- [New Boolean Condition]
System.HasHiddenInput
|
System.CanReboot | boolean | - Returns
- True if Kodi can reboot the system.
|
System.ScreenSaverActive | boolean | - Returns
- True if ScreenSaver is active.
|
System.IsInhibit | boolean | - Returns
- True when shutdown on idle is disabled.
|
System.HasShutdown | boolean | - Returns
- True when shutdown on idle is enabled.
|
System.Time | string | - Returns
- The current time.
|
System.Time(format) | string | - Returns
- The current time in a specified format.
- Parameters
-
format | [opt] The format of the return time value. See TIME_FORMAT for the list of possible values. |
|
System.Time(startTime[,endTime]) | boolean | - Returns
- True if the current system time is >=
startTime and < endTime (if defined).
- Parameters
-
startTime | - Start time |
endTime | - [opt] End time |
- Note
- Time must be specified in the format HH:mm, using a 24 hour clock.
|
System.Date | string | - Returns
- The current date.
- v16 Skinning engine changes:
- [Infolabel Updated]
System.Date will now return the full day and month names. old: sat, jul 18 2015 new: saturday, july 18 2015
|
System.Date(format) | string | - Returns
- The current date using a specified format.
- Parameters
-
format | - the format for the date. It can be one of the following values:
- d - day of month (1-31)
- dd - day of month (01-31)
- ddd - short day of the week Mon-Sun
- DDD - long day of the week Monday-Sunday
- m - month (1-12)
- mm - month (01-12)
- mmm - short month name Jan-Dec
- MMM - long month name January-December
- yy - 2-digit year
- yyyy - 4-digit year
|
|
System.Date(startDate[,endDate]) | boolean | - Returns
- True if the current system date is >=
startDate and < endDate (if defined).
- Parameters
-
startDate | - The start date |
endDate | - [opt] The end date |
- Note
- Date must be specified in the format MM-DD or YY-MM-DD.
|
System.AlarmPos | string | - Returns
- The shutdown Timer position.
|
System.BatteryLevel | string | - Returns
- The remaining battery level in range 0-100.
|
System.FreeSpace | string | - Returns
- The total Freespace on the drive.
|
System.UsedSpace | string | - Returns
- The total Usedspace on the drive.
|
System.TotalSpace | string | - Returns
- The total space on the drive.
|
System.UsedSpacePercent | string | - Returns
- The total Usedspace Percent on the drive.
|
System.FreeSpacePercent | string | - Returns
- The total Freespace Percent on the drive.
|
System.CPUTemperature | string | - Returns
- The current CPU temperature.
|
System.CpuUsage | string | - Returns
- The the cpu usage for each individual cpu core.
|
System.GPUTemperature | string | - Returns
- The current GPU temperature.
|
System.FanSpeed | string | - Returns
- The current fan speed.
|
System.BuildVersion | string | - Returns
- The version of build.
|
System.BuildVersionShort | string | - Returns
- The shorter string with version of build.
|
System.BuildDate | string | - Returns
- The date of build.
|
System.FriendlyName | string | - Returns
- The Kodi instance name.
- Note
- It will auto append (hostname%) in case the device name was not changed. eg. "Kodi (htpc)"
|
System.FPS | string | - Returns
- The current rendering speed (frames per second).
|
System.FreeMemory | string | - Returns
- The amount of free memory in Mb.
|
System.ScreenMode | string | - Returns
- The screenmode (eg windowed / fullscreen).
|
System.ScreenWidth | string | - Returns
- The width of screen in pixels.
|
System.ScreenHeight | string | - Returns
- The height of screen in pixels.
|
System.StartupWindow | string | - Returns
- The Window Kodi will load on startup.
- v13 Skinning engine changes:
- [New Infolabel]
System.StartupWindow
|
System.CurrentWindow | string | - Returns
- The current Window in use.
|
System.CurrentControl | string | - Returns
- The current focused control
|
System.CurrentControlId | string | - Returns
- The ID of the currently focused control.
|
System.DVDLabel | string | - Returns
- the label of the disk in the DVD-ROM drive.
|
System.KernelVersion | string | - Returns
- The System kernel version.
|
System.OSVersionInfo | string | - Returns
- The system name + kernel version.
|
System.Uptime | string | - Returns
- The system current uptime.
|
System.TotalUptime | string | - Returns
- The system total uptime.
|
System.CpuFrequency | string | - Returns
- The system cpu frequency.
|
System.ScreenResolution | string | - Returns
- The screen resolution.
|
System.VideoEncoderInfo | string | - Returns
- The video encoder info.
|
System.InternetState | string | - Returns
- The internet state: connected or not connected.
- Warning
- Do not use to check status in a pythonscript since it is threaded.
|
System.Language | string | - Returns
- the current language.
|
System.ProfileName | string | - Returns
- The user name of the currently logged in Kodi user
|
System.ProfileThumb | string | - Returns
- The thumbnail image of the currently logged in Kodi user
|
System.ProfileCount | string | - Returns
- The number of defined profiles.
|
System.ProfileAutoLogin | string | - Returns
- The profile Kodi will auto login to.
- v13 Skinning engine changes:
- [New Infolabel]
System.ProfileAutoLogin
|
System.StereoscopicMode | string | - Returns
- The prefered stereoscopic mode.
- Note
- Configured in settings > video > playback).
- v13 Skinning engine changes:
- [New Infolabel]
System.StereoscopicMode
|
System.TemperatureUnits | string | - Returns
- the Celsius or the Fahrenheit symbol.
|
System.Progressbar | string | - Returns
- The percentage of the currently active progress.
|
System.GetBool(boolean) | string | - Returns
- The value of any standard system boolean setting.
- Note
- Will not work with settings in advancedsettings.xml
|
System.Memory(type) | string | - Returns
- The memory value depending on the requested type.
- Parameters
-
type | - Can be one of the following:
- free
- free.percent
- used
- used.percent
- total
|
|
System.AddonTitle(id) | string | - Returns
- The title of the addon with the given id
- Parameters
-
|
System.AddonVersion(id) | string | - Returns
- The version of the addon with the given id.
- Parameters
-
- v13 Skinning engine changes:
- [New Infolabel]
System.AddonVersion(id)
|
System.AddonIcon(id) | string | - Returns
- The icon of the addon with the given id.
- Parameters
-
|
System.IdleTime(time) | boolean | - Returns
- True if Kodi has had no input for
time amount of seconds.
- Parameters
-
time | - elapsed seconds to check for idle activity. |
|
System.PrivacyPolicy | string | - Returns
- The official Kodi privacy policy.
- v17 Skinning engine changes:
- [New Infolabel]
System.PrivacyPolicy
|
System.HasAddon(id) | boolean | - Returns
- True if the specified addon is installed on the system.
- Parameters
-
|
System.HasCoreId(id) | boolean | - Returns
- True if the CPU core with the given 'id' exists.
- Parameters
-
id | - the id of the CPU core |
|
System.HasAlarm(alarm) | boolean | - Returns
- True if the system has the
alarm alarm set.
- Parameters
-
alarm | - the name of the alarm |
|
System.CoreUsage(id) | string | - Returns
- the usage of the CPU core with the given 'id'
- Parameters
-
id | - the id of the CPU core |
|
System.Setting(hidewatched) | boolean | - Returns
- True if 'hide watched items' is selected.
|
Labels | Type | Description |
MusicPlayer.Offset(number).Exists | boolean | - Returns
- True if the music players playlist has a song queued in position (number).
- Parameters
-
|
MusicPlayer.Title | string | - Returns
- The title of the currently playing song.
|
MusicPlayer.offset(number).Title | string | - Returns
- The title of the song which has an offset
number with respect to the current playing song.
- Parameters
-
number | - the offset number with respect to the current playing song |
|
MusicPlayer.Position(number).Title | string | - Returns
- The title of the song which as an offset
number with respect to the start of the playlist.
- Parameters
-
number | - the offset number with respect to the start of the playlist |
|
MusicPlayer.Album | string | - Returns
- The album from which the current song is from.
|
MusicPlayer.offset(number).Album | string | - Returns
- The album from which the song with offset
number with respect to the current song is from.
- Parameters
-
number | - the offset number with respect to the current playing song |
|
MusicPlayer.Position(number).Album | string | - Returns
- The album from which the song with offset
number with respect to the start of the playlist is from.
- Parameters
-
number | - the offset number with respect to the start of the playlist |
|
MusicPlayer.Property(Album_Mood) | string | - Returns
- The moods of the currently playing Album
|
MusicPlayer.Property(Role.Composer) | string | - Returns
- The name of the person who composed the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.Composer)
|
MusicPlayer.Property(Role.Conductor) | string | - Returns
- The name of the person who conducted the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.Conductor)
|
MusicPlayer.Property(Role.Orchestra) | string | - Returns
- The name of the orchestra performing the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.Orchestra)
|
MusicPlayer.Property(Role.Lyricist) | string | - Returns
- The name of the person who wrote the lyrics of the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.Lyricist)
|
MusicPlayer.Property(Role.Remixer) | string | - Returns
- The name of the person who remixed the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.Remixer)
|
MusicPlayer.Property(Role.Arranger) | string | - Returns
- The name of the person who arranged the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.Arranger)
|
MusicPlayer.Property(Role.Engineer) | string | - Returns
- The name of the person who was the engineer of the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.Engineer)
|
MusicPlayer.Property(Role.Producer) | string | - Returns
- The name of the person who produced the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.Producer)
|
MusicPlayer.Property(Role.DJMixer) | string | - Returns
- The name of the dj who remixed the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.DJMixer)
|
MusicPlayer.Property(Role.Mixer) | string | - Returns
- The name of the dj who remixed the selected song.
- Todo:
- So maybe rather than a row each have one entry for Role.XXXXX with composer, arranger etc. as listed values
- Note
- MusicPlayer.Property(Role.any_custom_role) also works, where any_custom_role could be an instrument violin or some other production activity e.g. sound engineer. The roles listed (composer, arranger etc.) are standard ones but there are many possible. Music file tagging allows for the musicians and all other people involved in the recording to be added, Kodi will gathers and stores that data, and it is availlable to GUI.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Role.Mixer)
|
MusicPlayer.Property(Album_Mood) | string | - Returns
- the moods of the currently playing Album
|
MusicPlayer.Property(Album_Style) | string | - Returns
- the styles of the currently playing Album.
|
MusicPlayer.Property(Album_Theme) | string | - Returns
- The themes of the currently playing Album
|
MusicPlayer.Property(Album_Type) | string | - Returns
- The album type (e.g. compilation, enhanced, explicit lyrics) of the currently playing album.
|
MusicPlayer.Property(Album_Label) | string | - Returns
- The record label of the currently playing album.
|
MusicPlayer.Property(Album_Description) | string | - Returns
- A review of the currently playing album
|
MusicPlayer.Artist | string | - Returns
- Artist(s) of current song.
|
MusicPlayer.offset(number).Artist | string | - Returns
- Artist(s) of the song which has an offset
number with respect to the current playing song.
- Parameters
-
number | - the offset of the song with respect to the current playing song |
|
MusicPlayer.Position(number).Artist | string | - Returns
- Artist(s) of the song which has an offset
number with respect to the start of the playlist.
- Parameters
-
number | - the offset of the song with respect to the start of the playlist |
|
MusicPlayer.AlbumArtist | string | - Returns
- The album artist of the currently playing song.
|
MusicPlayer.Cover | string | - Returns
- The album cover of currently playing song.
|
MusicPlayer.Property(Artist_Sortname) | string | - Returns
- The sortname of the currently playing Artist.
- v18 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Artist_Sortname)
|
MusicPlayer.Property(Artist_Type) | string | - Returns
- The type of the currently playing Artist - person, group, orchestra, choir etc.
- v18 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Artist_Type)
|
MusicPlayer.Property(Artist_Gender) | string | - Returns
- The gender of the currently playing Artist - male, female, other.
- v18 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Artist_Gender)
|
MusicPlayer.Property(Artist_Disambiguation) | string | - Returns
- A brief description of the currently playing Artist that differentiates them from others with the same name.
- v18 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Property(Artist_Disambiguation)
|
MusicPlayer.Property(Artist_Born) | string | - Returns
- The date of Birth of the currently playing Artist.
|
MusicPlayer.Property(Artist_Died) | string | - Returns
- The date of Death of the currently playing Artist.
|
MusicPlayer.Property(Artist_Formed) | string | - Returns
- The Formation date of the currently playing Artist/Band.
|
MusicPlayer.Property(Artist_Disbanded) | string | - Returns
- The disbanding date of the currently playing Artist/Band.
|
MusicPlayer.Property(Artist_YearsActive) | string | - Returns
- The years the currently Playing artist has been active.
|
MusicPlayer.Property(Artist_Instrument) | string | - Returns
- The instruments played by the currently playing artist.
|
MusicPlayer.Property(Artist_Description) | string | - Returns
- A biography of the currently playing artist.
|
MusicPlayer.Property(Artist_Mood) | string | - Returns
- The moods of the currently playing artist.
|
MusicPlayer.Property(Artist_Style) | string | - Returns
- The styles of the currently playing artist.
|
MusicPlayer.Property(Artist_Genre) | string | - Returns
- The genre of the currently playing artist.
|
MusicPlayer.Genre | string | - Returns
- The genre(s) of current song.
|
MusicPlayer.offset(number).Genre | string | - Returns
- The genre(s) of the song with an offset
number with respect to the current playing song.
- Parameters
-
number | - the offset song number with respect to the current playing song. |
|
MusicPlayer.Position(number).Genre | string | - Returns
- The genre(s) of the song with an offset
number with respect to the start of the playlist.
- Parameters
-
number | - the offset song number with respect to the start of the playlist song. |
|
MusicPlayer.Lyrics | string | - Returns
- The lyrics of current song stored in ID tag info.
|
MusicPlayer.Year | string | - Returns
- The year of release of current song.
|
MusicPlayer.offset(number).Year | string | - Returns
- The year of release of the song with an offset
number with respect to the current playing song.
- Parameters
-
number | - the offset numbet with respect to the current song. |
|
MusicPlayer.Position(number).Year | string | - Returns
- The year of release of the song with an offset
number with respect to the start of the playlist.
- Parameters
-
number | - the offset numbet with respect to the start of the playlist. |
|
MusicPlayer.Rating | string | - Returns
- The numeric Rating of current song (1-10).
|
MusicPlayer.offset(number).Rating | string | - Returns
- The numeric Rating of song with an offset
number with respect to the current playing song.
- Parameters
-
number | - the offset with respect to the current playing song |
|
MusicPlayer.Position(number).Rating | string | - Returns
- The numeric Rating of song with an offset
number with respect to the start of the playlist.
- Parameters
-
number | - the offset with respect to the start of the playlist |
|
MusicPlayer.RatingAndVotes | string | - Returns
- The scraped rating and votes of currently playing song, if it's in the database.
|
MusicPlayer.UserRating | string | - Returns
- The scraped rating of the currently playing song (1-10).
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.UserRating
|
MusicPlayer.Votes | string | - Returns
- The scraped votes of currently playing song, if it's in the database.
|
MusicPlayer.DiscNumber | string | - Returns
- The Disc Number of current song stored in ID tag info.
|
MusicPlayer.offset(number).DiscNumber | string | - Returns
- The Disc Number of current song stored in ID tag info for the song with an offset
number with respect to the playing song.
- Parameters
-
number | - The offset value for the song with respect to the playing song. |
|
MusicPlayer.Position(number).DiscNumber | string | - Returns
- The Disc Number of current song stored in ID tag info for the song with an offset
number with respect to the start of the playlist.
- Parameters
-
number | - The offset value for the song with respect to the start of the playlist. |
|
MusicPlayer.Comment | string | - Returns
- The Comment of current song stored in ID tag info.
|
MusicPlayer.offset(number).Comment | string | - Returns
- The Comment of current song stored in ID tag info for the song with an offset
number with respect to the playing song.
- Parameters
-
number | - The offset value for the song with respect to the playing song. |
|
MusicPlayer.Position(number).Comment | string | - Returns
- The Comment of current song stored in ID tag info for the song with an offset
number with respect to the start of the playlist.
- Parameters
-
number | - The offset value for the song with respect to the start of the playlist. |
|
MusicPlayer.Contributors | string | - Returns
- The list of all people who've contributed to the currently playing song
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Contributors
|
MusicPlayer.ContributorAndRole | string | - Returns
- The list of all people and their role who've contributed to the currently playing song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.ContributorAndRole
|
MusicPlayer.Mood | string | - Returns
- The mood of the currently playing song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.Mood
|
MusicPlayer.PlaylistPlaying | boolean | - Returns
- True if a playlist is currently playing.
|
MusicPlayer.Exists(relative,position) | boolean | - Returns
- True if the currently playing playlist has a song queued at the given position.
- Parameters
-
relative | - bool - If the position is relative |
position | - int - The position of the song |
- Note
- It is possible to define whether the position is relative or not, default is false.
|
MusicPlayer.HasPrevious | boolean | - Returns
- True if the music player has a a Previous Song in the Playlist.
|
MusicPlayer.HasNext | boolean | - Returns
- True if the music player has a next song queued in the Playlist.
|
MusicPlayer.PlayCount | integer | - Returns
- The play count of currently playing song, if it's in the database.
|
MusicPlayer.LastPlayed | string | - Returns
- The last play date of currently playing song, if it's in the database.
|
MusicPlayer.TrackNumber | string | - Returns
- The track number of current song.
|
MusicPlayer.offset(number).TrackNumber | string | - Returns
- The track number of the song with an offset
number with respect to the current playing song.
- Parameters
-
number | - The offset number of the song with respect to the playing song |
|
MusicPlayer.Position(number).TrackNumber | string | - Returns
- The track number of the song with an offset
number with respect to start of the playlist.
- Parameters
-
number | - The offset number of the song with respect to start of the playlist |
|
MusicPlayer.Duration | string | - Returns
- The duration of the current song.
|
MusicPlayer.offset(number).Duration | string | - Returns
- The duration of the song with an offset
number with respect to the current playing song.
- Parameters
-
number | - the offset number of the song with respect to the current playing song |
|
MusicPlayer.Position(number).Duration | string | - Returns
- The duration of the song with an offset
number with respect to the start of the playlist.
- Parameters
-
number | - the offset number of the song with respect to the start of the playlist |
|
MusicPlayer.BitRate | string | - Returns
- The bitrate of current song.
|
MusicPlayer.Channels | string | - Returns
- The number of channels of current song.
|
MusicPlayer.BitsPerSample | string | - Returns
- The number of bits per sample of current song.
|
MusicPlayer.SampleRate | string | - Returns
- The samplerate of current playing song.
|
MusicPlayer.Codec | string | - Returns
- The codec of current playing song.
|
MusicPlayer.PlaylistPosition | string | - Returns
- The position of the current song in the current music playlist.
|
MusicPlayer.PlaylistLength | string | - Returns
- The total size of the current music playlist.
|
MusicPlayer.ChannelName | string | - Returns
- The channel name of the radio programme that's currently playing (PVR).
|
MusicPlayer.ChannelNumberLabel | string | - Returns
- The channel and subchannel number of the radio channel that's currently playing (PVR).
- v14 Skinning engine changes:
- [New Infolabel]
MusicPlayer.ChannelNumberLabel
|
MusicPlayer.ChannelGroup | string | - Returns
- The channel group of the radio programme that's currently playing (PVR).
|
MusicPlayer.Property(propname) | string | - Returns
- The requested property value of the currently playing item.
- Parameters
-
propname | - The requested property |
|
MusicPlayer.DBID | string | - Returns
- The database id of the currently playing song.
- v17 Skinning engine changes:
- [New Infolabel]
MusicPlayer.DBID
|
Labels | Type | Description |
VideoPlayer.UsingOverlays | boolean | - Returns
- True if the video player is using the hardware overlays render method.
- Note
- This is useful, as with hardware overlays you have no alpha blending to the video image, so shadows etc. need redoing, or disabling.
|
VideoPlayer.IsFullscreen | boolean | - Returns
- True if the video player is in fullscreen mode.
|
VideoPlayer.HasMenu | boolean | - Returns
- True if the video player has a menu (ie is playing a DVD).
|
VideoPlayer.HasInfo | boolean | - Returns
- True if the current playing video has information from the library or from a plugin (eg director/plot etc.)
|
VideoPlayer.Content(parameter) | boolean | - Returns
- True if the current Video you are playing is contained in corresponding Video Library sections. The following values are accepted:
- files
- movies
- episodes
- musicvideos
- livetv
|
VideoPlayer.HasSubtitles | boolean | - Returns
- True if there are subtitles available for video.
|
VideoPlayer.HasTeletext | boolean | - Returns
- True if teletext is usable on played TV channel.
|
VideoPlayer.IsStereoscopic | boolean | - Returns
- True when the currently playing video is a 3D (stereoscopic) video.
- v13 Skinning engine changes:
- [New Boolean Condition]
VideoPlayer.IsStereoscopic
|
VideoPlayer.SubtitlesEnabled | boolean | - Returns
- True if subtitles are turned on for video.
|
VideoPlayer.HasEpg | boolean | - Returns
- True if epg information is available for the currently playing programme (PVR).
|
VideoPlayer.CanResumeLiveTV | boolean | - Returns
- True if a in-progress PVR recording is playing an the respective live TV channel is available.
|
VideoPlayer.Title | string | - Returns
- The title of currently playing video.
- Note
- If it's in the database it will return the database title, else the filename.
|
VideoPlayer.OriginalTitle | string | - Returns
- The original title of currently playing video. If it's in the database.
|
VideoPlayer.TVShowTitle | string | - Returns
- The title of currently playing episode's tvshow name.
|
VideoPlayer.Season | string | - Returns
- The season number of the currently playing episode, if it's in the database.
- v15 Skinning engine changes:
- [Infolabel Updated]
VideoPlayer.Season also supports EPG.
|
VideoPlayer.Episode | string | - Returns
- The episode number of the currently playing episode.
- v15 Skinning engine changes:
- [Infolabel Updated]
VideoPlayer.Episode also supports EPG.
|
VideoPlayer.Genre | string | - Returns
- The genre(s) of current movie, if it's in the database.
|
VideoPlayer.Director | string | - Returns
- The director of current movie, if it's in the database.
- v15 Skinning engine changes:
- [Infolabel Updated]
VideoPlayer.Director also supports EPG.
|
VideoPlayer.Country | string | - Returns
- The production country of current movie, if it's in the database.
|
VideoPlayer.Year | string | - Returns
- The year of release of current movie, if it's in the database.
|
VideoPlayer.Cover | string | - Returns
- The cover of currently playing movie.
|
VideoPlayer.Rating | string | - Returns
- The scraped rating of current movie, if it's in the database.
|
VideoPlayer.UserRating | string | - Returns
- The user rating of the currently playing item.
- v16 Skinning engine changes:
- [New Infolabel]
VideoPlayer.UserRating
|
VideoPlayer.Votes | string | - Returns
- The scraped votes of current movie, if it's in the database.
- v13 Skinning engine changes:
- [New Infolabel]
VideoPlayer.Votes
|
VideoPlayer.RatingAndVotes | string | - Returns
- The scraped rating and votes of current movie, if it's in the database
|
VideoPlayer.mpaa | string | - Returns
- The MPAA rating of current movie, if it's in the database.
|
VideoPlayer.IMDBNumber | string | - Returns
- The IMDb ID of the current movie, if it's in the database.
- v15 Skinning engine changes:
- [New Infolabel]
VideoPlayer.IMDBNumber
|
VideoPlayer.Top250 | string | - Returns
- The IMDb Top250 position of the currently playing movie, if it's in the database.
|
VideoPlayer.EpisodeName | string | - Returns
- The name of the episode if the playing video is a TV Show, if it's in the database (PVR).
- v15 Skinning engine changes:
- [New Infolabel]
VideoPlayer.EpisodeName
|
VideoPlayer.PlaylistPosition | string | - Returns
- The position of the current song in the current video playlist.
|
VideoPlayer.PlaylistLength | string | - Returns
- The total size of the current video playlist.
|
VideoPlayer.Cast | string | - Returns
- A concatenated string of cast members of the current movie, if it's in the database.
- v15 Skinning engine changes:
- [Infolabel Updated]
VideoPlayer.Cast also supports EPG.
|
VideoPlayer.CastAndRole | string | - Returns
- A concatenated string of cast members and roles of the current movie, if it's in the database.
|
VideoPlayer.Album | string | - Returns
- The album from which the current Music Video is from, if it's in the database.
|
VideoPlayer.Artist | string | - Returns
- The artist(s) of current Music Video, if it's in the database.
|
VideoPlayer.Studio | string | - Returns
- The studio of current Music Video, if it's in the database.
|
VideoPlayer.Writer | string | - Returns
- The name of Writer of current playing Video, if it's in the database.
- v15 Skinning engine changes:
- [Infolabel Updated]
VideoPlayer.Writer also supports EPG.
|
VideoPlayer.Tagline | string | - Returns
- The small Summary of current playing Video, if it's in the database.
|
VideoPlayer.PlotOutline | string | - Returns
- The small Summary of current playing Video, if it's in the database.
|
VideoPlayer.Plot | string | - Returns
- The complete Text Summary of current playing Video, if it's in the database.
|
VideoPlayer.Premiered | string | - Returns
- The release or aired date of the currently playing episode, show, movie or EPG item, if it's in the database.
|
VideoPlayer.Trailer | string | - Returns
- The path to the trailer of the currently playing movie, if it's in the database.
|
VideoPlayer.LastPlayed | string | - Returns
- The last play date of current playing Video, if it's in the database.
|
VideoPlayer.PlayCount | string | - Returns
- The playcount of current playing Video, if it's in the database.
|
VideoPlayer.VideoCodec | string | - Returns
- The video codec of the currently playing video (common values: see ListItem.VideoCodec).
|
VideoPlayer.VideoResolution | string | - Returns
- The video resolution of the currently playing video (possible values: see ListItem.VideoResolution).
|
VideoPlayer.VideoAspect | string | - Returns
- The aspect ratio of the currently playing video (possible values: see ListItem.VideoAspect).
|
VideoPlayer.AudioCodec | string | - Returns
- The audio codec of the currently playing video, optionally 'n' defines the number of the audiostream (common values: see ListItem.AudioCodec).
|
VideoPlayer.AudioChannels | string | - Returns
- The number of audio channels of the currently playing video (possible values: see ListItem.AudioChannels).
- v16 Skinning engine changes:
- [Infolabel Updated]
VideoPlayer.AudioChannels if a video contains no audio, these infolabels will now return empty. (they used to return 0)
|
VideoPlayer.AudioLanguage | string | - Returns
- The language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage).
- v13 Skinning engine changes:
- [New Infolabel]
VideoPlayer.AudioLanguage
|
VideoPlayer.SubtitlesLanguage | string | - Returns
- The language of the subtitle of the currently playing video (possible values: see ListItem.SubtitleLanguage).
- v13 Skinning engine changes:
- [New Infolabel]
VideoPlayer.SubtitlesLanguage
|
VideoPlayer.StereoscopicMode | string | - Returns
- The stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode).
- v13 Skinning engine changes:
- [New Infolabel]
VideoPlayer.StereoscopicMode
|
VideoPlayer.StartTime | string | - Returns
- The start date and time of the currently playing epg event or recording (PVR).
|
VideoPlayer.EndTime | string | - Returns
- The end date and time of the currently playing epg event or recording (PVR).
|
VideoPlayer.NextTitle | string | - Returns
- The title of the programme that will be played next (PVR).
|
VideoPlayer.NextGenre | string | - Returns
- The genre of the programme that will be played next (PVR).
|
VideoPlayer.NextPlot | string | - Returns
- The plot of the programme that will be played next (PVR).
|
VideoPlayer.NextPlotOutline | string | - Returns
- The plot outline of the programme that will be played next (PVR).
|
VideoPlayer.NextStartTime | string | - Returns
- The start time of the programme that will be played next (PVR).
|
VideoPlayer.NextEndTime | string | - Returns
- The end time of the programme that will be played next (PVR).
|
VideoPlayer.NextDuration | string | - Returns
- The duration of the programme that will be played next (PVR).
|
VideoPlayer.ChannelName | string | - Returns
- The name of the currently tuned channel (PVR).
|
VideoPlayer.ChannelNumberLabel | string | - Returns
- The channel and subchannel number of the tv channel that's currently playing (PVR).
- v14 Skinning engine changes:
- [New Infolabel]
VideoPlayer.ChannelNumberLabel
|
VideoPlayer.ChannelGroup | string | - Returns
- The group of the currently tuned channel (PVR).
|
VideoPlayer.ParentalRating | string | - Returns
- The parental rating of the currently playing programme (PVR).
|
VideoPlayer.DBID | string | - Returns
- The database id of the currently playing video
- v17 Skinning engine changes:
- [New Infolabel]
VideoPlayer.DBID
|
Labels | Type | Description |
Container(id).HasFiles | boolean | - Returns
- True if the container contains files (or current container if id is omitted).
|
Container(id).HasFolders | boolean | - Returns
- True if the container contains folders (or current container if id is omitted).
|
Container(id).IsStacked | boolean | - Returns
- True if the container is currently in stacked mode (or current container if id is omitted).
|
Container.FolderPath | string | - Returns
- The complete path of currently displayed folder.
|
Container.FolderName | string | - Returns
- The top most folder in currently displayed folder.
|
Container.PluginName | string | - Returns
- The current plugins base folder name.
|
Container.PluginCategory | string | - Returns
- The current plugins category (set by the scripter).
- v17 Skinning engine changes:
- [New Infolabel]
Container.PluginCategory
|
Container.Viewmode | string | - Returns
- The current viewmode (list, icons etc).
|
Container.ViewCount | integer | - Returns
- The number of available skin view modes for the current container listing.
- v17 Skinning engine changes:
- [New Infolabel]
Container.ViewCount
|
Container(id).Totaltime | string | - Returns
- The total time of all items in the current container.
|
Container(id).TotalWatched | string | - Returns
- The number of watched items in the container.
- Parameters
-
id | - [opt] if not supplied the current container will be used. |
- v16 Skinning engine changes:
- [New Infolabel]
Container(id).TotalWatched
|
Container(id).TotalUnWatched | string | - Returns
- The number of unwatched items in the container.
- Parameters
-
id | - [opt] if not supplied the current container will be used. |
- v16 Skinning engine changes:
- [New Infolabel]
Container(id).TotalUnWatched
|
Container.HasThumb | boolean | - Returns
- True if the current container you are in has a thumb assigned to it.
|
Container.SortMethod | boolean | - Returns
- True the current sort method (name, year, rating, etc).
|
Container.SortOrder | string | - Returns
- The current sort order (Ascending/Descending).
- v16 Skinning engine changes:
- [New Infolabel]
Container.SortOrder
|
Container.ShowPlot | string | - Returns
- The TV Show plot of the current container and can be used at season and episode level.
|
Container.ShowTitle | string | - Returns
- The TV Show title of the current container and can be used at season and episode level.
- v17 Skinning engine changes:
- [New Infolabel]
Container.ShowTitle
|
Container(id).OnNext | boolean | - Returns
- True if the container with id (or current container if id is omitted) is moving to the next item. Allows views to be custom-designed (such as 3D coverviews etc.)
|
Container(id).OnScrollNext | boolean | - Returns
- True if the container with id (or current container if id is omitted) is scrolling to the next item. Differs from OnNext in that OnNext triggers on movement even if there is no scroll involved.
|
Container(id).OnPrevious | boolean | - Returns
- True if the container with id (or current container if id is omitted) is moving to the previous item. Allows views to be custom-designed (such as 3D coverviews etc).
|
Container(id).OnScrollPrevious | boolean | - Returns
- True if the container with id (or current container if id is omitted) is scrolling to the previous item. Differs from OnPrevious in that OnPrevious triggers on movement even if there is no scroll involved.
|
Container(id).NumPages | integer | - Returns
- The number of pages in the container with given id. If no id is specified it grabs the current container.
|
Container(id).NumItems | integer | - Returns
- The number of items in the container or grouplist with given id excluding parent folder item.
- Note
- If no id is specified it grabs the current container.
|
Container(id).NumAllItems | integer | - Returns
- The number of all items in the container or grouplist with given id including parent folder item.
- Note
- If no id is specified it grabs the current container.
- v18 Skinning engine changes:
- [New Infolabel]
Container(id).NumAllItems
|
Container(id).NumNonFolderItems | integer | - Returns
- The Number of items in the container or grouplist with given id excluding all folder items.
- Note
- Example: pvr recordings folders, parent ".." folder). If no id is specified it grabs the current container.
- v18 Skinning engine changes:
- [New Infolabel]
Container(id).NumNonFolderItems
|
Container(id).CurrentPage | string | - Returns
- THe current page in the container with given id.
- Note
- If no id is specified it grabs the current container.
|
Container(id).Scrolling | boolean | - Returns
- True if the user is currently scrolling through the container with id (or current container if id is omitted).
- Note
- This is slightly delayed from the actual scroll start. Use Container(id).OnScrollNext or Container(id).OnScrollPrevious to trigger animations immediately on scroll.
|
Container(id).HasNext | boolean | - Returns
- True if the container or textbox with id (id) has a next page.
|
Container.HasParent | boolean | - Returns
- True when the container contains a parent ('..') item.
- v16 Skinning engine changes:
- [New Boolean Condition]
Container.HasParent
|
Container(id).HasPrevious | boolean | - Returns
- True if the container or textbox with id (id) has a previous page.
|
Container.CanFilter | boolean | - Returns
- True when the current container can be filtered.
|
Container.CanFilterAdvanced | boolean | - Returns
- True when advanced filtering can be applied to the current container.
|
Container.Filtered | boolean | - Returns
- True when a mediafilter is applied to the current container.
|
Container(id).IsUpdating | boolean | - Returns
- True if the container with dynamic list content is currently updating.
|
Container(id).Row | integer | - Returns
- The row number of the focused position in a panel container.
- v16 Skinning engine changes:
- [New Infolabel]
Container(id).Row
|
Container(id).Column | integer | - Returns
- The column number of the focused position in a panel container.
- v16 Skinning engine changes:
- [New Infolabel]
Container(id).Column
|
Container(id).Position | integer | - Returns
- The current focused position of container / grouplist (id) as a numeric label.
- v16 Skinning engine changes:
- [Infolabel Updated]
Container(id).Position now also returns the position for items inside a grouplist.
|
Container(id).CurrentItem | integer | - Returns
- The current item in the container or grouplist with given id.
- Note
- If no id is specified it grabs the current container.
- v15 Skinning engine changes:
- [New Infolabel]
Container(id).CurrentItem
|
Container(id).SubItem | integer | - Returns
- Sub-item in the container or grouplist with given id.
- Note
- If no id is specified it grabs the current container.
|
Container(id).HasFocus(item_number) | boolean | - Returns
- True if the container with id (or current container if id is omitted) has static content and is focused on the item with id item_number.
|
Container.Property(addoncategory) | string | - Returns
- The current add-on category.
|
Container.Property(reponame) | string | - Returns
- The current add-on repository name.
|
Container.Content | string | - Returns
- The content of the current container.
- v16 Skinning engine changes:
- [New Infolabel]
Container.Content
|
Container(id).ListItem(offset).Property | string | - Returns
- the property of the ListItem with a given offset.
- Parameters
-
offset | - The offset for the listitem. |
- Note
Property has to be replaced with Label , Label2 , Icon etc.
-
Example:
Container(50).Listitem(2).Label
|
Container(id).ListItemNoWrap(offset).Property | string | - Returns
- the same as
Container(id).ListItem(offset).Property but it won't wrap.
- Parameters
-
offset | - The offset for the listitem. |
- Note
- That means if the last item of a list is focused,
ListItemNoWrap(1) will be empty while ListItem(1) will return the first item of the list. Property has to be replaced with Label , Label2 , Icon etc.
-
Example:
Container(50).ListitemNoWrap(1).Plot
|
Container(id).ListItemPosition(x).[infolabel] | string | - Returns
- The infolabel for an item in a Container.
- Parameters
-
x | - the position in the container relative to the cursor position. |
- Note
- Example:
Container(50).ListItemPosition(4).Genre
|
Container(id).ListItemAbsolute(x).[infolabel] | string | - Returns
- The infolabel for an item in a Container.
- Parameters
-
x | - the absolute position in the container. |
- Note
- Example:
Container(50).ListItemAbsolute(4).Genre
- v16 Skinning engine changes:
- [New Infolabel]
Container(id).ListItemAbsolute(x).[infolabel]
|
Container.Content(parameter) | string | - Returns
- True if the current container you are in contains the following:
- files
- songs
- artists
- albums
- movies
- tvshows
- seasons
- episodes
- musicvideos
- genres
- years
- actors
- playlists
- plugins
- studios
- directors
- sets
- tags
- Note
- These currently only work in the Video and Music Library or unless a Plugin has set the value) also available are Addons true when a list of add-ons is shown LiveTV true when a htsp (tvheadend) directory is shown
|
Container.Art(type) | string | - Returns
- The path to the art image file for the given type of the current container.
- Parameters
-
type | - the art type to request. |
- Todo:
- List of all art types
- v16 Skinning engine changes:
- [Infolabel Updated]
Container.Art(type) set.fanart as possible type value.
- v15 Skinning engine changes:
- [New Infolabel]
Container.Art(type)
|
Container.SortDirection(direction) | boolean | - Returns
- True if the sort direction of a container equals direction.
- Parameters
-
direction | - The direction to check. It can be:
|
|
Labels | Type | Description |
ListItem.Thumb | string | - Returns
- The thumbnail (if it exists) of the currently selected item in a list or thumb control.
- Deprecated:
- but still available, returns the same as ListItem.Art(thumb)
|
ListItem.Icon | string | - Returns
- The thumbnail (if it exists) of the currently selected item in a list or thumb control.
- Note
- If no thumbnail image exists, it will show the icon.
|
ListItem.ActualIcon | string | - Returns
- The icon of the currently selected item in a list or thumb control.
|
ListItem.Overlay | string | - Returns
- The overlay icon status of the currently selected item in a list or thumb control.
- compressed file – OverlayRAR.png
- watched – OverlayWatched.png
- unwatched – OverlayUnwatched.png
- locked – OverlayLocked.png
|
ListItem.IsFolder | boolean | - Returns
- True if the current ListItem is a folder.
|
ListItem.IsPlaying | boolean | - Returns
- True if the current ListItem.* info labels and images are currently Playing media.
|
ListItem.IsResumable | boolean | - Returns
- True when the current ListItem has been partially played.
|
ListItem.IsCollection | boolean | - Returns
- True when the current ListItem is a movie set.
- v15 Skinning engine changes:
- [New Boolean Condition]
ListItem.IsCollection
|
ListItem.IsSelected | boolean | - Returns
- True if the current ListItem is selected (f.e. currently playing in playlist window).
|
ListItem.HasEpg | boolean | - Returns
- True when the selected programme has epg info (PVR).
|
ListItem.HasTimer | boolean | - Returns
- True when a recording timer has been set for the selected programme (PVR).
|
ListItem.IsRecording | boolean | - Returns
- True when the selected programme is being recorded (PVR).
|
ListItem.IsEncrypted | boolean | - Returns
- True when the selected programme is encrypted (PVR).
|
ListItem.IsStereoscopic | boolean | - Returns
- True when the selected video is a 3D (stereoscopic) video.
- v13 Skinning engine changes:
- [New Boolean Condition]
ListItem.IsStereoscopic
|
ListItem.Property(IsSpecial) | boolean | - Returns
- True if the current Season/Episode is a Special.
|
ListItem.Property(DateLabel) | boolean | - Returns
- True if the item is a date label, returns false if the item is a time label.
- Note
- Can be used in the rulerlayout of the epggrid control.
|
ListItem.Property(Addon.IsEnabled) | boolean | - Returns
- True when the selected addon is enabled (for use in the addon info dialog only).
- v17 Skinning engine changes:
- [Boolean Condition Updated]
ListItem.Property(Addon.IsEnabled) replaces ListItem.Property(Addon.Enabled) .
|
ListItem.Property(Addon.IsInstalled) | boolean | - Returns
- True when the selected addon is installed (for use in the addon info dialog only).
- v17 Skinning engine changes:
- [Boolean Condition Updated]
ListItem.Property(Addon.IsInstalled) replaces ListItem.Property(Addon.Installed) .
|
ListItem.Property(Addon.HasUpdate) | boolean | - Returns
- True when there's an update available for the selected addon.
- v17 Skinning engine changes:
- [Boolean Condition Updated]
ListItem.Property(Addon.HasUpdate) replaces ListItem.Property(Addon.UpdateAvail) .
|
ListItem.Label | string | - Returns
- The left label of the currently selected item in a container.
|
ListItem.Label2 | string | - Returns
- The right label of the currently selected item in a container.
|
ListItem.Title | string | - Returns
- The title of the currently selected song, movie, game in a container.
- v18 Skinning engine changes:
- [Infolabel Updated]
ListItem.Title extended to support games
|
ListItem.OriginalTitle | string | - Returns
- The original title of the currently selected movie in a container.
|
ListItem.SortLetter | string | - Returns
- The first letter of the current file in a container.
|
ListItem.TrackNumber | string | - Returns
- The track number of the currently selected song in a container.
|
ListItem.Artist | string | - Returns
- The artist of the currently selected song in a container.
|
ListItem.AlbumArtist | string | - Returns
- The artist of the currently selected album in a list.
|
ListItem.Property(Artist_Sortname) | string | - Returns
- The sortname of the currently selected Artist.
- v18 Skinning engine changes:
- [New Infolabel]
ListItem.Property(Artist_Sortname)
|
ListItem.Property(Artist_Type) | string | - Returns
- The type of the currently selected Artist - person, group, orchestra, choir etc.
- v18 Skinning engine changes:
- [New Infolabel]
ListItem.Property(Artist_Type)
|
ListItem.Property(Artist_Gender) | string | - Returns
- The Gender of the currently selected Artist - male, female, other.
- v18 Skinning engine changes:
- [New Infolabel]
ListItem.Property(Artist_Gender)
|
ListItem.Property(Artist_Disambiguation) | string | - Returns
- A Brief description of the currently selected Artist that differentiates them from others with the same name.
- v18 Skinning engine changes:
- [New Infolabel]
ListItem.Property(Artist_Disambiguation)
|
ListItem.Property(Artist_Born) | string | - Returns
- The date of Birth of the currently selected Artist.
|
ListItem.Property(Artist_Died) | string | - Returns
- The date of Death of the currently selected Artist.
|
ListItem.Property(Artist_Formed) | string | - Returns
- The formation date of the currently selected Band.
|
ListItem.Property(Artist_Disbanded) | string | - Returns
- The disbanding date of the currently selected Band.
|
ListItem.Property(Artist_YearsActive) | string | - Returns
- The years the currently selected artist has been active.
|
ListItem.Property(Artist_Instrument) | string | - Returns
- The instruments played by the currently selected artist.
|
ListItem.Property(Artist_Description) | string | - Returns
- A biography of the currently selected artist.
|
ListItem.Property(Artist_Mood) | string | - Returns
- The moods of the currently selected artist.
|
ListItem.Property(Artist_Style) | string | - Returns
- The styles of the currently selected artist.
|
ListItem.Property(Artist_Genre) | string | - Returns
- The genre of the currently selected artist.
|
ListItem.Album | string | - Returns
- The album of the currently selected song in a container.
|
ListItem.Property(Album_Mood) | string | - Returns
- The moods of the currently selected Album.
|
ListItem.Property(Album_Style) | string | - Returns
- The styles of the currently selected Album.
|
ListItem.Property(Album_Theme) | string | - Returns
- The themes of the currently selected Album.
|
ListItem.Property(Album_Type) | string | - Returns
- The Album Type (e.g. compilation, enhanced, explicit lyrics) of the currently selected Album.
|
ListItem.Property(Album_Label) | string | - Returns
- The record label of the currently selected Album.
|
ListItem.Property(Album_Description) | string | - Returns
- A review of the currently selected Album.
|
ListItem.DiscNumber | string | - Returns
- The disc number of the currently selected song in a container.
|
ListItem.Year | string | - Returns
- The year of the currently selected song, album, movie, game in a container.
- v18 Skinning engine changes:
- [Infolabel Updated]
ListItem.Title extended to support games
|
ListItem.Premiered | string | - Returns
- The release/aired date of the currently selected episode, show, movie or EPG item in a container.
- v15 Skinning engine changes:
- [Infolabel Updated]
ListItem.Premiered now also available for EPG items.
|
ListItem.Genre | string | - Returns
- The genre of the currently selected song, album or movie in a container.
|
ListItem.Contributors | string | - Returns
- The list of all people who've contributed to the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
ListItem.Contributors
|
ListItem.ContributorAndRole | string | - Returns
- The list of all people and their role who've contributed to the selected song.
- v17 Skinning engine changes:
- [New Infolabel]
ListItem.ContributorAndRole
|
ListItem.Director | string | - Returns
- The director of the currently selected movie in a container.
- v15 Skinning engine changes:
- [Infolabel Updated]
ListItem.Director also supports EPG.
|
ListItem.Country | string | - Returns
- The production country of the currently selected movie in a container.
|
ListItem.Episode | string | - Returns
- The episode number value for the currently selected episode. It also returns the number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
- v15 Skinning engine changes:
- [Infolabel Updated]
ListItem.Episode also supports EPG.
|
ListItem.Season | string | - Returns
- The season value for the currently selected tvshow.
- v15 Skinning engine changes:
- [Infolabel Updated]
ListItem.Season also supports EPG.
|
ListItem.TVShowTitle | string | - Returns
- The name value for the currently selected tvshow in the season and episode depth of the video library.
|
ListItem.Property(TotalSeasons) | string | - Returns
- The total number of seasons for the currently selected tvshow.
|
ListItem.Property(TotalEpisodes) | string | - Returns
- the total number of episodes for the currently selected tvshow or season.
|
ListItem.Property(WatchedEpisodes) | string | - Returns
- The number of watched episodes for the currently selected tvshow or season.
|
ListItem.Property(UnWatchedEpisodes) | string | - Returns
- The number of unwatched episodes for the currently selected tvshow or season.
|
ListItem.Property(NumEpisodes) | string | - Returns
- The number of total, watched or unwatched episodes for the currently selected tvshow or season, based on the the current watched filter.
|
ListItem.PictureAperture | string | - Returns
- The F-stop used to take the selected picture.
- Note
- This is the value of the EXIF FNumber tag (hex code 0x829D).
|
ListItem.PictureAuthor | string | - Returns
- The name of the person involved in writing about the selected picture.
- Note
- This is the value of the IPTC Writer tag (hex code 0x7A).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureAuthor
|
ListItem.PictureByline | string | - Returns
- The name of the person who created the selected picture.
- Note
- This is the value of the IPTC Byline tag (hex code 0x50).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureByline
|
ListItem.PictureBylineTitle | string | - Returns
- The title of the person who created the selected picture.
- Note
- This is the value of the IPTC BylineTitle tag (hex code 0x55).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureBylineTitle
|
ListItem.PictureCamMake | string | - Returns
- The manufacturer of the camera used to take the selected picture.
- Note
- This is the value of the EXIF Make tag (hex code 0x010F).
|
ListItem.PictureCamModel | string | - Returns
- The manufacturer's model name or number of the camera used to take the selected picture.
- Note
- This is the value of the EXIF Model tag (hex code 0x0110).
|
ListItem.PictureCaption | string | - Returns
- A description of the selected picture.
- Note
- This is the value of the IPTC Caption tag (hex code 0x78).
|
ListItem.PictureCategory | string | - Returns
- The subject of the selected picture as a category code.
- Note
- This is the value of the IPTC Category tag (hex code 0x0F).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureCategory
|
ListItem.PictureCCDWidth | string | - Returns
- The width of the CCD in the camera used to take the selected picture.
- Note
- This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureCCDWidth
|
ListItem.PictureCity | string | - Returns
- The city where the selected picture was taken.
- Note
- This is the value of the IPTC City tag (hex code 0x5A).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureCity
|
ListItem.PictureColour | string | - Returns
- Whether the selected picture is "Colour" or "Black and White".
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureColour
|
ListItem.PictureComment | string | - Returns
- A description of the selected picture.
- Note
- This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
ListItem.PictureCopyrightNotice | string | - Returns
- The copyright notice of the selected picture.
- Note
- This is the value of the IPTC Copyright tag (hex code 0x74).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureCopyrightNotice
|
ListItem.PictureCountry | string | - Returns
- The full name of the country where the selected picture was taken.
- Note
- This is the value of the IPTC CountryName tag (hex code 0x65).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureCountry
|
ListItem.PictureCountryCode | string | - Returns
- The country code of the country where the selected picture was taken.
- Note
- This is the value of the IPTC CountryCode tag (hex code 0x64).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureCountryCode
|
ListItem.PictureCredit | string | - Returns
- Who provided the selected picture.
- Note
- This is the value of the IPTC Credit tag (hex code 0x6E).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureCredit
|
ListItem.PictureDate | string | - Returns
- The localized date of the selected picture. The short form of the date is used.
- Note
- The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureDate
|
ListItem.PictureDatetime | string | - Returns
- The date/timestamp of the selected picture. The localized short form of the date and time is used.
- Note
- The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureDatetime
|
ListItem.PictureDesc | string | - Returns
- A short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description.
- Note
- This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
ListItem.PictureDigitalZoom | string | - Returns
- The digital zoom ratio when the selected picture was taken.
- Note
- This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureDigitalZoom
|
ListItem.PictureExpMode | string | - Returns
- The exposure mode of the selected picture. The possible values are:
- "Automatic"
- "Manual"
- "Auto bracketing"
- Note
- This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
ListItem.PictureExposure | string | - Returns
- The class of the program used by the camera to set exposure when the selected picture was taken. Values include:
- "Manual"
- "Program (Auto)"
- "Aperture priority (Semi-Auto)"
- "Shutter priority (semi-auto)"
- etc
- Note
- This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureExposure
|
ListItem.PictureExposureBias | string | - Returns
- The exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99.
- Note
- This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureExposureBias
|
ListItem.PictureExpTime | string | - Returns
- The exposure time of the selected picture, in seconds.
- Note
- This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
ListItem.PictureFlashUsed | string | - Returns
- The status of flash when the selected picture was taken. The value will be either "Yes" or "No", and might include additional information.
- Note
- This is the value of the EXIF Flash tag (hex code 0x9209).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureFlashUsed
|
ListItem.PictureFocalLen | string | - Returns
- The lens focal length of the selected picture.
|
ListItem.PictureFocusDist | string | - Returns
- The focal length of the lens, in mm.
- Note
- This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
ListItem.PictureGPSLat | string |
- Returns
- The latitude where the selected picture was taken (degrees, minutes, seconds North or South).
- Note
- This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
ListItem.PictureGPSLon | string | - Returns
- The longitude where the selected picture was taken (degrees, minutes, seconds East or West).
- Note
- This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
ListItem.PictureGPSAlt | string | - Returns
- The altitude in meters where the selected picture was taken.
- Note
- This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
ListItem.PictureHeadline | string | - Returns
- A synopsis of the contents of the selected picture.
- Note
- This is the value of the IPTC Headline tag (hex code 0x69).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureHeadline
|
ListItem.PictureImageType | string | - Returns
- The color components of the selected picture.
- Note
- This is the value of the IPTC ImageType tag (hex code 0x82).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureImageType
|
ListItem.PictureIPTCDate | string | - Returns
- The date when the intellectual content of the selected picture was created, rather than when the picture was created.
- Note
- This is the value of the IPTC DateCreated tag (hex code 0x37).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureIPTCDate
|
ListItem.PictureIPTCTime | string | - Returns
- The time when the intellectual content of the selected picture was created, rather than when the picture was created.
- Note
- This is the value of the IPTC TimeCreated tag (hex code 0x3C).
- v13 Skinning engine changes:
- [New Infolabel]
ListItem.PictureIPTCTime
|
ListItem.PictureISO | string | - Returns
- The ISO speed of the camera when the selected picture was taken.
- Note
- This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
ListItem.PictureKeywords | string | - Returns
- The keywords assigned to the selected picture.
- Note
- This is the value of the IPTC Keywords tag (hex code 0x19).
|
ListItem.PictureLightSource | string | - Returns
- The kind of light source when the picture was taken. Possible values include:
- "Daylight"
- "Fluorescent"
- "Incandescent</b>
- etc
@note This is the value of the EXIF LightSource tag (hex code 0x9208).
<p><hr>
\xrefitem skinning_v13 34.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureLongDate</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureLongDate
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return Only the localized date of the selected picture. The long form of
the date is used.
@note The value of the EXIF DateTimeOriginal tag (hex code
0x9003) is preferred. If the DateTimeOriginal tag is not found, the
value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code
0x0132) might be used.
<p><hr>
\xrefitem skinning_v13 35.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureLongDatetime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureLongDatetime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The date/timestamp of the selected picture. The localized long
form of the date and time is used.
@note The value of the EXIF DateTimeOriginal
tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not
found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime
(hex code 0x0132) might be used.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureMeteringMode</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureMeteringMode
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The metering mode used when the selected picture was taken. The
possible values are:
- <b>"Center weight"</b>
- <b>"Spot"</b>
- <b>"Matrix"</b>
@note This is the value of the EXIF MeteringMode tag (hex code 0x9207).
<p><hr>
\xrefitem skinning_v13 36.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureObjectName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureObjectName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A shorthand reference for the selected picture.
@note This is the value of the IPTC ObjectName tag (hex code 0x05).
<p><hr>
\xrefitem skinning_v13 37.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureOrientation</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureOrientation
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The orientation of the selected picture. Possible values are:
- <b>"Top Left"</b>
- <b>"Top Right"</b>
- <b>"Left Top"</b>
- <b>"Right Bottom"</b>
- etc
@note This is the value of the EXIF Orientation tag (hex code 0x0112).
<p><hr>
\xrefitem skinning_v13 38.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PicturePath</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PicturePath
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The filename and path of the selected picture.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureProcess</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureProcess
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The process used to compress the selected picture.
<p><hr>
\xrefitem skinning_v13 39.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureReferenceService</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureReferenceService
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The Service Identifier of a prior envelope to which the selected
picture refers.
@note This is the value of the IPTC ReferenceService tag (hex code 0x2D).
<p><hr>
\xrefitem skinning_v13 40.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureResolution</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureResolution
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The dimensions of the selected picture.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureSource</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureSource
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The original owner of the selected picture.
@note This is the value of the IPTC Source tag (hex code 0x73).
<p><hr>
\xrefitem skinning_v13 41.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureSpecialInstructions</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureSpecialInstructions
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return Other editorial instructions concerning the use of the selected
picture.
@note This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
<p><hr>
\xrefitem skinning_v13 42.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureState</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureState
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The State/Province where the selected picture was taken.
@note This is the value of the IPTC ProvinceState tag (hex code 0x5F).
<p><hr>
\xrefitem skinning_v13 43.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureSublocation</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureSublocation
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The location within a city where the selected picture was taken -
might indicate the nearest landmark.
@note This is the value of the IPTC SubLocation tag (hex code 0x5C).
<p><hr>
\xrefitem skinning_v13 44.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureSupplementalCategories</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureSupplementalCategories
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A supplemental category codes to further refine the subject of the
selected picture.
@note This is the value of the IPTC SuppCategory tag (hex code 0x14).
<p><hr>
\xrefitem skinning_v13 45.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureTransmissionReference</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureTransmissionReference
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A code representing the location of original transmission of the
selected picture.
@note This is the value of the IPTC TransmissionReference tag (hex code 0x67).
<p><hr>
\xrefitem skinning_v13 46.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureUrgency</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureUrgency
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The urgency of the selected picture. Values are 1-9.
@note The "1" is most urgent. Some image management programs use urgency to indicate
picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star.
Urgencies 6-9 are not used for rating. This is the value of the IPTC
Urgency tag (hex code 0x0A).
<p><hr>
\xrefitem skinning_v13 47.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PictureWhiteBalance</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PictureWhiteBalance
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The white balance mode set when the selected picture was taken.
The possible values are:
- <b>"Manual"</b>
- <b>"Auto"</b>
@note This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
<p><hr>
\xrefitem skinning_v13 48.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.FileName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_FileName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The filename of the currently selected song or movie in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Path</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Path
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The complete path of the currently selected song or movie in a
container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.FolderName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_FolderName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The top most folder of the path of the currently selected song or
movie in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.FolderPath</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_FolderPath
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The complete path of the currently selected song or movie in a
container (without user details).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.FileNameAndPath</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_FileNameAndPath
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The full path with filename of the currently selected song or
movie in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.FileExtension</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_FileExtension
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The file extension (without leading dot) of the currently selected
item in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Date</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Date
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return 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).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.DateTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_DateTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The date and time a certain event happened (event log).
<p><hr>
\xrefitem skinning_v16 15.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.DateAdded</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_DateAdded
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The date the currently selected item was added to the
library / Date and time of an event in the EventLog window.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Size</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Size
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The file size of the currently selected song or movie in a
container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Rating([name])</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Rating
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The scraped rating of the currently selected item in a container (1-10).
@param name - [opt] you can specify the name of the scraper to retrieve a specific rating,
for use in dialogvideoinfo.xml.
<p><hr>
\xrefitem skinning_v18 24. \xrefitem skinning_v17 52.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Set</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Set
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the set the movie is part of.
<p><hr>
\xrefitem skinning_v17 53.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.SetId</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_SetId
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The id of the set the movie is part of.
<p><hr>
\xrefitem skinning_v17 54.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Status</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Status
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return One of the following status:
- <b>"returning series"</b>
- <b>"in production"</b>
- <b>"planned"</b>
- <b>"cancelled"</b>
- <b>"ended"</b>
<p>
@note For use with tv shows.
<p><hr>
\xrefitem skinning_v17 55.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.EndTimeResume</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_EndTimeResume
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return Returns the time a video will end if you resume it, instead of playing it from the beginning.
<p><hr>
\xrefitem skinning_v17 56.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.UserRating</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_UserRating
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The user rating of the currently selected item in a container (1-10).
<p><hr>
\xrefitem skinning_v17 57. \xrefitem skinning_v16 16.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Votes([name])</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Votes
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The scraped votes of the currently selected movie in a container.
@param name - [opt] you can specify the name of the scraper to retrieve specific votes,
for use in <tt>dialogvideoinfo.xml</tt>.
<p><hr>
\xrefitem skinning_v17 58. \xrefitem skinning_v13 49.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.RatingAndVotes([name])</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_RatingAndVotes
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The scraped rating and votes of the currently selected movie in a
container (1-10).
@param name - [opt] you can specify the name of the scraper to retrieve specific votes,
for use in <tt>dialogvideoinfo.xml</tt>.
<p><hr>
\xrefitem skinning_v17 59.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Mood</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Mood
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The mood of the selected song.
<p><hr>
\xrefitem skinning_v17 60.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Mpaa</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Mpaa
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The MPAA rating of the currently selected movie in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.ProgramCount</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_ProgramCount
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The number of times an xbe has been run from "my programs".
\xrefitem todo 183.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Duration</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Duration
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The duration of the currently selected item in a container
in the format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 25.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Duration(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Duration_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The duration of the currently selected item in a container in
different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.DBTYPE</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_DBTYPE
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The database type of the \ref ListItem_DBID "ListItem.DBID" for videos (movie, set,
genre, actor, tvshow, season, episode). It does not return any value
for the music library.
@note Beware with season, the "*all seasons" entry does
give a DBTYPE "season" and a DBID, but you can't get the details of that
entry since it's a virtual entry in the Video Library.
<p><hr>
\xrefitem skinning_v17 61.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.DBID</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_DBID
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The database id of the currently selected listitem in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Appearances</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Appearances
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The number of movies featuring the selected actor / directed by the selected director.
<p><hr>
\xrefitem skinning_v17 62.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Cast</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Cast
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A concatenated string of cast members of the currently selected
movie, for use in dialogvideoinfo.xml.
<p><hr>
\xrefitem skinning_v15 16.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.CastAndRole</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_CastAndRole
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A concatenated string of cast members and roles of the currently
selected movie, for use in dialogvideoinfo.xml.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Studio</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Studio
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The studio of current selected Music Video in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Top250</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Top250
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The IMDb top250 position of the currently selected listitem in a
container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Trailer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Trailer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The full trailer path with filename of the currently selected
movie in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Writer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Writer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of Writer of current Video in a container.
<p><hr>
\xrefitem skinning_v15 17.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Tag</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Tag
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The summary of current Video in a container.
<p><hr>
\xrefitem skinning_v17 63.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Tagline</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Tagline
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A Small Summary of current Video in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PlotOutline</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PlotOutline
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A small Summary of current Video in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Plot</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Plot
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The complete Text Summary of Video in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.IMDBNumber</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_IMDBNumber
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The IMDb ID of the selected Video in a container.
<p><hr>
\xrefitem skinning_v15 18.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.EpisodeName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_EpisodeName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the episode if the selected EPG item is a TV Show (PVR).
<p><hr>
\xrefitem skinning_v15 19.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PercentPlayed</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PercentPlayed
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The percentage value [0-100] of how far the selected video has been
played.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.LastPlayed</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_LastPlayed
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The last play date of Video in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.PlayCount</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_PlayCount
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The playcount of Video in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.ChannelName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_ChannelName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of current selected TV channel in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.VideoCodec</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_VideoCodec
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The video codec of the currently selected video. Common values:
- <b>3iv2</b>
- <b>avc1</b>
- <b>div2</b>
- <b>div3</b>
- <b>divx</b>
- <b>divx 4</b>
- <b>dx50</b>
- <b>flv</b>
- <b>h264</b>
- <b>microsoft</b>
- <b>mp42</b>
- <b>mp43</b>
- <b>mp4v</b>
- <b>mpeg1video</b>
- <b>mpeg2video</b>
- <b>mpg4</b>
- <b>rv40</b>
- <b>svq1</b>
- <b>svq3</b>
- <b>theora</b>
- <b>vp6f</b>
- <b>wmv2</b>
- <b>wmv3</b>
- <b>wvc1</b>
- <b>xvid</b>
- etc
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.VideoResolution</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_VideoResolution
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The resolution of the currently selected video. Possible values:
- <b>480</b>
- <b>576</b>
- <b>540</b>
- <b>720</b>
- <b>1080</b>
- <b>4K</b>
- <b>8K</b>
@note 540 usually means a widescreen
format (around 960x540) while 576 means PAL resolutions (normally
720x576), therefore 540 is actually better resolution than 576.
<p><hr>
\xrefitem skinning_v18 26.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.VideoAspect</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_VideoAspect
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The aspect ratio of the currently selected video. Possible values:
- <b>1.33</b>
- <b>1.37</b>
- <b>1.66</b>
- <b>1.78</b>
- <b>1.85</b>
- <b>2.20</b>
- <b>2.35</b>
- <b>2.40</b>
- <b>2.55</b>
- <b>2.76</b>
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AudioCodec</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AudioCodec
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The audio codec of the currently selected video. Common values:
- <b>aac</b>
- <b>ac3</b>
- <b>cook</b>
- <b>dca</b>
- <b>dtshd_hra</b>
- <b>dtshd_ma</b>
- <b>eac3</b>
- <b>mp1</b>
- <b>mp2</b>
- <b>mp3</b>
- <b>pcm_s16be</b>
- <b>pcm_s16le</b>
- <b>pcm_u8</b>
- <b>truehd</b>
- <b>vorbis</b>
- <b>wmapro</b>
- <b>wmav2</b>
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AudioChannels</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AudioChannels
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The number of audio channels of the currently selected video. Possible values:
- <b>1</b>
- <b>2</b>
- <b>4</b>
- <b>5</b>
- <b>6</b>
- <b>8</b>
- <b>10</b>
<p><hr>
\xrefitem skinning_v16 17.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AudioLanguage</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AudioLanguage
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The audio language of the currently selected video (an
ISO 639-2 three character code: e.g. eng, epo, deu)
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.SubtitleLanguage</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_SubtitleLanguage
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The subtitle language of the currently selected video (an
ISO 639-2 three character code: e.g. eng, epo, deu)
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(AudioCodec.[n])</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_AudioCodec
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The audio codec of the currently selected video
@param n - the number of the audiostream (values: see \ref ListItem_AudioCodec "ListItem.AudioCodec")
<p><hr>
\xrefitem skinning_v16 18.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(AudioChannels.[n])</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_AudioChannels
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The number of audio channels of the currently selected video
@param n - the number of the audiostream (values: see
\ref ListItem_AudioChannels "ListItem.AudioChannels")
<p><hr>
\xrefitem skinning_v16 19.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(AudioLanguage.[n])</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_AudioLanguage
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The audio language of the currently selected video
@param n - the number of the audiostream (values: see \ref ListItem_AudioLanguage "ListItem.AudioLanguage")
<p><hr>
\xrefitem skinning_v16 20.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(SubtitleLanguage.[n])</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_SubtitleLanguage
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The subtitle language of the currently selected video
@param n - the number of the subtitle (values: see \ref ListItem_SubtitleLanguage "ListItem.SubtitleLanguage")
<p><hr>
\xrefitem skinning_v16 21.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Addon.Disclaimer)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_AddonDisclaimer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The disclaimer of the currently selected addon.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Addon.Changelog)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_AddonChangelog
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The changelog of the currently selected addon.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Addon.ID)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_AddonID
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The identifier of the currently selected addon.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Addon.Status)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_AddonStatus
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The status of the currently selected addon.
\xrefitem todo 184.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Addon.Orphaned)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_AddonOrphaned
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the Addon is orphanad.
\xrefitem todo 185.<p><hr>
\xrefitem skinning_v17 64.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Addon.Path)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_AddonPath
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The path of the currently selected addon.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.StartTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_StartTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start time of current selected TV programme in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.EndTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_EndTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The end time of current selected TV programme in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.StartDate</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_StartDate
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start date of current selected TV programme in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.EndDate</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_EndDate
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The end date of current selected TV programme in a container.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextTitle</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextTitle
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The title of the next item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextGenre</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextGenre
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The genre of the next item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextPlot</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextPlot
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The plot of the next item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextPlotOutline</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextPlotOutline
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The plot outline of the next item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextStartTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextStartTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start time of the next item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextEndTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextEndTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The end of the next item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextStartDate</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextStartDate
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start date of the next item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextEndDate</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextEndDate
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The end date of the next item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextDuration</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextDuration
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The duration of the next item (PVR) in the format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 27.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.NextDuration(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_NextDuration_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The duration of the next item (PVR) in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p><hr>
\xrefitem skinning_v18 28.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.ChannelGroup</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_ChannelGroup
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The channel group of the selected item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.ChannelNumberLabel</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_ChannelNumberLabel
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The channel and subchannel number of the currently selected channel that's
currently playing (PVR).
<p><hr>
\xrefitem skinning_v14 3.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Progress</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Progress
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The part of the programme that's been played (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.StereoscopicMode</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_StereoscopicMode
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The stereomode of the selected video:
- <b>mono</b>
- <b>split_vertical</b>
- <b>split_horizontal</b>
- <b>row_interleaved</b>
- <b>anaglyph_cyan_red</b>
- <b>anaglyph_green_magenta</b>
<p><hr>
\xrefitem skinning_v13 50.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.HasTimerSchedule</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_HasTimerSchedule
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the item was scheduled by a timer rule (PVR).
<p><hr>
\xrefitem skinning_v16 22.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.HasRecording</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_HasRecording
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if a given epg tag item currently gets recorded or has been recorded.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.TimerHasError</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_TimerHasError
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the item has a timer and it won't be recorded because of an error (PVR).
<p><hr>
\xrefitem skinning_v17 65.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.TimerHasConflict</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_TimerHasConflict
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the item has a timer and it won't be recorded because of a conflict (PVR).
<p><hr>
\xrefitem skinning_v17 66.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.TimerIsActive</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_TimerIsActive
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the item has a timer that will be recorded, i.e. the timer is enabled (PVR).
<p><hr>
\xrefitem skinning_v17 67.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Comment</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Comment
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The comment assigned to the item (PVR/MUSIC).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.TimerType</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_TimerType
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The type of the PVR timer / timer rule item as a human readable string.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.EpgEventTitle</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_EpgEventTitle
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The title of the epg event associated with the item, if any.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.EpgEventIcon</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_EpgEventIcon
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The thumbnail for the EPG event associated with the item (if it exists).
<p><hr>
\xrefitem skinning_v18 29.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.InProgress</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_InProgress
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the EPG event item is currently active (time-wise).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.IsParentFolder</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_IsParentFolder
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the current list item is the goto parent folder '..'.
<p><hr>
\xrefitem skinning_v17 68.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the currently selected addon.
<p><hr>
\xrefitem skinning_v17 69.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonVersion</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonVersion
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The version of the currently selected addon.
<p><hr>
\xrefitem skinning_v17 70.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonCreator</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonCreator
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the author the currently selected addon.
<p><hr>
\xrefitem skinning_v17 71.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonSummary</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonSummary
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A short description of the currently selected addon.
<p><hr>
\xrefitem skinning_v17 72.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonDescription</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonDescription
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The full description of the currently selected addon.
<p><hr>
\xrefitem skinning_v17 73.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonDisclaimer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonDisclaimer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The disclaimer of the currently selected addon.
<p><hr>
\xrefitem skinning_v17 74.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonBroken</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonBroken
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A message when the addon is marked as broken in the repo.
<p><hr>
\xrefitem skinning_v17 75.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonType</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonType
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The type (screensaver, script, skin, etc...) of the currently selected addon.
<p><hr>
\xrefitem skinning_v17 76.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonInstallDate</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonInstallDate
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The date the addon was installed.
<p><hr>
\xrefitem skinning_v17 77.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonLastUpdated</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonLastUpdated
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The date the addon was last updated.
<p><hr>
\xrefitem skinning_v17 78.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonLastUsed</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonLastUsed
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The date the addon was used last.
<p><hr>
\xrefitem skinning_v17 79.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonNews</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonNews
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A brief changelog, taken from the addons' <tt>addon.xml</tt> file.
<p><hr>
\xrefitem skinning_v17 80.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonSize</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonSize
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The filesize of the addon.
<p><hr>
\xrefitem skinning_v17 81.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.AddonOrigin</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_AddonOrigin
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the repository the add-on originates from.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.ExpirationDate</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_ExpirationDate
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The expiration date of the selected item in a container, empty string if not supported.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.ExpirationTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_ExpirationTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The expiration time of the selected item in a container, empty string if not supported
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Art(type)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Art_Type
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A particular art type for an item.
@param type - the art type. It can be any value (set by scripts and scrappers). Common values:
- <b>clearart</b> - the clearart (if it exists) of the currently selected movie or tv show.
- <b>clearlogo</b> - the clearlogo (if it exists) of the currently selected movie or tv show.
- <b>landscape</b> - the 16:9 landscape (if it exists) of the currently selected item.
- <b>thumb</b> - the thumbnail of the currently selected item.
- <b>poster</b> - the poster of the currently selected movie or tv show.
- <b>banner</b> - the banner of the currently selected tv show.
- <b>fanart</b> - the fanart image of the currently selected item.
- <b>set.fanart</b> - the fanart image of the currently selected movieset.
- <b>tvshow.poster</b> - the tv show poster of the parent container.
- <b>tvshow.banner</b> - the tv show banner of the parent container.
- <b>tvshow.clearlogo</b> - the tv show clearlogo (if it exists) of the parent container.
- <b>tvshow.landscape</b> - the tv show landscape (if it exists) of the parent container.
- <b>tvshow.clearart</b> - the tv show clearart (if it exists) of the parent container.
- <b>season.poster</b> - the season poster of the currently selected season. (Only available in DialogVideoInfo.xml).
- <b>season.banner</b> - the season banner of the currently selected season. (Only available in DialogVideoInfo.xml).
- <b>season.fanart</b> - the fanart image of the currently selected season. (Only available in DialogVideoInfo.xml)
- <b>artist.thumb</b> - the artist thumb of an album or song item.
- <b>artist.fanart</b> - the artist fanart of an album or song item.
- <b>album.thumb</b> - the album thumb (cover) of a song item.
- <b>artist[n].*</b> - in case a song has multiple artists, a digit is added to the art type for the 2nd artist onwards
e.g <tt>Listitem.Art(artist1.thumb)</tt> gives the thumb of the 2nd artist of a song. <br>
- <b>albumartist[n].*</b> - n case a song has multiple album artists, a digit is added to the art type for the 2nd artist
onwards e.g <tt>Listitem.Art(artist1.thumb)</tt> gives the thumb of the 2nd artist of a song.
<p>
\xrefitem todo 186.<p><hr>
\xrefitem skinning_v18 30.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Platform</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Platform
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The game platform (e.g. "Atari 2600") (RETROPLAYER).
<p><hr>
\xrefitem skinning_v18 31.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Genres</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Genres
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The game genres (e.g. "["Action","Strategy"]") (RETROPLAYER).
<p><hr>
\xrefitem skinning_v18 32.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Publisher</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Publisher
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The game publisher (e.g. "Nintendo") (RETROPLAYER).
<p><hr>
\xrefitem skinning_v18 33.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Developer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Developer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The game developer (e.g. "Square") (RETROPLAYER).
<p><hr>
\xrefitem skinning_v18 34.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Overview</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Overview
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The game overview/summary (RETROPLAYER).
<p><hr>
\xrefitem skinning_v18 35.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.GameClient</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_GameClient
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The add-on ID of the game client (a.k.a. emulator) to use for playing the game
(e.g. game.libretro.fceumm) (RETROPLAYER).
<p><hr>
\xrefitem skinning_v18 36.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(propname)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Propname
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The requested property of a ListItem.
@param propname - the property requested
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.Composer)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_Composer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the person who composed the selected song.
<p><hr>
\xrefitem skinning_v17 82.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.Conductor)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_Conductor
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the person who conducted the selected song.
<p><hr>
\xrefitem skinning_v17 83.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.Orchestra)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_Orchestra
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the orchestra performing the selected song.
<p><hr>
\xrefitem skinning_v17 84.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.Lyricist)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_Lyricist
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the person who wrote the lyrics of the selected song.
<p><hr>
\xrefitem skinning_v17 85.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.Remixer)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_Remixer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the person who remixed the selected song.
<p><hr>
\xrefitem skinning_v17 86.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.Arranger)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_Arranger
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the person who arranged the selected song.
<p><hr>
\xrefitem skinning_v17 87.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.Engineer)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_Engineer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the person who was the engineer of the selected song.
<p><hr>
\xrefitem skinning_v17 88.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.Producer)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_Producer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the person who produced the selected song.
<p><hr>
\xrefitem skinning_v17 89.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.DJMixer)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_DJMixer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the dj who remixed the selected song.
<p><hr>
\xrefitem skinning_v17 90.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Role.Mixer)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Role_Mixer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the person who mixed the selected song.
<p><hr>
\xrefitem skinning_v17 91.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Game.VideoFilter)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Game_VideoFilter
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The video filter of the list item representing a
gamewindow control (RETROPLAYER).
See \link RetroPlayer_VideoFilter RetroPlayer.VideoFilter \endlink
for the possible values.
<p><hr>
\xrefitem skinning_v18 37.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Game.StretchMode)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Game_StretchMode
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The stretch mode of the list item representing a
gamewindow control (RETROPLAYER).
See \link RetroPlayer_StretchMode RetroPlayer.StretchMode \endlink
for the possible values.
<p><hr>
\xrefitem skinning_v18 38.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.Property(Game.VideoRotation)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_Property_Game_VideoRotation
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The video rotation of the list item representing a
gamewindow control (RETROPLAYER).
See \link RetroPlayer_VideoRotation RetroPlayer.VideoRotation \endlink
for the possible values.
<p><hr>
\xrefitem skinning_v18 39.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>ListItem.ParentalRating</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor ListItem_ParentalRating
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The parental rating of the list item (PVR).
<p>
@htmlonly </td></tr>\endhtmlonly
</table>
<hr>
@subsection modules__infolabels_boolean_conditions_Visualisation Visualisation
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor=576f9f><th width=30% align=left valign=middle><b> Labels</b></th><th width=10% align=left valign=middle><b> Type</b></th><th width=60% align=left valign=middle><span><b> Description </b></span></th></tr>
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Visualisation.Enabled</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Visualisation_Enabled
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if any visualisation has been set in settings (so not None).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Visualisation.HasPresets</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Visualisation_HasPresets
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the visualisation has built in presets.
<p><hr>
\xrefitem skinning_v16 23.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Visualisation.Locked</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Visualisation_Locked
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the current visualisation preset is locked (e.g. in Milkdrop).
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Visualisation.Preset</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Visualisation_Preset
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The current preset of the visualisation.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Visualisation.Name</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Visualisation_Name
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return the name of the visualisation.
<p>
@htmlonly </td></tr>\endhtmlonly
</table>
<hr>
@subsection modules__infolabels_boolean_conditions_Fanart Fanart
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor=576f9f><th width=30% align=left valign=middle><b> Labels</b></th><th width=10% align=left valign=middle><b> Type</b></th><th width=60% align=left valign=middle><span><b> Description </b></span></th></tr>
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Fanart.Color1</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Fanart_Color1
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The first of three colors included in the currently selected
Fanart theme for the parent TV Show.
@note Colors are arranged Lightest to Darkest.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Fanart.Color2</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Fanart_Color2
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The second of three colors included in the currently selected
Fanart theme for the parent TV Show.
@note Colors are arranged Lightest to Darkest.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Fanart.Color3</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Fanart_Color3
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The third of three colors included in the currently selected
Fanart theme for the parent TV Show.
@note Colors are arranged Lightest to Darkest.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Fanart.Image</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Fanart_Image
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The fanart image, if any
<p>
@htmlonly </td></tr>\endhtmlonly
</table>
<hr>
@subsection modules__infolabels_boolean_conditions_Skin Skin
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor=576f9f><th width=30% align=left valign=middle><b> Labels</b></th><th width=10% align=left valign=middle><b> Type</b></th><th width=60% align=left valign=middle><span><b> Description </b></span></th></tr>
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Skin.CurrentTheme</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Skin_CurrentTheme
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The current selected skin theme.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Skin.CurrentColourTheme</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Skin_CurrentColourTheme
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return the current selected colour theme of the skin.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Skin.AspectRatio</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Skin_AspectRatio
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The closest aspect ratio match using the resolution info from the skin's <tt>addon.xml</tt> file.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Skin.Font</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Skin_Font
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return the current fontset from <tt>Font.xml</tt>.
<p><hr>
\xrefitem skinning_v18 40.<p>
@htmlonly </td></tr>\endhtmlonly
</table>
<hr>
@subsection modules__infolabels_boolean_conditions_Window Window
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor=576f9f><th width=30% align=left valign=middle><b> Labels</b></th><th width=10% align=left valign=middle><b> Type</b></th><th width=60% align=left valign=middle><span><b> Description </b></span></th></tr>
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.IsMedia</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_IsMedia
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if this window is a media window (programs, music, video,
scripts, pictures)
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.Is(window)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_Is
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the window with the given name is the window which is currently rendered.
@param window - the name of the window
@note Useful in xml files that are shared between multiple windows or dialogs.
<p><hr>
\xrefitem skinning_v17 92.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.IsActive(window)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_IsActive
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the window with id or title <em>window</em> is active
@param window - the id or name of the window
@note Excludes fade out time on dialogs
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.IsVisible(window)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_IsVisible
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the window is visible
@note Includes fade out time on dialogs
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.IsTopmost(window)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_IsTopmost
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the window with id or title <em>window</em> is on top of the
window stack.
@param window - the id or name of the window
@note Excludes fade out time on dialogs
\xrefitem deprecated 5.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.IsDialogTopmost(dialog)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_IsDialogTopmost
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the dialog with id or title <em>dialog</em> is on top of the
dialog stack.
@param window - the id or name of the window
@note Excludes fade out time on dialogs
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.IsModalDialogTopmost(dialog)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_IsModalDialogTopmost
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the dialog with id or title <em>dialog</em> is on top of the
modal dialog stack
@note Excludes fade out time on dialogs
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.Previous(window)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_Previous
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the window with id or title <em>window</em> is being moved from.
@param window - the window id or title
@note Only valid while windows are changing.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.Next(window)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_Next
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the window with id or title <em>window</em> is being moved to.
@param window - the window id or title
@note Only valid while windows are changing.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window.Property(Addon.ID)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_Property_AddonId
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The id of the selected addon, in <tt>DialogAddonSettings.xml</tt>.
<p><hr>
\xrefitem skinning_v17 93.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window([window]).Property(key)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_Window_Property_key
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A window property.
@param window - [opt] window id or name.
@param key - any value.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window(AddonBrowser).Property(Updated)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_Addonbrowser_Property_Updated
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The date and time the addon repo was last checked for updates.
\xrefitem todo 187.<p><hr>
\xrefitem skinning_v15 20.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Window(Weather).Property(property)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Window_Weather_Property
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The property for the weather window.
@param property - The requested property. The following are available:
- Current.ConditionIcon
- Day[0-6].OutlookIcon
- Current.FanartCode
- Day[0-6].FanartCode
- WeatherProviderLogo
- Daily.%i.OutlookIcon
- 36Hour.%i.OutlookIcon
- Weekend.%i.OutlookIcon
- Hourly.%i.OutlookIcon
\xrefitem todo 188.<p><hr>
\xrefitem skinning_v16 24.
previously the openweathermap addon would provide the full, hardcoded path to the icon
ie. <tt>resource://resource.images.weathericons.default/28.png</tt>
to make it easier for skins to work with custom icon sets, it now will return the filename only
i.e. 28.png
\xrefitem skinning_v13 51.<p>
@htmlonly </td></tr>\endhtmlonly
</table>
<hr>
@subsection modules__infolabels_boolean_conditions_Control Control
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor=576f9f><th width=30% align=left valign=middle><b> Labels</b></th><th width=10% align=left valign=middle><b> Type</b></th><th width=60% align=left valign=middle><span><b> Description </b></span></th></tr>
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Control.HasFocus(id)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Control_HasFocus
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the currently focused control has id "id".
@param id - The id of the control
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Control.IsVisible(id)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Control_IsVisible
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the control with id "id" is visible.
@param id - The id of the control
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Control.IsEnabled(id)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Control_IsEnabled
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the control with id "id" is enabled.
@param id - The id of the control
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Control.GetLabel(id)[.index()]</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Control_GetLabel
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The label value or texture name of the control with the given id.
@param id - The id of the control
@param index - [opt] Optionally you can specify index(1) to retrieve label2 from an Edit
control.
<p><hr>
\xrefitem skinning_v15 21.<p>
@htmlonly </td></tr>\endhtmlonly
</table>
<hr>
@subsection modules__infolabels_boolean_conditions_Playlist Playlist
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor=576f9f><th width=30% align=left valign=middle><b> Labels</b></th><th width=10% align=left valign=middle><b> Type</b></th><th width=60% align=left valign=middle><span><b> Description </b></span></th></tr>
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Playlist.Length(media)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Playlist_Length
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The total size of the current playlist.
@param media - [opt] mediatype with is either
video or music.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Playlist.Position(media)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Playlist_Position
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The position of the current item in the current playlist.
@param media - [opt] mediatype with is either
video or music.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Playlist.Random</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Playlist_Random
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return String ID for the random mode:
- <strong>16041</strong> (On)
- <strong>591</strong> (Off)
<p><hr>
\xrefitem skinning_v18 41.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Playlist.Repeat</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Playlist_Repeat
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The String Id for the repeat mode. It can be one of the following
values:
- <strong>592</strong> (Repeat One)
- <strong>593</strong> (Repeat All)
- <strong>594</strong> (Repeat Off)
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Playlist.IsRandom</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Playlist_IsRandom
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the player is in random mode.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Playlist.IsRepeat</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Playlist_IsRepeat
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the player is in repeat all mode.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>Playlist.IsRepeatOne</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor Playlist_IsRepeatOne
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if the player is in repeat one mode.
<p>
@htmlonly </td></tr>\endhtmlonly
</table>
<hr>
@subsection modules__infolabels_boolean_conditions_Pvr Pvr
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor=576f9f><th width=30% align=left valign=middle><b> Labels</b></th><th width=10% align=left valign=middle><b> Type</b></th><th width=60% align=left valign=middle><span><b> Description </b></span></th></tr>
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.IsRecording</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_IsRecording
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when the system is recording a tv or radio programme.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.HasTimer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_HasTimer
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when a recording timer is active.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.HasTVChannels</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_HasTVChannels
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if there are TV channels available.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.HasRadioChannels</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_HasRadioChannels
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if there are radio channels available.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.HasNonRecordingTimer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_HasNonRecordingTimer
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if there are timers present who currently not do recording.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the backend being used.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendVersion</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendVersion
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The version of the backend that's being used.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendHost</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendHost
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The backend hostname.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendDiskSpace</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendDiskSpace
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The available diskspace on the backend as string with size.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendDiskSpaceProgr</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendDiskSpaceProgr
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The available diskspace on the backend as percent value.
<p><hr>
\xrefitem skinning_v14 4.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendChannels</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendChannels
<em>string (integer)</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The number of available channels the backend provides.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendTimers</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendTimers
<em>string (integer)</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The number of timers set for the backend.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendRecordings</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendRecordings
<em>string (integer)</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The number of recordings available on the backend.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendDeletedRecordings</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendDeletedRecordings
<em>string (integer)</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The number of deleted recordings present on the backend.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.BackendNumber</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_BackendNumber
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The backend number.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TotalDiscSpace</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TotalDiscSpace
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The total diskspace available for recordings.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.NextTimer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_NextTimer
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The next timer date.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.IsPlayingTV</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_IsPlayingTV
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when live tv is being watched.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.IsPlayingRadio</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_IsPlayingRadio
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when live radio is being listened to.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.IsPlayingRecording</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_IsPlayingRecording
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when a recording is being watched.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.IsPlayingEpgTag</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_IsPlayingEpgTag
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when an epg tag is being watched.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventProgress</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventProgress
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The percentage complete of the currently playing epg event.
<p><hr>
\xrefitem skinning_v18 42.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamClient</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamClient
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The stream client name.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamDevice</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamDevice
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The stream device name.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamStatus</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamStatus
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The status of the stream.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamSignal</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamSignal
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The signal quality of the stream.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamSnr</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamSnr
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The signal to noise ratio of the stream.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamBer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamBer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The bit error rate of the stream.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamUnc</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamUnc
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The UNC value of the stream.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamProgrSignal</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamProgrSignal
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The signal quality of the programme.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamProgrSnr</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamProgrSnr
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The signal to noise ratio of the programme.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamIsEncrypted</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamIsEncrypted
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when channel is encrypted on source.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamEncryptionName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamEncryptionName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The encryption used on the stream.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamServiceName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamServiceName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The service name of played channel if available.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamMux</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamMux
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The multiplex type of played channel if available.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ActStreamProviderName</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ActStreamProviderName
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The provider name of the played channel if available.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.IsTimeShift</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_IsTimeShift
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when for channel is timeshift available.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeShiftProgress</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeShiftProgress
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The position of currently timeshifted title on TV as integer.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.NowRecordingTitle</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_NowRecordingTitle
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The title of the programme being recorded.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.NowRecordingDateTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_NowRecordingDateTime
<em>Date/Time string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start date and time of the current recording.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.NowRecordingChannel</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_NowRecordingChannel
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The channel name of the current recording.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.NowRecordingChannelIcon</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_NowRecordingChannelIcon
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The icon of the current recording channel.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.NextRecordingTitle</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_NextRecordingTitle
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The title of the next programme that will be recorded.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.NextRecordingDateTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_NextRecordingDateTime
<em>Date/Time string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start date and time of the next recording.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.NextRecordingChannel</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_NextRecordingChannel
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The channel name of the next recording.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.NextRecordingChannelIcon</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_NextRecordingChannelIcon
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The icon of the next recording channel.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TVNowRecordingTitle</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TVNowRecordingTitle
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The title of the tv programme being recorded.
<p><hr>
\xrefitem skinning_v17 94.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TVNowRecordingDateTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TVNowRecordingDateTime
<em>Date/Time string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start date and time of the current tv recording.
<p><hr>
\xrefitem skinning_v17 95.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TVNowRecordingChannel</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TVNowRecordingChannel
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The channel name of the current tv recording.
<p><hr>
\xrefitem skinning_v17 96.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TVNowRecordingChannelIcon</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TVNowRecordingChannelIcon
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The icon of the current recording TV channel.
<p><hr>
\xrefitem skinning_v17 97.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TVNextRecordingTitle</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TVNextRecordingTitle
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The title of the next tv programme that will be recorded.
<p><hr>
\xrefitem skinning_v17 98.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TVNextRecordingDateTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TVNextRecordingDateTime
<em>Date/Time string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start date and time of the next tv recording.
<p><hr>
\xrefitem skinning_v17 99.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TVNextRecordingChannel</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TVNextRecordingChannel
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The channel name of the next tv recording.
<p><hr>
\xrefitem skinning_v17 100.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TVNextRecordingChannelIcon</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TVNextRecordingChannelIcon
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The icon of the next recording tv channel.
<p><hr>
\xrefitem skinning_v17 101.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.RadioNowRecordingTitle</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_RadioNowRecordingTitle
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The title of the radio programme being recorded.
<p><hr>
\xrefitem skinning_v17 102.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.RadioNowRecordingDateTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_RadioNowRecordingDateTime
<em>Date/Time string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start date and time of the current radio recording.
<p><hr>
\xrefitem skinning_v17 103.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.RadioNowRecordingChannel</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_RadioNowRecordingChannel
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The channel name of the current radio recording.
<p><hr>
\xrefitem skinning_v17 104.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.RadioNowRecordingChannelIcon</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_RadioNowRecordingChannelIcon
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The icon of the current recording radio channel.
<p><hr>
\xrefitem skinning_v17 105.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.RadioNextRecordingTitle</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_RadioNextRecordingTitle
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The title of the next radio programme that will be recorded.
<p><hr>
\xrefitem skinning_v17 106.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.RadioNextRecordingDateTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_RadioNextRecordingDateTime
<em>Date/Time string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start date and time of the next radio recording.
<p><hr>
\xrefitem skinning_v17 107.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.RadioNextRecordingChannel</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_RadioNextRecordingChannel
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The channel name of the next radio recording.
<p><hr>
\xrefitem skinning_v17 108.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.RadioNextRecordingChannelIcon</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_RadioNextRecordingChannelIcon
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The icon of the next recording radio channel.
<p><hr>
\xrefitem skinning_v17 109.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.IsRecordingTV</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_IsRecordingTV
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when the system is recording a tv programme.
<p><hr>
\xrefitem skinning_v17 110.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.HasTVTimer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_HasTVTimer
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if at least one tv timer is active.
<p><hr>
\xrefitem skinning_v17 111.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.HasNonRecordingTVTimer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_HasNonRecordingTVTimer
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if there are tv timers present who currently not do recording.
<p><hr>
\xrefitem skinning_v17 112.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.IsRecordingRadio</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_IsRecordingRadio
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> when the system is recording a radio programme.
<p><hr>
\xrefitem skinning_v17 113.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.HasRadioTimer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_HasRadioTimer
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if at least one radio timer is active.
<p><hr>
\xrefitem skinning_v17 114.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.HasNonRecordingRadioTimer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_HasNonRecordingRadioTimer
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if there are radio timers present who currently not do recording.
<p><hr>
\xrefitem skinning_v17 115.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.ChannelNumberInput</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_ChannelNumberInput
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The currently entered channel number while in numeric channel input mode, an empty string otherwise.
<p><hr>
\xrefitem skinning_v18 43.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.CanRecordPlayingChannel</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_CanRecordPlayingChannel
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if PVR is currently playing a channel and if this channel can be recorded.
<p><hr>
\xrefitem skinning_v18 44.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.IsRecordingPlayingChannel</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_IsRecordingPlayingChannel
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if PVR is currently playing a channel and if this channel is currently recorded.
<p><hr>
\xrefitem skinning_v18 45.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressPlayPos</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressPlayPos
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The percentage of the current play position within the PVR timeshift progress.
<p><hr>
\xrefitem skinning_v18 46.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressEpgStart</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressEpgStart
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The percentage of the start of the currently playing epg event within the PVR timeshift progress.
<p><hr>
\xrefitem skinning_v18 47.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressEpgEnd</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressEpgEnd
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The percentage of the end of the currently playing epg event within the PVR timeshift progress.
<p><hr>
\xrefitem skinning_v18 48.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressBufferStart</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressBufferStart
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The percentage of the start of the timeshift buffer within the PVR timeshift progress.
<p><hr>
\xrefitem skinning_v18 49.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressBufferEnd</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressBufferEnd
<em>integer</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The percentage of the end of the timeshift buffer within the PVR timeshift progress.
<p><hr>
\xrefitem skinning_v18 50.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventIcon</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventIcon
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The icon of the currently playing epg event, if any.
<p><hr>
\xrefitem skinning_v18 51.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventDuration</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventDuration
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The duration of the currently playing epg event in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 52.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventDuration(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventDuration_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The duration of the currently playing EPG event in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventElapsedTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventElapsedTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return the time of the current position of the currently playing epg event in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 53.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventElapsedTime(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventElapsedTime_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The time of the current position of the currently playing epg event in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventRemainingTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventRemainingTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The remaining time for currently playing epg event in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 54.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventRemainingTime(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventRemainingTime_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The remaining time for currently playing epg event in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventSeekTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventSeekTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The time the user is seeking within the currently playing epg event in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 55.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventSeekTime(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventSeekTime_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The time the user is seeking within the currently playing epg event in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventFinishTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventFinishTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The time the currently playing epg event will end in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 56.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.EpgEventFinishTime(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_EpgEventFinishTime_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
Returns the time the currently playing epg event will end in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeShiftStart</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeShiftStart
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start time of the timeshift buffer in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeShiftStart(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeShiftStart_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
Returns the start time of the timeshift buffer in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeShiftEnd</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeShiftEnd
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The end time of the timeshift buffer in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeShiftEnd(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeShiftEnd_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The end time of the timeshift buffer in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeShiftCur</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeShiftCur
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The current playback time within the timeshift buffer in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeShiftCur(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeShiftCur_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
Returns the current playback time within the timeshift buffer in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeShiftOffset</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeShiftOffset
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The delta of timeshifted time to actual time in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeShiftOffset(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeShiftOffset_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
Returns the delta of timeshifted time to actual time in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressDuration</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressDuration
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return the duration of the PVR timeshift progress in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 57.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressDuration(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressDuration_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The duration of the PVR timeshift progress in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressStartTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressStartTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start time of the PVR timeshift progress in the
format <b>hh:mm:ss</b>.
@note <b>hh:</b> will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 58.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressStartTime(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressStartTime_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The start time of the PVR timeshift progress in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressEndTime</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressEndTime
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The end time of the PVR timeshift progress in the
format <b>hh:mm:ss</b>.
@note hh: will be omitted if hours value is zero.
<p><hr>
\xrefitem skinning_v18 59.<p> <br>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>PVR.TimeshiftProgressEndTime(format)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor PVR_TimeshiftProgressEndTime_format
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The end time of the PVR timeshift progress in different formats.
@param format [opt] The format of the return time value.
See \ref TIME_FORMAT for the list of possible values.
<p>
@htmlonly </td></tr>\endhtmlonly
</table>
<hr>
@subsection modules__infolabels_boolean_conditions_RDS RDS
@note Only supported if both the PVR backend and the Kodi client support RDS.
<table width="100%" style="border" bgcolor="576f9f" border="0">
<tr bgcolor=576f9f><th width=30% align=left valign=middle><b> Labels</b></th><th width=10% align=left valign=middle><b> Type</b></th><th width=60% align=left valign=middle><span><b> Description </b></span></th></tr>
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.HasRds</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_HasRds
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if RDS is present.
<p><hr>
\xrefitem skinning_v16 25.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.HasRadioText</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_HasRadioText
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if RDS contains also Radiotext.
<p><hr>
\xrefitem skinning_v16 26.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.HasRadioTextPlus</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_HasRadioTextPlus
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if RDS with Radiotext contains also the plus information.
<p><hr>
\xrefitem skinning_v16 27.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.HasHotline</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_HasHotline
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if a hotline phone number is present.
@note Only available on RadiotextPlus
<p><hr>
\xrefitem skinning_v16 28.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.HasStudio</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_HasStudio
<em>boolean</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return <strong>True</strong> if a studio name is present.
@note Only available on RadiotextPlus
<p><hr>
\xrefitem skinning_v16 29.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.AudioLanguage</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_AudioLanguage
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The RDS reported audio language of the channel.
<p><hr>
\xrefitem skinning_v16 30.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.ChannelCountry</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_ChannelCountry
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The country where the radio channel is broadcasted.
<p><hr>
\xrefitem skinning_v16 31.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.GetLine(number)</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_GetLine
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The last sent RDS text messages on given number.
@param number - given number for RDS, 0 is the
last and 4 rows are supported (0-3)
<p><hr>
\xrefitem skinning_v16 32.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.Title</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_Title
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The title of item; e.g. track title of an album.
@note Only available on RadiotextPlus
<p><hr>
\xrefitem skinning_v16 33.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.Artist</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_Artist
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return A person or band/collective generally considered responsible for the work.
@note Only available on RadiotextPlus
<p><hr>
\xrefitem skinning_v16 34.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.Band</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_Band
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The band/orchestra/musician.
@note Only available on RadiotextPlus
<p><hr>
\xrefitem skinning_v16 35.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.Composer</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_Composer
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The name of the original composer/author.
@note Only available on RadiotextPlus
<p><hr>
\xrefitem skinning_v16 36.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.Conductor</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_Conductor
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The artist(s) who performed the work. In classical music this would be
the conductor.
@note Only available on RadiotextPlus
<p><hr>
\xrefitem skinning_v16 37.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.Album</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_Album
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The album of the song.
@note Only available on RadiotextPlus
<p><hr>
\xrefitem skinning_v16 38.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.TrackNumber</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_TrackNumber
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The track number of the item on the album on which it was originally
released.
@note Only be available on RadiotextPlus
<p><hr>
\xrefitem skinning_v16 39.<p>
@htmlonly </td></tr>\endhtmlonly
@htmlonly <tr bgcolor=white><td width= 30% align=left>\endhtmlonly <b><tt>RDS.RadioStyle</tt></b>@htmlonly </td><td width= 10% align=left>\endhtmlonly
@anchor RDS_RadioStyle
<em>string</em>@htmlonly </td><td width= 60% align=left>\endhtmlonly
@return The style of current played radio channel, it is always
updated once the style changes, e.g "popmusic" to "news" or "weather"...
<table class="markdownTable">
<tr class="markdownTableHead"> <th class="markdownTableHeadLeft"> RDS
| RBDS |
none | none |
news | news |
currentaffairs | information |
information | sport |
sport | talk |
education | rockmusic |
drama | classicrockmusic |
cultures | adulthits |
science | softrock |
variedspeech | top40 |
popmusic | countrymusic |
rockmusic | oldiesmusic |
easylistening | softmusic |
lightclassics | nostalgia |
seriousclassics | jazzmusic |
othermusic | classical |
weather | randb |
finance | softrandb |
childrensprogs | language |
socialaffairs | religiousmusic |
religion | religioustalk |
phonein | personality |
travelandtouring | public |
leisureandhobby | college |
jazzmusic | spanishtalk |
countrymusic | spanishmusic |
nationalmusic | hiphop |
oldiesmusic | |
folkmusic | |
documentary | weather |
alarmtest | alarmtest |
alarm-alarm | alarm-alarm |
Labels | Type | Description |
Slideshow.IsActive | boolean | - Returns
- True if the picture slideshow is running.
|
Slideshow.IsPaused | boolean | - Returns
- True if the picture slideshow is paused.
|
Slideshow.IsRandom | boolean | - Returns
- True if the picture slideshow is in random mode.
|
Slideshow.IsVideo | boolean | - Returns
- True if the picture slideshow is playing a video.
- v13 Skinning engine changes:
- [New Boolean Condition]
Slideshow.IsVideo
|
Slideshow.Altitude | string | - Returns
- The altitude in meters where the current picture was taken.
- Note
- This is the value of the EXIF GPSInfo.GPSAltitude tag.
|
Slideshow.Aperture | string | - Returns
- The F-stop used to take the current picture.
- Note
- This is the value of the EXIF FNumber tag (hex code 0x829D).
|
Slideshow.Author | string | - Returns
- The name of the person involved in writing about the current picture.
- Note
- This is the value of the IPTC Writer tag (hex code 0x7A).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Author
|
Slideshow.Byline | string | - Returns
- The name of the person who created the current picture.
- Note
- This is the value of the IPTC Byline tag (hex code 0x50).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Byline
|
Slideshow.BylineTitle | string | - Returns
- The title of the person who created the current picture.
- Note
- This is the value of the IPTC BylineTitle tag (hex code 0x55).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.BylineTitle
|
Slideshow.CameraMake | string | - Returns
- The manufacturer of the camera used to take the current picture.
- Note
- This is the value of the EXIF Make tag (hex code 0x010F).
|
Slideshow.CameraModel | string | - Returns
- The manufacturer's model name or number of the camera used to take the current picture.
- Note
- This is the value of the EXIF Model tag (hex code 0x0110).
|
Slideshow.Caption | string | - Returns
- A description of the current picture.
- Note
- This is the value of the IPTC Caption tag (hex code 0x78).
|
Slideshow.Category | string | - Returns
- The subject of the current picture as a category code.
- Note
- This is the value of the IPTC Category tag (hex code 0x0F).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Category
|
Slideshow.CCDWidth | string | - Returns
- The width of the CCD in the camera used to take the current picture.
- Note
- This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.CCDWidth
|
Slideshow.City | string | - Returns
- The city where the current picture was taken.
- Note
- This is the value of the IPTC City tag (hex code 0x5A).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.City
|
Slideshow.Colour | string | - Returns
- the colour of the picture. It can have one of the following values:
- "Colour"
- "Black and White"
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Colour
|
Slideshow.CopyrightNotice | string | - Returns
- The copyright notice of the current picture.
- Note
- This is the value of the IPTC Copyright tag (hex code 0x74).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.CopyrightNotice
|
Slideshow.Country | string | - Returns
- The full name of the country where the current picture was taken.
- Note
- This is the value of the IPTC CountryName tag (hex code 0x65).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Country
|
Slideshow.CountryCode | string | - Returns
- The country code of the country where the current picture was taken.
- Note
- This is the value of the IPTC CountryCode tag (hex code 0x64).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.CountryCode
|
Slideshow.Credit | string | - Returns
- Who provided the current picture.
- Note
- This is the value of the IPTC Credit tag (hex code 0x6E).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Credit
|
Slideshow.DigitalZoom | string | - Returns
- The digital zoom ratio when the current picture was taken.
- Note
- This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.DigitalZoom
|
Slideshow.EXIFComment | string | - Returns
- A description of the current picture.
- Note
- This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment.
|
Slideshow.EXIFDate | string | - Returns
- The localized date of the current picture. The short form of the date is used.
- Note
- The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.EXIFDate
|
Slideshow.EXIFDescription | string | - Returns
- A short description of the current picture. The SlideComment, EXIFComment or Caption values might contain a longer description.
- Note
- This is the value of the EXIF ImageDescription tag (hex code 0x010E).
|
Slideshow.EXIFSoftware | string | - Returns
- The name and version of the firmware used by the camera that took the current picture.
- Note
- This is the value of the EXIF Software tag (hex code 0x0131).
|
Slideshow.EXIFTime | string | - Returns
- The date/timestamp of the current picture. The localized short form of the date and time is used.
- Note
- The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
|
Slideshow.Exposure | string | - Returns
- The class of the program used by the camera to set exposure when the current picture was taken. Values include:
- "Manual"
- "Program (Auto)"
- "Aperture priority (Semi-Auto)"
- "Shutter priority (semi-auto)"
- etc...
- Note
- This is the value of the EXIF ExposureProgram tag (hex code 0x8822).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Exposure
|
Slideshow.ExposureBias | string | - Returns
- The exposure bias of the current picture. Typically this is a number between -99.99 and 99.99.
- Note
- This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.ExposureBias
|
Slideshow.ExposureMode | string | - Returns
- The exposure mode of the current picture. The possible values are:
- "Automatic"
- "Manual"
- "Auto bracketing"
- Note
- This is the value of the EXIF ExposureMode tag (hex code 0xA402).
|
Slideshow.ExposureTime | string | - Returns
- The exposure time of the current picture, in seconds.
- Note
- This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used.
|
Slideshow.Filedate | string | - Returns
- The file date of the current picture.
|
Slideshow.Filename | string | - Returns
- The file name of the current picture.
|
Slideshow.Filesize | string | - Returns
- The file size of the current picture.
|
Slideshow.FlashUsed | string | - Returns
- The status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information.
- Note
- This is the value of the EXIF Flash tag (hex code 0x9209).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.FlashUsed
|
Slideshow.FocalLength | string | - Returns
- The focal length of the lens, in mm.
- Note
- This is the value of the EXIF FocalLength tag (hex code 0x920A).
|
Slideshow.FocusDistance | string | - Returns
- The distance to the subject, in meters.
- Note
- This is the value of the EXIF SubjectDistance tag (hex code 0x9206).
|
Slideshow.Headline | string | - Returns
- A synopsis of the contents of the current picture.
- Note
- This is the value of the IPTC Headline tag (hex code 0x69).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Headline
|
Slideshow.ImageType | string | - Returns
- The color components of the current picture.
- Note
- This is the value of the IPTC ImageType tag (hex code 0x82).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.ImageType
|
Slideshow.IPTCDate | string | - Returns
- The date when the intellectual content of the current picture was created, rather than when the picture was created.
- Note
- This is the value of the IPTC DateCreated tag (hex code 0x37).
|
Slideshow.ISOEquivalence | string | - Returns
- The ISO speed of the camera when the current picture was taken.
- Note
- This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827).
|
Slideshow.Keywords | string | - Returns
- The keywords assigned to the current picture.
- Note
- This is the value of the IPTC Keywords tag (hex code 0x19).
|
Slideshow.Latitude | string | - Returns
- The latitude where the current picture was taken (degrees, minutes, seconds North or South).
- Note
- This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags.
|
Slideshow.LightSource | string | - Returns
- The kind of light source when the picture was taken. Possible values include:
- "Daylight"
- "Fluorescent"
- "Incandescent"
- etc...
- Note
- This is the value of the EXIF LightSource tag (hex code 0x9208).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.LightSource
|
Slideshow.LongEXIFDate | string | - Returns
- Only the localized date of the current picture. The long form of the date is used.
- Note
- The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.LongEXIFDate
|
Slideshow.LongEXIFTime | string | - Returns
- The date/timestamp of the current picture. The localized long form of the date and time is used.
- Note
- The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used.
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.LongEXIFTime
|
Slideshow.Longitude | string | - Returns
- The longitude where the current picture was taken (degrees, minutes, seconds East or West).
- Note
- This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags.
|
Slideshow.MeteringMode | string | - Returns
- The metering mode used when the current picture was taken. The possible values are:
- "Center weight"
- "Spot"
- "Matrix"
- Note
- This is the value of the EXIF MeteringMode tag (hex code 0x9207).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.MeteringMode
|
Slideshow.ObjectName | string | - Returns
- a shorthand reference for the current picture.
- Note
- This is the value of the IPTC ObjectName tag (hex code 0x05).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.ObjectName
|
Slideshow.Orientation | string | - Returns
- The orientation of the current picture. Possible values are:
- "Top Left"
- "Top Right"
- "Left Top"
- "Right Bottom"
- etc...
- Note
- This is the value of the EXIF Orientation tag (hex code 0x0112).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Orientation
|
Slideshow.Path | string | - Returns
- The file path of the current picture.
|
Slideshow.Process | string | - Returns
- The process used to compress the current picture.
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Process
|
Slideshow.ReferenceService | string | - Returns
- The Service Identifier of a prior envelope to which the current picture refers.
- Note
- This is the value of the IPTC ReferenceService tag (hex code 0x2D).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.ReferenceService
|
Slideshow.Resolution | string | - Returns
- The dimensions of the current picture (Width x Height)
|
Slideshow.SlideComment | string | - Returns
- A description of the current picture.
- Note
- This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment.
|
Slideshow.SlideIndex | string | - Returns
- The slide index of the current picture.
|
Slideshow.Source | string | - Returns
- The original owner of the current picture.
- Note
- This is the value of the IPTC Source tag (hex code 0x73).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Source
|
Slideshow.SpecialInstructions | string | - Returns
- Other editorial instructions concerning the use of the current picture.
- Note
- This is the value of the IPTC SpecialInstructions tag (hex code 0x28).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.SpecialInstructions
|
Slideshow.State | string | - Returns
- The State/Province where the current picture was taken.
- Note
- This is the value of the IPTC ProvinceState tag (hex code 0x5F).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.State
|
Slideshow.Sublocation | string | - Returns
- The location within a city where the current picture was taken - might indicate the nearest landmark.
- Note
- This is the value of the IPTC SubLocation tag (hex code 0x5C).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Sublocation
|
Slideshow.SupplementalCategories | string | - Returns
- The supplemental category codes to further refine the subject of the current picture.
- Note
- This is the value of the IPTC SuppCategory tag (hex code 0x14).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.SupplementalCategories
|
Slideshow.TimeCreated | string | - Returns
- The time when the intellectual content of the current picture was created, rather than when the picture was created.
- Note
- This is the value of the IPTC TimeCreated tag (hex code 0x3C).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.TimeCreated
|
Slideshow.TransmissionReference | string | - Returns
- A code representing the location of original transmission of the current picture.
- Note
- This is the value of the IPTC TransmissionReference tag (hex code 0x67).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.TransmissionReference
|
Slideshow.Urgency | string | - Returns
- The urgency of the current picture. Values are 1-9. The 1 is most urgent.
- Note
- Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.Urgency
|
Slideshow.WhiteBalance | string | - Returns
- The white balance mode set when the current picture was taken. The possible values are:
- Note
- This is the value of the EXIF WhiteBalance tag (hex code 0xA403).
- v13 Skinning engine changes:
- [New Infolabel]
Slideshow.WhiteBalance
|