Official Kodi Wiki - User contributions [en]

Opening Windows and Dialogs

2015-01-28T16:28:22Z

MassIV: /* Videos */

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

You can use the ActivateWindow() [[List of Built In Functions|Built In Function]] to open a certain [[Window IDs|Window]].

This command can be assigned to a [[Button control|button]] in a skin or mapped to a key in your [[Keyboard.xml|Keymap]].

'''Example:'''
* This will take you directly to the settings section/window of xbmc:
<pre>ActivateWindow(Settings)</pre>

Some windows allow you to jump directly to a sub-section of that window. To do this, you can use either the sub-section's name or its path.

'''Example:'''
* If you want a button in your skin or on your remote to take you directly to the movie listing, you let that button do:
<pre>ActivateWindow(Videos,MovieTitles)</pre>
or, in Gotham
<pre>ActivateWindow(Videos,videodb://movies/titles/)</pre>

Below is a list of the available sub-sections in the Videos, Music, and Programs sections/windows.

== Videos ==
{| class="prettytable"
! Sub-section Name !! Path (Frodo) !! Path (Gotham)
|-
|VideoLibrary ||videodb://||videodb://
|-
|   ||  || 
|-
|Movies ||videodb://1/ ||videodb://movies/
|-
|MovieGenres ||videodb://1/1/ ||videodb://movies/genres/
|-
|MovieTitles ||videodb://1/2/ ||videodb://movies/titles/
|-
|MovieYears ||videodb://1/3/ ||videodb://movies/years/
|-
|MovieActors ||videodb://1/4/ ||videodb://movies/actors/
|-
|MovieDirectors ||videodb://1/5/ ||videodb://movies/directors/
|-
|MovieStudios ||videodb://1/6/ ||videodb://movies/studios/
|-
|MovieSets ||videodb://1/7/ ||videodb://movies/sets/
|-
|MovieCountries ||videodb://1/8/ ||videodb://movies/countries/
|-
|MovieTags ||videodb://1/9/ ||videodb://movies/tags/
|-
|RecentlyAddedMovies ||videodb://4/ ||videodb://recentlyaddedmovies/
|-
|   ||  || 
|-
|TvShows ||videodb://2/ ||videodb://tvshows/
|-
|TvShowGenres ||videodb://2/1/ ||videodb://tvshows/genres/
|-
|TvShowTitles ||videodb://2/2/ ||videodb://tvshows/titles/
|-
|TvShowYears ||videodb://2/3/ ||videodb://tvshows/years/
|-
|TvShowActors ||videodb://2/4/ ||videodb://tvshows/actors/
|-
|TvShowStudios ||videodb://2/5/ ||videodb://tvshows/studios/
|-
|RecentlyAddedEpisodes ||videodb://5/ ||videodb://recentlyaddedepisodes/
|-
|   ||  || 
|-
|MusicVideos ||videodb://3/ ||videodb://musicvideos/
|-
|MusicVideoGenres ||videodb://3/1/ ||videodb://musicvideos/genres/
|-
|MusicVideoTitles ||videodb://3/2/ ||videodb://musicvideos/titles/
|-
|MusicVideoYears ||videodb://3/3/ ||videodb://musicvideos/years/
|-
|MusicVideoArtists ||videodb://3/4/ ||videodb://musicvideos/artists/
|-
|MusicVideoAlbums ||videodb://3/5/ ||videodb://musicvideos/albums/
|-
|MusicVideoDirectors ||videodb://3/6/ ||videodb://musicvideos/directors/
|-
|MusicVideoStudios ||videodb://3/7/ ||videodb://musicvideos/studios/
|-
|RecentlyAddedMusicVideos ||videodb://6/ ||videodb://recentlyaddedmusicvideos/
|-
|   ||  || 
|-
|Playlists ||special://videoplaylists/ ||special://videoplaylists/
|-
|Video Add-ons ||addons://sources/video/ ||addons://sources/video/
|-
|Files ||sources://video/ ||sources://video/
|-
|Root ||? ||library://video/
|-
|}

== Music ==
{| class="prettytable"
! Sub-section Name !! Path (Frodo) !! Path (Gotham)
|-
|MusicLibrary ||musicdb:// ||musicdb://
|-
|   ||  || 
|-
|Genres ||musicdb://1/ ||musicdb://genres/
|-
|Artists ||musicdb://2/ ||musicdb://artists/
|-
|Albums ||musicdb://3/ ||musicdb://albums/
|-
|Songs ||musicdb://4/ ||musicdb://songs/
|-
|Top100 ||musicdb://5/ ||musicdb://top100/
|-
|Top100Songs ||musicdb://5/1/ ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://5/2/ ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://6/ ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://7/ ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://8/ ||musicdb://compilations/
|-
|Years ||musicdb://9/ ||musicdb://years/
|-
|Singles ||musicdb://10/ ||musicdb://singles/
|-
|   ||  || 
|-
|Playlists ||special://musicplaylists/ ||special://musicplaylists/
|-
|Music Add-ons ||addons://sources/audio/ ||addons://sources/audio/
|}

== Programs ==
{| class="prettytable"
! Sub-section Name !! Path (Frodo) !! Path (Gotham)
|-
|Addons||addons://sources/executable/ ||addons://sources/executable/
|-
|AndroidApps <ref>The "AndroidApps" sub-section name is a Helix addition. In Gotham, you must specify the full source path. </ref> || ||androidapp://sources/apps/
|}

== Notes ==
<references />

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

List of boolean conditions

2014-11-17T14:57:51Z

MassIV:

{{see also|Conditional Visibility}}
<section begin="main content" />
Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with <code>xbmc.getCondVisibility(condition)</code>.

{| class="prettytable"
! Condition !! Description
|-
| <code>ButtonScroller.HasFocus(id)</code>
| Returns true if the buttonscroller is focused, and the current button has id ?id?.
|-
| <code>Container.HasThumb</code>
| Returns true if the current container you are in has a thumb assigned to it
|-
| <code>Container.Content(parameter)</code>
| Returns true if the current container you are in contains the following: '''files, songs, artists, albums, movies, tvshows, seasons, episodes, musicvideos, genres, years, actors, playlists, plugins, studios, directors, sets, tags''' (Note: these currently only work in the Video and Music Library or unless a Plugin has set the value) also available are '''Addons''' true when a list of add-ons is shown '''LiveTV''' true when a htsp (tvheadend) directory is shown
|-
| <code>Container(id).OnNext</code>
| 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.)
|-
| <code>Container(id).OnScrollNext</code>
| 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.
|-
| <code>Container(id).OnPrevious</code>
| 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.)
|-
| <code>Container(id).OnScrollPrevious</code>
| 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.
|-
| <code>Container(id).HasFocus(item_number)</code>
| 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.
|-
| <code>Container(id).HasFiles</code>
| Returns true if the container contains files (or current container if id is omitted).
|-
| <code>Container(id).HasFolders</code>
| Returns true if the container contains folders (or current container if id is omitted).
|-
| <code>Container(id).HasNext</code>
| Returns true if the container (id) has a next page.
|-
| <code>Container(id).HasPrevious</code>
| Returns true if the container (id) has a previous page.
|-
| <code>Container(id).IsStacked</code>
| Returns true if the container is currently in stacked mode (or current container if id is omitted).
|- {{frodo row}}
| <code>Container.CanFilter</code>
| Returns true when the current container can be filtered. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Container.CanFilterAdvanced</code>
| Returns true when advanced filtering can be applied to the current container. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Container.Filtered</code>
| Returns true when a mediafilter is applied to the current container. '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>Container(id).Row(row)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the row given.
|-
| <code>Container(id).Column(col)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the column given.
|-
| <code>Container(id).Position(pos)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the position given.
|-
| <code>Container(id).Scrolling</code>
| 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.
|-
| <code>Control.IsEnabled(id)</code>
| Returns true if the control with id "id" is enabled.
|-
| <code>Control.IsVisible(id)</code>
| Returns true if the control with id "id" is visible.
|-
| <code>Control.HasFocus(id)</code>
| Returns true if the currently focused control has id "id".
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| 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”.
|-
| <code>IntegerGreaterThan([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than the supplied number. Example: IntegerGreaterThan(ListItem.Year,2000)
|-
| <code>IsEmpty([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is empty. Example: IsEmpty(ListItem.Plot)
|-
| <code>Library.HasContent(string)</code>
| Returns true if the XBMC libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets)
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|- {{frodo row}}
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR) '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR) '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR) '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR) '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{gotham row}}
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|-
| <code>Player.CanRecord</code>
| Returns true if the player can record the current internet stream.
|-
| <code>Player.Recording</code>
| Returns true if the player is recording the current internet stream.
|-
| <code>Player.Caching</code>
| Returns true if the player is current re-caching data (internet based video playback).
|-
| <code>Player.SeekBar</code>
| Returns true for the first 2.5 seconds after a video seek.
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true after any seek.
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|-
| <code>Player.ShowCodec</code>
| Returns true if the user has requested the codec to show (occurs in visualisation and video fullscreen)
|- {{gotham row}}
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream. '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|-
| <code>Playlist.IsRandom</code>
| Returns true if the player is in random mode.
|-
| <code>Playlist.IsRepeat</code>
| Returns true if the player is in repeat all mode.
|-
| <code>Playlist.IsRepeatOne</code>
| Returns true if the player is in repeat one mode.
|- {{frodo row}}
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.HasEpg</code>
| Returns true when an epg is available. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.HasTxt</code>
| Returns true when teletext is available.'''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.HasDirector</code>
| ? '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>Skin.HasTheme(theme)</code>
| Returns true if the user has selected the theme with name ?theme?.
|-
| <code>Skin.HasSetting(setting)</code>
| Returns the state of the skin-specified setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is non-empty.
|-
| <code>Skin.String(string1,string2)</code>
| Same as stringcompare(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|-
| <code>Slideshow.IsActive</code>
| Returns true if the picture slideshow is running
|-
| <code>Slideshow.IsPaused</code>
| Returns true if the picture slideshow is paused
|-
| <code>Slideshow.IsRandom</code>
| Returns true if the picture slideshow is in random mode
|- {{gotham row}}
| <code>Slideshow.IsVideo</code>
| Returns true if the picture slideshow is playing a video '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>StringCompare([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] equals the string. example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item.
|-
| <code>SubString([[InfoLabels|info]],string)</code>
| Returns true if the string is found anywhere in the [[InfoLabels|info]]
|-
| <code>SubString([[InfoLabels|info]],string,[Left or Right])</code>
| Returns true if the string is found from the start or the end. Example: 
(foobars,foob,Left) -> true 
(foobars,foob,Right) -> False 
(foobars,bars,Right) -> true
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|-
| <code>System.HasPVR</code>
| Returns true on pvr enabled XBMC builds. (Note: Replaced with System.GetBool(pvrmanager.enabled) for Frodo)
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| 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.
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the DVD-ROM drive.
|-
| <code>System.IdleTime(time)</code>
| Returns true if XBMC has had no input for ?time? amount of seconds.
|-
| <code>System.IsStandalone</code>
| Returns true if XBMC is running in standalone mode.
|-
| <code>System.IsFullscreen</code>
| Returns true if XBMC is running fullscreen.
|-
| <code>System.KaiConnected</code>
| Returns true if XBMC's Kai client is connected to the PC engine.
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles|profile]]
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles|profile]] login screen is enabled
|-
| <code>System.Time(startTime,endTime)</code>
| 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.
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|-
| <code>System.Platform.Linux</code>
| Returns true if XBMC is running on a linux/unix based computer.
|- {{gotham row}}
| <code>System.Platform.Linux.RaspberryPi</code>
| Returns true if XBMC is running on a Raspberry Pi. '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>System.Platform.Windows</code>
| Returns true if XBMC is running on a windows based computer.
|-
| <code>System.Platform.OSX</code>
| Returns true if XBMC is running on an OSX based computer.
|-
| <code>System.Platform.IOS</code>
| Returns true if XBMC is running on an IOS device.
|- {{frodo row}}
| <code>System.Platform.Darwin</code>
| Returns true if XBMC is running on an OSX or IOS system. '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>System.Platform.ATV2</code>
| Returns true if XBMC is running on an atv2.
|-
| <code>System.Platform.Android</code>
| Returns true if XBMC is running on an android device.
|-
| <code>System.CanPowerDown</code>
| Returns true if XBMC can powerdown the system.
|-
| <code>System.CanSuspend</code>
| Returns true if XBMC can suspend the system.
|-
| <code>System.CanHibernate</code>
| Returns true if XBMC can hibernate the system.
|-
| <code>System.CanReboot</code>
| Returns true if XBMC can reboot the system.
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|- {{frodo row}}
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled. '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>VideoPlayer.UsingOverlays</code>
| 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.
|-
| <code>VideoPlayer.IsFullscreen</code>
| Returns true if the video player is in fullscreen mode.
|-
| <code>VideoPlayer.HasMenu</code>
| Returns true if the video player has a menu (ie is playing a DVD)
|-
| <code>VideoPlayer.HasInfo</code>
| Returns true if the current playing video has information from the library or from a plugin (eg director/plot etc.)
|-
| <code>VideoPlayer.Content(parameter)</code>
| 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
|-
| <code>VideoPlayer.HasSubtitles</code>
| Returns true if there are subtitles available for video. (available for version 11.0 and above)
|- {{gotham row}}
| <code>VideoPlayer.IsStereoscopic</code>
| Returns true when the currently playing video is a 3D (stereoscopic) video '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>VideoPlayer.SubtitlesEnabled</code>
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)
|- {{frodo row}}
| <code>VideoPlayer.HasEpg</code>
| Returns true when epg information is available for the currently playing programme (PVR). '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>Visualisation.Enabled</code>
| Returns true if any visualisation has been set in settings (so not None).
|-
| <code>Visualisation.Locked</code>
| Returns true if the current visualisation preset is locked (eg in Milkdrop.)
|-
| <code>Weather.IsFetched</code>
| Returns true if the weather data has been downloaded.
|-
| <code>Window.IsVisible(window)</code>
| Returns true if the window is visible (includes fade out time on dialogs)
|-
| <code>Window.IsActive(window)</code>
| Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) [[Window IDs|See here for a list of windows]]
|-
| <code>Window.IsTopMost(window)</code>
| Returns true if the window with id or title ?window? is on top of the window stack (excludes fade out time on dialogs) [[Window IDs|See here for a list of windows]]
|-
| <code>Window.IsMedia</code>
| Returns true if this window is a media window (programs, music, video, scripts, pictures)
|-
| <code>Window.Next(window)</code>
| Returns true if the window with id or title ?window? is being moved to. [[Window IDs|See here for a list of windows]]. Only valid while windows are changing.
|-
| <code>Window.Previous(window)</code>
| Returns true if the window with id or title ?window? is being moved from. [[Window IDs|See here for a list of windows]]. Only valid while windows are changing.
|}
<section end="main content" />

== Removed conditions ==
* <code>AudioScrobbler.Enabled</code> - Removed in v12 Frodo
* <code>LastFM.RadioPlaying</code> - Removed in v12 Frodo
* <code>LastFM.CanLov</code> - Removed in v12 Frodo
* <code>LastFM.CanBan</code> - Removed in v12 Frodo

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

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

HOW-TO:Add a new view type to the skin

2014-11-17T02:22:12Z

MassIV: /* Troubleshooting */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The first image control is separate from the list, is technically placed behind the list in layer depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags. This line of code should be near the top.
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so maybe you see numbers behind the includes. Kodi does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now we can head over to our TV Shows (remember it's not available everywhere) to work on our new viewtype.

Now for your next challenge you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

==Troubleshooting==

Viewtype not showing up? It is possible that the ID you have used for the viewtype is already in use.
A good editor like Notepad++ will allow you to search your entire 720p (or other resolution) folder for the ID you used.
You can even include the word id and the quotes around the number.

There are some ID's you can't use. The ones used by the window: http://kodi.wiki/view/Window_IDs

And the ones of the mandatory controls: http://kodi.wiki/view/XBMC_Skinning_Manual#.xml_files

Easiest way to know if a number does not belong to a Window or a mandatory control is to look at the numbers used by other skins.

HOW-TO:Add a new view type to the skin

2014-11-17T02:21:22Z

MassIV: /* That's it */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The first image control is separate from the list, is technically placed behind the list in layer depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags. This line of code should be near the top.
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so maybe you see numbers behind the includes. Kodi does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now we can head over to our TV Shows (remember it's not available everywhere) to work on our new viewtype.

Now for your next challenge you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

==Troubleshooting==

Viewtype not showing up? It is possible that the ID you have used for the viewtype is already in use.
A good editor like Notepad++ will allow you to search your entire 720p (or other resolution) folder for the ID you used.
You can even include the word id and the quotes around it.

There are some ID's you can't use. The ones used by the window: http://kodi.wiki/view/Window_IDs

And the ones of the mandatory controls: http://kodi.wiki/view/XBMC_Skinning_Manual#.xml_files

Easiest way to know if a number does not belong to a Window or a mandatory control is to look at the numbers used by other skins.

HOW-TO:Add a new view type to the skin

2014-11-17T02:18:35Z

MassIV: /* Lets make it available in the skin */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The first image control is separate from the list, is technically placed behind the list in layer depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags. This line of code should be near the top.
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so maybe you see numbers behind the includes. Kodi does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now we can head over to our TV Shows (remember it's not available everywhere) to work on our new viewtype.

Now you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

==Troubleshooting==

Viewtype not showing up? It is possible that the ID you have used for the viewtype is already in use.
A good editor like Notepad++ will allow you to search your entire 720p (or other resolution) folder for the ID you used.
You can even include the word id and the quotes around it.

There are some ID's you can't use. The ones used by the window: http://kodi.wiki/view/Window_IDs

And the ones of the mandatory controls: http://kodi.wiki/view/XBMC_Skinning_Manual#.xml_files

Easiest way to know if a number does not belong to a Window or a mandatory control is to look at the numbers used by other skins.

HOW-TO:Add a new view type to the skin

2014-11-17T02:16:26Z

MassIV: /* Lets make it available in the skin */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The first image control is separate from the list, is technically placed behind the list in layer depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags. This line of code should be near the top.
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so maybe you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now we can head over to our TV Shows (remember it's not available everywhere) to work on our new viewtype.

Now you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

==Troubleshooting==

Viewtype not showing up? It is possible that the ID you have used for the viewtype is already in use.
A good editor like Notepad++ will allow you to search your entire 720p (or other resolution) folder for the ID you used.
You can even include the word id and the quotes around it.

There are some ID's you can't use. The ones used by the window: http://kodi.wiki/view/Window_IDs

And the ones of the mandatory controls: http://kodi.wiki/view/XBMC_Skinning_Manual#.xml_files

Easiest way to know if a number does not belong to a Window or a mandatory control is to look at the numbers used by other skins.

HOW-TO:Add a new view type to the skin

2014-11-17T02:14:39Z

MassIV: /* The content of our viewtype */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The first image control is separate from the list, is technically placed behind the list in layer depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so maybe you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now we can head over to our TV Shows (remember it's not available everywhere) to work on our new viewtype.

Now you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

==Troubleshooting==

Viewtype not showing up? It is possible that the ID you have used for the viewtype is already in use.
A good editor like Notepad++ will allow you to search your entire 720p (or other resolution) folder for the ID you used.
You can even include the word id and the quotes around it.

There are some ID's you can't use. The ones used by the window: http://kodi.wiki/view/Window_IDs

And the ones of the mandatory controls: http://kodi.wiki/view/XBMC_Skinning_Manual#.xml_files

Easiest way to know if a number does not belong to a Window or a mandatory control is to look at the numbers used by other skins.

HOW-TO:Add a new view type to the skin

2014-11-17T02:08:35Z

MassIV:

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The image control is separate from the list, is technically placed behind the list in depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so maybe you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now we can head over to our TV Shows (remember it's not available everywhere) to work on our new viewtype.

Now you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

==Troubleshooting==

Viewtype not showing up? It is possible that the ID you have used for the viewtype is already in use.
A good editor like Notepad++ will allow you to search your entire 720p (or other resolution) folder for the ID you used.
You can even include the word id and the quotes around it.

There are some ID's you can't use. The ones used by the window: http://kodi.wiki/view/Window_IDs

And the ones of the mandatory controls: http://kodi.wiki/view/XBMC_Skinning_Manual#.xml_files

Easiest way to know if a number does not belong to a Window or a mandatory control is to look at the numbers used by other skins.

Add-on:Metroid

2014-10-01T19:27:14Z

MassIV: Created page with "{{Addon |Name=Metroid |provider-name=MassIV |ID=skin.metroid |latest-version=1.0.0 |extension point=xbmc.gui.skin |provides= |Summary=A GUI for XBMC Media Center |Description..."

{{Addon
|Name=Metroid
|provider-name=MassIV
|ID=skin.metroid
|latest-version=1.0.0
|extension point=xbmc.gui.skin
|provides=
|Summary=A GUI for XBMC Media Center
|Description=Metroid is a GUI for XBMC Media Center. Metroid is all about simplicity, usability and easy navigation. Touch optional 16:9 skin.
|Platform=all
|Language=
|License=Creative Commons Attribution-NonCommercial-Share Alike 3.0 Unported License
|Forum=http://forum.xbmc.org/showthread.php?tid=178956
|Website=
|Source=https://github.com/MassIV/skin.metroid
|Email=
|broken=
|icon url=http://mirrors.xbmc.org/addons/gotham/skin.metroid/icon.png}}

==Installing==

To install this add-on you must do so from the Add-on manager from within XBMC by going to:
# Settings
# Add-ons
# Get add-ons
# XBMC.org Add-ons
# Skins
# Metroid
# Install

==Special skin features==

* touch screen = yes
* mouse = yes
* custom home items = yes
* Media flags = yes
* TV show logo = yes
* Artwork downloader = yes
* Live TV = channels only

==Screenshots==

* Kodi forum: http://forum.xbmc.org/showthread.php?tid=178956
* Direct Imgur album: https://imgur.com/a/NogGl/all
* Github source: https://github.com/MassIV/skin.metroid/tree/master/_screenshots

[[Category:Gotham add-on repository]]

Opening Windows and Dialogs

2014-08-01T22:57:48Z

MassIV: /* Programs: */

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

You can use the ActivateWindow() [[List of Built In Functions|Built In Function]] to open a certain [[Window IDs|Window]].

This command can be assigned to a [[Button control|button]] in a skin or mapped to a key in your [[Keyboard.xml|Keymap]].

'''Example:'''
* This will take you directly to the settings section of xbmc:
<pre>ActivateWindow(Settings)</pre>

Some windows even allow you to jump directly to a sub-section of that window.

'''Example:'''
* If you want a button in your skin or on your remote to take you directly to the movie listing, you let that button do:
<pre>ActivateWindow(Videos,MovieTitles)</pre>

Below is a list of the available sub-sections in the Video- and MusicLibrary.

=== '''VideoLibrary:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|VideoLibrary ||videodb://||videodb://
|-
|   ||  || 
|-
|Movies ||videodb://1/ ||videodb://movies/
|-
|MovieGenres ||videodb://1/1/ ||videodb://movies/genres/
|-
|MovieTitles ||videodb://1/2/ ||videodb://movies/titles/
|-
|MovieYears ||videodb://1/3/ ||videodb://movies/years/
|-
|MovieActors ||videodb://1/4/ ||videodb://movies/actors/
|-
|MovieDirectors ||videodb://1/5/ ||videodb://movies/directors/
|-
|MovieStudios ||videodb://1/6/ ||videodb://movies/studios/
|-
|MovieSets ||videodb://1/7/ ||videodb://movies/sets/
|-
|MovieCountries ||videodb://1/8/ ||videodb://movies/countries/
|-
|MovieTags ||videodb://1/9/ ||videodb://movies/tags/
|-
|RecentlyAddedMovies ||videodb://4/ ||videodb://recentlyaddedmovies/
|-
|   ||  || 
|-
|TvShows ||videodb://2/ ||videodb://tvshows/
|-
|TvShowGenres ||videodb://2/1/ ||videodb://tvshows/genres/
|-
|TvShowTitles ||videodb://2/2/ ||videodb://tvshows/titles/
|-
|TvShowYears ||videodb://2/3/ ||videodb://tvshows/years/
|-
|TvShowActors ||videodb://2/4/ ||videodb://tvshows/actors/
|-
|TvShowStudios ||videodb://2/5/ ||videodb://tvshows/studios/
|-
|RecentlyAddedEpisodes ||videodb://5/ ||videodb://recentlyaddedepisodes/
|-
|   ||  || 
|-
|MusicVideos ||videodb://3/ ||videodb://musicvideos/
|-
|MusicVideoGenres ||videodb://3/1/ ||videodb://musicvideos/genres/
|-
|MusicVideoTitles ||videodb://3/2/ ||videodb://musicvideos/titles/
|-
|MusicVideoYears ||videodb://3/3/ ||videodb://musicvideos/years/
|-
|MusicVideoArtists ||videodb://3/4/ ||videodb://musicvideos/artists/
|-
|MusicVideoAlbums ||videodb://3/5/ ||videodb://musicvideos/albums/
|-
|MusicVideoDirectors ||videodb://3/6/ ||videodb://musicvideos/directors/
|-
|MusicVideoStudios ||videodb://3/7/ ||videodb://musicvideos/studios/
|-
|RecentlyAddedMusicVideos ||videodb://6/ ||videodb://recentlyaddedmusicvideos/
|-
|   ||  || 
|-
|Playlists ||special://videoplaylists/ ||special://videoplaylists/
|-
|Video Add-ons ||addons://sources/video/ ||addons://sources/video/
|-
|Files ||sources://video/ ||sources://video/
|-
|}

