- __builtin__.object
- InfoTagMusic
- InfoTagVideo
- Keyboard
- Monitor
- PlayList
- Player
- RenderCapture
class InfoTagMusic(__builtin__.object) | InfoTagMusic class.
| Methods defined here:
- getAlbum(...)
- getAlbum() --returns a string.
- getAlbumArtist(...)
- getAlbumArtist() --returns a string.
- getArtist(...)
- getArtist() --returns a string.
- getComment(...)
- getComment() --returns a string.
- getDisc(...)
- getDisc() --returns an integer.
- getDuration(...)
- getDuration() --returns an integer.
- getGenre(...)
- getGenre() --returns a string.
- getLastPlayed(...)
- getLastPlayed() --returns a string.
- getListeners(...)
- getListeners() --returns an integer.
- getLyrics(...)
- getLyrics() --returns a string.
- getPlayCount(...)
- getPlayCount() --returns an integer.
- getReleaseDate(...)
- getReleaseDate() --returns a string.
- getTitle(...)
- getTitle() --returns a string.
- getTrack(...)
- getTrack() --returns an integer.
- getURL(...)
- getURL() --returns a string.
Data and other attributes defined here:
- __new__ = <built-in method __new__ of type object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class InfoTagVideo(__builtin__.object) | Methods defined here:
- getCast(...)
- getCast() - returns a string.
- getDirector(...)
- getDirector() - returns a string.
- getFile(...)
- getFile() - returns a string.
- getFirstAired(...)
- getFirstAired() - returns a string.
- getGenre(...)
- getGenre() - returns a string.
- getIMDBNumber(...)
- getIMDBNumber() - returns a string.
- getLastPlayed(...)
- getLastPlayed() --returns a string.
- getOriginalTitle(...)
- getOriginalTitle() - returns a string.
- getPath(...)
- getPath() - returns a string.
- getPictureURL(...)
- getPictureURL() - returns a string.
- getPlayCount(...)
- getPlayCount() --returns a integer.
- getPlot(...)
- getPlot() - returns a string.
- getPlotOutline(...)
- getPlotOutline() - returns a string.
- getPremiered(...)
- getPremiered() - returns a string.
- getRating(...)
- getRating() - returns a float (double where supported)
- getTagLine(...)
- getTagLine() - returns a string.
- getTitle(...)
- getTitle() - returns a string.
- getVotes(...)
- getVotes() - returns a string.
- getWritingCredits(...)
- getWritingCredits() - returns a string.
- getYear(...)
- getYear() - returns an integer.
Data and other attributes defined here:
- __new__ = <built-in method __new__ of type object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class Keyboard(__builtin__.object) | Keyboard class.
Keyboard([default, heading, hidden])--Creates a newKeyboard object with default text
heading and hidden input flag if supplied.
default : [opt] string - default text entry.
heading : [opt] string - keyboard heading.
hidden : [opt] boolean - True for hidden text entry.
example:
- kb =xbmc.Keyboard ('default', 'heading', True)
- kb.setDefault('password') # optional
- kb.setHeading('Enter password') # optional
- kb.setHiddenInput(True) # optional
- kb.doModal()
- if (kb.isConfirmed()):
- text = kb.getText()
| Methods defined here:
- doModal(...)
- doModal([autoclose])--Show keyboard and wait for user action.
autoclose : [opt] integer - milliseconds to autoclose dialog. (default=do not autoclose)
example:
- kb.doModal(30000)
- getText(...)
- getText() --Returns the user input as a string.
*Note, This will always return the text entry even if you cancel the keyboard.
Use theisConfirmed() method to check if user cancelled the keyboard.
example:
- text = kb.getText()
- isConfirmed(...)
- isConfirmed() --Returns False if the user cancelled the input.
example:
- if (kb.isConfirmed()):
- setDefault(...)
- setDefault(default)--Set the default text entry.
default : string - default text entry.
example:
- kb.setDefault('password')
- setHeading(...)
- setHeading(heading)--Set the keyboard heading.
heading : string - keyboard heading.
example:
- kb.setHeading('Enter password')
- setHiddenInput(...)
- setHiddenInput(hidden)--Allows hidden text entry.
hidden : boolean - True for hidden text entry.
example:
- kb.setHiddenInput(True)
Data and other attributes defined here:
- __new__ = <built-in method __new__ of type object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class Monitor(__builtin__.object) | Monitor class.
Monitor()--Creates a newMonitor to notify addon about changes.
| Methods defined here:
- abortRequested(...)
- abortRequested() --Returns True if abort has been requested.
- onAbortRequested(...)
- onAbortRequested() --Deprecated, usewaitForAbort() to be notified about this event.
- onCleanFinished(...)
- onCleanFinished(library)--onCleanFinished method.
library : video/music as string
Will be called when library clean has ended and return video or music to indicate which library has been cleaned
- onCleanStarted(...)
- onCleanStarted(library)--onCleanStarted method.
library : video/music as string
Will be called when library clean has started and return video or music to indicate which library is being cleaned
- onDPMSActivated(...)
- onDPMSActivated() --onDPMSActivated method.
Will be called when energysaving/DPMS gets active
- onDPMSDeactivated(...)
- onDPMSDeactivated() --onDPMSDeactivated method.
Will be called when energysaving/DPMS is turned off
- onDatabaseScanStarted(...)
- onDatabaseScanStarted(database)--Deprecated, useonScanStarted() .
- onDatabaseUpdated(...)
- onDatabaseUpdated(database)--Deprecated, useonScanFinished() .
- onNotification(...)
- onNotification(sender, method, data)--onNotification method.
sender : sender of the notification
method : name of the notification
data : JSON-encoded data of the notification
Will be called when Kodi receives or sends a notification
- onScanFinished(...)
- onScanFinished(library)--onScanFinished method.
library : video/music as string
Will be called when library scan has ended and return video or music to indicate which library has been scanned
- onScanStarted(...)
- onScanStarted(library)--onScanStarted method.
library : video/music as string
Will be called when library scan has started and return video or music to indicate which library is being scanned
- onScreensaverActivated(...)
- onScreensaverActivated() --onScreensaverActivated method.
Will be called when screensaver kicks in
- onScreensaverDeactivated(...)
- onScreensaverDeactivated() --onScreensaverDeactivated method.
Will be called when screensaver goes off
- onSettingsChanged(...)
- onSettingsChanged() --onSettingsChanged method.
Will be called when addon settings are changed
- waitForAbort(...)
- waitForAbort([timeout])--Block until abort is requested, or until timeout occurs. If an abort requested have already been made, return immediately.
Returns True when abort have been requested, False if a timeout is given and the operation times out.
timeout : [opt] float - timeout in seconds. Default: no timeout.
Data and other attributes defined here:
- __new__ = <built-in method __new__ of type object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class PlayList(__builtin__.object) | Methods defined here:
- __getitem__(...)
- x.__getitem__(y) <> x[y]
- __len__(...)
- x.__len__() <> len(x)
- add(...)
- add(url[, listitem, index])--Adds a new file to the playlist.
url : string or unicode - filename or url to add.
listitem : [opt] listitem - used with setInfo() to set different infolabels.
index : [opt] integer - position to add playlist item. (default=end)
*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:
- playlist =xbmc.PlayList (xbmc.PLAYLIST_VIDEO)
- video = 'F:moviesIronman.mov'
- listitem =xbmcgui.ListItem ('Ironman', thumbnailImage='F:moviesIronman.tbn')
- listitem.setInfo('video', {'Title': 'Ironman', 'Genre': 'Science Fiction'})
- playlist.add(url=video, listitem=listitem, index=7)n
- clear(...)
- clear() --clear all items in the playlist.
- getPlayListId(...)
- getPlayListId() --returns an integer.
- 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.
- unshuffle(...)
- unshuffle() --unshuffle the playlist.
Data and other attributes defined here:
- __new__ = <built-in method __new__ of type object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class Player(__builtin__.object) | Player class.
Player()--Creates a newPlayer class.
| Methods defined here:
- disableSubtitles(...)
- DisableSubtitles()--disable subtitles
- getAvailableAudioStreams(...)
- getAvailableAudioStreams() --get Audio stream names
- getAvailableSubtitleStreams(...)
- getAvailableSubtitleStreams() --get Subtitle stream names
- 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.
Note: For LiveTV, returns a pvr:// url which is not translatable to an OS specific file or external url
Throws: Exception, if player is not playing a file.
- getSubtitles(...)
- getSubtitles() --get subtitle stream name
- 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.
- isPlaying(...)
- isPlaying() --returns True is Kodi is playing a file.
- isPlayingAudio(...)
- isPlayingAudio() --returns True is Kodi is playing an audio file.
- isPlayingVideo(...)
- isPlayingVideo() --returns True if Kodi is playing a video.
- onPlayBackEnded(...)
- onPlayBackEnded() --onPlayBackEnded method.
Will be called when Kodi stops playing a file
- onPlayBackPaused(...)
- onPlayBackPaused() --onPlayBackPaused method.
Will be called when user pauses a playing file
- onPlayBackResumed(...)
- onPlayBackResumed() --onPlayBackResumed method.
Will be called when user resumes a paused file
- onPlayBackSeek(...)
- onPlayBackSeek(time, seekOffset)--onPlayBackSeek method.
time : integer - time to seek to.
seekOffset : integer - ?.
Will be called when user seeks to a time
- onPlayBackSeekChapter(...)
- onPlayBackSeekChapter(chapter)--onPlayBackSeekChapter method.
chapter : integer - chapter to seek to.
Will be called when user performs a chapter seek
- onPlayBackSpeedChanged(...)
- onPlayBackSpeedChanged(speed)--onPlayBackSpeedChanged method.
speed : integer - current speed of player.
*Note, negative speed means player is rewinding, 1 is normal playback speed.
Will be called when players speed changes. (eg. user FF/RW)
- onPlayBackStarted(...)
- onPlayBackStarted() --onPlayBackStarted method.
Will be called when Kodi starts playing a file
- onPlayBackStopped(...)
- onPlayBackStopped() --onPlayBackStopped method.
Will be called when user stops Kodi playing a file
- onQueueNextItem(...)
- onQueueNextItem() --onQueueNextItem method.
Will be called when user queues the next item
- pause(...)
- pause() --Pause or resume playing if already paused.
- play(...)
- play([item, listitem, windowed, startpos])--Play this item.
item : [opt] string - filename, url or playlist.
listitem : [opt] listitem - used with setInfo() to set different infolabels.
windowed : [opt] bool - true=play video windowed, false=play users preference.(default)
startpos : [opt] int - starting position when playing a playlist. Default = -1
*Note, If item is not given then thePlayer will try to play the current item
in the current playlist.
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:
- listitem =xbmcgui.ListItem ('Ironman')
- listitem.setInfo('video', {'Title': 'Ironman', 'Genre': 'Science Fiction'})
- xbmc.Player().play(url, listitem, windowed)
- xbmc.Player().play(playlist, listitem, windowed, startpos)
- 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.
- setAudioStream(...)
- setAudioStream(stream)--set Audio Stream.
stream : int
example:
- setAudioStream(1)
- setSubtitleStream(...)
- setSubtitleStream(stream)--set Subtitle Stream
stream : int
example:
- setSubtitleStream(1)
- setSubtitles(...)
- setSubtitles() --set subtitle file and enable subtitlesn
- showSubtitles(...)
- showSubtitles(visible)--enable/disable subtitles
visible : boolean - True for visible subtitles.
example:
- xbmc.Player().showSubtitles(True)
- stop(...)
- stop() --Stop playing.
Data and other attributes defined here:
- __new__ = <built-in method __new__ of type object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
class RenderCapture(__builtin__.object) | Methods defined here:
- capture(...)
- capture(width, height [, flags])--issue capture request.
width : Width capture image should be rendered to
height : Height capture image should should be rendered to
flags : Optional. Flags that control the capture processing.
The value for 'flags' could be or'ed from the following constants:
- xbmc.CAPTURE_FLAG_CONTINUOUS : after a capture is done, issue a new capture request immediately
- xbmc.CAPTURE_FLAG_IMMEDIATELY : read out immediately whencapture() is called, this can cause a busy wait
- getAspectRatio(...)
- getAspectRatio() --returns aspect ratio of currently displayed video.
This may be called prior to callingRenderCapture.capture() .
- getCaptureState(...)
- getCaptureState() --returns processing state of capture request.
The returned value could be compared against the following constants:
- xbmc.CAPTURE_STATE_WORKING : Capture request in progress.
- xbmc.CAPTURE_STATE_DONE : Capture request done. The image could be retrieved withgetImage()
- xbmc.CAPTURE_STATE_FAILED : Capture request failed.
- getHeight(...)
- getHeight() --returns height of captured image as set during
RenderCapture.capture() . Returns 0 prior to calling capture.
- getImage(...)
- getImage() --returns captured image as a bytearray.
The size of the image isgetWidth() *getHeight() * 4
- getImageFormat(...)
- getImageFormat() --returns format of captured image: 'BGRA' or 'RGBA'.
- getWidth(...)
- getWidth() --returns width of captured image as set during
RenderCapture.capture() . Returns 0 prior to calling capture.
- waitForCaptureStateChangeEvent(...)
- waitForCaptureStateChangeEvent([msecs])--wait for capture state change event.
msecs : Milliseconds to wait. Waits forever if not specified.
The method will return 1 if the Event was triggered. Otherwise it will return 0.
Data and other attributes defined here:
- __new__ = <built-in method __new__ of type object>
- T.__new__(S, ...) -> a new object with type S, a subtype of T
|
|
