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

mixer: Mark methods that may be implemented by subclasses

Browse Source
This commit is contained in:
Stein Magnus Jodal 2014-07-09 22:19:34 +02:00
parent bf8307f329
commit bb269688c6
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
mopidy/mixer.py
View File

@ -25,6 +25,8 @@ class Mixer(object):
:class:`None`:
Volume is unknown.
*MAY be implemented by subclass.*
:rtype: int in range [0..100] or :class:`None`
"""
return None
@ -33,6 +35,8 @@ class Mixer(object):
"""
Set volume level of the mixer.
*MAY be implemented by subclass.*
:param volume: Volume in the range [0..100]
:type volume: int
:rtype: :class:`True` if success, :class:`False` if failure
@ -43,6 +47,8 @@ class Mixer(object):
"""
Get mute status of the mixer.
*MAY be implemented by subclass.*
:rtype: :class:`True` if muted, :class:`False` if unmuted,
:class:`None` if unknown.
"""
@ -52,6 +58,8 @@ class Mixer(object):
"""
Mute or unmute the mixer.
*MAY be implemented by subclass.*
:param muted: :class:`True` to mute, :class:`False` to unmute
:type muted: bool
:rtype: :class:`True` if success, :class:`False` if failure