=== '''MusicLibrary:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|MusicLibrary ||musicdb:// ||musicdb://
|-
|   ||  || 
|-
|Genres ||musicdb://1/ ||musicdb://genres/
|-
|Artists ||musicdb://2/ ||musicdb://artists/
|-
|Albums ||musicdb://3/ ||musicdb://albums/
|-
|Songs ||musicdb://4/ ||musicdb://songs/
|-
|Top100 ||musicdb://5/ ||musicdb://top100/
|-
|Top100Songs ||musicdb://5/1/ ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://5/2/ ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://6/ ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://7/ ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://8/ ||musicdb://compilations/
|-
|Years ||musicdb://9/ ||musicdb://years/
|-
|Singles ||musicdb://10/ ||musicdb://singles/
|-
|   ||  || 
|-
|Playlists ||special://musicplaylists/ ||special://musicplaylists/
|-
|Music Add-ons ||addons://sources/audio/ ||addons://sources/audio/
|}

=== '''Programs:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|Programs || ||
|-
|   ||  || 
|-
|Executable ||addons://sources/executable/ ||addons://sources/executable/
|-
|AndroidApp || ||androidapp://sources/apps/
|}
[[Category:Skin development]]
[[Category:Add-on development]]
[[Category:Python]]

Opening Windows and Dialogs

