Labels | Type | Description |
System.AlarmLessOrEqual(alarmname,seconds) | boolean | Returns true if the alarm with alarmname has less or equal to seconds left. Standard use would be system.alarmlessorequal(shutdowntimer,119), which would return true when the shutdowntimer has less then 2 minutes left. |
System.HasNetwork | boolean | Returns true if the ethernet cable is plugged in. |
System.HasMediadvd | boolean | Returns true if there is a CD or DVD in the DVD-ROM drive. |
System.DVDReady | boolean | Returns true if disc is ready to use. |
System.TrayOpen | boolean | Returns true if discs tray is open |
System.HasLocks | boolean | Returns true if system has an active lock mode. |
System.IsMaster | boolean | Returns true if 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.IdleTime(time) | boolean | Returns true if Kodi has had no input for ?time? amount of seconds. |
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(id) | boolean | Returns true if at least one pvr client addon is installed and enabled. |
System.HasCMS | boolean | Returns true if colour management is supported from Kodi - Note
- currently only supported for OpenGL
|
System.HasActiveModalDialog | boolean | Returns true if a modal dialog is active |
System.HasVisibleModalDialog | boolean | Returns true if a modal dialog is visible |
System.Time(startTime,endTime) | boolean | Returns true if the current system time is >= startTime and < endTime. endTime is optional. Time must be specified in the format HH:mm, using a 24 hour clock. |
System.Date(startDate,endDate) | boolean | Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD. |
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. |
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). |
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.ATV2 | boolean | Returns true if Kodi is running on an atv2. |
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 | Return true when to osd keyboard/numeric dialog requests a password/pincode. |
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 | Current time |
System.Time(format) | string | Returns hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
System.Date | string | Current date |
System.Date(format) | string | Show current date using format, available markings: d (day of month 1-31), dd (day of month 01-31), ddd (short day of the week Mon-Sun), DDD (long day of the week Monday-Sunday), m (month 1-12), mm (month 01-12), mmm (short month name Jan-Dec), MMM (long month name January - December), yy (2-digit year), yyyy (4-digit year). Added after dharma. |
System.AlarmPos | string | Shutdown Timer position |
System.BatteryLevel | string | Returns the remaining battery level in range 0-100 |
System.FreeSpace | string | Total Freespace on the drive |
System.UsedSpace | string | Total Usedspace on the drive |
System.TotalSpace | string | Totalspace on the drive |
System.UsedSpacePercent | string | Total Usedspace Percent on the drive |
System.FreeSpacePercent | string | Total Freespace Percent on the drive |
System.CPUTemperature | string | Current CPU temperature |
System.CpuUsage | string | Displays the cpu usage for each individual cpu core. |
System.GPUTemperature | string | Current GPU temperature |
System.FanSpeed | string | Current fan speed |
System.BuildVersion | string | Version of build |
System.BuildVersionShort | string | Shorter string with version of build |
System.BuildDate | string | Date of build |
System.FriendlyName | string | Returns the Kodi instance name. It will auto append (hostname%) in case the device name was not changed. eg. "Kodi (htpc)" |
System.FPS | string | Current rendering speed (frames per second) |
System.FreeMemory | string | Amount of free memory in Mb |
System.ScreenMode | string | Screenmode (eg windowed / fullscreen) |
System.ScreenWidth | string | Width of screen in pixels |
System.ScreenHeight | string | Height of screen in pixels |
System.StartupWindow | string | The Window Kodi will load on startup |
System.CurrentWindow | string | Current Window we are in |
System.CurrentControl | string | Current focused control |
System.CurrentControlId | string | ID of the currently focused control. |
System.DVDLabel | string | Label of the disk in the DVD-ROM drive |
System.KernelVersion | string | System kernel version |
System.OSVersionInfo | string | System name + kernel version |
System.Uptime | string | System current uptime |
System.TotalUptime | string | System total uptime |
System.CpuFrequency | string | System cpu frequency |
System.ScreenResolution | string | Screen resolution |
System.VideoEncoderInfo | string | Video encoder info |
System.InternetState | string | Will return the internet state, connected or not connected and for Conditional use: Connected->TRUE, not Connected->FALSE, do not use to check status in a pythonscript since it is threaded. |
System.Language | 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 | The profile Kodi will auto login to |
System.StereoscopicMode | string | The prefered stereoscopic mode (settings > video > playback) |
System.TemperatureUnits | string | Returns Celsius or 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. Will not work with settings in advancedsettings.xml |
System.AddonTitle(id) | string | Returns the title of the addon with the given id |
System.AddonVersion(id) | string | Returns the version of the addon with the given id |
System.PrivacyPolicy | string | Returns the official Kodi privacy policy |
Labels | Type | Description |
MusicPlayer.Offset(number).Exists | boolean | Returns true if the music players playlist has a song queued in position (number). |
MusicPlayer.Title | string | Title of the currently playing song, also available are "MusicPlayer.offset(number).Title" offset is relative to the current playing item and "MusicPlayer.Position(number).Title" position is relative to the start of the playlist |
MusicPlayer.Album | string | Album from which the current song is from, also available are "MusicPlayer.offset(number).Album" offset is relative to the current playing item and "MusicPlayer.Position(number).Album" position is relative to the start of the playlist |
MusicPlayer.Property(Album_Mood) | 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 | Artist(s) of current song, also available are "MusicPlayer.offset(number).Artist" offset is relative to the current playing item and "MusicPlayer.Position(number).Artist" position is relative to the start of the playlist |
MusicPlayer.AlbumArtist | string | Album artist of the currently playing song |
MusicPlayer.Cover | string | Album cover of currently playing song |
MusicPlayer.Property(Artist_Sortname) | string | Sortname of the currently playing Artist |
MusicPlayer.Property(Artist_Type) | string | Type of the currently playing Artist - person, group, orchestra, choir etc. |
MusicPlayer.Property(Artist_Gender) | string | Gender of the currently playing Artist - male, female, other |
MusicPlayer.Property(Artist_Disambiguation) | string | Brief description of the currently playing Artist that differentiates them from others with the same name |
MusicPlayer.Property(Artist_Born) | string | Date of Birth of the currently playing Artist |
MusicPlayer.Property(Artist_Died) | string | Date of Death of the currently playing Artist |
MusicPlayer.Property(Artist_Formed) | string | Formation date of the currently playing Artist/Band |
MusicPlayer.Property(Artist_Disbanded) | string | Disbanding date of the currently playing Artist/Band |
MusicPlayer.Property(Artist_YearsActive) | string | Years the currently Playing artist has been active |
MusicPlayer.Property(Artist_Instrument) | string | 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 | Genre(s) of current song, also available are "MusicPlayer.offset(number).Genre" offset is relative to the current playing item and "MusicPlayer.Position(number).Genre" position is relative to the start of the playlist |
MusicPlayer.Lyrics | string | Lyrics of current song stored in ID tag info |
MusicPlayer.Year | string | Year of release of current song, also available are "MusicPlayer.offset(number).Year" offset is relative to the current playing item and "MusicPlayer.Position(number).Year" position is relative to the start of the playlist |
MusicPlayer.Rating | string | Numeric Rating of current song, also available are "MusicPlayer.offset(number).Rating" offset is relative to the current playing item and "MusicPlayer.Position(number).Rating" position is relative to the start of the playlist |
MusicPlayer.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 |
MusicPlayer.Votes | string | Returns the scraped votes of currently playing song, if it's in the database |
MusicPlayer.DiscNumber | string | Disc Number of current song stored in ID tag info, also available are "MusicPlayer.offset(number).DiscNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).DiscNumber" position is relative to the start of the playlist |
MusicPlayer.Comment | string | Comment of current song stored in ID tag info, also available are "MusicPlayer.offset(number).Comment" offset is relative to the current playing item and "MusicPlayer.Position(number).Comment" position is relative to the start of the playlist |
MusicPlayer.Mood | string | Mood of the currently playing song |
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. 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 | Track number of current song, also available are "MusicPlayer.offset(number).TrackNumber" offset is relative to the current playing item and "MusicPlayer.Position(number).TrackNumber" position is relative to the start of the playlist |
MusicPlayer.Duration | string | Duration of current song, also available are "MusicPlayer.offset(number).Duration" offset is relative to the current playing item and "MusicPlayer.Position(number).Duration" position is relative to the start of the playlist |
MusicPlayer.BitRate | string | Bitrate of current song |
MusicPlayer.Channels | string | Number of channels of current song |
MusicPlayer.BitsPerSample | string | Number of bits per sample of current song |
MusicPlayer.SampleRate | string | Samplerate of current song |
MusicPlayer.Codec | string | Codec of current song |
MusicPlayer.PlaylistPosition | string | Position of the current song in the current music playlist |
MusicPlayer.PlaylistLength | string | Total size of the current music playlist |
MusicPlayer.ChannelName | string | Channel name of the radio programme that's currently playing (PVR). |
MusicPlayer.ChannelNumberLabel | string | Channel and subchannel number of the radio channel that's currently playing (PVR). |
MusicPlayer.ChannelGroup | string | Channel group of the radio programme that's currently playing (PVR). |
MusicPlayer.Property(propname) | string | Get a property of the currently playing item. |
Labels | Type | Description |
VideoPlayer.UsingOverlays | boolean | Returns true if the video player is using the hardware overlays render method. 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 |
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 | Title of currently playing video. If it's in the database it will return the database title, else the filename |
VideoPlayer.OriginalTitle | string | Original title of currently playing video. If it's in the database |
VideoPlayer.TVShowTitle | string | Title of currently playing episode's tvshow name |
VideoPlayer.Season | string | Season number of the currently playing episode, if it's in the database |
VideoPlayer.Episode | string | Episode number of the currently playing episode |
VideoPlayer.Genre | string | Genre(s) of current movie, if it's in the database |
VideoPlayer.Director | string | Director of current movie, if it's in the database |
VideoPlayer.Country | string | Production country of current movie, if it's in the database |
VideoPlayer.Year | string | Year of release of current movie, if it's in the database |
VideoPlayer.Cover | string | 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 |
VideoPlayer.Votes | string | Returns the scraped votes of current movie, if it's in the database |
VideoPlayer.RatingAndVotes | string | Returns the scraped rating and votes of current movie, if it's in the database |
VideoPlayer.mpaa | string | MPAA rating of current movie, if it's in the database |
VideoPlayer.IMDBNumber | string | The IMDb ID of the current movie, if it's in the database |
VideoPlayer.Top250 | string | IMDb Top250 position of the currently playing movie, if it's in the database |
VideoPlayer.EpisodeName | string | (PVR only) The name of the episode if the playing video is a TV Show, if it's in the database |
VideoPlayer.PlaylistPosition | string | Position of the current song in the current video playlist |
VideoPlayer.PlaylistLength | string | Total size of the current video playlist |
VideoPlayer.Cast | string | A concatenated string of cast members of the current movie, if it's in the database |
VideoPlayer.CastAndRole | string | A concatenated string of cast members and roles of the current movie, if it's in the database |
VideoPlayer.Album | string | Album from which the current Music Video is from, if it's in the database |
VideoPlayer.Artist | string | Artist(s) of current Music Video, if it's in the database |
VideoPlayer.Studio | string | Studio of current Music Video, if it's in the database |
VideoPlayer.Writer | string | Name of Writer of current playing Video, if it's in the database |
VideoPlayer.Tagline | string | Small Summary of current playing Video, if it's in the database |
VideoPlayer.PlotOutline | string | Small Summary of current playing Video, if it's in the database |
VideoPlayer.Plot | string | Complete Text Summary of current playing Video, if it's in the database |
VideoPlayer.Premiered | string | Release or aired date of the currently playing episode, show, movie or EPG item, if it's in the database |
VideoPlayer.Trailer | string | The path to the trailer of the currently playing movie, if it's in the database |
VideoPlayer.LastPlayed | string | Last play date of current playing Video, if it's in the database |
VideoPlayer.PlayCount | string | 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) |
VideoPlayer.AudioLanguage | string | Returns the language of the audio of the currently playing video(possible values: see ListItem.AudioLanguage) |
VideoPlayer.SubtitlesLanguage | string | Returns the language of the subtitle of the currently playing video (possible values: see ListItem.SubtitleLanguage) |
VideoPlayer.StereoscopicMode | string | Returns the stereoscopic mode of the currently playing video (possible values: see ListItem.StereoscopicMode) |
VideoPlayer.StartTime | string | Start date and time of the currently playing epg event or recording (PVR). |
VideoPlayer.EndTime | string | End date and time of the currently playing epg event or recording (PVR). |
VideoPlayer.NextTitle | string | Title of the programme that will be played next (PVR). |
VideoPlayer.NextGenre | string | Genre of the programme that will be played next (PVR). |
VideoPlayer.NextPlot | string | Plot of the programme that will be played next (PVR). |
VideoPlayer.NextPlotOutline | string | Plot outline of the programme that will be played next (PVR). |
VideoPlayer.NextStartTime | string | Start time of the programme that will be played next (PVR). |
VideoPlayer.NextEndTime | string | End time of the programme that will be played next (PVR). |
VideoPlayer.NextDuration | string | Duration of the programme that will be played next (PVR). |
VideoPlayer.ChannelName | string | Name of the currently tuned channel (PVR). |
VideoPlayer.ChannelNumberLabel | string | Channel and subchannel number of the tv channel that's currently playing (PVR). |
VideoPlayer.ChannelGroup | string | Group of the currently tuned channel (PVR). |
VideoPlayer.ParentalRating | string | Parental rating of the currently playing programme (PVR). |
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. 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 whether the current ListItem is a folder |
ListItem.IsPlaying | boolean | Returns whether 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 |
ListItem.IsSelected | boolean | Returns whether 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 |
ListItem.Property(IsSpecial) | boolean | Returns whether the current Season/Episode is a Special |
ListItem.Property(DateLabel) | string | Can be used in the rulerlayout of the epggrid control. Will return true if the item is a date label, returns false if the item is a time label. |
ListItem.Property(Addon.Enabled) | boolean | Returns true when the selected addon is enabled (for use in the addon info dialog only). |
ListItem.Property(Addon.Installed) | boolean | Returns true when the selected addon is installed (for use in the addon info dialog only). |
ListItem.Property(Addon.UpdateAvail) | boolean | Returns true when there's an update available for the selected addon. |
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 or movie in a container |
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 | Sortname of the currently selected Artist |
ListItem.Property(Artist_Type) | string | Type of the currently selected Artist - person, group, orchestra, choir etc. |
ListItem.Property(Artist_Gender) | string | Gender of the currently selected Artist - male, female, other |
ListItem.Property(Artist_Disambiguation) | string | Brief description of the currently selected Artist that differentiates them from others with the same name |
ListItem.Property(Artist_Born) | string | Date of Birth of the currently selected Artist |
ListItem.Property(Artist_Died) | string | Date of Death of the currently selected Artist |
ListItem.Property(Artist_Formed) | string | Formation date of the currently selected Band |
ListItem.Property(Artist_Disbanded) | string | Disbanding date of the currently selected Band |
ListItem.Property(Artist_YearsActive) | string | Years the currently selected artist has been active |
ListItem.Property(Artist_Instrument) | string | 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 or movie in a container |
ListItem.Premiered | string | Returns the release/aired date of the currently selected episode, show, movie or EPG item in a container |
ListItem.Genre | string | Returns the genre of the currently selected song, album or movie in a container |
ListItem.Contributors | string | List of all people who've contributed to the selected song |
ListItem.ContributorAndRole | string | List of all people and their role who've contributed to the selected song |
ListItem.Director | string | Returns the director of the currently selected movie in a container |
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. |
ListItem.Season | string | Returns the season value for the currently selected tvshow |
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. 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. This is the value of the IPTC Writer tag (hex code 0x7A). |
ListItem.PictureByline | string | Returns the name of the person who created the selected picture. This is the value of the IPTC Byline tag (hex code 0x50). |
ListItem.PictureBylineTitle | string | Returns the title of the person who created the selected picture. This is the value of the IPTC BylineTitle tag (hex code 0x55). |
ListItem.PictureCamMake | string | Returns the manufacturer of the camera used to take the selected picture. This is the value of the EXIF Make tag (hex code 0x010F). |
ListItem.PictureCamModel | string | Returns the manufacturer's model name or number of the camera used to take the selected picture. This is the value of the EXIF Model tag (hex code 0x0110). |
ListItem.PictureCaption | string | Returns a description of the selected picture. 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. This is the value of the IPTC Category tag (hex code 0x0F). |
ListItem.PictureCCDWidth | string | Returns the width of the CCD in the camera used to take the selected picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e). |
ListItem.PictureCity | string | Returns the city where the selected picture was taken. This is the value of the IPTC City tag (hex code 0x5A). |
ListItem.PictureColour | string | Returns whether the selected picture is "Colour" or "Black and White". |
ListItem.PictureComment | string | Returns a description of the selected picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment. |
ListItem.PictureCopyrightNotice | string | Returns the copyright notice of the selected picture. This is the value of the IPTC Copyright tag (hex code 0x74). |
ListItem.PictureCountry | string | Returns the full name of the country where the selected picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65). |
ListItem.PictureCountryCode | string | Returns the country code of the country where the selected picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64). |
ListItem.PictureCredit | string | Returns who provided the selected picture. This is the value of the IPTC Credit tag (hex code 0x6E). |
ListItem.PictureDate | string | Returns the localized date of the selected picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used. |
ListItem.PictureDatetime | string | Returns the date/timestamp of the selected picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used. |
ListItem.PictureDesc | string | Returns a short description of the selected picture. The SlideComment, EXIFComment, or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E). |
ListItem.PictureDigitalZoom | string | Returns the digital zoom ratio when the selected picture was taken. This is the value of the EXIF DigitalZoomRatio tag (hex code 0xA404). |
ListItem.PictureExpMode | string | Returns the exposure mode of the selected picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402). |
ListItem.PictureExposure | 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. This is the value of the EXIF ExposureProgram tag (hex code 0x8822). |
ListItem.PictureExposureBias | string | Returns the exposure bias of the selected picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204). |
ListItem.PictureExpTime | string | Returns the exposure time of the selected picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used. |
ListItem.PictureFlashUsed | 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. This is the value of the EXIF Flash tag (hex code 0x9209). |
ListItem.PictureFocalLen | string | Returns the lens focal length of the selected picture |
ListItem.PictureFocusDist | string | Returns the focal length of the lens, in mm. 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). 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). 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. This is the value of the EXIF GPSInfo.GPSAltitude tag. |
ListItem.PictureHeadline | string | Returns a synopsis of the contents of the selected picture. This is the value of the IPTC Headline tag (hex code 0x69). |
ListItem.PictureImageType | string | Returns the color components of the selected picture. This is the value of the IPTC ImageType tag (hex code 0x82). |
ListItem.PictureIPTCDate | string | Returns the date when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37). |
ListItem.PictureIPTCTime | string | Returns the time when the intellectual content of the selected picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C). |
ListItem.PictureISO | string | Returns the ISO speed of the camera when the selected picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827). |
ListItem.PictureKeywords | string | Returns keywords assigned to the selected picture. This is the value of the IPTC Keywords tag (hex code 0x19). |
ListItem.PictureLightSource | string | Returns the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208). |
ListItem.PictureLongDate | string | Returns only the localized date of the selected picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used. |
ListItem.PictureLongDatetime | string | Returns the date/timestamp of the selected picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used. |
ListItem.PictureMeteringMode | string | Returns the metering mode used when the selected picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207). |
ListItem.PictureObjectName | string | Returns a shorthand reference for the selected picture. This is the value of the IPTC ObjectName tag (hex code 0x05). |
ListItem.PictureOrientation | string | Returns the orientation of the selected picture. Possible values are "Top
Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112). |
ListItem.PicturePath | string | Returns the filename and path of the selected picture |
ListItem.PictureProcess | string | Returns the process used to compress the selected picture |
ListItem.PictureReferenceService | string | Returns the Service Identifier of a prior envelope to which the selected picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D). |
ListItem.PictureResolution | string | Returns the dimensions of the selected picture |
ListItem.PictureSource | string | Returns the original owner of the selected picture. This is the value of the IPTC Source tag (hex code 0x73). |
ListItem.PictureSpecialInstructions | string | Returns other editorial instructions concerning the use of the selected picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28). |
ListItem.PictureState | string | Returns the State/Province where the selected picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F). |
ListItem.PictureSublocation | string | Returns the location within a city where the selected picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C). |
ListItem.PictureSupplementalCategories | string | Returns supplemental category codes to further refine the subject of the selected picture. This is the value of the IPTC SuppCategory tag (hex code 0x14). |
ListItem.PictureTransmissionReference | string | Returns a code representing the location of original transmission of the selected picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67). |
ListItem.PictureUrgency | string | Returns the urgency of the selected picture. Values are 1-9. The "1" is most urgent. Some image management programs use urgency to indicate picture rating, where urgency "1" is 5 stars and urgency "5" is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A). |
ListItem.PictureWhiteBalance | string | Returns the white balance mode set when the selected picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403). |
ListItem.FileName | string | Returns the filename of the currently selected song or movie in a container |
ListItem.Path | string | Returns the complete path of the currently selected song or movie in a container |
ListItem.FolderName | string | Returns top most folder of the path of the currently selected song or movie in a container |
ListItem.FolderPath | string | Returns the complete path of the currently selected song or movie in a container (without user details). |
ListItem.FileNameAndPath | string | Returns the full path with filename of the currently selected song or movie in a container |
ListItem.FileExtension | string | Returns the file extension (without leading dot) of the currently selected item in a container |
ListItem.Date | string | Returns the file date of the currently selected song or movie in a container / Aired date of an episode / Day, start time and end time of current selected TV programme (PVR) |
ListItem.DateAdded | string | Returns the date the currently selected item was added to the library / Date and time of an event in the EventLog window. |
ListItem.Size | string | Returns the file size of the currently selected song or movie in a container |
ListItem.Rating | string | Returns the scraped rating of the currently selected movie in a container |
ListItem.Set | string | Returns the name of the set the movie is part of |
ListItem.SetId | string | Returns the id of the set the movie is part of |
ListItem.UserRating | string | Returns the user rating of the currently selected item in a container |
ListItem.Votes | string | Returns the scraped votes of the currently selected movie in a container |
ListItem.RatingAndVotes | string | Returns the scraped rating and votes of the currently selected movie in a container |
ListItem.Mood | string | Mood of the selected song |
ListItem.Mpaa | string | Show the MPAA rating of the currently selected movie in a container |
ListItem.ProgramCount | string | Returns the number of times an xbe has been run from "my programs" |
ListItem.Duration | string | Returns the duration of the currently selected item in a container in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
ListItem.Duration(format) | .Duration_format string | Returns the duration of the currently selected item in a container in different formats: hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
ListItem.DBTYPE | string | Returns the database type of the ListItem.DBID for videos (movie, set, genre, actor, tvshow, season, episode). It does not return any value for the music library. Beware with season, the "*all seasons" entry does give a DBTYPE "season" and a DBID, but you can't get the details of that entry since it's a virtual entry in the Video Library. |
ListItem.DBID | string | Returns the database id of the currently selected listitem in a container |
ListItem.Cast | string | Returns a concatenated string of cast members of the currently selected movie, for use in dialogvideoinfo.xml |
ListItem.CastAndRole | string | Returns a concatenated string of cast members and roles of the currently selected movie, for use in dialogvideoinfo.xml |
ListItem.Studio | string | Studio of current selected Music Video in a container |
ListItem.Top250 | string | Returns the IMDb top250 position of the currently selected listitem in a container. |
ListItem.Trailer | string | Returns the full trailer path with filename of the currently selected movie in a container |
ListItem.Writer | string | Name of Writer of current Video in a container |
ListItem.Tag | string | Summary of current Video in a container |
ListItem.Tagline | string | Small Summary of current Video in a container |
ListItem.PlotOutline | string | Small Summary of current Video in a container |
ListItem.Plot | string | Complete Text Summary of Video in a container |
ListItem.IMDBNumber | string | The IMDb ID of the selected Video in a container |
ListItem.EpisodeName | string | (PVR only) The name of the episode if the selected EPG item is a TV Show |
ListItem.PercentPlayed | string | Returns percentage value [0-100] of how far the selected video has been played |
ListItem.LastPlayed | string | Last play date of Video in a container |
ListItem.PlayCount | string | Playcount of Video in a container |
ListItem.ChannelName | string | Name of current selected TV channel in a container |
ListItem.VideoCodec | string | Returns the video codec of the currently selected video (common values: 3iv2, avc1, div2, div3, divx, divx 4, dx50, flv, h264, microsoft, mp42, mp43, mp4v, mpeg1video, mpeg2video, mpg4, rv40, svq1, svq3, theora, vp6f, wmv2, wmv3, wvc1, xvid) |
ListItem.VideoResolution | string | Returns the resolution of the currently selected video (possible values: 480, 576, 540, 720, 1080, 4K). Note that 540 usually means a widescreen format (around 960x540) while 576 means PAL resolutions (normally 720x576), therefore 540 is actually better resolution than 576. |
ListItem.VideoAspect | string | Returns the aspect ratio of the currently selected video (possible values: 1.33, 1.37, 1.66, 1.78, 1.85, 2.20, 2.35, 2.40, 2.55, 2.76) |
ListItem.AudioCodec | string | Returns the audio codec of the currently selected video (common values: aac, ac3, cook, dca, dtshd_hra, dtshd_ma, eac3, mp1, mp2, mp3, pcm_s16be, pcm_s16le, pcm_u8, truehd, vorbis, wmapro, wmav2) |
ListItem.AudioChannels | string | Returns the number of audio channels of the currently selected video (possible values: 1, 2, 4, 5, 6, 8, 10) |
ListItem.AudioLanguage | string | Returns the audio language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu) |
ListItem.SubtitleLanguage | string | Returns the subtitle language of the currently selected video (returns an ISO 639-2 three character code, e.g. eng, epo, deu) |
ListItem.Property(AudioCodec.[n]) | string | Returns the audio codec of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioCodec) |
ListItem.Property(AudioChannels.[n]) | string | Returns the number of audio channels of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioChannels) |
ListItem.Property(AudioLanguage.[n]) | string | Returns the audio language of the currently selected video, 'n' defines the number of the audiostream (values: see ListItem.AudioLanguage) |
ListItem.Property(SubtitleLanguage.[n]) | string | Returns the subtitle language of the currently selected video, 'n' defines the number of the subtitle (values: see ListItem.SubtitleLanguage) |
ListItem.Property(Addon.Name) | string | Returns the name of the currently selected addon |
ListItem.Property(Addon.Version) | string | Returns the version of the currently selected addon |
ListItem.Property(Addon.Summary) | string | Returns a short description of the currently selected addon |
ListItem.Property(Addon.Description) | string | Returns the full description of the currently selected addon |
ListItem.Property(Addon.Type) | string | Returns the type (screensaver, script, skin, etc...) of the currently selected addon |
ListItem.Property(Addon.Creator) | string | Returns the name of the author the currently selected addon |
ListItem.Property(Addon.Disclaimer) | string | Returns the disclaimer of the currently selected addon |
ListItem.Property(Addon.Changelog) | string | Returns the changelog of the currently selected addon |
ListItem.Property(Addon.ID) | string | Returns the identifier of the currently selected addon |
ListItem.Property(Addon.Status) | string | Returns the status of the currently selected addon |
ListItem.Property(Addon.Broken) | string | Returns a message when the addon is marked as broken in the repo |
ListItem.Property(Addon.Path) | string | Returns the path of the currently selected addon |
ListItem.StartTime | string | Start time of current selected TV programme in a container |
ListItem.EndTime | string | End time of current selected TV programme in a container |
ListItem.StartDate | string | Start date of current selected TV programme in a container |
ListItem.EndDate | string | End date of current selected TV programme in a container |
ListItem.NextTitle | string | Title of the next item (PVR). |
ListItem.NextGenre | string | Genre of the next item (PVR). |
ListItem.NextPlot | string | Plot of the next item (PVR). |
ListItem.NextPlotOutline | string | Plot outline of the next item (PVR). |
ListItem.NextStartTime | string | Start time of the next item (PVR). |
ListItem.NextEndTime | string | End of the next item (PVR). |
ListItem.NextStartDate | string | Start date of the next item (PVR). |
ListItem.NextEndDate | string | End date of the next item (PVR). |
ListItem.ChannelGroup | string | Channel group of the selected item (PVR). |
ListItem.ChannelNumberLabel | string | Channel and subchannel number of the currently selected channel that's currently playing (PVR). |
ListItem.Progress | string | Part of the programme that's been played (PVR). |
ListItem.StereoscopicMode | string | Returns the stereomode of the selected video (i.e. mono, split_vertical, split_horizontal, row_interleaved, anaglyph_cyan_red, anaglyph_green_magenta) |
ListItem.HasTimerSchedule | boolean | Whether the item was scheduled by a timer rule (PVR). (v16 addition) |
ListItem.HasRecording | boolean | Returns true if a given epg tag item currently gets recorded or has been recorded |
ListItem.TimerHasError | boolean | Whether the item has a timer and it won't be recorded because of an error (PVR). (v17 addition) |
ListItem.TimerHasConflict | boolean | Whether the item has a timer and it won't be recorded because of a conflict (PVR). (v17 addition) |
ListItem.TimerIsActive | boolean | Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR). (v17 addition) |
ListItem.Comment | string | Comment assigned to the item (PVR/MUSIC). |
ListItem.TimerType | string | Returns the type of the PVR timer / timer rule item as a human readable string |
ListItem.EpgEventTitle | string | Returns the title of the epg event associated with the item, if any |
ListItem.EpgEventIcon | string | Returns the thumbnail for the epg event associated with the item (if it exists) |
ListItem.InProgress | boolean | Returns true if the epg event item is currently active (time-wise) |
ListItem.IsParentFolder | boolean | Returns true if the current list item is the goto parent folder '..' |
ListItem.AddonName | string | Returns the name of the currently selected addon |
ListItem.AddonVersion | string | Returns the version of the currently selected addon |
ListItem.AddonCreator | string | Returns the name of the author the currently selected addon |
ListItem.AddonSummary | string | Returns a short description of the currently selected addon |
ListItem.AddonDescription | string | Returns the full description of the currently selected addon |
ListItem.AddonDisclaimer | string | Returns the disclaimer of the currently selected addon |
ListItem.AddonBroken | string | Returns a message when the addon is marked as broken in the repo |
ListItem.AddonType | string | Returns the type (screensaver, script, skin, etc...) of the currently selected addon |
ListItem.AddonInstallDate | string | Returns the date the addon was installed |
ListItem.AddonLastUpdated | string | Returns the date the addon was last updated |
ListItem.AddonLastUsed | string | Returns the date the addon was used last
|
Labels | Type | Description |
PVR.IsRecording | boolean | Returns true when the system is recording a tv or radio programme. |
PVR.HasTimer | boolean | Returns true when a recording timer is active. |
PVR.HasTVChannels | boolean | Returns true if there are TV channels available |
PVR.HasRadioChannels | boolean | Returns true if there are radio channels available |
PVR.HasNonRecordingTimer | boolean | Returns true if there are timers present who currently not do recording |
PVR.BackendName | string | Name of the backend being used |
PVR.BackendVersion | string | Version of the backend that's being used |
PVR.BackendHost | string | Backend hostname |
PVR.BackendDiskSpace | string | Available diskspace on the backend as string with size |
PVR.BackendDiskSpaceProgr | integer | Available diskspace on the backend as percent value |
PVR.BackendChannels | string (integer) | Number of available channels the backend provides |
PVR.BackendTimers | string (integer) | Number of timers set for the backend |
PVR.BackendRecordings | string (integer) | Number of recording available on the backend |
PVR.BackendDeletedRecordings | string (integer) | Number of deleted recording present on the backend |
PVR.BackendNumber | string | Backend number |
PVR.TotalDiscSpace | string | Total diskspace available for recordings |
PVR.NextTimer | boolean | Next timer date |
PVR.IsPlayingTV | boolean | Returns true when live tv is being watched. |
PVR.IsPlayingRadio | boolean | Returns true when live radio is being listened to. |
PVR.IsPlayingRecording | boolean | Returns true when a recording is being watched. |
PVR.IsPlayingEpgTag | boolean | Returns true when an epg tag is being watched. |
PVR.EpgEventProgress | integer | Returns the percentage complete of the currently playing epg event |
PVR.ActStreamClient | string | Stream client name |
PVR.ActStreamDevice | string | Stream device name |
PVR.ActStreamStatus | string | Status of the stream |
PVR.ActStreamSignal | string | Signal quality of the stream |
PVR.ActStreamSnr | string | Signal to noise ratio of the stream |
PVR.ActStreamBer | string | Bit error rate of the stream |
PVR.ActStreamUnc | string | UNC value of the stream |
PVR.ActStreamProgrSignal | integer | Signal quality of the programme |
PVR.ActStreamProgrSnr | integer | Signal to noise ratio of the programme |
PVR.ActStreamIsEncrypted | boolean | Returns true when channel is encrypted on source |
PVR.ActStreamEncryptionName | string | Encryption used on the stream |
PVR.ActStreamServiceName | string | Returns the service name of played channel if available |
PVR.ActStreamMux | string | Returns the multiplex type of played channel if available |
PVR.ActStreamProviderName | string | Returns the provider name of the played channel if available |
PVR.IsTimeShift | boolean | Returns true when for channel is timeshift available |
PVR.TimeShiftProgress | integer | Returns the position of currently timeshifted title on TV as integer |
PVR.NowRecordingTitle | string | Title of the programme being recorded |
PVR.NowRecordingDateTime | Date/Time string | Start date and time of the current recording |
PVR.NowRecordingChannel | string | Channel name of the current recording |
PVR.NowRecordingChannelIcon | string | Icon of the current recording channel |
PVR.NextRecordingTitle | string | Title of the next programme that will be recorded |
PVR.NextRecordingDateTime | Date/Time string | Start date and time of the next recording |
PVR.NextRecordingChannel | string | Channel name of the next recording |
PVR.NextRecordingChannelIcon | string | Icon of the next recording channel |
PVR.TVNowRecordingTitle | string | Title of the tv programme being recorded |
PVR.TVNowRecordingDateTime | Date/Time string | Start date and time of the current tv recording |
PVR.TVNowRecordingChannel | string | Channel name of the current tv recording |
PVR.TVNowRecordingChannelIcon | string | Icon of the current recording TV channel |
PVR.TVNextRecordingTitle | string | Title of the next tv programme that will be recorded |
PVR.TVNextRecordingDateTime | Date/Time string | Start date and time of the next tv recording |
PVR.TVNextRecordingChannel | string | Channel name of the next tv recording |
PVR.TVNextRecordingChannelIcon | | Icon of the next recording tv channel |
PVR.RadioNowRecordingTitle | string | Title of the radio programme being recorded |
PVR.RadioNowRecordingDateTime | Date/Time string | Start date and time of the current radio recording |
PVR.RadioNowRecordingChannel | string | Channel name of the current radio recording |
PVR.RadioNowRecordingChannelIcon | string | Icon of the current recording radio channel |
PVR.RadioNextRecordingTitle | string | Title of the next radio programme that will be recorded |
PVR.RadioNextRecordingDateTime | Date/Time string | Start date and time of the next radio recording |
PVR.RadioNextRecordingChannel | string | Channel name of the next radio recording |
PVR.RadioNextRecordingChannelIcon | string | Icon of the next recording radio channel |
PVR.IsRecordingTV | boolean | Returns true when the system is recording a tv programme. |
PVR.HasTVTimer | boolean | Returns true if at least one tv timer is active. |
PVR.HasNonRecordingTVTimer | boolean | Returns true if there are tv timers present who currently not do recording |
PVR.IsRecordingRadio | boolean | Returns true when the system is recording a radio programme. |
PVR.HasRadioTimer | boolean | Returns true if at least one radio timer is active. |
PVR.HasNonRecordingRadioTimer | boolean | Returns true if there are radio timers present who currently not do recording |
PVR.ChannelNumberInput | string | Returns the currently entered channel number while in numeric channel input mode, an empty string otherwise |
PVR.CanRecordPlayingChannel | boolean | Returns true if PVR is currently playing a channel and if this channel can be recorded. |
PVR.IsRecordingPlayingChannel | boolean | Returns true if PVR is currently playing a channel and if this channel is currently recorded. |
PVR.TimeshiftProgressPlayPos | integer | Returns the percentage of the current play position within the PVR timeshift progress. |
PVR.TimeshiftProgressEpgStart | integer | Returns the percentage of the start of the currently playing epg event within the PVR timeshift progress. |
PVR.TimeshiftProgressEpgEnd | integer | Returns the percentage of the end of the currently playing epg event within the PVR timeshift progress. |
PVR.TimeshiftProgressBufferStart | integer | Returns the percentage of the start of the timeshift buffer within the PVR timeshift progress. |
PVR.TimeshiftProgressBufferEnd | integer | Returns the percentage of the end of the timeshift buffer within the PVR timeshift progress. |
Labels | Type | Description { PVR.EpgEventIcon , string, Returns the icon of the currently playing epg event, if any. } |
PVR.EpgEventDuration | string | Returns the duration of the currently playing epg event in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.EpgEventDuration(format) | string | Returns the duration of the currently playing epg event in different formats: Hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.EpgEventElapsedTime | string | Returns the time of the current position of the currently playing epg event in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.EpgEventElapsedTime(format) | string | Returns the time of the current position of the currently playing epg event in different formats: Hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.EpgEventRemainingTime | string | Returns the remaining time for currently playing epg event in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.EpgEventRemainingTime(format) | string | Returns the remaining time for currently playing epg event in different formats: Hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.EpgEventSeekTime | string | Returns the time the user is seeking within the currently playing epg event in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.EpgEventSeekTime(format) | string | Returns the time the user is seeking within the currently playing epg event in different formats: Hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.EpgEventFinishTime | string | Returns the time the currently playing epg event will end in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.EpgEventFinishTime(format) | string | Returns the time the currently playing epg event will end in different formats: Hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.TimeShiftStart | string | Returns the start time of the timeshift buffer in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.TimeShiftStart(format) | string | Returns the start time of the timeshift buffer in different formats: Hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.TimeShiftEnd | string | Returns the end time of the timeshift buffer in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.TimeShiftEnd(format) | string | Returns the end time of the timeshift buffer in different formats: Hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.TimeShiftCur | string | Returns the current playback time within the timeshift buffer in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.TimeShiftCur(format) | string | Returns the current playback time within the timeshift buffer in different formats: Hours (hh), minutes (mm) or seconds (ss). When 12 hour clock is used (xx) will return AM/PM. Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.TimeShiftOffset | string | Returns the delta of timeshifted time to actual time in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.TimeShiftOffset(format) | string | Returns the delta of timeshifted time to actual time in different formats: Hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.TimeshiftProgressDuration | string | Returns the duration of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.TimeshiftProgressDuration(format) | string | Returns the duration of the PVR timeshift progress in different formats: Hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.TimeshiftProgressStartTime | string | Returns the start time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.TimeshiftProgressStartTime(format) | string | Returns the start time of the PVR timeshift progress in different formats: Hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
PVR.TimeshiftProgressEndTime | string | Returns the end time of the PVR timeshift progress in the format hh:mm:ss. hh: will be omitted if hours value is zero. |
PVR.TimeshiftProgressEndTime(format) | string | Returns the end time of the PVR timeshift progress in different formats: Hours (hh), minutes (mm) or seconds (ss). Also supported: (hh:mm), (mm:ss), (hh:mm:ss), (h:mm:ss). Added with Leia: (secs), (mins), (hours) for total time values and (m). Example: 3661 seconds => h=1, hh=01, m=1, mm=01, ss=01, hours=1, mins=61, secs=3661 |
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 |
Slideshow.Altitude | string | Shows the altitude in meters where the current picture was taken. This is the value of the EXIF GPSInfo.GPSAltitude tag. |
Slideshow.Aperture | string | Shows the F-stop used to take the current picture. This is the value of the EXIF FNumber tag (hex code 0x829D). |
Slideshow.Author | string | Shows the name of the person involved in writing about the current picture. This is the value of the IPTC Writer tag (hex code 0x7A). |
Slideshow.Byline | string | Shows the name of the person who created the current picture. This is the value of the IPTC Byline tag (hex code 0x50). |
Slideshow.BylineTitle | string | Shows the title of the person who created the current picture. This is the value of the IPTC BylineTitle tag (hex code 0x55). |
Slideshow.CameraMake | string | Shows the manufacturer of the camera used to take the current picture. This is the value of the EXIF Make tag (hex code 0x010F). |
Slideshow.CameraModel | string | Shows the manufacturer's model name or number of the camera used to take the current picture. This is the value of the EXIF Model tag (hex code 0x0110). |
Slideshow.Caption | string | Shows a description of the current picture. This is the value of the IPTC Caption tag (hex code 0x78). |
Slideshow.Category | string | Shows the subject of the current picture as a category code. This is the value of the IPTC Category tag (hex code 0x0F). |
Slideshow.CCDWidth | string | Shows the width of the CCD in the camera used to take the current picture. This is calculated from three EXIF tags (0xA002 * 0xA210 / 0xA20e). |
Slideshow.City | string | Shows the city where the current picture was taken. This is the value of the IPTC City tag (hex code 0x5A). |
Slideshow.Colour | string | Shows whether the current picture is "Colour" or "Black and White". |
Slideshow.CopyrightNotice | string | Shows the copyright notice of the current picture. This is the value of the IPTC Copyright tag (hex code 0x74). |
Slideshow.Country | string | Shows the full name of the country where the current picture was taken. This is the value of the IPTC CountryName tag (hex code 0x65). |
Slideshow.CountryCode | string | Shows the country code of the country where the current picture was taken. This is the value of the IPTC CountryCode tag (hex code 0x64). |
Slideshow.Credit | string | Shows who provided the current picture. This is the value of the IPTC Credit tag (hex code 0x6E). |
Slideshow.DigitalZoom | string | Shows the digital zoom ratio when the current picture was taken. This is the value of the EXIF .DigitalZoomRatio tag (hex code 0xA404). |
Slideshow.EXIFComment | string | Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.SlideComment. |
Slideshow.EXIFDate | string | Shows the localized date of the current picture. The short form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used. |
Slideshow.EXIFDescription | string | Shows a short description of the current picture. The SlideComment, EXIFComment or Caption values might contain a longer description. This is the value of the EXIF ImageDescription tag (hex code 0x010E). |
Slideshow.EXIFSoftware | string | Shows the name and version of the firmware used by the camera that took the current picture. This is the value of the EXIF Software tag (hex code 0x0131). |
Slideshow.EXIFTime | string | Shows the date/timestamp of the current picture. The localized short form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used. |
Slideshow.Exposure | string | Shows the class of the program used by the camera to set exposure when the current picture was taken. Values include "Manual", "Program (Auto)", "Aperture priority (Semi-Auto)", "Shutter priority
(semi-auto)", etc. This is the value of the EXIF ExposureProgram tag (hex code 0x8822). |
Slideshow.ExposureBias | string | Shows the exposure bias of the current picture. Typically this is a number between -99.99 and 99.99. This is the value of the EXIF ExposureBiasValue tag (hex code 0x9204). |
Slideshow.ExposureMode | string | Shows the exposure mode of the current picture. The possible values are "Automatic", "Manual", and "Auto bracketing". This is the value of the EXIF ExposureMode tag (hex code 0xA402). |
Slideshow.ExposureTime | string | Shows the exposure time of the current picture, in seconds. This is the value of the EXIF ExposureTime tag (hex code 0x829A). If the ExposureTime tag is not found, the ShutterSpeedValue tag (hex code 0x9201) might be used. |
Slideshow.Filedate | string | Shows the file date of the current picture |
Slideshow.Filename | string | Shows the file name of the current picture |
Slideshow.Filesize | string | Shows the file size of the current picture |
Slideshow.FlashUsed | string | Shows the status of flash when the current picture was taken. The value will be either "Yes" or "No", and might include additional information. This is the value of the EXIF Flash tag (hex code 0x9209). |
Slideshow.FocalLength | string | Shows the focal length of the lens, in mm. This is the value of the EXIF FocalLength tag (hex code 0x920A). |
Slideshow.FocusDistance | string | Shows the distance to the subject, in meters. This is the value of the EXIF SubjectDistance tag (hex code 0x9206). |
Slideshow.Headline | string | Shows a synopsis of the contents of the current picture. This is the value of the IPTC Headline tag (hex code 0x69). |
Slideshow.ImageType | string | Shows the color components of the current picture. This is the value of the IPTC ImageType tag (hex code 0x82). |
Slideshow.IPTCDate | string | Shows the date when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC DateCreated tag (hex code 0x37). |
Slideshow.ISOEquivalence | string | Shows the ISO speed of the camera when the current picture was taken. This is the value of the EXIF ISOSpeedRatings tag (hex code 0x8827). |
Slideshow.Keywords | string | Shows keywords assigned to the current picture. This is the value of the IPTC Keywords tag (hex code 0x19). |
Slideshow.Latitude | string | Shows the latitude where the current picture was taken (degrees, minutes, seconds North or South). This is the value of the EXIF GPSInfo.GPSLatitude and GPSInfo.GPSLatitudeRef tags. |
Slideshow.LightSource | string | Shows the kind of light source when the picture was taken. Possible values include "Daylight", "Fluorescent", "Incandescent", etc. This is the value of the EXIF LightSource tag (hex code 0x9208). |
Slideshow.LongEXIFDate | string | Shows only the localized date of the current picture. The long form of the date is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. If the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used. |
Slideshow.LongEXIFTime | string | Shows the date/timestamp of the current picture. The localized long form of the date and time is used. The value of the EXIF DateTimeOriginal tag (hex code 0x9003) is preferred. if the DateTimeOriginal tag is not found, the value of DateTimeDigitized (hex code 0x9004) or of DateTime (hex code 0x0132) might be used. |
Slideshow.Longitude | string | Shows the longitude where the current picture was taken (degrees, minutes, seconds East or West). This is the value of the EXIF GPSInfo.GPSLongitude and GPSInfo.GPSLongitudeRef tags. |
Slideshow.MeteringMode | string | Shows the metering mode used when the current picture was taken. The possible values are "Center weight", "Spot", or "Matrix". This is the value of the EXIF MeteringMode tag (hex code 0x9207). |
Slideshow.ObjectName | string | Shows a shorthand reference for the current picture. This is the value of the IPTC ObjectName tag (hex code 0x05). |
Slideshow.Orientation | string | Shows the orientation of the current picture. Possible values are "Top
Left", "Top Right", "Left Top", "Right Bottom", etc. This is the value of the EXIF Orientation tag (hex code 0x0112). |
Slideshow.Path | string | Shows the file path of the current picture |
Slideshow.Process | string | Shows the process used to compress the current picture |
Slideshow.ReferenceService | string | Shows the Service Identifier of a prior envelope to which the current picture refers. This is the value of the IPTC ReferenceService tag (hex code 0x2D). |
Slideshow.Resolution | string | Shows the dimensions of the current picture (Width x Height) |
Slideshow.SlideComment | string | Shows a description of the current picture. This is the value of the EXIF User Comment tag (hex code 0x9286). This is the same value as Slideshow.EXIFComment. |
Slideshow.SlideIndex | string | Shows the slide index of the current picture |
Slideshow.Source | string | Shows the original owner of the current picture. This is the value of the IPTC Source tag (hex code 0x73). |
Slideshow.SpecialInstructions | string | Shows other editorial instructions concerning the use of the current picture. This is the value of the IPTC SpecialInstructions tag (hex code 0x28). |
Slideshow.State | string | Shows the State/Province where the current picture was taken. This is the value of the IPTC ProvinceState tag (hex code 0x5F). |
Slideshow.Sublocation | string | Shows the location within a city where the current picture was taken - might indicate the nearest landmark. This is the value of the IPTC SubLocation tag (hex code 0x5C). |
Slideshow.SupplementalCategories | string | Shows supplemental category codes to further refine the subject of the current picture. This is the value of the IPTC SuppCategory tag (hex code 0x14). |
Slideshow.TimeCreated | string | Shows the time when the intellectual content of the current picture was created, rather than when the picture was created. This is the value of the IPTC TimeCreated tag (hex code 0x3C). |
Slideshow.TransmissionReference | string | Shows a code representing the location of original transmission of the current picture. This is the value of the IPTC TransmissionReference tag (hex code 0x67). |
Slideshow.Urgency | string | Shows the urgency of the current picture. Values are 1-9. The 1 is most urgent. Some image management programs use urgency to indicate picture rating, where urgency 1 is 5 stars and urgency 5 is 1 star. Urgencies 6-9 are not used for rating. This is the value of the IPTC Urgency tag (hex code 0x0A). |
Slideshow.WhiteBalance | string | Shows the white balance mode set when the current picture was taken. The possible values are "Manual" and "Auto". This is the value of the EXIF WhiteBalance tag (hex code 0xA403). |