Public Member Functions | |
| def | __init__ (self, config, bus) |
| def | add_list (self, tracks) |
| def | clear_list (self) |
| def | lower_volume (self) |
| def | next (self) |
| def | pause (self) |
| def | play (self, repeat=False) |
| def | previous (self) |
| def | restore_volume (self) |
| def | resume (self) |
| def | seek_backward (self, seconds=1) |
| def | seek_forward (self, seconds=1) |
| def | set_track_start_callback (self, callback_func) |
| def | shutdown (self) |
| def | stop (self) |
| def | supported_uris (self) |
| def | track_info (self) |
Public Attributes | |
| supports_mime_hints | |
Private Attributes | |
| _track_start_callback | |
Static Private Attributes | |
| __metaclass__ = ABCMeta | |
Detailed Description
Base class for all audio backend implementations.
Args:
config: configuration dict for the instance
bus: Mycroft messagebus emitter
Definition at line 18 of file scripts/mycroft/audio/services/__init__.py.
Constructor & Destructor Documentation
| def mycroft.audio.services.AudioBackend.__init__ | ( | self, | |
| config, | |||
| bus | |||
| ) |
Definition at line 28 of file scripts/mycroft/audio/services/__init__.py.
Member Function Documentation
| def mycroft.audio.services.AudioBackend.add_list | ( | self, | |
| tracks | |||
| ) |
Add tracks to backend's playlist.
Args:
tracks: list of tracks.
Definition at line 47 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.clear_list | ( | self | ) |
Clear playlist
Definition at line 40 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.lower_volume | ( | self | ) |
Lower volume.
Definition at line 106 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.next | ( | self | ) |
Skip to next track in playlist.
Definition at line 94 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.pause | ( | self | ) |
Pause playback.
Definition at line 82 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.play | ( | self, | |
repeat = False |
|||
| ) |
Start playback.
Args:
repeat: Repeat playlist, defaults to False
Definition at line 57 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.previous | ( | self | ) |
Skip to previous track in playlist.
Definition at line 100 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.restore_volume | ( | self | ) |
Restore normal volume.
Definition at line 112 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.resume | ( | self | ) |
Resume paused playback.
Definition at line 88 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.seek_backward | ( | self, | |
seconds = 1 |
|||
| ) |
Rewind X seconds
Args:
seconds (int): number of seconds to seek, if negative rewind
Definition at line 129 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.seek_forward | ( | self, | |
seconds = 1 |
|||
| ) |
Skip X seconds
Args:
seconds (int): number of seconds to seek, if negative rewind
Definition at line 119 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.set_track_start_callback | ( | self, | |
| callback_func | |||
| ) |
Register callback on track start, should be called as each track
in a playlist is started.
Definition at line 75 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.shutdown | ( | self | ) |
Perform clean shutdown
Definition at line 150 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.stop | ( | self | ) |
Stop playback.
Returns: (bool) True if playback was stopped, otherwise False
Definition at line 67 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.supported_uris | ( | self | ) |
Returns: list of supported uri types.
Definition at line 33 of file scripts/mycroft/audio/services/__init__.py.
| def mycroft.audio.services.AudioBackend.track_info | ( | self | ) |
Fetch info about current playing track.
Returns:
Dict with track info.
Definition at line 138 of file scripts/mycroft/audio/services/__init__.py.
Member Data Documentation
|
staticprivate |
Definition at line 26 of file scripts/mycroft/audio/services/__init__.py.
|
private |
Definition at line 29 of file scripts/mycroft/audio/services/__init__.py.
| mycroft.audio.services.AudioBackend.supports_mime_hints |
Definition at line 30 of file scripts/mycroft/audio/services/__init__.py.
The documentation for this class was generated from the following file: