xbmcplugin (version 1.0, 20 August 2007)
index
(built-in)

 
Functions
       
addDirectoryItem(...)
addDirectoryItem(handle, url, listitem [,isFolder, totalItems]) -- Callback function to pass directory contents back to XBMC.
 - Returns a bool for successful completion.
 
handle      : Integer - handle the plugin was started with.
url         : string - url of the entry. would be plugin:// for another virtual directory
listitem    : ListItem - item to add.
isFolder    : [opt] bool - True=folder / False=not a folder(default).
totalItems  : [opt] Integer - Total number of items that will be passed.(used for progressbar)
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
       Once you use a keyword, all following arguments require the keyword.
 
example:
  - if not xbmcplugin.addDirectoryItem(int(sys.argv[1]), 'F:\\Trailers\\300.mov', listitem, totalItems=50): break
addSortMethod(...)
addSortMethod(handle, sortMethod) -- Adds a sorting method for the media list.
 
handle      : Integer - handle the plugin was started with.
sortMethod  : Integer - Number for sortmethod see FileItem.h.
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
       Once you use a keyword, all following arguments require the keyword.
 
example:
  - xbmcplugin.addSortMethod(int(sys.argv[1]), xbmcplugin.SORT_METHOD_TITLE)
endOfDirectory(...)
endOfDirectory(handle[, succeeded, updateListing]) -- Callback function to tell XBMC that the end of the directory listing in a virtualPythonFolder module is reached.
 
handle           : Integer - handle the plugin was started with.
succeeded        : [opt] bool - True=script completed successfully(Default)/False=Script did not.
updateListing    : [opt] bool - True=this folder should update the current listing/False=Folder is a subfolder(Default).
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
       Once you use a keyword, all following arguments require the keyword.
 
example:
  - xbmcplugin.endOfDirectory(int(sys.argv[1]))
getSetting(...)
getSetting(id) -- Returns the value of a setting as a string.
 
id        : string - id of the setting that the module needs to access.
 
*Note, You can use the above as a keyword.
 
example:
  - apikey = xbmcplugin.getSetting('apikey')
setContent(...)
setContent(handle, content) -- Sets the plugins content.
 
handle      : Integer - handle the plugin was started with.
content     : string - content type (eg. movies)
 
*Note, You can use the above as keywords for arguments.
       content: files, songs, artists, albums, movies, tvshows, episodes, musicvideos
 
example:
  - xbmcplugin.setContent(int(sys.argv[1]), 'movies')

 
Data
        SORT_METHOD_ALBUM = 13
SORT_METHOD_ALBUM_IGNORE_THE = 14
SORT_METHOD_ARTIST = 11
SORT_METHOD_ARTIST_IGNORE_THE = 12
SORT_METHOD_DATE = 3
SORT_METHOD_DRIVE_TYPE = 6
SORT_METHOD_DURATION = 8
SORT_METHOD_EPISODE = 20
SORT_METHOD_FILE = 5
SORT_METHOD_GENRE = 15
SORT_METHOD_LABEL = 1
SORT_METHOD_LABEL_IGNORE_THE = 2
SORT_METHOD_MPAA_RATING = 24
SORT_METHOD_NONE = 0
SORT_METHOD_PLAYLIST_ORDER = 19
SORT_METHOD_PRODUCTIONCODE = 22
SORT_METHOD_PROGRAM_COUNT = 18
SORT_METHOD_SIZE = 4
SORT_METHOD_SONG_RATING = 23
SORT_METHOD_STUDIO = 26
SORT_METHOD_STUDIO_IGNORE_THE = 27
SORT_METHOD_TITLE = 9
SORT_METHOD_TITLE_IGNORE_THE = 10
SORT_METHOD_TRACKNUM = 7
SORT_METHOD_UNSORTED = 28
SORT_METHOD_VIDEO_RATING = 17
SORT_METHOD_VIDEO_RUNTIME = 25
SORT_METHOD_VIDEO_TITLE = 21
SORT_METHOD_VIDEO_YEAR = 16
__author__ = 'J. Mulder <darkie@xboxmediacenter.com>'
__credits__ = 'XBMC TEAM.'
__date__ = '20 August 2007'
__platform__ = 'XBOX'
__version__ = '1.0'

 
Author
        J. Mulder <darkie@xboxmediacenter.com>

 
Credits
        XBMC TEAM.