Adding music to the library, InfoLabels

From XBMC
(Difference between pages)
Jump to: navigation, search
(Album art and thumbnails)
 
(Labels Available In XBMC)
 
Line 1: Line 1:
{{GetStarted|'''Managing XBMC's music library'''}}<br />
+
===Labels Available In XBMC===
{{XBMC wiki toc}}
+
{| class="usertable" border="1"
<section begin="Intro"/>XBMC adds music to the library by [[Adding_music_to_the_library#Scanning_Your_Music_Into_the_Music_Library|scanning]] music files to extract identifying information from tags in the files. In order to be able to include information on your music collection in the '''[[music library]]''', XBMC needs your music to be tagged. When your collection is scanned, XBMC stores all the tagging information (artist, album, year, genre, etc) in the database which allows you to efficiently search and manage your music collection.
+
|- class="userrow"
 +
| class="usercell" | AudioScrobbler.ConnectState
 +
| class="usercell" | Connected to the audioscrobbler
 +
|- class="userrow"
 +
| class="usercell" | AudioScrobbler.SubmitInterval
 +
| class="usercell" | Shows next reconnect when submission failed
 +
|- class="userrow"
 +
| class="usercell" | AudioScrobbler.FilesCached
 +
| class="usercell" | Number of cached songs
 +
|- class="userrow"
 +
| class="usercell" | AudioScrobbler.SubmitState
 +
| class="usercell" | Shows time left until the current song is submitted
 +
|- class="userrow"
 +
| class="usercell" | container.folderpath
 +
| class="usercell" | Shows path of currently displayed folder
 +
|- class="userrow"
 +
| class="usercell" | Container(id).ListItem(offset).Label
 +
| class="usercell" | Shows ListItem.Label for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(2).Label )''
 +
|- class="userrow"
 +
| class="usercell" | Container(id).ListItem(offset).Label2
 +
| class="usercell" | Shows ListItem.Label2 for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(-2).Label2 )''
 +
|- class="userrow"
 +
| class="usercell" | Container(id).ListItem(offset).Icon
 +
| class="usercell" | Shows ListItem.Icon for a specific List or Panel Container with a offset ''( eg: Container(52).Listitem(1).Icon)''
 +
|- class="userrow"
 +
| class="usercell" | Container(id).ListItem(offset).ActualIcon
 +
| class="usercell" | Shows ListItem.ActualIcon for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).ActualIcon )''
 +
|- class="userrow"
 +
| class="usercell" | Container(id).ListItem(offset).Thumb
 +
| class="usercell" | Shows ListItem.Thumb for a specific List or Panel Container with a offset ''( eg: Container(50).Listitem(0).Thumb )''
 +
|- class="userrow"
 +
| class="usercell" | listitem.label
 +
| class="usercell" | Shows the left label of the currently selected item in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.label2
 +
| class="usercell" | Shows the right label of the currently selected item in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.title
 +
| class="usercell" | Shows the title of the currently selected song or movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.tracknumber
 +
| class="usercell" | Shows the track number of the currently selected song in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.artist
 +
| class="usercell" | Shows the artist of the currently selected song in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.album
 +
| class="usercell" | Shows the album of the currently selected song in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.year
 +
| class="usercell" | Shows the year of the currently selected song, album or movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.genre
 +
| class="usercell" | Shows the genre of the currently selected song, album or movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.director
 +
| class="usercell" | Shows the director of the currently selected movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.filename
 +
| class="usercell" | Shows the filename of the currently selected song or movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.date
 +
| class="usercell" | Shows the file date of the currently selected song or movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.size
 +
| class="usercell" | Shows the file size of the currently selected song or movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.rating
 +
| class="usercell" | Shows the IMDB rating of the currently selected movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.mpaa
 +
| class="usercell" | Show the MPAA rating of the currently selected movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.programcount
 +
| class="usercell" | Shows the number of times an xbe has been run from "my programs"
 +
|- class="userrow"
 +
| class="usercell" | listitem.duration
 +
| class="usercell" | Shows the song or movie duration of the currently selecter movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.cast
 +
| class="usercell" | Shows a concatenated string of cast members of the currently selected movie in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.castandrole
 +
| class="usercell" | Shows a concatenated string of cast members and roles of the currently selected movie in a list or controlpanel
 +
|- class="userrow"
 +
| class="usercell" | listitem.Studio
 +
| class="usercell" | Studio of current selected Music Video in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.Writer
 +
| class="usercell" | Name of Writer of current Video in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.Tagline
 +
| class="usercell" | Small Summary of current Video in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.PlotOutline
 +
| class="usercell" | Small Summary of current Video in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | listitem.Plot
 +
| class="usercell" | Complete Text Summary of Video in a list or thumb control
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.Title
 +
| class="usercell" | Title of the currently playing song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.Album
 +
| class="usercell" | Album from which the current song is from
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.Artist
 +
| class="usercell" | Artist(s) of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.Genre
 +
| class="usercell" | Genre(s) of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.Year
 +
| class="usercell" | Year of release of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.Time
 +
| class="usercell" | Current time in song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.TimeRemaining
 +