2014-08-01T22:56:53Z

MassIV: /* Programs: */

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

You can use the ActivateWindow() [[List of Built In Functions|Built In Function]] to open a certain [[Window IDs|Window]].

This command can be assigned to a [[Button control|button]] in a skin or mapped to a key in your [[Keyboard.xml|Keymap]].

'''Example:'''
* This will take you directly to the settings section of xbmc:
<pre>ActivateWindow(Settings)</pre>

Some windows even allow you to jump directly to a sub-section of that window.

'''Example:'''
* If you want a button in your skin or on your remote to take you directly to the movie listing, you let that button do:
<pre>ActivateWindow(Videos,MovieTitles)</pre>

Below is a list of the available sub-sections in the Video- and MusicLibrary.

=== '''VideoLibrary:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|VideoLibrary ||videodb://||videodb://
|-
|   ||  || 
|-
|Movies ||videodb://1/ ||videodb://movies/
|-
|MovieGenres ||videodb://1/1/ ||videodb://movies/genres/
|-
|MovieTitles ||videodb://1/2/ ||videodb://movies/titles/
|-
|MovieYears ||videodb://1/3/ ||videodb://movies/years/
|-
|MovieActors ||videodb://1/4/ ||videodb://movies/actors/
|-
|MovieDirectors ||videodb://1/5/ ||videodb://movies/directors/
|-
|MovieStudios ||videodb://1/6/ ||videodb://movies/studios/
|-
|MovieSets ||videodb://1/7/ ||videodb://movies/sets/
|-
|MovieCountries ||videodb://1/8/ ||videodb://movies/countries/
|-
|MovieTags ||videodb://1/9/ ||videodb://movies/tags/
|-
|RecentlyAddedMovies ||videodb://4/ ||videodb://recentlyaddedmovies/
|-
|   ||  || 
|-
|TvShows ||videodb://2/ ||videodb://tvshows/
|-
|TvShowGenres ||videodb://2/1/ ||videodb://tvshows/genres/
|-
|TvShowTitles ||videodb://2/2/ ||videodb://tvshows/titles/
|-
|TvShowYears ||videodb://2/3/ ||videodb://tvshows/years/
|-
|TvShowActors ||videodb://2/4/ ||videodb://tvshows/actors/
|-
|TvShowStudios ||videodb://2/5/ ||videodb://tvshows/studios/
|-
|RecentlyAddedEpisodes ||videodb://5/ ||videodb://recentlyaddedepisodes/
|-
|   ||  || 
|-
|MusicVideos ||videodb://3/ ||videodb://musicvideos/
|-
|MusicVideoGenres ||videodb://3/1/ ||videodb://musicvideos/genres/
|-
|MusicVideoTitles ||videodb://3/2/ ||videodb://musicvideos/titles/
|-
|MusicVideoYears ||videodb://3/3/ ||videodb://musicvideos/years/
|-
|MusicVideoArtists ||videodb://3/4/ ||videodb://musicvideos/artists/
|-
|MusicVideoAlbums ||videodb://3/5/ ||videodb://musicvideos/albums/
|-
|MusicVideoDirectors ||videodb://3/6/ ||videodb://musicvideos/directors/
|-
|MusicVideoStudios ||videodb://3/7/ ||videodb://musicvideos/studios/
|-
|RecentlyAddedMusicVideos ||videodb://6/ ||videodb://recentlyaddedmusicvideos/
|-
|   ||  || 
|-
|Playlists ||special://videoplaylists/ ||special://videoplaylists/
|-
|Video Add-ons ||addons://sources/video/ ||addons://sources/video/
|-
|Files ||sources://video/ ||sources://video/
|-
|}

=== '''MusicLibrary:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|MusicLibrary ||musicdb:// ||musicdb://
|-
|   ||  || 
|-
|Genres ||musicdb://1/ ||musicdb://genres/
|-
|Artists ||musicdb://2/ ||musicdb://artists/
|-
|Albums ||musicdb://3/ ||musicdb://albums/
|-
|Songs ||musicdb://4/ ||musicdb://songs/
|-
|Top100 ||musicdb://5/ ||musicdb://top100/
|-
|Top100Songs ||musicdb://5/1/ ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://5/2/ ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://6/ ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://7/ ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://8/ ||musicdb://compilations/
|-
|Years ||musicdb://9/ ||musicdb://years/
|-
|Singles ||musicdb://10/ ||musicdb://singles/
|-
|   ||  || 
|-
|Playlists ||special://musicplaylists/ ||special://musicplaylists/
|-
|Music Add-ons ||addons://sources/audio/ ||addons://sources/audio/
|}

=== '''Programs:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|Programs ||root ||root
|-
|   ||  || 
|-
|Executable ||addons://sources/executable/ ||addons://sources/executable/
|-
|AndroidApp || ||androidapp://sources/apps/
|}
[[Category:Skin development]]
[[Category:Add-on development]]
[[Category:Python]]

Opening Windows and Dialogs

2014-08-01T22:51:03Z

MassIV: /* Programs: */

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

You can use the ActivateWindow() [[List of Built In Functions|Built In Function]] to open a certain [[Window IDs|Window]].

This command can be assigned to a [[Button control|button]] in a skin or mapped to a key in your [[Keyboard.xml|Keymap]].

'''Example:'''
* This will take you directly to the settings section of xbmc:
<pre>ActivateWindow(Settings)</pre>

Some windows even allow you to jump directly to a sub-section of that window.

'''Example:'''
* If you want a button in your skin or on your remote to take you directly to the movie listing, you let that button do:
<pre>ActivateWindow(Videos,MovieTitles)</pre>

Below is a list of the available sub-sections in the Video- and MusicLibrary.

=== '''VideoLibrary:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|VideoLibrary ||videodb://||videodb://
|-
|   ||  || 
|-
|Movies ||videodb://1/ ||videodb://movies/
|-
|MovieGenres ||videodb://1/1/ ||videodb://movies/genres/
|-
|MovieTitles ||videodb://1/2/ ||videodb://movies/titles/
|-
|MovieYears ||videodb://1/3/ ||videodb://movies/years/
|-
|MovieActors ||videodb://1/4/ ||videodb://movies/actors/
|-
|MovieDirectors ||videodb://1/5/ ||videodb://movies/directors/
|-
|MovieStudios ||videodb://1/6/ ||videodb://movies/studios/
|-
|MovieSets ||videodb://1/7/ ||videodb://movies/sets/
|-
|MovieCountries ||videodb://1/8/ ||videodb://movies/countries/
|-
|MovieTags ||videodb://1/9/ ||videodb://movies/tags/
|-
|RecentlyAddedMovies ||videodb://4/ ||videodb://recentlyaddedmovies/
|-
|   ||  || 
|-
|TvShows ||videodb://2/ ||videodb://tvshows/
|-
|TvShowGenres ||videodb://2/1/ ||videodb://tvshows/genres/
|-
|TvShowTitles ||videodb://2/2/ ||videodb://tvshows/titles/
|-
|TvShowYears ||videodb://2/3/ ||videodb://tvshows/years/
|-
|TvShowActors ||videodb://2/4/ ||videodb://tvshows/actors/
|-
|TvShowStudios ||videodb://2/5/ ||videodb://tvshows/studios/
|-
|RecentlyAddedEpisodes ||videodb://5/ ||videodb://recentlyaddedepisodes/
|-
|   ||  || 
|-
|MusicVideos ||videodb://3/ ||videodb://musicvideos/
|-
|MusicVideoGenres ||videodb://3/1/ ||videodb://musicvideos/genres/
|-
|MusicVideoTitles ||videodb://3/2/ ||videodb://musicvideos/titles/
|-
|MusicVideoYears ||videodb://3/3/ ||videodb://musicvideos/years/
|-
|MusicVideoArtists ||videodb://3/4/ ||videodb://musicvideos/artists/
|-
|MusicVideoAlbums ||videodb://3/5/ ||videodb://musicvideos/albums/
|-
|MusicVideoDirectors ||videodb://3/6/ ||videodb://musicvideos/directors/
|-
|MusicVideoStudios ||videodb://3/7/ ||videodb://musicvideos/studios/
|-
|RecentlyAddedMusicVideos ||videodb://6/ ||videodb://recentlyaddedmusicvideos/
|-
|   ||  || 
|-
|Playlists ||special://videoplaylists/ ||special://videoplaylists/
|-
|Video Add-ons ||addons://sources/video/ ||addons://sources/video/
|-
|Files ||sources://video/ ||sources://video/
|-
|}

=== '''MusicLibrary:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|MusicLibrary ||musicdb:// ||musicdb://
|-
|   ||  || 
|-
|Genres ||musicdb://1/ ||musicdb://genres/
|-
|Artists ||musicdb://2/ ||musicdb://artists/
|-
|Albums ||musicdb://3/ ||musicdb://albums/
|-
|Songs ||musicdb://4/ ||musicdb://songs/
|-
|Top100 ||musicdb://5/ ||musicdb://top100/
|-
|Top100Songs ||musicdb://5/1/ ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://5/2/ ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://6/ ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://7/ ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://8/ ||musicdb://compilations/
|-
|Years ||musicdb://9/ ||musicdb://years/
|-
|Singles ||musicdb://10/ ||musicdb://singles/
|-
|   ||  || 
|-
|Playlists ||special://musicplaylists/ ||special://musicplaylists/
|-
|Music Add-ons ||addons://sources/audio/ ||addons://sources/audio/
|}

=== '''Programs:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|Programs ||root ||root
|-
|   ||  || 
|-
|Executable ||addons://sources/executable/ ||addons://sources/executable/
|-
|AndroidApp || ? ||androidapp://sources/apps/
|}
[[Category:Skin development]]
[[Category:Add-on development]]
[[Category:Python]]

Opening Windows and Dialogs

2014-08-01T22:47:25Z

MassIV:

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

You can use the ActivateWindow() [[List of Built In Functions|Built In Function]] to open a certain [[Window IDs|Window]].

This command can be assigned to a [[Button control|button]] in a skin or mapped to a key in your [[Keyboard.xml|Keymap]].

'''Example:'''
* This will take you directly to the settings section of xbmc:
<pre>ActivateWindow(Settings)</pre>

Some windows even allow you to jump directly to a sub-section of that window.

'''Example:'''
* If you want a button in your skin or on your remote to take you directly to the movie listing, you let that button do:
<pre>ActivateWindow(Videos,MovieTitles)</pre>

Below is a list of the available sub-sections in the Video- and MusicLibrary.

=== '''VideoLibrary:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|VideoLibrary ||videodb://||videodb://
|-
|   ||  || 
|-
|Movies ||videodb://1/ ||videodb://movies/
|-
|MovieGenres ||videodb://1/1/ ||videodb://movies/genres/
|-
|MovieTitles ||videodb://1/2/ ||videodb://movies/titles/
|-
|MovieYears ||videodb://1/3/ ||videodb://movies/years/
|-
|MovieActors ||videodb://1/4/ ||videodb://movies/actors/
|-
|MovieDirectors ||videodb://1/5/ ||videodb://movies/directors/
|-
|MovieStudios ||videodb://1/6/ ||videodb://movies/studios/
|-
|MovieSets ||videodb://1/7/ ||videodb://movies/sets/
|-
|MovieCountries ||videodb://1/8/ ||videodb://movies/countries/
|-
|MovieTags ||videodb://1/9/ ||videodb://movies/tags/
|-
|RecentlyAddedMovies ||videodb://4/ ||videodb://recentlyaddedmovies/
|-
|   ||  || 
|-
|TvShows ||videodb://2/ ||videodb://tvshows/
|-
|TvShowGenres ||videodb://2/1/ ||videodb://tvshows/genres/
|-
|TvShowTitles ||videodb://2/2/ ||videodb://tvshows/titles/
|-
|TvShowYears ||videodb://2/3/ ||videodb://tvshows/years/
|-
|TvShowActors ||videodb://2/4/ ||videodb://tvshows/actors/
|-
|TvShowStudios ||videodb://2/5/ ||videodb://tvshows/studios/
|-
|RecentlyAddedEpisodes ||videodb://5/ ||videodb://recentlyaddedepisodes/
|-
|   ||  || 
|-
|MusicVideos ||videodb://3/ ||videodb://musicvideos/
|-
|MusicVideoGenres ||videodb://3/1/ ||videodb://musicvideos/genres/
|-
|MusicVideoTitles ||videodb://3/2/ ||videodb://musicvideos/titles/
|-
|MusicVideoYears ||videodb://3/3/ ||videodb://musicvideos/years/
|-
|MusicVideoArtists ||videodb://3/4/ ||videodb://musicvideos/artists/
|-
|MusicVideoAlbums ||videodb://3/5/ ||videodb://musicvideos/albums/
|-
|MusicVideoDirectors ||videodb://3/6/ ||videodb://musicvideos/directors/
|-
|MusicVideoStudios ||videodb://3/7/ ||videodb://musicvideos/studios/
|-
|RecentlyAddedMusicVideos ||videodb://6/ ||videodb://recentlyaddedmusicvideos/
|-
|   ||  || 
|-
|Playlists ||special://videoplaylists/ ||special://videoplaylists/
|-
|Video Add-ons ||addons://sources/video/ ||addons://sources/video/
|-
|Files ||sources://video/ ||sources://video/
|-
|}

=== '''MusicLibrary:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|MusicLibrary ||musicdb:// ||musicdb://
|-
|   ||  || 
|-
|Genres ||musicdb://1/ ||musicdb://genres/
|-
|Artists ||musicdb://2/ ||musicdb://artists/
|-
|Albums ||musicdb://3/ ||musicdb://albums/
|-
|Songs ||musicdb://4/ ||musicdb://songs/
|-
|Top100 ||musicdb://5/ ||musicdb://top100/
|-
|Top100Songs ||musicdb://5/1/ ||musicdb://top100/songs/
|-
|Top100Albums ||musicdb://5/2/ ||musicdb://top100/albums/
|-
|RecentlyAddedAlbums ||musicdb://6/ ||musicdb://recentlyaddedalbums/
|-
|RecentlyPlayedAlbums ||musicdb://7/ ||musicdb://recentlyplayedalbums/
|-
|Compilations ||musicdb://8/ ||musicdb://compilations/
|-
|Years ||musicdb://9/ ||musicdb://years/
|-
|Singles ||musicdb://10/ ||musicdb://singles/
|-
|   ||  || 
|-
|Playlists ||special://musicplaylists/ ||special://musicplaylists/
|-
|Music Add-ons ||addons://sources/audio/ ||addons://sources/audio/
|}

