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

docs: Add mopidy.ext to API docs

Browse Source
This commit is contained in:
Stein Magnus Jodal 2013-04-13 13:51:02 +02:00
parent dbbe0fd16e
commit 0007597961
3 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api/ext.rst Normal file
View File

@ -0,0 +1,9 @@
.. _ext-api:
*************
Extension API
*************
.. automodule:: mopidy.ext
:synopsis: Extension API for extending Mopidy
:members:

1
docs/api/index.rst
View File

@ -11,4 +11,5 @@ API reference
core core
audio audio
frontends frontends
ext
http http

7
mopidy/ext.py
View File

@ -11,28 +11,35 @@ logger = logging.getLogger('mopidy.ext')
class Extension(object): class Extension(object):
"""Base class for Mopidy extensions"""
dist_name = None dist_name = None
ext_name = None ext_name = None
version = None version = None
def get_default_config(self): def get_default_config(self):
"""TODO"""
raise NotImplementedError( raise NotImplementedError(
'Add at least a config section with "enabled = true"') 'Add at least a config section with "enabled = true"')
def get_config_schema(self): def get_config_schema(self):
"""TODO"""
return config_utils.ExtensionConfigSchema() return config_utils.ExtensionConfigSchema()
def validate_environment(self): def validate_environment(self):
"""TODO"""
pass pass
def get_frontend_classes(self): def get_frontend_classes(self):
"""TODO"""
return [] return []
def get_backend_classes(self): def get_backend_classes(self):
"""TODO"""
return [] return []
def register_gstreamer_elements(self): def register_gstreamer_elements(self):
"""TODO"""
pass pass