| class="usercell" | Current remaining time in song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.TimeSpeed
 +
| class="usercell" | Both the time and the playspeed formatted up. eg 1:23 (2x)
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.TrackNumber
 +
| class="usercell" | Track number of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.Duration
 +
| class="usercell" | Duration of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.BitRate
 +
| class="usercell" | Bitrate of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.Channels
 +
| class="usercell" | Number of channels of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.BitsPerSample
 +
| class="usercell" | Number of bits per sample of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.SampleRate
 +
| class="usercell" | Samplerate of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.Codec
 +
| class="usercell" | Codec of current song
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.PlaylistPosition
 +
| class="usercell" | Position of the current song in the current music playlist
 +
|- class="userrow"
 +
| class="usercell" | MusicPlayer.PlaylistLength
 +
| class="usercell" | Total size of the current music playlist
 +
|- class="userrow"
 +
| class="usercell" | MusicPartyMode.SongsPlayed
 +
| class="usercell" | Number of songs played during Party Mode
 +
|- class="userrow"
 +
| class="usercell" | MusicPartyMode.MatchingSongs
 +
| class="usercell" | Number of songs available to Party Mode
 +
|- class="userrow"
 +
| class="usercell" | MusicPartyMode.MatchingSongsPicked
 +
| class="usercell" | Number of songs picked already for Party Mode
 +
|- class="userrow"
 +
| class="usercell" | MusicPartyMode.MatchingSongsLeft
 +
| class="usercell" | Number of songs left to be picked from for Party Mode
 +
|- class="userrow"
 +
| class="usercell" | MusicPartyMode.RelaxedSongsPicked
 +
| class="usercell" | Not currently used
 +
|- class="userrow"
 +
| class="usercell" | MusicPartyMode.RandomSongsPicked
 +
| class="usercell" | Number of unique random songs picked during Party Mode
 +
|- class="userrow"
 +
| class="usercell" | Network.IPAddress
 +
| class="usercell" | The Xbox's IP Address (formatted as IP: <ipaddress>)
 +
|- class="userrow"
 +
| class="usercell" | Network.MacAddress
 +
| class="usercell" | xbox mac address
 +
|- class="userrow"
 +
| class="usercell" | Network.IsDHCP
 +
| class="usercell" | network type is DHCP or FIXED
 +
|- class="userrow"
 +
| class="usercell" | Network.LinkState
 +
| class="usercell" | network linkstate e.g. 10mbit/100mbit etc.
 +
|- class="userrow"
 +
| class="usercell" | Network.SubnetAddress
 +
| class="usercell" | network subnet address
 +
|- class="userrow"
 +
| class="usercell" | Network.GatewayAddress
 +
| class="usercell" | network gateway address
 +
|- class="userrow"
 +
| class="usercell" | Network.DHCPAddress
 +
| class="usercell" | DHCP ip address
 +
|- class="userrow"
 +
| class="usercell" | Network.DNS1Address
 +
| class="usercell" | network dns 1 address
 +
|- class="userrow"
 +
| class="usercell" | Network.DNS2Address
 +
| class="usercell" | network dns 2 address
 +
|- class="userrow"
 +
| class="usercell" | Player.FinishTime
 +
| class="usercell" | Time playing media will end
 +
|- class="userrow"
 +
| class="usercell" | Player.Time
 +
| class="usercell" | Elapsed time of current playing media
 +
|- class="userrow"
 +
| class="usercell" | Player.TimeRemaining
 +
| class="usercell" | Remaining time of current playing media
 +
|- class="userrow"
 +
| class="usercell" | Player.Duration
 +
| class="usercell" | Total duration of the current playing media
 +
|- class="userrow"
 +
| class="usercell" | Player.SeekTime
 +
| class="usercell" | Time to which the user is seeking
 +
|- class="userrow"
 +
| class="usercell" | Player.Volume
 +
| class="usercell" | Current volume (between -60 and 0dB)
 +
|- class="userrow"
 +
| class="usercell" | Playlist.Position
 +
| class="usercell" | Position of the current item in the current playlist (video or music)
 +
|- class="userrow"
 +
| class="usercell" | Playlist.Length
 +
| class="usercell" | Total size of the current playlist (video or music)
 +
|- class="userrow"
 +
| class="usercell" | Playlist.Random
 +
| class="usercell" | Returns string ID's 590 (Randomize Play Enabled) or 591 (Disabled)
 +
|- class="userrow"
 +
| class="usercell" | Playlist.Repeat
 +
| class="usercell" | Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
 +
|- class="userrow"
 +
| class="usercell" | Skin.CurrentTheme
 +
| class="usercell" | Returns the current selected skin theme.
 +
|- class="userrow"
 +
| class="usercell" | Skin.String(name)
 +
| class="usercell" |
 +
