Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
mycroft.audio.services.simple.SimpleAudioService Class Reference
Inheritance diagram for mycroft.audio.services.simple.SimpleAudioService:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, config, bus, name='simple')
 
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 stop (self)
 
def supported_uris (self)
 
- Public Member Functions inherited from mycroft.audio.services.AudioBackend
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

 bus
 
 config
 
 index
 
 name
 
 process
 
 supports_mime_hints
 
 tracks
 
- Public Attributes inherited from mycroft.audio.services.AudioBackend
 supports_mime_hints
 

Private Member Functions

def _is_process_running (self)
 
def _pause (self)
 
def _play (self, message)
 
def _resume (self)
 
def _stop_running_process (self)
 

Private Attributes

 _is_playing
 
 _paused
 
 _stop_signal
 

Detailed Description

    Simple Audio backend for both mpg123 and the ogg123 player.
    This one is rather limited and only implements basic usage.

Definition at line 41 of file scripts/mycroft/audio/services/simple/__init__.py.

Constructor & Destructor Documentation

def mycroft.audio.services.simple.SimpleAudioService.__init__ (   self,
  config,
  bus,
  name = 'simple' 
)

Member Function Documentation

def mycroft.audio.services.simple.SimpleAudioService._is_process_running (   self)
private
def mycroft.audio.services.simple.SimpleAudioService._pause (   self)
private
Pauses playback if possible.

    Returns: (bool) New paused status:

Definition at line 148 of file scripts/mycroft/audio/services/simple/__init__.py.

def mycroft.audio.services.simple.SimpleAudioService._play (   self,
  message 
)
private
Implementation specific async method to handle playback.
    This allows mpg123 service to use the "next method as well
    as basic play/stop.

Definition at line 73 of file scripts/mycroft/audio/services/simple/__init__.py.

def mycroft.audio.services.simple.SimpleAudioService._resume (   self)
private
Resumes playback if possible.

    Returns: (bool) New paused status:

Definition at line 164 of file scripts/mycroft/audio/services/simple/__init__.py.

def mycroft.audio.services.simple.SimpleAudioService._stop_running_process (   self)
private
def mycroft.audio.services.simple.SimpleAudioService.add_list (   self,
  tracks 
)
def mycroft.audio.services.simple.SimpleAudioService.clear_list (   self)
def mycroft.audio.services.simple.SimpleAudioService.lower_volume (   self)
def mycroft.audio.services.simple.SimpleAudioService.next (   self)
def mycroft.audio.services.simple.SimpleAudioService.pause (   self)
def mycroft.audio.services.simple.SimpleAudioService.play (   self,
  repeat = False 
)
def mycroft.audio.services.simple.SimpleAudioService.previous (   self)
def mycroft.audio.services.simple.SimpleAudioService.restore_volume (   self)
def mycroft.audio.services.simple.SimpleAudioService.resume (   self)
def mycroft.audio.services.simple.SimpleAudioService.stop (   self)
def mycroft.audio.services.simple.SimpleAudioService.supported_uris (   self)

Member Data Documentation

mycroft.audio.services.simple.SimpleAudioService._is_playing
private
mycroft.audio.services.simple.SimpleAudioService._paused
private
mycroft.audio.services.simple.SimpleAudioService._stop_signal
private
mycroft.audio.services.simple.SimpleAudioService.bus
mycroft.audio.services.simple.SimpleAudioService.config
mycroft.audio.services.simple.SimpleAudioService.index
mycroft.audio.services.simple.SimpleAudioService.name
mycroft.audio.services.simple.SimpleAudioService.process
mycroft.audio.services.simple.SimpleAudioService.supports_mime_hints
mycroft.audio.services.simple.SimpleAudioService.tracks

The documentation for this class was generated from the following file:


mycroft_ros
Author(s):
autogenerated on Mon Apr 26 2021 02:35:40