List of boolean conditions

From Official Kodi Wiki
Jump to: navigation, search

Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with xbmc.getCondVisibility(condition).

Contents

1 ADSP

InfoLabels Definition Version
ADSP.IsActive Returns true if dsp system is enabled
ADSP.HasModes Returns true if one or more modes are present on any of the types
ADSP.HasInputResample Returns true if on stream is a input resample is active
ADSP.HasPreProcess Returns true if on stream is a pre process mode active
ADSP.HasMasterProcess Returns true if on stream is a master process mode available
ADSP.HasPostProcess Returns true if on stream is a post process
ADSP.HasOutputResample Returns true if on stream is a output resample
ADSP.MasterActive Returns true if on stream is a master mode selected and active

2 Container

InfoLabels Definition Version
Container.HasThumb Returns true if the current container you are in has a thumb assigned to it
Container.Content(parameter) 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, countries, roles, images (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(id).OnNext 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 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 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 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).HasFocus(item_number) 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(id).HasFiles Returns true if the container contains files (or current container if id is omitted).
Container(id).HasFolders Returns true if the container contains folders (or current container if id is omitted).
Container(id).HasNext Returns true if the container or textbox with id (id) has a next page.
Container(id).HasPrevious Returns true if the container or textbox with id (id) has a previous page.
Container(id).IsUpdating Returns true if the container with dynamic list content is currently updating.
Container(id).IsStacked Returns true if the container is currently in stacked mode (or current container if id is omitted).
Container.CanFilter Returns true when the current container can be filtered.
Container.CanFilterAdvanced Returns true when advanced filtering can be applied to the current container.
Container.Filtered Returns true when a mediafilter is applied to the current container.
Container.HasParent Return true when the container contains a parent ('..') item.
Container.SortDirection(ascending) Returns true the sort direction of a container is ascending.
Container.SortDirection(descending) Returns true the sort direction of a container is descending.
Container(id).Row(row) Returns true if the container with id (or current container if id is omitted) is focused on the row given.
Container(id).Column(col) Returns true if the container with id (or current container if id is omitted) is focused on the column given.
Container(id).Position(pos) Returns true if the container with id (or current container if id is omitted) is focused on the position given.
Container(id).Scrolling Returns true if the user is currently scrolling through the container with id (or current container if id is omitted). Note that this is slightly delayed from the actual scroll start. Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.

3 Control

InfoLabels Definition Version
Control.IsEnabled(id) Returns true if the control with id "id" is enabled.
Control.IsVisible(id) Returns true if the control with id "id" is visible.
Control.HasFocus(id) Returns true if the currently focused control has id "id".
ControlGroup(group).HasFocus(id) Returns true if the control group with id “group” has control id “id” as it's focused item. If “id” is not present, or is 0, then it will return true if the currently focused control is in the control group with id “group”. Note that if the control group with id “group” does not have focus, then this will still return true if the last focused item in the group had control id “id”.

4 Integer

InfoLabels Definition Version
Integer.IsEqual(info,number) Returns true if the value of the infolabel is equal to the supplied number.
Example: Integer.IsEqual(ListItem.Year,2000)
v17 Addition
Integer.IsGreater(info,number) Returns true if the value of the infolabel is greater than to the supplied number.
Example: Integer.IsGreater(ListItem.Year,2000)
v17 Addition
Integer.IsGreaterOrEqual(info,number) Returns true if the value of the infolabel is greater or equal to the supplied number.
Example: Integer.IsGreaterOrEqual(ListItem.Year,2000)
v17 Addition
Integer.IsLess(info,number) Returns true if the value of the infolabel is less than the supplied number.
Example: Integer.IsLess(ListItem.Year,2000)
v17 Addition
Integer.IsLessOrEqual(info,number) Returns true if the value of the infolabel is less or equal to the supplied number.
Example: Integer.IsLessOrEqual(ListItem.Year,2000)
v17 Addition

5 Library

InfoLabels Definition Version
Library.HasContent(string) Returns true if the Kodi libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets)
Library.IsScanningMusic Returns true if the music library is being updated
Library.IsScanningVideo Returns true if the video library is being updated
Library.HasContent(Role, Composer) Tag can be Composer, Conductor, Orchestra, Lyricist, Remixer, Arranger, Engineer, Producer, DJMixer or Mixer. Returns true if there are any artists with that role in the library v17 addition

6 ListItem

InfoLabels Definition Version
ListItem.IsFolder Returns whether the current ListItem is a folder
ListItem.IsPlaying Returns whether the current ListItem.* info labels and images are currently Playing media
ListItem.IsResumable Returns true when the current ListItem has been partially played
ListItem.IsCollection Returns true when the current ListItem is a movie set
ListItem.IsSelected Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
ListItem.HasEpg Returns true when the selected programme has epg info (PVR)
ListItem.HasTimer Returns true when a recording timer has been set for the selected programme (PVR)
ListItem.IsRecording Returns true when the selected programme is being recorded (PVR)
ListItem.IsEncrypted Returns true when the selected programme is encrypted (PVR)
ListItem.IsStereoscopic Returns true when the selected video is a 3D (stereoscopic) video
ListItem.Property(IsSpecial) Returns whether the current Season/Episode is a Special
ListItem.Property(DateLabel) 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.IsEnabled) Returns true when the selected addon is enabled (for use in the addon info dialog only).
ListItem.Property(Addon.IsInstalled) Returns true when the selected addon is installed (for use in the addon info dialog only).
ListItem.Property(Addon.HasUpdate) Returns true when there's an update available for the selected addon.
ListItem.HasTimerSchedule Whether the item is part of a repeating timer schedule (PVR). v16 addition
ListItem.TimerHasError Whether the item has a timer and it won't be recorded because of an error (PVR). v17 addition
ListItem.TimerHasConflict Whether the item has a timer and it won't be recorded because of a conflict (PVR). v17 addition
ListItem.TimerIsActive Whether the item has a timer that will be recorded, i.e. the timer is enabled (PVR). v17 addition
ListItem.Property(Addon.Orphaned) Returns true if the slected addon is orphaned (not needed anymore by any other addon) v17 addition
ListItem.IsParentFolder Returns true is the slected item is the 'up' item v17 addition

7 Player

InfoLabels Definition Version
Player.HasMedia Returns true if the player has an audio or video file.
Player.HasAudio Returns true if the player has an audio file.
Player.HasDuration Returns true if Media isn't a true stream
Player.HasVideo Returns true if the player has a video file.
Player.Passthrough Returns true if the player is using audio passthrough.
Player.Playing Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
Player.Paused Returns true if the player is paused.
Player.Forwarding Returns true if the player is fast forwarding.
Player.Forwarding2x Returns true if the player is fast forwarding at 2x.
Player.Forwarding4x Returns true if the player is fast forwarding at 4x.
Player.Forwarding8x Returns true if the player is fast forwarding at 8x.
Player.Forwarding16x Returns true if the player is fast forwarding at 16x.
Player.Forwarding32x Returns true if the player is fast forwarding at 32x.
Player.Rewinding Returns true if the player is rewinding.
Player.Rewinding2x Returns true if the player is rewinding at 2x.
Player.Rewinding4x Returns true if the player is rewinding at 4x.
Player.Rewinding8x Returns true if the player is rewinding at 8x.
Player.Rewinding16x Returns true if the player is rewinding at 16x.
Player.Rewinding32x Returns true if the player is rewinding at 32x.
Player.CanRecord Returns true if the player can record the current internet stream.
Player.Recording Returns true if the player is recording the current internet stream.
Player.Caching Returns true if the player is current re-caching data (internet based video playback).
Player.DisplayAfterSeek Returns true for the first 2.5 seconds after a seek.
Player.Seeking Returns true if a seek is in progress
Player.ShowTime Returns true if the user has requested the time to show (occurs in video fullscreen)
Player.ShowInfo Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
Player.IsInternetStream Returns true if the player is playing an internet stream.
Player.Muted Returns true if the volume is muted.
Player.Process(videohwdecoder) Returns true if the currently playing video is decoded in hardware v17 addition
Player.TempoEnabled Returns true if the current player supports changing the playback speed v17 addition
Player.IsTempo Returns true if the current playbackspeed is not equal to 1 v17 addition

7.1 MusicPlayer

