xbmc (version 1.3, 15 November 2005)
index
(built-in)

 
Classes
       
__builtin__.object
InfoTagMusic
InfoTagVideo
Keyboard
PlayList
PlayListItem
Player

 
class InfoTagMusic(__builtin__.object)
    InfoTagMusic class.
 
  Methods defined here:
getAlbum(...)
getAlbum() -- returns a string.
getArtist(...)
getArtist() -- returns a string.
getDuration(...)
getDuration() -- returns an integer.
getGenre(...)
getAlbum() -- returns a string.
getReleaseDate(...)
getReleaseDate() -- returns a string.
getTitle(...)
getTitle() -- returns a string.
getTrack(...)
getTrack() -- returns an integer.
getURL(...)
getURL() -- returns a string.

 
class InfoTagVideo(__builtin__.object)
    InfoTagVideo class.
 
  Methods defined here:
getCast(...)
getCast() -- returns a string.
getDVDLabel(...)
getDVDLabel() -- returns a string.
getDirector(...)
getDirector() -- returns a string.
getFile(...)
getFile() -- returns a string.
getGenre(...)
getGenre() -- returns a string.
getIMDBNumber(...)
getIMDBNumber() -- returns a string.
getPictureURL(...)
getPictureURL() -- returns a string.
getPlot(...)
getPlot() -- returns a string.
getPlotOutline(...)
getPlotOutline() -- returns a string.
getRating(...)
getRating() -- returns a float.
getTagLine(...)
getTagLine() -- returns a string.
getTitle(...)
getTitle() -- returns a string.
getVotes(...)
getVotes() -- returns a string.
getWritingCredits(...)
getWritingCredits() -- returns a string.
getYear(...)
getYear() -- returns a integer.

 
class Keyboard(__builtin__.object)
    Keyboard class.
 
Keyboard([string default, string heading]) -- Creates a new Keyboard object with default text
                              and heading if supplied.
 
  Methods defined here:
doModal(...)
doModal() -- Show keyboard and wait for user action.
getText(...)
getText() -- Returns the user input.
 
This will only succeed if the user entered some text or if there is a default
text set for this Keyboard.
isConfirmed(...)
isConfirmed() -- Returns False if the user cancelled the input.
setDefault(...)
setDefault(string default) -- Set new text that is displayed as default.
setHeading(...)
setHeading(string heading) -- Set new text that is displayed as heading.

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object at 0x00D65D00>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
class PlayList(__builtin__.object)
    PlayList class.
 
PlayList(int playlist) -- retrieve a reference from a valid xbmc playlist
 
int playlist can be one of the next values:
 
  0 : xbmc.PLAYLIST_MUSIC
  1 : xbmc.PLAYLIST_MUSIC_TEMP
  2 : xbmc.PLAYLIST_VIDEO
  3 : xbmc.PLAYLIST_VIDEO_TEMP
 
Use PlayList[int position] or __getitem__(int position) to get a PlayListItem.
 
  Methods defined here:
__getitem__(...)
x.__getitem__(y) <==> x[y]
__len__(...)
x.__len__() <==> len(x)
add(...)
add(filename[, description, duration]) -- Add's a new file to the playlist.
clear(...)
clear() -- clear all items in the playlist.
getposition(...)
getposition() -- returns the position of the current song in this playlist.
load(...)
load(filename) -- Load a playlist.
 
clear current playlist and copy items from the file to this Playlist
filename can be like .pls or .m3u ...
returns False if unable to load playlist
remove(...)
remove(filename) -- remove an item with this filename from the playlist.
shuffle(...)
shuffle() -- shuffle the playlist.
size(...)
size() -- returns the total number of PlayListItems in this playlist.

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object at 0x00D67410>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
class PlayListItem(__builtin__.object)
    PlayListItem class.
 
PlayListItem() -- Creates a new PlaylistItem which can be added to a PlayList.
 
  Methods defined here:
getdescription(...)
getdescription() -- Returns the description of this PlayListItem.
getduration(...)
getduration() -- Returns the duration of this PlayListItem.
getfilename(...)
getfilename() -- Returns the filename of this PlayListItem.

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object at 0x00D67340>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
class Player(__builtin__.object)
    Player class.
 
Player([core]) -- Creates a new Player with as default the xbmc music playlist.
 
core     : (optional) Use a specified playcore instead of letting xbmc decide the playercore to use.
         : - xbmc.PLAYER_CORE_AUTO
         : - xbmc.PLAYER_CORE_DVDPLAYER
         : - xbmc.PLAYER_CORE_MPLAYER
         : - xbmc.PLAYER_CORE_PAPLAYER
         : - xbmc.PLAYER_CORE_MODPLAYER
 
  Methods defined here:
getMusicInfoTag(...)
getMusicInfoTag() -- returns the MusicInfoTag of the current playing 'Song'.
 
Throws: Exception, if player is not playing a file or current file is not a music file.
getPlayingFile(...)
getPlayingFile() -- returns the current playing file as a string.
 
