From: Olivier Guilyardi <olivier@samalyse.com>
Date: Wed, 24 Feb 2010 12:25:42 +0000 (+0000)
Subject: api: require to call parent from setup(), fix and clarify IDecoder.resolution()
X-Git-Tag: 0.3.2~176
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=4a2971dcee26dccf8ed11abe5acecbbf71b80403;p=timeside.git

api: require to call parent from setup(), fix and clarify IDecoder.resolution()
---

diff --git a/api.py b/api.py
index 702f510..4ecaa3a 100644
--- a/api.py
+++ b/api.py
@@ -43,6 +43,8 @@ class IProcessor(Interface):
         these arguments is passed to an output-only processor such as a decoder.
         """
 
+        # implementations should always call the parent method
+
     def channels(self):
         """Number of channels in the data returned by process(). May be different from
         the number of channels passed to setup()"""
@@ -135,7 +137,8 @@ class IDecoder(IProcessor):
         """Return a user-friendly encoding string"""
 
     def resolution():
-        """Return the sample depth"""
+        """Return the sample width (8, 16, etc..) of original audio file/stream,
+           or None if not applicable/known"""
 
     def metadata(self):
         """Return the metadata embedded into the encoded stream, if any."""