InfoLabels Definition Version
MusicPlayer.HasNext Returns true if the music player has a next song queued in the Playlist.
MusicPlayer.HasPrevious Returns true if the music player has a a Previous Song in the Playlist .
MusicPlayer.Offset(number).Exists Returns true if the music players playlist has a song queued in position (number).
MusicPartyMode.Enabled Returns true if Party Mode is enabled

7.2 VideoPlayer

InfoLabels Definition Version
VideoPlayer.UsingOverlays 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 Returns true if the video player is in fullscreen mode.
VideoPlayer.HasMenu Returns true if the video player has a menu (ie is playing a DVD)
VideoPlayer.HasInfo Returns true if the current playing video has information from the library or from a plugin (eg director/plot etc.)
VideoPlayer.Content(parameter) 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 Returns true if there are subtitles available for video. (available for version 11.0 and above)
VideoPlayer.IsStereoscopic Returns true when the currently playing video is a 3D (stereoscopic) video
VideoPlayer.SubtitlesEnabled Returns true if subtitles are turned on for video. (available for version 11.0 and above)
VideoPlayer.HasEpg Returns true when epg information is available for the currently playing programme (PVR).
VideoPlayer.HasTeletext Returns true when teletext is available.

8 PlayList

InfoLabels Definition Version
Playlist.IsRandom Returns true if the player is in random mode.
Playlist.IsRepeat Returns true if the player is in repeat all mode.
Playlist.IsRepeatOne Returns true if the player is in repeat one mode.

9 PVR

InfoLabels Definition Version
Pvr.HasTimer Returns true when a recording timer is active.
Pvr.HasNonRecordingTimer Returns true when a non recording timer is active.
Pvr.HasTVChannels Returns true if there are tv channels available
Pvr.HasRadioChannels Returns true if there are radio channels available
Pvr.IsPlayingTv Returns true when live tv is being watched.
Pvr.IsPlayingRadio Returns true when live radio is being listened to.
Pvr.IsPlayingRecording Returns true when a recording is being watched.
Pvr.IsRecording Returns true when the system is recording a tv programme.
Pvr.IsTimeShift Returns true when the playback is timeshifted.
Pvr.ActStreamIsEncrypted Returns true if the stream is encrypted
Pvr.RadioNextRecordingChannelIcon Icon of the next recording radio channel v17 Addition
Pvr.IsRecordingTV Returns true when the system is recording a tv programme. v17 Addition
Pvr.HasTVTimer Returns true if at least one tv timer is active. v17 Addition
Pvr.HasNonRecordingTVTimer Returns true if there are tv timers present who currently not do recording v17 Addition
Pvr.IsRecordingRadio Returns true when the system is recording a radio programme. v17 Addition
Pvr.HasRadioTimer Returns true if at least one radio timer is active. v17 Addition
Pvr.HasNonRecordingRadioTimer Returns true if there are radio timers present who currently not do recording v17 Addition

10 RDS

InfoLabels Definition Version
RDS.HasRds Returns true if RDS is present
RDS.HasRadioText Returns true if RDS contains also Radiotext
RDS.HasRadioTextPlus Returns true if RDS with Radiotext contains also the plus information
RDS.HasHotline Returns true if a hotline phone number is present (Only be available on RadiotextPlus)
RDS.HasStudio Returns true if a studio name is present (Only be available on RadiotextPlus)

11 Skin