=== '''Programs:''' ===
{| class="prettytable"
! section !! frodo !! gotham
|-
|Programs ||root ||root
|-
|   ||  || 
|-
|Executable ||addons://sources/executable/ ||addons://sources/executable/
|-
|Android app || ? ||androidapp://sources/apps/
|}
[[Category:Skin development]]
[[Category:Add-on development]]
[[Category:Python]]

HOW-TO:Add a new view type to the skin

2014-06-23T18:50:47Z

MassIV: /* That's it */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The image control is separate from the list, is technically placed behind the list in depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so maybe you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now we can head over to our TV Shows (remember it's not available everywhere) to work on our new viewtype.

Now you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

HOW-TO:Add a new view type to the skin

2014-06-23T18:42:18Z

MassIV: /* Lets make it available in the skin */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The image control is separate from the list, is technically placed behind the list in depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so maybe you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

HOW-TO:Add a new view type to the skin

2014-06-23T18:39:40Z

MassIV: /* Lets make it available in the skin */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The image control is separate from the list, is technically placed behind the list in depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

HOW-TO:Add a new view type to the skin

2014-06-23T18:34:03Z

MassIV: /* That's it */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The image control is separate from the list, is technically placed behind the list in depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now you can try to change the banner view into something else. How about a panel that loads posters?
http://wiki.xbmc.org/?title=Panel_Container

HOW-TO:Add a new view type to the skin

2014-06-23T18:32:35Z

MassIV: /* Lets make it available in the skin */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The image control is separate from the list, is technically placed behind the list in depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

A. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

B. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

C. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now you can try to change the banner view into something else. How about a panel that loads posters?

HOW-TO:Add a new view type to the skin

2014-06-23T18:31:54Z

MassIV: /* That's it */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The image control is separate from the list, is technically placed behind the list in depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

1. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

2. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

3. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

Now you can try to change the banner view into something else. How about a panel that loads posters?

HOW-TO:Add a new view type to the skin

2014-06-23T18:29:22Z

MassIV: /* The content of our viewtype */

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The image control is separate from the list, is technically placed behind the list in depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="Banners">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

1. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

2. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

3. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

HOW-TO:Add a new view type to the skin

2014-06-23T18:27:17Z

MassIV: Created page with "{{mininav|Development|Add-on development|Skinning|Skinning Tutorials}} ==Create the extra includes type xml file== We start by creating the new include type ..."

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

==Create the extra includes type xml file==

We start by creating the new include type xml file. This means we are going to extend the current includes.xml file with another file. While making this file is not strictly needed (you could just add the new view in already huge includes.xml) it is recommended for organizing and readability. In this tutorial the new file we are making is named "Viewtype_Banners.xml".

==The content of our viewtype==

This example contains one list with banners and one image control. Before we look at them, notice line 2 and 3 of the content. Line two declares we are dealing with includes. Line 3 declares the name of this (or the first) include in this content.

The image control is separate from the list, is technically placed behind the list in depth (first in code), and it requests the thumb image of the currently focussed item in the list. The list shows the banner and the label of the current item. Make sure "font14" is a supported entry in Font.xml or you won't see the text. The example list also has two visible conditions like: '''Container.Content(tvshows)''', this is because not all media has banners. Lets not keep you any longer, just paste the below in your empty file (don't forget the xml version).

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<includes>
<include name="Banners">

<control type="image">
<left>250</left>
<top>250</top>
<width>300</width>
<height>100</height>
<texture>$INFO[Container(709).ListItem.Art(thumb)]</texture>
<aspectratio>keep</aspectratio>
<visible>Control.IsVisible(709)</visible>
</control>

<control type="fixedlist" id="709">
<viewtype label="31268">list</viewtype>
<left>351</left>
<top>112</top>
<width>950</width>
<height>550</height>
<orientation>vertical</orientation>
<focusposition>1</focusposition>
<visible>Container.Content(tvshows) | Container.Content(seasons)</visible>

<itemlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</itemlayout>
<focusedlayout width="585" height="190">

<control type="image">
<left>2</left>
<top>13</top>
<width>573</width>
<height>105</height>
<texture>$INFO[ListItem.Art(banner)]</texture>
<aspectratio>stretch</aspectratio>
</control>
<control type="label">
<left>10</left>
<top>107</top>
<width>633</width>
<height>60</height>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
font14
<textcolor>FFFFFFFF</textcolor>
<selectedcolor>FFFFFFFF</selectedcolor>
</control>

</focusedlayout>
</control>

</include>
</includes>
</syntaxhighlight>

==Lets make it available in the skin==

Three little things XBMC needs to know about our new viewtype.

1. '''Open the file includes.xml.''' First we need to actually add the extension of includes.xml that we made (Viewtype_Banners.xml) to includes.xml. So we add the following line to includes.xml
<syntaxhighlight lang="xml">
<include file="Viewtype_Banners.xml" />
</syntaxhighlight>

2. '''Open the file MyVideoNav.xml.''' The skin needs to know in what order the viewtypes get flipped through when we press the "next viewtype" button. So the number of our viewtype '''709''' needs to get added inbetween the views tags (should be near the top).
<syntaxhighlight lang="xml">
<views>637,709,501,603,781,50</views>
</syntaxhighlight>

3. '''Open the file MyVideoNav.xml.''' Hey great, you already had it open. Now we add the actual include. What did we name our include again in line 3 of our content? Did we use a capital B? '''<include>Banners</include>''' is what we add. Alright, so you see numbers behind the includes. The code does not read those, that is how you format a comment.
<syntaxhighlight lang="xml">
<include>Banners</include>
<include>Panel</include>
<include>List</include>
</syntaxhighlight>

==That's it==

What might be left to do? Well your skin might not have a button to flip through the available viewtypes. So you need to add a button or item to perform this function. Look in the documentation or in the skin if you need an example.
<syntaxhighlight lang="xml">
<onclick>Container.NextViewMode</onclick>
</syntaxhighlight>

Don't forget to refresh the skin to load the new code. Have a look at the foundation thread for how to do this:
http://forum.xbmc.org/showthread.php?tid=94438

List of boolean conditions

2014-05-12T04:40:17Z

MassIV:

{{see also|Conditional Visibility}}
<section begin="main content" />
Skins can use boolean conditions with the <visible> tag or with condition attributes. Scripts can read boolean conditions with <code>xbmc.getCondVisibility(condition)</code>.

{| class="prettytable"
! Condition !! Description
|-
| <code>ButtonScroller.HasFocus(id)</code>
| Returns true if the buttonscroller is focused, and the current button has id ?id?.
|-
| <code>Container.HasThumb</code>
| Returns true if the current container you are in has a thumb assigned to it
|-
| <code>Container.Content(parameter)</code>
| Returns true if the current container you are in contains the following: '''files, songs, artists, albums, movies, tvshows, seasons, episodes, musicvideos, genres, years, actors, playlists, plugins, studios, directors, sets, tags''' (Note: these currently only work in the Video and Music Library or unless a Plugin has set the value) also available are '''Addons''' true when a list of add-ons is shown '''LiveTV''' true when a htsp (tvheadend) directory is shown
|-
| <code>Container(id).OnNext</code>
| 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.)
|-
| <code>Container(id).OnScrollNext</code>
| 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.
|-
| <code>Container(id).OnPrevious</code>
| 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.)
|-
| <code>Container(id).OnScrollPrevious</code>
| 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.
|-
| <code>Container(id).HasFocus(item_number)</code>
| 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.
|-
| <code>Container(id).HasFiles</code>
| Returns true if the container contains files (or current container if id is omitted).
|-
| <code>Container(id).HasFolders</code>
| Returns true if the container contains folders (or current container if id is omitted).
|-
| <code>Container(id).HasNext</code>
| Returns true if the container (id) has a next page.
|-
| <code>Container(id).HasPrevious</code>
| Returns true if the container (id) has a previous page.
|-
| <code>Container(id).IsStacked</code>
| Returns true if the container is currently in stacked mode (or current container if id is omitted).
|- {{frodo row}}
| <code>Container.CanFilter</code>
| Returns true when the current container can be filtered. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Container.CanFilterAdvanced</code>
| Returns true when advanced filtering can be applied to the current container. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Container.Filtered</code>
| Returns true when a mediafilter is applied to the current container. '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>Container(id).Row(row)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the row given.
|-
| <code>Container(id).Column(col)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the column given.
|-
| <code>Container(id).Position(pos)</code>
| Returns true if the container with id (or current container if id is omitted) is focused on the position given.
|-
| <code>Container(id).Scrolling</code>
| 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.
|-
| <code>Control.IsEnabled(id)</code>
| Returns true if the control with id "id" is enabled.
|-
| <code>Control.IsVisible(id)</code>
| Returns true if the control with id "id" is visible.
|-
| <code>Control.HasFocus(id)</code>
| Returns true if the currently focused control has id "id".
|-
| <code>ControlGroup(group).HasFocus(id)</code>
| 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”.
|-
| <code>IntegerGreaterThan([[InfoLabels|info]],number)</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is greater than the supplied number. Example: IntegerGreaterThan(ListItem.Year,2000)
|-
| <code>IsEmpty([[InfoLabels|info]])</code>
| Returns true if the value of the [[InfoLabels|infolabel]] is empty. Example: IsEmpty(ListItem.Plot)
|-
| <code>Library.HasContent(string)</code>
| Returns true if the XBMC libraries have the content from string. Valid Strings are (Video, Music, Movies, TVShows, MusicVideos, MovieSets)
|-
| <code>Library.IsScanningMusic</code>
| Returns true if the music library is being updated
|-
| <code>Library.IsScanningVideo</code>
| Returns true if the video library is being updated
|-
| <code>ListItem.IsFolder</code>
| Returns whether the current ListItem is a folder
|-
| <code>ListItem.IsPlaying</code>
| Returns whether the current ListItem.* [[InfoLabels|info labels]] and images are currently Playing media
|-
| <code>ListItem.IsResumable</code>
| Returns true when the current ListItem has been partially played
|-
| <code>ListItem.IsSelected</code>
| Returns whether the current ListItem is selected (f.e. currently playing in playlist window)
|-
| <code>ListItem.Property(IsSpecial)</code>
| Returns whether the current Season/Episode is a Special
|- {{frodo row}}
| <code>ListItem.HasEpg</code>
| Returns true when the selected programme has epg info (PVR) '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>ListItem.HasTimer</code>
| Returns true when a recording timer has been set for the selected programme (PVR) '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>ListItem.IsRecording</code>
| Returns true when the selected programme is being recorded (PVR) '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>ListItem.IsEncrypted</code>
| Returns true when the selected programme is encrypted (PVR) '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{gotham row}}
| <code>ListItem.IsStereoscopic</code>
| Returns true when the selected video is a 3D (stereoscopic) video '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>MusicPlayer.HasNext</code>
| Returns true if the music player has a next song queued in the Playlist.
|-
| <code>MusicPlayer.HasPrevious</code>
| Returns true if the music player has a a Previous Song in the Playlist .
|-
| <code>MusicPlayer.Offset(number).Exists</code>
| Returns true if the music players playlist has a song queued in position (number).
|-
| <code>MusicPartyMode.Enabled</code>
| Returns true if Party Mode is enabled
|-
| <code>Player.HasMedia</code>
| Returns true if the player has an audio or video file.
|-
| <code>Player.HasAudio</code>
| Returns true if the player has an audio file.
|-
| <code>Player.HasDuration</code>
| Returns true if Media isn't a true stream
|-
| <code>Player.HasVideo</code>
| Returns true if the player has a video file.
|-
| <code>Player.Playing</code>
| Returns true if the player is currently playing (ie not ffwding, rewinding or paused.)
|-
| <code>Player.Paused</code>
| Returns true if the player is paused.
|-
| <code>Player.Forwarding</code>
| Returns true if the player is fast forwarding.
|-
| <code>Player.Forwarding2x</code>
| Returns true if the player is fast forwarding at 2x.
|-
| <code>Player.Forwarding4x</code>
| Returns true if the player is fast forwarding at 4x.
|-
| <code>Player.Forwarding8x</code>
| Returns true if the player is fast forwarding at 8x.
|-
| <code>Player.Forwarding16x</code>
| Returns true if the player is fast forwarding at 16x.
|-
| <code>Player.Forwarding32x</code>
| Returns true if the player is fast forwarding at 32x.
|-
| <code>Player.Rewinding</code>
| Returns true if the player is rewinding.
|-
| <code>Player.Rewinding2x</code>
| Returns true if the player is rewinding at 2x.
|-
| <code>Player.Rewinding4x</code>
| Returns true if the player is rewinding at 4x.
|-
| <code>Player.Rewinding8x</code>
| Returns true if the player is rewinding at 8x.
|-
| <code>Player.Rewinding16x</code>
| Returns true if the player is rewinding at 16x.
|-
| <code>Player.Rewinding32x</code>
| Returns true if the player is rewinding at 32x.
|-
| <code>Player.CanRecord</code>
| Returns true if the player can record the current internet stream.
|-
| <code>Player.Recording</code>
| Returns true if the player is recording the current internet stream.
|-
| <code>Player.Caching</code>
| Returns true if the player is current re-caching data (internet based video playback).
|-
| <code>Player.SeekBar</code>
| Returns true for the first 2.5 seconds after a video seek.
|-
| <code>Player.DisplayAfterSeek</code>
| Returns true after any seek.
|-
| <code>Player.Seeking</code>
| Returns true if a seek is in progress
|-
| <code>Player.ShowTime</code>
| Returns true if the user has requested the time to show (occurs in video fullscreen)
|-
| <code>Player.ShowInfo</code>
| Returns true if the user has requested the song info to show (occurs in visualisation fullscreen and slideshow)
|-
| <code>Player.ShowCodec</code>
| Returns true if the user has requested the codec to show (occurs in visualisation and video fullscreen)
|- {{gotham row}}
| <code>Player.IsInternetStream</code>
| Returns true if the player is playing an internet stream. '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>Player.Muted</code>
| Returns true if the volume is muted.
|-
| <code>Playlist.IsRandom</code>
| Returns true if the player is in random mode.
|-
| <code>Playlist.IsRepeat</code>
| Returns true if the player is in repeat all mode.
|-
| <code>Playlist.IsRepeatOne</code>
| Returns true if the player is in repeat one mode.
|- {{frodo row}}
| <code>Pvr.HasTimer</code>
| Returns true when a recording timer is active. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.HasNonRecordingTimer</code>
| Returns true when a non recording timer is active. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.HasEpg</code>
| Returns true when an epg is available. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.HasTxt</code>
| Returns true when teletext is available.'''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.HasDirector</code>
| ? '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.IsPlayingTv</code>
| Returns true when live tv is being watched. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.IsPlayingRadio</code>
| Returns true when live radio is being listened to. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.IsPlayingRecording</code>
| Returns true when a recording is being watched. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.IsRecording</code>
| Returns true when the system is recording a tv programme. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>Pvr.ActStreamIsEncrypted</code>
| Returns true if the stream is encrypted '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>Skin.HasTheme(theme)</code>
| Returns true if the user has selected the theme with name ?theme?.
|-
| <code>Skin.HasSetting(setting)</code>
| Returns the state of the skin-specified setting ?setting?. You can toggle a setting from a button by using <onclick>Skin.ToggleSetting(setting)</onclick>.
|-
| <code>Skin.String(string)</code>
| Returns whether the skin string (set via Skin.SetString, Skin.SetPath, or Skin.SetImage) is non-empty.
|-
| <code>Skin.String(string1,string2)</code>
| Same as stringcompare(Skin.String(string1),string2). Returns true if Skin.String(string1) equals string2.
|-
| <code>Slideshow.IsActive</code>
| Returns true if the picture slideshow is running
|-
| <code>Slideshow.IsPaused</code>
| Returns true if the picture slideshow is paused
|-
| <code>Slideshow.IsRandom</code>
| Returns true if the picture slideshow is in random mode
|- {{gotham row}}
| <code>Slideshow.IsVideo</code>
| Returns true if the picture slideshow is playing a video '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>StringCompare([[InfoLabels|info]],string)</code>
| Returns true if the [[InfoLabels|info]] equals the string. example of info: ListItem.Title, ListItem.Genre. Please note that string can also be a $LOCALIZE[] or [[InfoLabels|info label]] (without $INFO prefix). Also note that in a panelview or similar this only works on the focused item. Both arguments are evaluated on the fly, unlike substring.
|-
| <code>SubString([[InfoLabels|info]],string)</code>
| Returns true if the string is found anywhere in the [[InfoLabels|info]] 
Parameter is evaluated at time of parsing (XML load) not on the fly.
|-
| <code>SubString([[InfoLabels|info]],string,[Left or Right])</code>
| Returns true if the string is found from the start or the end. Example: 
(foobars,foob,Left) -> true 
(foobars,foob,Right) -> False 
(foobars,bars,Right) -> true
|-
| <code>System.HasAddon(id)</code>
| Returns true if the specified addon is installed on the system.
|-
| <code>System.HasAlarm(alarm)</code>
| Returns true if the system has the ?alarm? alarm set.
|-
| <code>System.HasPVR</code>
| Returns true on pvr enabled XBMC builds. (Note: Replaced with System.GetBool(pvrmanager.enabled) for Frodo)
|-
| <code>System.AlarmLessOrEqual(alarmname,seconds)</code>
| 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.
|-
| <code>System.HasNetwork</code>
| Returns true if the ethernet cable is plugged in.
|-
| <code>System.HasMediadvd</code>
| Returns true if there is a CD or DVD in the DVD-ROM drive.
|-
| <code>System.IdleTime(time)</code>
| Returns true if XBMC has had no input for ?time? amount of seconds.
|-
| <code>System.IsStandalone</code>
| Returns true if XBMC is running in standalone mode.
|-
| <code>System.IsFullscreen</code>
| Returns true if XBMC is running fullscreen.
|-
| <code>System.KaiConnected</code>
| Returns true if XBMC's Kai client is connected to the PC engine.
|-
| <code>System.IsLoggedOn</code>
| Returns true if a user is currently logged on under a [[Profiles|profile]]
|-
| <code>System.HasLoginScreen</code>
| Returns true if the [[Profiles|profile]] login screen is enabled
|-
| <code>System.Time(startTime,endTime)</code>
| 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.
|-
| <code>System.Date(startDate,endDate)</code>
| Returns true if the current system date is >= startDate and < endDate. endDate is optional. Date must be specified in the format MM-DD.
|-
| <code>System.Platform.Linux</code>
| Returns true if XBMC is running on a linux/unix based computer.
|- {{gotham row}}
| <code>System.Platform.Linux.RaspberryPi</code>
| Returns true if XBMC is running on a Raspberry Pi. '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>System.Platform.Windows</code>
| Returns true if XBMC is running on a windows based computer.
|-
| <code>System.Platform.OSX</code>
| Returns true if XBMC is running on an OSX based computer.
|-
| <code>System.Platform.IOS</code>
| Returns true if XBMC is running on an IOS device.
|- {{frodo row}}
| <code>System.Platform.Darwin</code>
| Returns true if XBMC is running on an OSX or IOS system. '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>System.Platform.ATV2</code>
| Returns true if XBMC is running on an atv2.
|-
| <code>System.Platform.Android</code>
| Returns true if XBMC is running on an android device.
|-
| <code>System.CanPowerDown</code>
| Returns true if XBMC can powerdown the system.
|-
| <code>System.CanSuspend</code>
| Returns true if XBMC can suspend the system.
|-
| <code>System.CanHibernate</code>
| Returns true if XBMC can hibernate the system.
|-
| <code>System.CanReboot</code>
| Returns true if XBMC can reboot the system.
|-
| <code>System.ScreenSaverActive</code>
| Returns true if ScreenSaver is active.
|-
| <code>System.Setting(hidewatched)</code>
| Returns true if 'hide watched items' is selected.
|- {{frodo row}}
| <code>System.IsInhibit</code>
| Returns true when shutdown on idle is disabled. '''([[:Category:Frodo feature|Frodo addition]])'''
|- {{frodo row}}
| <code>System.HasShutdown</code>
| Returns true when shutdown on idle is enabled. '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>VideoPlayer.UsingOverlays</code>
| 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.
|-
| <code>VideoPlayer.IsFullscreen</code>
| Returns true if the video player is in fullscreen mode.
|-
| <code>VideoPlayer.HasMenu</code>
| Returns true if the video player has a menu (ie is playing a DVD)
|-
| <code>VideoPlayer.HasInfo</code>
| Returns true if the current playing video has information from the library or from a plugin (eg director/plot etc.)
|-
| <code>VideoPlayer.Content(parameter)</code>
| 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
|-
| <code>VideoPlayer.HasSubtitles</code>
| Returns true if there are subtitles available for video. (available for version 11.0 and above)
|- {{gotham row}}
| <code>VideoPlayer.IsStereoscopic</code>
| Returns true when the currently playing video is a 3D (stereoscopic) video '''([[:Category:Gotham feature|Gotham addition]])'''
|-
| <code>VideoPlayer.SubtitlesEnabled</code>
| Returns true if subtitles are turned on for video. (available for version 11.0 and above)
|- {{frodo row}}
| <code>VideoPlayer.HasEpg</code>
| Returns true when epg information is available for the currently playing programme (PVR). '''([[:Category:Frodo feature|Frodo addition]])'''
|-
| <code>Visualisation.Enabled</code>
| Returns true if any visualisation has been set in settings (so not None).
|-
| <code>Visualisation.Locked</code>
| Returns true if the current visualisation preset is locked (eg in Milkdrop.)
|-
| <code>Weather.IsFetched</code>
| Returns true if the weather data has been downloaded.
|-
| <code>Window.IsVisible(window)</code>
| Returns true if the window is visible (includes fade out time on dialogs)
|-
| <code>Window.IsActive(window)</code>
| Returns true if the window with id or title ?window? is active (excludes fade out time on dialogs) [[Window IDs|See here for a list of windows]]
|-
| <code>Window.IsMedia</code>
| Returns true if this window is a media window (programs, music, video, scripts, pictures)
|-
| <code>Window.Next(window)</code>
| Returns true if the window with id or title ?window? is being moved to. [[Window IDs|See here for a list of windows]]. Only valid while windows are changing.
|-
| <code>Window.Previous(window)</code>
| Returns true if the window with id or title ?window? is being moved from. [[Window IDs|See here for a list of windows]]. Only valid while windows are changing.
|}
<section end="main content" />

