andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Use Extension.setup() in extensiondev guide

Browse Source
This commit is contained in:
Stein Magnus Jodal 2014-01-11 14:24:32 +01:00
parent b628825964
commit 3c7c0ae46c
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/extensiondev.rst
View File

@ -290,28 +290,29 @@ This is ``mopidy_soundspot/__init__.py``::
schema['password'] = config.Secret() schema['password'] = config.Secret()
return schema return schema
def get_command(self):
from .commands import SoundspotCommand
return SoundspotCommand()
def validate_environment(self): def validate_environment(self):
try: try:
import pysoundspot import pysoundspot
except ImportError as e: except ImportError as e:
raise exceptions.ExtensionError('pysoundspot library not found', e) raise exceptions.ExtensionError('pysoundspot library not found', e)
# You will typically only implement one of the next three methods def setup(self, registry):
# in a single extension. # You will typically only do one of the following things in a
# single extension.
def get_frontend_classes(self): # Register a frontend
from .frontend import SoundspotFrontend from .frontend import SoundspotFrontend
return [SoundspotFrontend] registry.add('frontend', SoundspotFrontend)
def get_backend_classes(self): # Register a backend
from .backend import SoundspotBackend from .backend import SoundspotBackend
return [SoundspotBackend] registry.add('backend', SoundspotBackend)
def get_command(self): # Register a custom GStreamer element
from .commands import SoundspotCommand
return SoundspotCommand()
def register_gstreamer_elements(self):
from .mixer import SoundspotMixer from .mixer import SoundspotMixer
gobject.type_register(SoundspotMixer) gobject.type_register(SoundspotMixer)
gst.element_register( gst.element_register(
@ -415,8 +416,8 @@ If you want to extend Mopidy's GStreamer pipeline with new custom GStreamer
elements, you'll need to register them in GStreamer before they can be used. elements, you'll need to register them in GStreamer before they can be used.
Basically, you just implement your GStreamer element in Python and then make Basically, you just implement your GStreamer element in Python and then make
your :meth:`~mopidy.ext.Extension.register_gstreamer_elements` method register your :meth:`~mopidy.ext.Extension.setup` method register all your custom
all your custom GStreamer elements. GStreamer elements.
For examples of custom GStreamer elements implemented in Python, see For examples of custom GStreamer elements implemented in Python, see
:mod:`mopidy.audio.mixers`. :mod:`mopidy.audio.mixers`.