InfoLabels Definition Version
Skin.HasTheme(theme) Returns true if the user has selected the theme with name ?theme?.
Skin.HasSetting(setting) Returns the state of the skin-specified setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
Skin.String(string) Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is non-empty.
Skin.String(string1,string2) Same as stringcompare(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.

12 SlideShow

InfoLabels Definition Version
Slideshow.IsActive Returns true if the picture slideshow is running
Slideshow.IsPaused Returns true if the picture slideshow is paused
Slideshow.IsRandom Returns true if the picture slideshow is in random mode
Slideshow.IsVideo Returns true if the picture slideshow is playing a video

13 String

InfoLabels Definition Version
String.IsEmpty(info) Returns true if the info is empty.
Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
v17 Addition
String.IsEqual(info,string) Returns true if the info is equal to the given string.
Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or info label (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
v17 Addition
String.StartsWith(info,substring) Returns true if the info starts with the given substring.
Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
v17 Addition
String.EndsWith(info,substring) Returns true if the info ends with the given substring.
Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
v17 Addition
String.Contains(info,substring) Returns true if the info contains the given substring.
Example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[]. Also note that in a panelview or similar this only works on the focused item.
v17 Addition

14 System

InfoLabels Definition Version
System.HasAddon(id) Returns true if the specified addon is installed on the system.
System.HasPVRAddon Returns true if at least one PVR addon is installed on the system.
System.HasAlarm(alarm) Returns true if the system has the ?alarm? alarm set.
System.AlarmLessOrEqual(alarmname,seconds) 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 Returns true if the ethernet cable is plugged in.
System.HasMediadvd Returns true if there is a CD or DVD in the DVD-ROM drive.
System.IdleTime(time) Returns true if Kodi has had no input for ?time? amount of seconds.
System.IsStandalone Returns true if Kodi is running in standalone mode.
System.IsFullscreen Returns true if Kodi is running fullscreen.
System.KaiConnected Returns true if XBMC's Kai client is connected to the PC engine.
System.IsLoggedOn Returns true if a user is currently logged on under a profile
System.HasLoginScreen Returns true if the profile login screen is enabled
System.HasADSP Returns true if ADSP is enabled
System.HasModalDialog Returns true true if a modal dialog is visible
System.Time(startTime,endTime) 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) 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 Returns true if Kodi is running on a linux/unix based computer.
System.Platform.Linux.RaspberryPi Returns true if Kodi is running on a Raspberry Pi.
System.Platform.Windows Returns true if Kodi is running on a windows based computer.
System.Platform.OSX Returns true if Kodi is running on an OSX based computer.
System.Platform.IOS Returns true if Kodi is running on an IOS device.
System.Platform.Darwin Returns true if Kodi is running on an OSX or IOS system.
System.Platform.ATV2 Returns true if Kodi is running on an atv2.
System.Platform.Android Returns true if Kodi is running on an android device.
System.CanPowerDown Returns true if Kodi can powerdown the system.
System.CanSuspend Returns true if Kodi can suspend the system.
System.CanHibernate Returns true if Kodi can hibernate the system.
System.HasHiddenInput Return true when to osd keyboard/numeric dialog requests a password/pincode.
System.CanReboot Returns true if Kodi can reboot the system.
System.ScreenSaverActive Returns true if ScreenSaver is active.
System.Setting(hidewatched) Returns true if 'hide watched items' is selected.
System.IsInhibit Returns true when shutdown on idle is disabled.
System.HasShutdown Returns true when shutdown on idle is enabled.
System.HasCMS Returns true if colour management is supported in Kodi. v17 Addition

15 Visualisation

InfoLabels Definition Version
Visualisation.Enabled Returns true if any visualisation has been set in settings (so not None).
Visualisation.HasPresets Returns true if the visualisation has built in presets.
Visualisation.Locked Returns true if the current visualisation preset is locked (eg in Milkdrop.)

16 Weather

InfoLabels Definition Version
Weather.IsFetched Returns true if the weather data has been downloaded.

17 Window

InfoLabels Definition Version
Window.IsVisible(window) Returns true if the window is visible (includes fade out time on dialogs)
Window.IsActive(window) Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) See here for a list of windows
Window.IsTopMost(window) Returns true if the window with id or title ?window? is on top of the window stack (excludes fade out time on dialogs) See here for a list of windows
Window.IsMedia Returns true if this window is a media window (programs, music, video, scripts, pictures)
Window.Next(window) Returns true if the window with id or title ?window? is being moved to. See here for a list of windows. Only valid while windows are changing.
Window.Previous(window) Returns true if the window with id or title ?window? is being moved from. See here for a list of windows. Only valid while windows are changing.
Window.Property(IsRadio) Returns true if the window is a radio window (for use in the PVR windows)
Window.Is(name) Useful in xml files that are shared between multiple windows/dialogs. Will return true if the window with the given name is visible v17 addition


18 See also

Development:

Personal tools
Namespaces

Variants
Actions
Navigation
Wiki help
Toolbox