Returns the <span class="nobr">user-set</span> skin string, set via the Skin.SetString(name) [http://manual.xboxmediacenter.de/wakka.php?wakka=BuiltInFunctions&v=1dty built in function]. Allows skinners to have <span class="nobr">user-customisable</span> labels.
 +
|- class="userrow"
 +
| class="usercell" | System.Time
 +
| class="usercell" | Current time
 +
|- class="userrow"
 +
| class="usercell" | System.Date
 +
| class="usercell" | Current date
 +
|- class="userrow"
 +
| class="usercell" | System.Alarmpos
 +
| class="usercell" | Shutdown Timer position
 +
|- class="userrow"
 +
| class="usercell" | System.Freespace
 +
| class="usercell" | Total Freespace on the drive
  
Your audio files '''MUST''' have a valid ID tag for them to work properly in the XBMC music library. There are third party applications available for download from the internet that allow you to add and manage ID tags in your music files.<section end="Intro"/><br /><br />
+
|- class="userrow"
 +
| class="usercell" | System.Usedspace
 +
| class="usercell" | Total Usedspace on the drive
  
== See also audio streams ==
+
|- class="userrow"
{{see also|Internet_video_and_audio_streams}}
+
| class="usercell" | System.Totalspace
 +
| class="usercell" | Totalspace on the drive
  
== Scanning Your Music Into the Music Library ==
+
|- class="userrow"
To scan your music collection into the Music Library, first make sure you are not in 'Library Mode' (checkmark on the left). Next, browse to the location of your music collection and bring up the the [[Music_library#Context Menu|Context Menu]]. (The selected item can be a music file, a folder containing music files, or a folder containing other folders.) Select the option labelled "Scan Item to Library". XBMC will then scan the selected music source into the library database. Once the scan is complete, you can browse your collection by selecting 'Library Mode'.
+
| class="usercell" | System.UsedspacePercent
 +
| class="usercell" | Total Usedspace Percent on the drive
  
== Sources for Music ==
+
|- class="userrow"
{{main|Media sources}}
+
| class="usercell" | System.FreespacePercent
XBMC gives you the ability to listen to music from a variety of sources, click here for more information and examples of [[Types of Media Sources|Types of Media Sources (link)]].<br />
+
| class="usercell" | Total Freespace Percent on the drive
Some examples of sources that allow you to easily access all your digital music collection:
+
* '''On your computer or a [[NAS (Network Attached Storage)]] device/system, which supports [[SMB]] file sharing'''
+
* '''Stored directly on the hard drive'''
+
* '''On CDs/DVDs'''
+
* '''Streamed from the Internet'''
+
For information on how to configure remote file shares, please click [[Configuring PC Shares|here (link)]]
+
  
== Applications to edit music Tags ==
+
|- class="userrow"
Your audio files '''MUST''' have correct audio tags to use the Music Library mode. Without tags you're limited to the fileview in XBMC. There are several tools out there that will allow you to manipulate music ID tags.
+
| class="usercell" | System.Freespace(DRIVE)
 +
| class="usercell" | Freespace on drive DRIVE. DRIVE can be C, E, F, G, X, Y or Z
  
*[[Supplemental tools/Linux#Music tools]]
+
|- class="userrow"
*[[Supplemental tools/Mac OS X#Music tools]]
+
| class="usercell" | system.usedspace(DRIVE)
*[[Supplemental tools/Windows#Music tools]]
+
| class="usercell" | Usedspace on drive DRIVE. DRIVE can be C, E, F, G, X, Y or Z
  
== Technical Explanation: File tags ==
+
|- class="userrow"
''Skip this section if you're not interested a technical explanation of this subject. You don't need this information to use what is explained in the previous section.''
+
| class="usercell" | system.totalspace(DRIVE)
 +
| class="usercell" | Totalspace on drive DRIVE. DRIVE can be C, E, F, or G
  
 +
|- class="userrow"
 +
| class="usercell" | System.UsedspacePercent(DRIVE)
 +
| class="usercell" | Usedspace Percent on drive DRIVE. DRIVE can be C, E, F, or G
  
For many categories, such as genres and artists, XBMC supports multiple values in the one field. By default it uses the character sequence " / " to divide the entry into multiple values. This divider may be changed via [[advancedsettings.xml]].
+
|- class="userrow"
 
+
| class="usercell" | System.FreespacePercent(DRIVE)
=== Artist Tags - Resolving Compilations and Multiple Artists ===
+
| class="usercell" | Freespace Percent on drive DRIVE. DRIVE can be C, E, F, or G
XBMC reads the ''Album Artist'' tag in ID3, Ogg, APE and MP4 tags and uses it if available to assign an artist to the album (independently of the track's artist information). This is the "Album Artist" tag (in ID3 this is represented by the "TPE2" tag; in vorbiscomment (ogg) files "ALBUMARTIST", "ALBUM ARTIST" and "ENSEMBLE" are all supported).  Multiple artists for either a track or album artist can be specified in "Artist1 / Artist2 / Artist3" format.
+
|- class="userrow"
 
+
| class="usercell" | System.CPUTemperature
If no ''Album Artist'' tag exists, XBMC will use the first (primary) artist from the tracks as the ''Album Artist''. Essentially we do a string comparison of all the track artists, and assign the common artists as the ''Album artist''. This is generally the TPE1 tag in ID3.
+
| class="usercell" | Current CPU temperature
 
+
|- class="userrow"
As many users don't yet use the ''Album Artist'' tag, XBMC has an additional filter system for identifying compilation albums, where each track normally has a different artist. As XBMC scans a folder, it does the following:
+
| class="usercell" | System.GPUTemperature
 
+
| class="usercell" | Current GPU temperature
# Identifies albums based on ''Album'' name alone in the folder and groups the songs that have the same ''Album'' name together as an album.
+
|- class="userrow"
# Runs through each album's assigned songs. If there is 2 or more tracks with the same ''Track'' number, the group of songs must come from 2 or more albums, so the ''Album'' name is ruled out as a possible compilation.
+
| class="usercell" | System.FanSpeed
# If any of the songs assigned to the ''Album'' name have an ''Album Artist'' tag, then XBMC assumes the user knows what they're doing, and this album is also ruled out from being a compilation.
+
| class="usercell" | Current fan speed
# If two or more songs assigned to the ''Album'' name then have different primary artists, then the ''Album'' name is considered to be a group of songs from a compilation, and the ''Various Artists''" tag is assigned as the album artist.
+
|- class="userrow"
# Otherwise, if all the songs have the same primary artist but don't have the same full artist list (eg a song or two has an additional artist) then the album is assigned the primary artist as it's ''Album Artist'', and we assume the additional artists are guest artists.
+
| class="usercell" | System.BuildVersion
 
+
| class="usercell" | Version of build
=== Ratings in ID3 tags ===
+
|- class="userrow"
Ratings in ID3 tags are read via the POPM field, and (if this doesn't exist) in a custom (TXXX) field named "RATING". For the RATING field, we accept 1-5 as valid ratings. For the POPM field things are more complicated, as there is no established standard in place. We currently most closely respect what Mediamonkey does, and also have some support for what Windows Media Player 11 does.  The POPM tag takes a value from 0..255, with 0 meaning no rating, 1 the worst, and 255 the best.  We currently map these as follows:
+
| class="usercell" | System.BuildDate
 
+
| class="usercell" | Date of build
{| class="wikitable"
+
|- class="userrow"
|-  
+
| class="usercell" | System.FPS
|  
+
| class="usercell" | Current rendering speed (frames per second)
'''POPM value'''
+
|- class="userrow"
|  
+
| class="usercell" | System.FreeMemory
'''Star rating'''
+
| class="usercell" | Amount of free memory in Mb
|-  
+
|- class="userrow"
|  
+
| class="usercell" | System.ScreenMode
0
+
| class="usercell" | Screenmode (eg PAL)
|  
+
|- class="userrow"
|-  
+
| class="usercell" | System.ScreenWidth
|  
+
| class="usercell" | Width of screen in pixels
1
+
|- class="userrow"
|  
+
| class="usercell" | System.ScreenHeight
'''*''' This is a special case for Windows Media Player
+
| class="usercell" | Height of screen in pixels
|-  
+
|- class="userrow"
|  
+
| class="usercell" | System.CurrentWindow
2-8
+
| class="usercell" | Current Window we are in
|  
+
|- class="userrow"
|-  
+
| class="usercell" | System.CurrentControl
|  
+
| class="usercell" | Current focused control
9-49
+
|- class="userrow"
|  
+
| class="usercell" | System.XboxNickName
'''*'''
+
| class="usercell" | Nickname of the xbox
|-  
+
|- class="userrow"
|  
+
| class="usercell" | System.DVDLabel
50-113
+
| class="usercell" | Label of the disk in the <span class="nobr">DVD-ROM</span> drive
|  
+
|- class="userrow"
'''**'''
+
| class="usercell" | System.LaunchXBE
|-  
+
| class="usercell" | Label of the currently launched Game or Application
|  
+
|- class="userrow"
114-167
+
| class="usercell" | system.hddtemperature
|  
+
| class="usercell" | hdd temperature
'''***'''
+
|- class="userrow"
|-  
+
| class="usercell" | system.hddinfomodel
|  
+
| class="usercell" | hdd model info
168-218
+
|- class="userrow"
|  
+
| class="usercell" | system.hddinfofirmware
'''****'''
+
| class="usercell" | hdd firmware version
|-  
+
|- class="userrow"
|  
+
| class="usercell" | system.hddinfoserial
219-255
+
| class="usercell" | hdd serial number
|  
+
|- class="userrow"
'''*****'''
+
| class="usercell" | system.hddinfopw
 +
| class="usercell" | hdd password
 +
|- class="userrow"
 +
| class="usercell" | system.hddinfolockstate
 +
| class="usercell" | hdd lockstate info
 +
|- class="userrow"
 +
| class="usercell" | system.hddlockkey
 +
| class="usercell" | hdd lock key
 +
|- class="userrow"
 +
| class="usercell" | system.hddbootdate
 +
| class="usercell" | hdd first boot date
 +
|- class="userrow"
 +
| class="usercell" | system.hddcyclecount
 +
| class="usercell" | hdd switch on counter
 +
|- class="userrow"
 +
| class="usercell" | system.dvdinfomodel
 +
| class="usercell" | dvd model info
 +
|- class="userrow"
 +
| class="usercell" | system.dvdinfofirmware
 +
| class="usercell" | dvd firmware version
 +
|- class="userrow"
 +
| class="usercell" | system.hddcyclecount
 +
| class="usercell" | hdd switch on counter
 +
|- class="userrow"
 +
| class="usercell" | system.mplayerversion
 +
| class="usercell" | mplayer.dll version
 +
|- class="userrow"
 +
| class="usercell" | system.kernelversion
 +
| class="usercell" | xbox kernel version
 +
|- class="userrow"
 +
| class="usercell" | system.uptime
 +
| class="usercell" | system current uptime
 +
|- class="userrow"
 +
| class="usercell" | system.totaluptime
 +
| class="usercell" | system total uptime
 +
|- class="userrow"
 +
| class="usercell" | system.cpufrequency
 +
| class="usercell" | xbox cpu frequency
 +
|- class="userrow"
 +
| class="usercell" | system.xboxversion
 +
| class="usercell" | detected xbox version
 +
|- class="userrow"
 +
| class="usercell" | system.avcablepackinfo
 +
| class="usercell" | av cablepack info
 +
|- class="userrow"
 +
| class="usercell" | system.screenresolution
 +
| class="usercell" | screen resolution
 +
|- class="userrow"
 +
| class="usercell" | system.videoencoderinfo
 +
| class="usercell" | video encoder info
 +
|- class="userrow"
 +
| class="usercell" | system.xboxserial
 +
| class="usercell" | xbox serial number
 +
|- class="userrow"
 +
| class="usercell" | system.videoxberegion
 +
| class="usercell" | xbox video xbe region
 +
|- class="userrow"
 +
| class="usercell" | system.bios
 +
| class="usercell" | xbox detected bios, id's -> \system\systeminfo\biosIds.ini
 +
|- class="userrow"
 +
| class="usercell" | system.modchip
 +
| class="usercell" | detected modchip
 +
|- class="userrow"
 +
| class="usercell" | system.internetstate
 +
| class="usercell" | will return the internet state, connected or not connected
 +
and for Conditional use: Connected->TRUE, not Connected->FALSE, do not use to check status in a pythonscript since it is threaded.
 +
|- class="userrow"
 +
| class="usercell" | system.controllerport(x)
 +
| class="usercell" | for x=1,2,3,4 will in time return connected devices on the controller port e.g. system.controllerport(1)
 +
|- class="userrow"
 +
| class="usercell" | System.Language
 +
| class="usercell" | Shows the current language
 +
|- class="userrow"
 +
| class="usercell" | Visualisation.Preset
 +
| class="usercell" | Shows the current preset of the visualisation
 +
|- class="userrow"
 +
| class="usercell" | Visualisation.Name
 +
| class="usercell" | Shows the name of the visualisation
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Time
 +
| class="usercell" | Current time in movie
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.TimeRemaining
 +
| class="usercell" | Current remaining time in movie
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.TimeSpeed
 +
| class="usercell" | Current time + playspeed. eg 1:23:14 (-4x)
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Duration
 +
| class="usercell" | Length of current movie
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Title
 +
| class="usercell" | Title of current movie. If it's in the database it will return the database title, else the filename
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Genre
 +
| class="usercell" | Genre(s) of current movie, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Director
 +
| class="usercell" | Director of current movie, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Year
 +
| class="usercell" | Year of release of current movie, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Rating
 +
| class="usercell" | IMDB user rating of current movie, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.mpaa
 +
| class="usercell" | MPAA rating of current movie, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.PlaylistPosition
 +
| class="usercell" | Position of the current song in the current video playlist
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.PlaylistLength
 +
| class="usercell" | Total size of the current video playlist
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Cast
 +
| class="usercell" | A concatenated string of cast members of the current movie, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.CastAndRole
 +
| class="usercell" | A concatenated string of cast members and roles of the current movie, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Album
 +
| class="usercell" | Album from which the current Music Video is from, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Artist
 +
| class="usercell" | Artist(s) of current Music Video, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Studio
 +
| class="usercell" | Studio of current Music Video, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Writer
 +
| class="usercell" | Name of Writer of current playing Video, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Tagline
 +
| class="usercell" | Small Summary of current playing Video, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.PlotOutline
 +
| class="usercell" | Small Summary of current playing Video, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | VideoPlayer.Plot
 +
| class="usercell" | Complete Text Summary of current playing Video, if it's in the database
 +
|- class="userrow"
 +
| class="usercell" | Weather.Conditions
 +
| class="usercell" | Current weather conditions – this is looked up in a background process.
 +
|- class="userrow"
 +
| class="usercell" | Weather.Temperature
 +
| class="usercell" | Current weather temperature
 +
|- class="userrow"
 +
| class="usercell" | Weather.Location
 +
| class="usercell" | City/town which the above two items are for
 +
|- class="userrow"
 +
| class="usercell" | XLinkKai.UserName
 +
| class="usercell" | Shows the XLink Kai username
 
|}
 
|}
  
== Embedded Album Art ==
+
===Images Available in XBMC===
XBMC supports embedded album art in files with ID3 tags, WMA tags and MP4 tags only. It does not support embedded album art in APE, Ogg or FLAC tags currently. To have album art for these formats, see the [[Thumbnails]] portion of the manual.
+
{| class="usertable" border="1"
 
+
|- class="userrow"
== Album art and thumbnails ==
+
| class="usercell" | container.folderthumb
{{See also|Thumbnails}}
+
| class="usercell" | Thumbnail Image of the current displayed folder of list and thumb panels
{|
+
|- class="userrow"
| valign="top" |
+
| class="usercell" | Weather.Conditions
There are a number of ways to get thumbnails to display in Music.<br />
+
| class="usercell" | Image of current weather conditions
Album art can by obtained via [http://www.allmusic.com Allmusic.com] and described in the [[My Music Navigation and Control#The Context Menu|The Context Menu]] section. Music tags can also contain art for that specific song, as can be seen in [[Preparing your Music]].<br />
+
|- class="userrow"
If you want a custom thumb, you can add a .jpg file to your music directory. The .tbn file can be either a .JPG or a .PNG file (with transparency) that you simply rename the extension from .jpg/.png to .tbn.<br />
+
| class="usercell" | MusicPlayer.Cover
The size of the picture can be anything from 64x64 to 256x256 in pixel-size (you may want to use a larger pixel-size if you use XBMC in 720p/1080i HDTV resolution to get a sharper image).<br />
+
| class="usercell" | Cover of currently playing album
 
+
|- class="userrow"
'''Examples:'''<br />
+
| class="usercell" | VideoPlayer.Cover
In this example audiofilename.mp3 will use audiofilename.tbn as thumbnail:
+
| class="usercell" | Cover of currently playing movie
Music\path\'''audiofilename.mp3'''
+
|- class="userrow"
Music\path\'''audiofilename.tbn'''
+
| class="usercell" | ListItem.Thumb
|
+
| class="usercell" | Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control
[[File:mymusic.jpg|right|500px]]
+
|- class="userrow"
 +
| class="usercell" | ListItem.Icon
 +
| class="usercell" | Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the “Big” version of the icon.
 +
|- class="userrow"
 +
| class="usercell" | ListItem.ActualIcon
 +
| class="usercell" | Shows the icon of the currently selected item in a list or thumb control.
 +
|- class="userrow"
 +
| class="usercell" | ListItem.Overlay
 +
| class="usercell" | Shows the Overlay Icon status (compressed file, Trainer, watched, unwatched, locked) of the currently selected item in a list or thumb control.
 +
|- class="userrow"
 +
| class="usercell" | Skin.String(name)
 +
| class="usercell" |
 +
Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) [http://manual.xboxmediacenter.de/wakka.php?wakka=BuiltInFunctions&v=1dty built in function]. Allows skinners to have <span class="nobr">user-customisable</span> images and multiimages.
 
|}
 
|}
The same goes for playlists, [[Cue sheets]], SHOUTcast, and [[HOW-TO: Play Internet Streams|internet-stream files]], eg:
 
Music\path\'''audioplaylistname.m3u'''
 
Music\path\'''audioplaylistname.tbn'''
 
Music\path\'''cuelistname.cue'''
 
Music\path\'''cuelistname.tbn'''
 
Music\path\'''shoutcastlinkname.pls'''
 
Music\path\'''shoutcastlinkname.tbn'''
 
Music\path\'''audiostreamname.strm'''
 
Music\path\'''audiostreamname.tbn'''
 
 
If you store each of your music-albums or artists in a separate subfolder to keep things organized, you can also make the folder have a custom thumbnail image. To do this you need to rename your .jpg thumbnail as folder.jpg and place it in the folder (the size of the picture can be anything from 64x64 to 256x256 in pixel size).<br />
 
 
'''Example:'''<br />
 
Music\path\album\'''folder.jpg'''
 
 
Now your album/artist folder will have a lovely custom thumbnail-image.
 
 
You can via [[advancedsettings.xml]] change the default filename of the image that XBMC uses for music folders. See the [[advancedsettings.xml#<musicthumbs>|<musicthumbs>]] tag. for more information.
 
  
[[Category:Music Library]]
+
[[category:Skin Development]]
[[Category:How-to]]
+

Revision as of 09:29, 15 October 2007

1 Labels Available In XBMC

AudioScrobbler.ConnectState Connected to the audioscrobbler
AudioScrobbler.SubmitInterval Shows next reconnect when submission failed
AudioScrobbler.FilesCached Number of cached songs
AudioScrobbler.SubmitState Shows time left until the current song is submitted
container.folderpath Shows path of currently displayed folder
Container(id).ListItem(offset).Label Shows ListItem.Label for a specific List or Panel Container with a offset ( eg: Container(50).Listitem(2).Label )
Container(id).ListItem(offset).Label2 Shows ListItem.Label2 for a specific List or Panel Container with a offset ( eg: Container(50).Listitem(-2).Label2 )
Container(id).ListItem(offset).Icon Shows ListItem.Icon for a specific List or Panel Container with a offset ( eg: Container(52).Listitem(1).Icon)
Container(id).ListItem(offset).ActualIcon Shows ListItem.ActualIcon for a specific List or Panel Container with a offset ( eg: Container(50).Listitem(0).ActualIcon )
Container(id).ListItem(offset).Thumb Shows ListItem.Thumb for a specific List or Panel Container with a offset ( eg: Container(50).Listitem(0).Thumb )
listitem.label Shows the left label of the currently selected item in a list or thumb control
listitem.label2 Shows the right label of the currently selected item in a list or thumb control
listitem.title Shows the title of the currently selected song or movie in a list or thumb control
listitem.tracknumber Shows the track number of the currently selected song in a list or thumb control
listitem.artist Shows the artist of the currently selected song in a list or thumb control
listitem.album Shows the album of the currently selected song in a list or thumb control
listitem.year Shows the year of the currently selected song, album or movie in a list or thumb control
listitem.genre Shows the genre of the currently selected song, album or movie in a list or thumb control
listitem.director Shows the director of the currently selected movie in a list or thumb control
listitem.filename Shows the filename of the currently selected song or movie in a list or thumb control
listitem.date Shows the file date of the currently selected song or movie in a list or thumb control
listitem.size Shows the file size of the currently selected song or movie in a list or thumb control
listitem.rating Shows the IMDB rating of the currently selected movie in a list or thumb control
listitem.mpaa Show the MPAA rating of the currently selected movie in a list or thumb control
listitem.programcount Shows the number of times an xbe has been run from "my programs"
listitem.duration Shows the song or movie duration of the currently selecter movie in a list or thumb control
listitem.cast Shows a concatenated string of cast members of the currently selected movie in a list or thumb control
listitem.castandrole Shows a concatenated string of cast members and roles of the currently selected movie in a list or controlpanel
listitem.Studio Studio of current selected Music Video in a list or thumb control
listitem.Writer Name of Writer of current Video in a list or thumb control
listitem.Tagline Small Summary of current Video in a list or thumb control
listitem.PlotOutline Small Summary of current Video in a list or thumb control
listitem.Plot Complete Text Summary of Video in a list or thumb control
MusicPlayer.Title Title of the currently playing song
MusicPlayer.Album Album from which the current song is from
MusicPlayer.Artist Artist(s) of current song
MusicPlayer.Genre Genre(s) of current song
MusicPlayer.Year Year of release of current song
MusicPlayer.Time Current time in song
MusicPlayer.TimeRemaining Current remaining time in song
MusicPlayer.TimeSpeed Both the time and the playspeed formatted up. eg 1:23 (2x)
MusicPlayer.TrackNumber Track number of current song
MusicPlayer.Duration Duration of current song
MusicPlayer.BitRate Bitrate of current song
MusicPlayer.Channels Number of channels of current song
MusicPlayer.BitsPerSample Number of bits per sample of current song
MusicPlayer.SampleRate Samplerate of current song
MusicPlayer.Codec Codec of current song
MusicPlayer.PlaylistPosition Position of the current song in the current music playlist
MusicPlayer.PlaylistLength Total size of the current music playlist
MusicPartyMode.SongsPlayed Number of songs played during Party Mode
MusicPartyMode.MatchingSongs Number of songs available to Party Mode
MusicPartyMode.MatchingSongsPicked Number of songs picked already for Party Mode
MusicPartyMode.MatchingSongsLeft Number of songs left to be picked from for Party Mode
MusicPartyMode.RelaxedSongsPicked Not currently used
MusicPartyMode.RandomSongsPicked Number of unique random songs picked during Party Mode
Network.IPAddress The Xbox's IP Address (formatted as IP: <ipaddress>)
Network.MacAddress xbox mac address
Network.IsDHCP network type is DHCP or FIXED
Network.LinkState network linkstate e.g. 10mbit/100mbit etc.
Network.SubnetAddress network subnet address
Network.GatewayAddress network gateway address
Network.DHCPAddress DHCP ip address
Network.DNS1Address network dns 1 address
Network.DNS2Address network dns 2 address
Player.FinishTime Time playing media will end
Player.Time Elapsed time of current playing media
Player.TimeRemaining Remaining time of current playing media
Player.Duration Total duration of the current playing media
Player.SeekTime Time to which the user is seeking
Player.Volume Current volume (between -60 and 0dB)
Playlist.Position Position of the current item in the current playlist (video or music)
Playlist.Length Total size of the current playlist (video or music)
Playlist.Random Returns string ID's 590 (Randomize Play Enabled) or 591 (Disabled)
Playlist.Repeat Returns string ID's 592 (Repeat One), 593 (Repeat All), or 594 (Repeat Off)
Skin.CurrentTheme Returns the current selected skin theme.
Skin.String(name)

Returns the user-set skin string, set via the Skin.SetString(name) built in function. Allows skinners to have user-customisable labels.

System.Time Current time
System.Date Current date
System.Alarmpos Shutdown Timer position
System.Freespace Total Freespace on the drive
System.Usedspace Total Usedspace on the drive
System.Totalspace Totalspace on the drive
System.UsedspacePercent Total Usedspace Percent on the drive
System.FreespacePercent Total Freespace Percent on the drive
System.Freespace(DRIVE) Freespace on drive DRIVE. DRIVE can be C, E, F, G, X, Y or Z
system.usedspace(DRIVE) Usedspace on drive DRIVE. DRIVE can be C, E, F, G, X, Y or Z
system.totalspace(DRIVE) Totalspace on drive DRIVE. DRIVE can be C, E, F, or G
System.UsedspacePercent(DRIVE) Usedspace Percent on drive DRIVE. DRIVE can be C, E, F, or G
System.FreespacePercent(DRIVE) Freespace Percent on drive DRIVE. DRIVE can be C, E, F, or G
System.CPUTemperature Current CPU temperature
System.GPUTemperature Current GPU temperature
System.FanSpeed Current fan speed
System.BuildVersion Version of build
System.BuildDate Date of build
System.FPS Current rendering speed (frames per second)
System.FreeMemory Amount of free memory in Mb
System.ScreenMode Screenmode (eg PAL)
System.ScreenWidth Width of screen in pixels
System.ScreenHeight Height of screen in pixels
System.CurrentWindow Current Window we are in
System.CurrentControl Current focused control
System.XboxNickName Nickname of the xbox
System.DVDLabel Label of the disk in the DVD-ROM drive
System.LaunchXBE Label of the currently launched Game or Application
system.hddtemperature hdd temperature
system.hddinfomodel hdd model info
system.hddinfofirmware hdd firmware version
system.hddinfoserial hdd serial number
system.hddinfopw hdd password
system.hddinfolockstate hdd lockstate info
system.hddlockkey hdd lock key
system.hddbootdate hdd first boot date
system.hddcyclecount hdd switch on counter
system.dvdinfomodel dvd model info
system.dvdinfofirmware dvd firmware version
system.hddcyclecount hdd switch on counter
system.mplayerversion mplayer.dll version
system.kernelversion xbox kernel version
system.uptime system current uptime
system.totaluptime system total uptime
system.cpufrequency xbox cpu frequency
system.xboxversion detected xbox version
system.avcablepackinfo av cablepack info
system.screenresolution screen resolution
system.videoencoderinfo video encoder info
system.xboxserial xbox serial number
system.videoxberegion xbox video xbe region
system.bios xbox detected bios, id's -> \system\systeminfo\biosIds.ini
system.modchip detected modchip
system.internetstate will return the internet state, connected or not connected

and for Conditional use: Connected->TRUE, not Connected->FALSE, do not use to check status in a pythonscript since it is threaded.

system.controllerport(x) for x=1,2,3,4 will in time return connected devices on the controller port e.g. system.controllerport(1)
System.Language Shows the current language
Visualisation.Preset Shows the current preset of the visualisation
Visualisation.Name Shows the name of the visualisation
VideoPlayer.Time Current time in movie
VideoPlayer.TimeRemaining Current remaining time in movie
VideoPlayer.TimeSpeed Current time + playspeed. eg 1:23:14 (-4x)
VideoPlayer.Duration Length of current movie
VideoPlayer.Title Title of current movie. If it's in the database it will return the database title, else the filename
VideoPlayer.Genre Genre(s) of current movie, if it's in the database
VideoPlayer.Director Director of current movie, if it's in the database
VideoPlayer.Year Year of release of current movie, if it's in the database
VideoPlayer.Rating IMDB user rating of current movie, if it's in the database
VideoPlayer.mpaa MPAA rating of current movie, if it's in the database
VideoPlayer.PlaylistPosition Position of the current song in the current video playlist
VideoPlayer.PlaylistLength Total size of the current video playlist
VideoPlayer.Cast A concatenated string of cast members of the current movie, if it's in the database
VideoPlayer.CastAndRole A concatenated string of cast members and roles of the current movie, if it's in the database
VideoPlayer.Album Album from which the current Music Video is from, if it's in the database
VideoPlayer.Artist Artist(s) of current Music Video, if it's in the database
VideoPlayer.Studio Studio of current Music Video, if it's in the database
VideoPlayer.Writer Name of Writer of current playing Video, if it's in the database
VideoPlayer.Tagline Small Summary of current playing Video, if it's in the database
VideoPlayer.PlotOutline Small Summary of current playing Video, if it's in the database
VideoPlayer.Plot Complete Text Summary of current playing Video, if it's in the database
Weather.Conditions Current weather conditions – this is looked up in a background process.
Weather.Temperature Current weather temperature
Weather.Location City/town which the above two items are for
XLinkKai.UserName Shows the XLink Kai username

2 Images Available in XBMC

container.folderthumb Thumbnail Image of the current displayed folder of list and thumb panels
Weather.Conditions Image of current weather conditions
MusicPlayer.Cover Cover of currently playing album
VideoPlayer.Cover Cover of currently playing movie
ListItem.Thumb Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control
ListItem.Icon Shows the thumbnail (if it exists) of the currently selected item in a list or thumb control. If no thumbnail image exists, it will show the “Big” version of the icon.
ListItem.ActualIcon Shows the icon of the currently selected item in a list or thumb control.
ListItem.Overlay Shows the Overlay Icon status (compressed file, Trainer, watched, unwatched, locked) of the currently selected item in a list or thumb control.
Skin.String(name)

Returns the image or image folder set by the user via a Skin.SetPath(name) or Skin.SetImage(name) built in function. Allows skinners to have user-customisable images and multiimages.

Personal tools
Namespaces

Variants
Actions
Google Search
Navigation
Wiki help
Toolbox