Throws: Exception, if player is not playing a file.
getTime(...)
getTime() -- Returns the current time of the current playing media as fractional seconds.
 
Throws: Exception, if player is not playing a file.
getTotalTime(...)
getTotalTime() -- Returns the total time of the current playing media in
                  seconds.  This is only accurate to the full second.
 
Throws: Exception, if player is not playing a file.
getVideoInfoTag(...)
getVideoInfoTag() -- returns the VideoInfoTag of the current playing Movie.
 
Throws: Exception, if player is not playing a file or current file is not a movie file.
 
Note, this doesn't work yet, it's not tested
isPlaying(...)
isPlayingAudio() -- returns True is xbmc is playing a file.
isPlayingAudio(...)
isPlayingAudio() -- returns True is xbmc is playing an audio file.
isPlayingVideo(...)
isPlayingVideo() -- returns True if xbmc is playing a video.
onPlayBackEnded(...)
onPlayBackEnded() -- onPlayBackEnded method.
 
Will be called when xbmc stops playing a file
onPlayBackStarted(...)
onPlayBackStarted() -- onPlayBackStarted method.
 
Will be called when xbmc starts playing a file
onPlayBackStopped(...)
onPlayBackStopped() -- onPlayBackStopped method.
 
Will be called when user stops xbmc playing a file
pause(...)
pause() -- Pause playing.
play(...)
play([item]) -- Play this item.
 
item can be a filename or a PlayList.
If item is not given then the Player will try to play the current item
in the current playlist.
playnext(...)
playnext() -- Play next item in playlist.
playprevious(...)
playprevious() -- Play previous item in playlist.
playselected(...)
playselected() -- Play a certain item from the current playlist.
seekTime(...)
seekTime() -- Seeks the specified amount of time as fractional seconds.
              The time specified is relative to the beginning of the
              currently playing media file.
 
Throws: Exception, if player is not playing a file.
stop(...)
stop() -- Stop playing.

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object at 0x00D66968>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
Functions
       
dashboard(...)
dashboard() -- Boot to dashboard.
executebuiltin(...)
executebuiltin(string) -- Execute a built in XBMC function.
 
example:
  - executebuiltin('XBMC.RunXBE(C:valaunch.xbe)')
executehttpapi(...)
executehttpapi(string) -- Execute an HTTP API.
 
example:
  - executehttpapi('SetPlaySpeed(2)')
executescript(...)
executescript(string) -- Execute a python script.
 
example:
  - executescript('q:\scripts\update.py')
getCpuTemp(...)
getCpuTemp() -- Returns the current cpu tempature.
getDVDState(...)
getDVDState() -- Returns the dvd state.
 
return values are:
 
  16 : xbmc.TRAY_OPEN
  1  : xbmc.DRIVE_NOT_READY
  64 : xbmc.TRAY_CLOSED_NO_MEDIA
  96 : xbmc.TRAY_CLOSED_MEDIA_PRESENT
getFreeMem(...)
getFreeMem() -- Returns free memory as a string.
getIPAddress(...)
getIPAddress() -- Returns the current ip adres as string.
getLanguage(...)
getLanguage() -- Returns the active language as string.
getLocalizedString(...)
getLocalizedString(int id) -- Returns a Localized 'unicode string'.
 
See the xml language files in /language/ which id you need for a string
getSkinDir(...)
getSkinDir() -- Returns the active skin directory.
 
Note, this is not the full path like 'q:\skins\MediaCenter', 
but only 'MediaCenter'
log(...)
log(string) -- Write a string to xbmc's log file with log level 6.
output(...)
output(string) -- Write a string to xbmc's log file and the debug window.
 
Strings are written to the log with log level 1 (NOTICE)
restart(...)
restart() -- Restart Xbox.
shutdown(...)
shutdown() -- Shutdown the xbox.
sleep(...)
sleep(int time) -- Sleeps for 'time' msec.
 
Throws: PyExc_TypeError, if time is not a  integer
This is usefull you have for example a Player class that is waiting for onPlayBackEnded()
calls

 
Data
        DRIVE_NOT_READY = 1
PLAYER_CORE_AUTO = 0
PLAYER_CORE_DVDPLAYER = 1
PLAYER_CORE_MODPLAYE = 4
PLAYER_CORE_MPLAYER = 2
PLAYER_CORE_PAPLAYER = 3
PLAYLIST_MUSIC = 0
PLAYLIST_MUSIC_TEMP = 1
PLAYLIST_VIDEO = 2
PLAYLIST_VIDEO_TEMP = 3
TRAY_CLOSED_MEDIA_PRESENT = 96
TRAY_CLOSED_NO_MEDIA = 64
TRAY_OPEN = 16
__author__ = 'J. Mulder <darkie@xboxmediacenter.com>'
__credits__ = 'XBMC TEAM.'
__date__ = '15 November 2005'
__platform__ = 'XBOX'
__version__ = '1.3'

 
Author
        J. Mulder <darkie@xboxmediacenter.com>

 
Credits
        XBMC TEAM.