== Removed conditions ==
* <code>AudioScrobbler.Enabled</code> - Removed in v12 Frodo
* <code>LastFM.RadioPlaying</code> - Removed in v12 Frodo
* <code>LastFM.CanLov</code> - Removed in v12 Frodo
* <code>LastFM.CanBan</code> - Removed in v12 Frodo

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

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

Archive:Pivos XIOS DS

2014-05-05T18:34:54Z

MassIV:

[[File:Pivos XIOS.png|300px|right]]
{{mininav|[[Devices]]|[[Android]] }}
{{forum link2|1=Read this page and still need help? Check out these forums: [http://www.pivosforums.com/viewforum.php?f=11 Pivosforums.com (Android & Linux)] and XBMC.org: [http://forum.xbmc.org/forumdisplay.php?fid=164 Android] & [http://forum.xbmc.org/forumdisplay.php?fid=52 Linux].}}
<section begin="intro" />'''Pivos XIOS DS''' is an ARM-based media player set-top box that can run XBMC on either Android or Linux.

This Pivos XIOS DS was the original reference hardware target for the XBMC for Android port development. Pivos XIOS DS performs roughly at the level as a jailbroken ATV2, but also comes with USB ports, micro-SD card, and doesn't need to be jailbroken.<section end="intro" />
__TOC__
{{-}}

== Installing XBMC ==
* Overall guide, including switching between Android and Linux: http://www.pivosforums.com/viewtopic.php?f=16&t=3150

=== Android ===
* '''Nightly builds (Gotham):''' As of December 30th 2013, Pivos XIOS DS can use the normal XBMC for Android '''[[nightly builds]]''' and have hardware video decoding: http://mirrors.xbmc.org/nightlies/android/arm/
* Pivos's Official build: http://www.pivosforums.com/viewtopic.php?f=11&t=847
* Unofficial Frodo builds: http://www.pivosforums.com/viewtopic.php?f=24&t=2967

=== Linux ===
* Pivos's Official build: http://www.pivosforums.com/viewtopic.php?f=11&t=941
* Unofficial Frodo builds: [http://www.pivosforums.com/viewtopic.php?f=27&t=1987 For M1 models] • [http://www.pivosforums.com/viewtopic.php?f=27&t=2031 For M3 models]

==Remote control==
[[File:Pivos XIOX remote.png|right|border|211px]]
{{note|For a slightly improved keymap layout for the Pivos XIOS DS remote, see '''[[Alternative keymaps for Pivos XIOS DS remote]]'''.}}
;Global
# Contextual menu
# Power/sleep
# Directional pad: Up, Down, Right, Left
# Select/Play
# Volume (on side)
# Back
# Info

;Playback
# Nothing
# Power/sleep
# Directional pad:
## '''Up:''' +10 minutes or next chapter
## '''Down:''' -10 minutes or previous chapter
## '''Right:''' +30 seconds
## '''Left:''' -30 seconds
# On-screen-display controls
# Volume (on side)
# Goes back into the video listing ''(won't stop playback, so you must return to fullscreen using the lefthand sidebar menu. See [[Alternative keymaps for Pivos XIOS DS remote|here]] for an alternative.)''
# Video info

{{-}}

==Random notes==
{{large|''Feel free to place various notes, tips, and links here. As this section of the wiki gets more organized, those notes will be properly sorted. Consider this like a dumping ground for when you're not sure where to put something.''}}

* User notes:
I have an M3 model, Firmware: ICS-110913-M3, currently on Gotham stable.

I found Extending your app space to your mSD card and moving XBMC there actually slower (might just be my Sandisk card). Then again i hardly have other apps installed. Same with swap files/partitions on mSD, personally found it of no benefit or worth the trouble. Best results with XBMC on the internal memory and using a clean (no partitions, factory formatted) SD card for userdata.

So far only found one android FTP app that doesn't shut down the wireless: WellFTP Server.
Updating XBMC: Been using "XBMC updater" app for Alpha and Betas. Replaces and removes old version (First use download, then use install button). And "Rescan Media" to turn off Android's media scanner.

Hardware acceleration: Amcodec + libstagefright turned on seems to play the most. If you have better info plz add.

Been using the below advancedsettings.xml file on Gotham. Anyone have improvements plz share.

<syntaxhighlight lang="XML" enclose="div">
<advancedsettings>
<loglevel>-1</loglevel>
<skiploopfilter>8</skiploopfilter>
<fanartres>720</fanartres>
<imageres>720</imageres>
<sleepbeforeflip>0.85</sleepbeforeflip>
<network>
<buffermode>0</buffermode>
<cachemembuffersize>33554432</cachemembuffersize>
<readbufferfactor>1.8</readbufferfactor>
</network>
<window>
<width>1280</width>
<height>720</height>
</window>
<pvr>
<minvideocachelevel>30</minvideocachelevel>
<minaudiocachelevel>50</minaudiocachelevel>
</pvr>
<gui>
<algorithmdirtyregions>1</algorithmdirtyregions>
<nofliptimeout>1</nofliptimeout>
</gui>
</advancedsettings>
</syntaxhighlight>

==Links==
* http://pivosgroup.com/xios.html - Pivos XIOS DS product page
* http://www.pivosforums.com/viewforum.php?f=11 Pivos XIOS DS help forums from Pivosforums.com

[[Category:HTPC]]
[[Category:XBMC Manual]]
[[Category:Index]]
[[Category:Pivos XIOS|*]]
[[Category:Android]]
[[Category:ARM]]
{{Frodo updated}}

Add-on:IrcChat

2014-02-24T23:00:59Z

MassIV: /* How To */

{{Addon
|Name=IrcChat
|provider-name=divingmule & MassIV
|ID=script.ircchat
|latest-version=1.0.0
|extension point=xbmc.python.script
|provides=executable
|Summary=An IRC Client
|Description=
This add-on is a basic IRC client for XBMC mediacenter.
Internet Relay Chat (IRC) is a protocol for live interactive
Internet text messaging (chat) or synchronous conferencing.
It is mainly designed for group communication in discussion forums, called channels.

|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=
|Website=http://wiki.xbmc.org/index.php?title=Add-on:IrcChat#IRC
|Source=https://github.com/divingmule/script.ircchat
|Email=
|broken=
|icon url=http://mirrors.xbmc.org/addons/frodo/script.ircchat/icon.png}}

== IRC ==
Internet Relay Chat (IRC) is a protocol for live interactive Internet text messaging (chat) or synchronous conferencing.

[http://en.wikipedia.org/wiki/Internet_Relay_Chat Internet Relay Chat Wiki]

Many web chat's on the internet use an IRC server behind the scenes. It's well established and usable on all operating systems.
And for instance XBMC, has it's own IRC channel on Freenode. Much like the forum, a place to talk or ask a question.
Now lets have a look at that channel as example. The host looks like this '''irc.freenode.org'''. Kind of like a web address.
And you could in fact connect to the channel with a browser like so:

[http://irc.lc/freenode/xbmc/irctc@@@ XBMC via webchat]

That's nice. But why a chat in a media center?
Well, many live video streaming websites have a chat next to the stream. And watching these streams on our mediacenter without them sometimes felt like listening to half a conversation. So that is how the first version of the chat came to be. It was just read only, but then it started to grow.

== Popular servers ==
* [http://xbmc.org/ Xbmc.org]: irc.freenode.org #xbmc
* [http://www.justin.tv/ Justin.tv]: channel_name.jtvirc.com #channel_name
* [http://twit.tv/ Twit.tv]: irc.twit.tv #twitlive
* [http://www.twitch.tv/ Twitch.tv]: channel_name.jtvirc.com #channel_name
* [http://www.ustream.tv/ Ustream.tv]: chat1.ustream.tv OR c.ustream.tv #channel_name

== How To ==
After installing the addon.
* Go into the addon settings.
{{highlight|bordered=yes|[[Add-ons|Program Add-Ons -> IrcChat -> Context -> Add-On Settings]]}}
* Here you can input your initial login information, host and channel.
* Next, start a steam or playlist.
* Go to programs and start the IrcChat addon (use TAB toswitch to fullscreen video).

* It is also possible to map a key to starting the script. As an easy way to start during playback, switch hosts or usernames.
<source lang="xml">
<F1>RunScript(script.ircchat, run_irc=True&nickname=MyNick&username=name&password=pass123&host=irc.freenode.org&channel=xbmc)</F1>
</source>

* There is a button in the top {{highlight|bordered=yes|[[List_Container|<]]}} to slide out either a list of channels or a list of users. Depending on whether you are in a channel or not.
* A button to change colors {{highlight|bordered=yes|[[Spin_Control|c]]}} that gives you a 'spin control'.
* The chat's keyboard input also allows you to input a channel name to connect to IF you are not in a channel. You do not need to enter the # in front of the channel name.
* Selecting your own name in the list of users allows you options like changing your name IF this is supported by the host you are on.

== Login Token ==
As of Sept. 17, 2013, Twitch now requires that you log into IRC using an OAuth token instead of your plaintext password or hash for additional security. To generate a token, visit:
http://www.twitchapps.com/tmi/

==Screenshots==

<gallery widths=200px heights=113px>
File:script.ircchat-screenshot-1.png
File:script.ircchat-screenshot-2.png
File:script.ircchat-screenshot-3.png
File:script.ircchat-screenshot-4.png
</gallery>

==Add-on integration==
If you wish to integrate the chat with your video streaming add-on. Host, nickname, and username are required, the other parameters are optional.
<source lang="xml">
<settings>
<category label="Chat">
<setting id="run_chat" type="bool" label="Run IrcChat" default="false" />
<setting id="nickname" type="text" label="Justin.tv Username" default="" visible="eq(-1,true)" />
<setting id="password" type="text" label="Justin.tv Password" default="" option="hidden" visible="eq(-2,true)" />
</category>
</settings>
</source>

Then pass the host, channel and user parameters of your website to the chat.
<source lang="python">
#if stream started:
xbmc.sleep(3000)
if addon.getSetting('run_chat') == 'true':
xbmc.executebuiltin(
"RunScript(script.ircchat, run_irc=True&nickname=%s&username=%s&password=%s&host=%s&channel=%s)"
%(addon.getSetting('nickname'), addon.getSetting('nickname'),
addon.getSetting('password'), name+'.jtvirc.com', name)
)
</source>

==Skin integration==
To simply overwrite one or two images (for example the loading .png). Add a folder to your skin media folder called "IrcChat".
And place your own loading image in there with the same name as it has in the IrcChat add-on. In this case "ChatBusy.png".

To completely adjust all aspects of the chat layout. Place an xml file with the name "script-IrcChat-main.xml" in your skin's 720p folder. Or start by taking a copy of the one from the add-on. Note: Doing so requires all images to be in your skin, it will no longer look in the add-on folder.

[[Category:Frodo add-on repository]]
[[Category:Eden add-on repository]]
[[Category:Social media]]

Add-on:IrcChat

2014-02-02T22:17:50Z

MassIV:

{{Addon
|Name=IrcChat
|provider-name=divingmule & MassIV
|ID=script.ircchat
|latest-version=1.0.0
|extension point=xbmc.python.script
|provides=executable
|Summary=An IRC Client
|Description=
This add-on is a basic IRC client for XBMC mediacenter.
Internet Relay Chat (IRC) is a protocol for live interactive
Internet text messaging (chat) or synchronous conferencing.
It is mainly designed for group communication in discussion forums, called channels.

|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=
|Website=http://wiki.xbmc.org/index.php?title=Add-on:IrcChat#IRC
|Source=https://github.com/divingmule/script.ircchat
|Email=
|broken=
|icon url=http://mirrors.xbmc.org/addons/frodo/script.ircchat/icon.png}}

== IRC ==
Internet Relay Chat (IRC) is a protocol for live interactive Internet text messaging (chat) or synchronous conferencing.

[http://en.wikipedia.org/wiki/Internet_Relay_Chat Internet Relay Chat Wiki]

Many web chat's on the internet use an IRC server behind the scenes. It's well established and usable on all operating systems.
And for instance XBMC, has it's own IRC channel on Freenode. Much like the forum, a place to talk or ask a question.
Now lets have a look at that channel as example. The host looks like this '''irc.freenode.org'''. Kind of like a web address.
And you could in fact connect to the channel with a browser like so:

[http://irc.lc/freenode/xbmc/irctc@@@ XBMC via webchat]

That's nice. But why a chat in a media center?
Well, many live video streaming websites have a chat next to the stream. And watching these streams on our mediacenter without them sometimes felt like listening to half a conversation. So that is how the first version of the chat came to be. It was just read only, but then it started to grow.

== Popular servers ==
* [http://xbmc.org/ Xbmc.org]: irc.freenode.org #xbmc
* [http://www.justin.tv/ Justin.tv]: channel_name.jtvirc.com #channel_name
* [http://twit.tv/ Twit.tv]: irc.twit.tv #twitlive
* [http://www.twitch.tv/ Twitch.tv]: channel_name.jtvirc.com #channel_name
* [http://www.ustream.tv/ Ustream.tv]: chat1.ustream.tv OR c.ustream.tv #channel_name

== How To ==
After installing the addon.
* Go into the addon settings.
{{highlight|bordered=yes|[[Add-ons|Program Add-Ons -> IrcChat -> Context -> Add-On Settings]]}}
* Here you can input your initial login information, host and channel.
* Next, start a steam or playlist.
* Go to programs and start the IrcChat addon (use TAB toswitch to fullscreen video).

* It is also possible to map a key to starting the script. As an easy way to start during playback, switch hosts or usernames.
<source lang="xml">
<F1>RunScript(script.ircchat, run_irc=True,nickname=MyNick,username=name,password=pass123,host=irc.freenode.org,channel=xbmc</F1>
</source>

* There is a button in the top {{highlight|bordered=yes|[[List_Container|<]]}} to slide out either a list of channels or a list of users. Depending on whether you are in a channel or not.
* A button to change colors {{highlight|bordered=yes|[[Spin_Control|c]]}} that gives you a 'spin control'.
* The chat's keyboard input also allows you to input a channel name to connect to IF you are not in a channel. You do not need to enter the # in front of the channel name.
* Selecting your own name in the list of users allows you options like changing your name IF this is supported by the host you are on.

== Login Token ==
As of Sept. 17, 2013, Twitch now requires that you log into IRC using an OAuth token instead of your plaintext password or hash for additional security. To generate a token, visit:
http://www.twitchapps.com/tmi/

==Screenshots==

<gallery widths=200px heights=113px>
File:script.ircchat-screenshot-1.png
File:script.ircchat-screenshot-2.png
File:script.ircchat-screenshot-3.png
File:script.ircchat-screenshot-4.png
</gallery>

==Add-on integration==
If you wish to integrate the chat with your video streaming add-on. Host, nickname, and username are required, the other parameters are optional.
<source lang="xml">
<settings>
<category label="Chat">
<setting id="run_chat" type="bool" label="Run IrcChat" default="false" />
<setting id="nickname" type="text" label="Justin.tv Username" default="" visible="eq(-1,true)" />
<setting id="password" type="text" label="Justin.tv Password" default="" option="hidden" visible="eq(-2,true)" />
</category>
</settings>
</source>

Then pass the host, channel and user parameters of your website to the chat.
<source lang="python">
#if stream started:
xbmc.sleep(3000)
if addon.getSetting('run_chat') == 'true':
xbmc.executebuiltin(
"RunScript(script.ircchat, run_irc=True&nickname=%s&username=%s&password=%s&host=%s&channel=%s)"
%(addon.getSetting('nickname'), addon.getSetting('nickname'),
addon.getSetting('password'), name+'.jtvirc.com', name)
)
</source>

==Skin integration==
To simply overwrite one or two images (for example the loading .png). Add a folder to your skin media folder called "IrcChat".
And place your own loading image in there with the same name as it has in the IrcChat add-on. In this case "ChatBusy.png".

To completely adjust all aspects of the chat layout. Place an xml file with the name "script-IrcChat-main.xml" in your skin's 720p folder. Or start by taking a copy of the one from the add-on. Note: Doing so requires all images to be in your skin, it will no longer look in the add-on folder.

[[Category:Frodo add-on repository]]
[[Category:Eden add-on repository]]
[[Category:Social media]]

Skinning Manual

2013-12-20T00:48:36Z

MassIV: /* Variables */

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

 
{{TOC right}}
XBMC includes a new GUI library written from scratch. This library allows you to skin/change everything you see in XBMC, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. 
The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning XBMC, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Confluence, includes almost all the various tricks and features that make the XBMC skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the [[XBMC Skinning Tutorials|tutorial section on skinning XBMC]] as well as the "[[Skinning XBMC]]" article, and try modifying a window or two by adding a button, or altering the textures or layout.
 

== Anatomy of a Skin ==
XBMC skins once installed are located in [[userdata]] addons folder. This is the folder where all skins are placed and listed. 
Any additional skins you create, or download from [[Category:Repositories]] or be installed via zip XBMC will load and ask you if you would like to load the skin and also allow you to load them up from within the Appearance Settings. It is suggested that if you want to make your own skin, then starting by copying an existing skins files over into a new folder (let's say skin/myskin) is a good place to start. You can then edit each of the files as you become more familiar with the skinning system. 
Each skin folder contains several subdirectorys, and one file:
; myskin/font
: This subdirectory contains all fonts used by the skin. you can add/replace fonts here
; myskin/media
: This subdirectory contains all the media files (.png/.gif/.jpg...) You can replace/edit these as you like.
; [[addon.xml|myskin/addon.xml]]
: This contains the information that XBMC uses to find the other files that XBMC requires to describe it's skin. It also contains credits information, and versioning information.
; myskin/720p
: This is a resolution-specific directory. XBMC can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!) [[Addon.xml#Skin_specific_elements|See here for the order in which it looks for skin files.]]

== Skin Themes ==
All the basic media files for a skin should be compressed into the Textures.xbt file, and placed in the media/ folder. You can use the tool [[Texturepacker]] for this. All the images that make up the default skin theme should be in the Textures.xbt file.

In addition to this, XBMC allows other .xbt files in the media/ folder, each one representing a different theme for your skin.
For instance, you could tint all your main textures a red colour, and create a new theme package Red.xbt.
This gives users more choice in the look of a particular skin, and only the textures change when you change themes – the layout stays the same.
If the user has selected a theme, then when a control requires a texture, XBMC will first look in the <themename>.xbt file for the texture.
It will fall back to the Textures.xbt file if <themename>.xbt doesn't contain the image. This means that the theme .xbt files need only contain the changed textures – all other textures will fallback to using Textures.xbt as usual.

A suggested method of creating a theme is as follows:

# Run Texturepacker.exe on the folder containing the default texture files, to generate Textures.xbt as you would normally do.
# Identify the textures you wish to have themed and copy them to a separate folder.
# Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
# Run Texturepacker.exe on each of the theme folders created in step 3 to create the themed .xbt files (note you can use the -output switch with Texturepacker.exe to name the theme appropriately).
# Place Textures.xbt and each of the theme .xbt files in the media/ folder of your skin. XBMC will automatically pick them up.

== Includes ==
The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless of course you want to override the default look or size etc. in a particular window. 
This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution. 
With the 2.1 skinning engine, you can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes. 
The layout of an includes file is as follows.

<source lang="xml">
<includes>
<include name="whitetext">
<textcolor>ffffffff</textcolor>
</include>
<include file="listdefaults.xml" />
<default type="button">
<include>whitetext</include>
</default>
<constant name="leftedge">50</constant>
</includes>
</source>

You'll notice in the above example that we have 4 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<source lang="xml">
<control type="togglebutton">
<include>whitetext</include>
... other tags go here
</control>
</source>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specified, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

And finally, the <constant> tag allows you to define a numeric (floating point) constant by name for use in place of numeric values (<posx>, height="" etc.) would otherwise be used. This allows alignment of items using the same position values which can then easily be altered in one place.
 
=== Variables ===
Variables are a special kind of include. You can put them in Includes.xml. But usually, to keep them separate, Includes.xml gets extended with a file named Variables.xml. You can extend on the file Includes.xml by adding a line like this:
<source lang="xml">
<include file="Variables.xml" />
</source>
Variables can be used in textures or labels/textbox/buttons ect. Instead of having to include two whole controls with a condition, they allow you to just apply the condition to the actual texture or label. Meaning less controls to maintain ect. The values in the variable are read from top to bottom and the first condition that is met gets used. The last value usually has no condition and it's content acts as a fallback. The following example shows the album label if the player has audio, the year if there is no audio and no fallback is used (because there either is or is not any audio).
<source lang="xml">
<variable name="Example">
<value condition="Player.HasAudio">$INFO[ListItem.Album]</value>
<value condition="!Player.HasAudio">$INFO[ListItem.Year]</value>
<value>-</value>
</variable>
</source>
You can use a variable in a label control like this:
<source lang="xml">
<label>$VAR[Example]</label>
</source>
 

== [[Window Structure|The Window XML Files]] ==
The other xml files each define the skin for a single window. They all have the same basic layout, allowing you to place different controls on the window, and define how navigation should operate. 
A list of all window .xml files and what they represent may be found in Apendix I: List of Windows.

The important thing to remember is that each window has a unique identifying number (id). This is how XBMC identifies the window from within the source code.

Furthermore, many of the controls within each window should have a unique id as well, unless they're just used as images or labels where navigation is unimportant and XBMC does not need to be able to identify them uniquely. The window id's are all listed in the Apendix I: List of Windows. 
The structure of the window .xml files can be found below in the Window Structure.

= addon.xml =

{{see also|addon.xml}}

= Windows =
== Window Structure ==
{{:Window_Structure}}

= Controls =
Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.
== Label Control ==
{{:Label_Control}}
== Fade Label Control ==
{{:Fade_Label_Control}}
== Button Control ==
{{:Button_control}}
== Multiselect Control ==
{{:Multiselect control}}
== Image Control ==
{{:Image_Control}}
== MultiImage Control ==
{{:MultiImage_Control}}
== Radio button Control ==
{{:Radio_button_control}}
== Select button control ==
{{:Select_button_control}}
== Toggle button control ==
{{:Toggle_button_control}}
== Spin Control ==
{{:Spin_Control}}
== Settings Spin Control ==
{{:Settings_Spin_Control}}
== Slider Control ==
{{:Slider Control}}
== List Container ==
{{:List Container}}
== Wraplist Container ==
{{:Wrap List Container}}
== FixedList Container ==
{{:Fixed List Container}}
== Panel Container ==
{{:Panel Container}}
== Progress Control ==
{{:Progress Control}}
== Text Box ==
{{:Text Box}}
== RSS feed Control ==
{{:RSS feed Control}}
== Visualisation Control ==
{{:Visualisation Control}}
== Video Control ==
{{:Video Control}}
== Mover Control ==
{{:Mover Control}}
== Resize Control ==
{{:Resize Control}}
== Edit Control ==
{{:Edit Control}}
== EPGGrid Control ==
{{:EPGGrid_control}}

== Console Control ==
used to display the last few items added to the video database.
== Checkmark Control ==
Used on the Kai Host Dialog. Similar to Radio Button but does not have the button texture, and the checkmark is on the left
== Extended List Control ==
used in the XLink Kai window.

= Conditional_Visibility =
XBMC's skinning engine versatility is based upon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implementations. For further information of available variable and how they can be applied.
{{:Conditional_Visibility}}

= Animating Your Skin =
The XBMC skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.
{{:Animating_Your_Skin}}

= Fonts =
XBMC allows you to customize which fonts are displayed onscreen in the User Interface.
{{:Fonts}}

= Apendix I: List of Windows =
{{:Window_IDs}}

= Apendix II: List of Boolean Conditions =
{{:List_of_Boolean_Conditions}}

= Apendix III: List of Info Labels =
{{:InfoLabels}}

= Apendix IV: List of Built In Functions =
{{:List_of_Built_In_Functions}}

= Apendix V: List of Built In Controls =
{{:List_of_Built_In_Controls}}

= Apendix VI: List of Default Icons =
{{:Default_Icons}}

[[Category:XBMC Manual]]
[[Category:Development]]
[[Category:Skin Development|*]]
[[Category:Python]]

Skinning Manual

2013-12-20T00:27:12Z

MassIV:

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

 
{{TOC right}}
XBMC includes a new GUI library written from scratch. This library allows you to skin/change everything you see in XBMC, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. 
The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning XBMC, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Confluence, includes almost all the various tricks and features that make the XBMC skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the [[XBMC Skinning Tutorials|tutorial section on skinning XBMC]] as well as the "[[Skinning XBMC]]" article, and try modifying a window or two by adding a button, or altering the textures or layout.
 

== Anatomy of a Skin ==
XBMC skins once installed are located in [[userdata]] addons folder. This is the folder where all skins are placed and listed. 
Any additional skins you create, or download from [[Category:Repositories]] or be installed via zip XBMC will load and ask you if you would like to load the skin and also allow you to load them up from within the Appearance Settings. It is suggested that if you want to make your own skin, then starting by copying an existing skins files over into a new folder (let's say skin/myskin) is a good place to start. You can then edit each of the files as you become more familiar with the skinning system. 
Each skin folder contains several subdirectorys, and one file:
; myskin/font
: This subdirectory contains all fonts used by the skin. you can add/replace fonts here
; myskin/media
: This subdirectory contains all the media files (.png/.gif/.jpg...) You can replace/edit these as you like.
; [[addon.xml|myskin/addon.xml]]
: This contains the information that XBMC uses to find the other files that XBMC requires to describe it's skin. It also contains credits information, and versioning information.
; myskin/720p
: This is a resolution-specific directory. XBMC can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!) [[Addon.xml#Skin_specific_elements|See here for the order in which it looks for skin files.]]

== Skin Themes ==
All the basic media files for a skin should be compressed into the Textures.xbt file, and placed in the media/ folder. You can use the tool [[Texturepacker]] for this. All the images that make up the default skin theme should be in the Textures.xbt file.

In addition to this, XBMC allows other .xbt files in the media/ folder, each one representing a different theme for your skin.
For instance, you could tint all your main textures a red colour, and create a new theme package Red.xbt.
This gives users more choice in the look of a particular skin, and only the textures change when you change themes – the layout stays the same.
If the user has selected a theme, then when a control requires a texture, XBMC will first look in the <themename>.xbt file for the texture.
It will fall back to the Textures.xbt file if <themename>.xbt doesn't contain the image. This means that the theme .xbt files need only contain the changed textures – all other textures will fallback to using Textures.xbt as usual.

A suggested method of creating a theme is as follows:

# Run Texturepacker.exe on the folder containing the default texture files, to generate Textures.xbt as you would normally do.
# Identify the textures you wish to have themed and copy them to a separate folder.
# Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
# Run Texturepacker.exe on each of the theme folders created in step 3 to create the themed .xbt files (note you can use the -output switch with Texturepacker.exe to name the theme appropriately).
# Place Textures.xbt and each of the theme .xbt files in the media/ folder of your skin. XBMC will automatically pick them up.

== Includes ==
The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless of course you want to override the default look or size etc. in a particular window. 
This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution. 
With the 2.1 skinning engine, you can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes. 
The layout of an includes file is as follows.

<source lang="xml">
<includes>
<include name="whitetext">
<textcolor>ffffffff</textcolor>
</include>
<include file="listdefaults.xml" />
<default type="button">
<include>whitetext</include>
</default>
<constant name="leftedge">50</constant>
</includes>
</source>

You'll notice in the above example that we have 4 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<source lang="xml">
<control type="togglebutton">
<include>whitetext</include>
... other tags go here
</control>
</source>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specified, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

And finally, the <constant> tag allows you to define a numeric (floating point) constant by name for use in place of numeric values (<posx>, height="" etc.) would otherwise be used. This allows alignment of items using the same position values which can then easily be altered in one place.
 
=== Variables ===
Variables are a special kind of include. Usually found in the file Variables.xml which itself is an include in Includes.xml

Variables can be used in textures or labels/textbox/buttons ect. Instead of having to include two whole controls with a condition, they allow you to just apply the condition to the actual texture or label. Meaning less controls to maintain ect. The values in the variable are read from top to bottom and the first condition that is met gets used. The last value usually has no condition and it's content acts as a fallback. The following example shows the album label if the player has audio, the year if there is no audio and no fallback is used (because there either is or is not any audio).
<source lang="xml">
<variable name="Example">
<value condition="Player.HasAudio">$INFO[ListItem.Album]</value>
<value condition="!Player.HasAudio">$INFO[ListItem.Year]</value>
<value>-</value>
</variable>
</source>
You can use a variable in a label control like this:
<source lang="xml">
<label>$VAR[Example]</label>
</source>
 
== [[Window Structure|The Window XML Files]] ==
The other xml files each define the skin for a single window. They all have the same basic layout, allowing you to place different controls on the window, and define how navigation should operate. 
A list of all window .xml files and what they represent may be found in Apendix I: List of Windows.

The important thing to remember is that each window has a unique identifying number (id). This is how XBMC identifies the window from within the source code.

Furthermore, many of the controls within each window should have a unique id as well, unless they're just used as images or labels where navigation is unimportant and XBMC does not need to be able to identify them uniquely. The window id's are all listed in the Apendix I: List of Windows. 
The structure of the window .xml files can be found below in the Window Structure.

= addon.xml =

{{see also|addon.xml}}

= Windows =
== Window Structure ==
{{:Window_Structure}}

= Controls =
Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.
== Label Control ==
{{:Label_Control}}
== Fade Label Control ==
{{:Fade_Label_Control}}
== Button Control ==
{{:Button_control}}
== Multiselect Control ==
{{:Multiselect control}}
== Image Control ==
{{:Image_Control}}
== MultiImage Control ==
{{:MultiImage_Control}}
== Radio button Control ==
{{:Radio_button_control}}
== Select button control ==
{{:Select_button_control}}
== Toggle button control ==
{{:Toggle_button_control}}
== Spin Control ==
{{:Spin_Control}}
== Settings Spin Control ==
{{:Settings_Spin_Control}}
== Slider Control ==
{{:Slider Control}}
== List Container ==
{{:List Container}}
== Wraplist Container ==
{{:Wrap List Container}}
== FixedList Container ==
{{:Fixed List Container}}
== Panel Container ==
{{:Panel Container}}
== Progress Control ==
{{:Progress Control}}
== Text Box ==
{{:Text Box}}
== RSS feed Control ==
{{:RSS feed Control}}
== Visualisation Control ==
{{:Visualisation Control}}
== Video Control ==
{{:Video Control}}
== Mover Control ==
{{:Mover Control}}
== Resize Control ==
{{:Resize Control}}
== Edit Control ==
{{:Edit Control}}
== EPGGrid Control ==
{{:EPGGrid_control}}

== Console Control ==
used to display the last few items added to the video database.
== Checkmark Control ==
Used on the Kai Host Dialog. Similar to Radio Button but does not have the button texture, and the checkmark is on the left
== Extended List Control ==
used in the XLink Kai window.

= Conditional_Visibility =
XBMC's skinning engine versatility is based upon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implementations. For further information of available variable and how they can be applied.
{{:Conditional_Visibility}}

= Animating Your Skin =
The XBMC skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.
{{:Animating_Your_Skin}}

= Fonts =
XBMC allows you to customize which fonts are displayed onscreen in the User Interface.
{{:Fonts}}

= Apendix I: List of Windows =
{{:Window_IDs}}

= Apendix II: List of Boolean Conditions =
{{:List_of_Boolean_Conditions}}

= Apendix III: List of Info Labels =
{{:InfoLabels}}

= Apendix IV: List of Built In Functions =
{{:List_of_Built_In_Functions}}

= Apendix V: List of Built In Controls =
{{:List_of_Built_In_Controls}}

= Apendix VI: List of Default Icons =
{{:Default_Icons}}

[[Category:XBMC Manual]]
[[Category:Development]]
[[Category:Skin Development|*]]
[[Category:Python]]

Skinning Manual

2013-12-19T18:52:01Z

MassIV:

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

 
{{TOC right}}
XBMC includes a new GUI library written from scratch. This library allows you to skin/change everything you see in XBMC, from the images, the sizes and positions of all controls, colours, fonts, and text, through to altering navigation and even adding new functionality. 
The skin system is quite complex, and this portion of the manual is dedicated to providing in depth information on how it all works, along with tips to make the experience a little more pleasant.

If you are just getting started with skinning XBMC, then it is suggested that the best way to learn is by modifying one of the many existing skins that are available. The default skin, Confluence, includes almost all the various tricks and features that make the XBMC skinning engine so powerful, so is an ideal place to start. You may wish to start by having a look through the [[XBMC Skinning Tutorials|tutorial section on skinning XBMC]] as well as the "[[Skinning XBMC]]" article, and try modifying a window or two by adding a button, or altering the textures or layout.
 

== Anatomy of a Skin ==
XBMC skins once installed are located in [[userdata]] addons folder. This is the folder where all skins are placed and listed. 
Any additional skins you create, or download from [[Category:Repositories]] or be installed via zip XBMC will load and ask you if you would like to load the skin and also allow you to load them up from within the Appearance Settings. It is suggested that if you want to make your own skin, then starting by copying an existing skins files over into a new folder (let's say skin/myskin) is a good place to start. You can then edit each of the files as you become more familiar with the skinning system. 
Each skin folder contains several subdirectorys, and one file:
; myskin/font
: This subdirectory contains all fonts used by the skin. you can add/replace fonts here
; myskin/media
: This subdirectory contains all the media files (.png/.gif/.jpg...) You can replace/edit these as you like.
; [[addon.xml|myskin/addon.xml]]
: This contains the information that XBMC uses to find the other files that XBMC requires to describe it's skin. It also contains credits information, and versioning information.
; myskin/720p
: This is a resolution-specific directory. XBMC can run in multiple resolutions, and thus can use different files for some resolutions (as there is a big difference between NTSC at 720x480 pixels and 1080i at 1920x1080 pixels!) [[Addon.xml#Skin_specific_elements|See here for the order in which it looks for skin files.]]

== Skin Themes ==
All the basic media files for a skin should be compressed into the Textures.xbt file, and placed in the media/ folder. You can use the tool [[Texturepacker]] for this. All the images that make up the default skin theme should be in the Textures.xbt file.

In addition to this, XBMC allows other .xbt files in the media/ folder, each one representing a different theme for your skin.
For instance, you could tint all your main textures a red colour, and create a new theme package Red.xbt.
This gives users more choice in the look of a particular skin, and only the textures change when you change themes – the layout stays the same.
If the user has selected a theme, then when a control requires a texture, XBMC will first look in the <themename>.xbt file for the texture.
It will fall back to the Textures.xbt file if <themename>.xbt doesn't contain the image. This means that the theme .xbt files need only contain the changed textures – all other textures will fallback to using Textures.xbt as usual.

A suggested method of creating a theme is as follows:

# Run Texturepacker.exe on the folder containing the default texture files, to generate Textures.xbt as you would normally do.
# Identify the textures you wish to have themed and copy them to a separate folder.
# Create a separate folder for each theme outside of your normal skin work area, and place the altered copies of each of the textures in them.
# Run Texturepacker.exe on each of the theme folders created in step 3 to create the themed .xbt files (note you can use the -output switch with Texturepacker.exe to name the theme appropriately).
# Place Textures.xbt and each of the theme .xbt files in the media/ folder of your skin. XBMC will automatically pick them up.

== Includes ==
The other special (and arguably the most important skinning file of all) is includes.xml. This is, as its title suggests, a place from which you can define the default look, size, and positioning of controls, to save you replicating many of the control's attributes throughout the window .xml files. For instance, you can setup the size, and textures used for a button control, thus allowing you to leave those details out in the rest of the skin files, unless of course you want to override the default look or size etc. in a particular window. 
This is extremely valuable as it allows you to greatly simplify a lot of the work in building a skin. For one thing, it means that once you have include files setup, many of the default parameters for a different resolution can be done by just altering the parameters within the include file(s) for the different resolution. 
With the 2.1 skinning engine, you can infact have more than one include file - you can specify the file attribute when including from a different file, allowing you to have an include file dedicated to a particular set of attributes. 
The layout of an includes file is as follows.

<source lang="xml">
<includes>
<include name="whitetext">
<textcolor>ffffffff</textcolor>
</include>
<include file="listdefaults.xml" />
<default type="button">
<include>whitetext</include>
</default>
<constant name="leftedge">50</constant>
</includes>
</source>

You'll notice in the above example that we have 4 different types of includes. The first <include> tag basically allows a substitution of the tags underneath it whenever it occurs. For instance, if in a window .xml file you have this:

<source lang="xml">
<control type="togglebutton">
<include>whitetext</include>
... other tags go here
</control>
</source>

Then it would substitute the <textcolor> tag for where the include tag is. You can have as many includes as you like, and as many tags can be inside an include - even complete controls, or complete control groups.

The second <include> tag in the example demonstrates how to include from a different file. As there is no include name specified, it will include the contents of the entire file at that point.

The <default> tag is similar to an include, except that it is used in every control of that type - even if you don't specify that the control is to use includes. Thus every buttoncontrol will have the whitetext include in it. Note that you can override this by specifying the <textcolor> tag in the buttoncontrol.

And finally, the <constant> tag allows you to define a numeric (floating point) constant by name for use in place of numeric values (<posx>, height="" etc.) would otherwise be used. This allows alignment of items using the same position values which can then easily be altered in one place.
 
=== Variables ===
Variables are a special kind of include. Usually found in the file Variables.xml which itself is an include in Includes.xml

Variables van be used in textures or labels/textbox. Instead of having to include two whole controls with a condition, they allow you to just apply the condition to the actual texture or label. The values in the variable are read from top to bottom and the first condition that is met gets used. The last value usually has no condition to act as a fallback. The following example shows the album label if the player has audio, the year if there is no audio and no fallback is needed.
<source lang="xml">
<variable name="Example">
<value condition="Player.HasAudio">$INFO[ListItem.Album]</value>
<value condition="!Player.HasAudio">$INFO[ListItem.Year]</value>
<value>-</value>
</variable>
</source>
You can use a variable in a label control like this:
<source lang="xml">
<label>$VAR[Example]</label>
</source>
 
== [[Window Structure|The Window XML Files]] ==
The other xml files each define the skin for a single window. They all have the same basic layout, allowing you to place different controls on the window, and define how navigation should operate. 
A list of all window .xml files and what they represent may be found in Apendix I: List of Windows.

The important thing to remember is that each window has a unique identifying number (id). This is how XBMC identifies the window from within the source code.

Furthermore, many of the controls within each window should have a unique id as well, unless they're just used as images or labels where navigation is unimportant and XBMC does not need to be able to identify them uniquely. The window id's are all listed in the Apendix I: List of Windows. 
The structure of the window .xml files can be found below in the Window Structure.

= addon.xml =

{{see also|addon.xml}}

= Windows =
== Window Structure ==
{{:Window_Structure}}

= Controls =
Controls are the substance of your skin. They define everything from buttons, to text labels, to visualization placement. This portion of the manual will explain each and every control in detail.
== Label Control ==
{{:Label_Control}}
== Fade Label Control ==
{{:Fade_Label_Control}}
== Button Control ==
{{:Button_control}}
== Multiselect Control ==
{{:Multiselect control}}
== Image Control ==
{{:Image_Control}}
== MultiImage Control ==
{{:MultiImage_Control}}
== Radio button Control ==
{{:Radio_button_control}}
== Select button control ==
{{:Select_button_control}}
== Toggle button control ==
{{:Toggle_button_control}}
== Spin Control ==
{{:Spin_Control}}
== Settings Spin Control ==
{{:Settings_Spin_Control}}
== Slider Control ==
{{:Slider Control}}
== List Container ==
{{:List Container}}
== Wraplist Container ==
{{:Wrap List Container}}
== FixedList Container ==
{{:Fixed List Container}}
== Panel Container ==
{{:Panel Container}}
== Progress Control ==
{{:Progress Control}}
== Text Box ==
{{:Text Box}}
== RSS feed Control ==
{{:RSS feed Control}}
== Visualisation Control ==
{{:Visualisation Control}}
== Video Control ==
{{:Video Control}}
== Mover Control ==
{{:Mover Control}}
== Resize Control ==
{{:Resize Control}}
== Edit Control ==
{{:Edit Control}}
== EPGGrid Control ==
{{:EPGGrid_control}}

== Console Control ==
used to display the last few items added to the video database.
== Checkmark Control ==
Used on the Kai Host Dialog. Similar to Radio Button but does not have the button texture, and the checkmark is on the left
== Extended List Control ==
used in the XLink Kai window.

= Conditional_Visibility =
XBMC's skinning engine versatility is based upon the fact that the skinner can display and hide portions of the skin using a variety of conditional statements that can be combined to create very user friendly UI implementations. For further information of available variable and how they can be applied.
{{:Conditional_Visibility}}

= Animating Your Skin =
The XBMC skinning engine supports animations of any control allowing them to rotate, slide, fade or any combination there-of. Combining animations with conditional statements ensure your skin will have stunning effects that appear as professional as a 1st party product.
{{:Animating_Your_Skin}}

= Fonts =
XBMC allows you to customize which fonts are displayed onscreen in the User Interface.
{{:Fonts}}

= Apendix I: List of Windows =
{{:Window_IDs}}

= Apendix II: List of Boolean Conditions =
{{:List_of_Boolean_Conditions}}

= Apendix III: List of Info Labels =
{{:InfoLabels}}

= Apendix IV: List of Built In Functions =
{{:List_of_Built_In_Functions}}

= Apendix V: List of Built In Controls =
{{:List_of_Built_In_Controls}}

= Apendix VI: List of Default Icons =
{{:Default_Icons}}

[[Category:XBMC Manual]]
[[Category:Development]]
[[Category:Skin Development|*]]
[[Category:Python]]