Commit e08a66a3 authored by R. David Murray's avatar R. David Murray

Document the fact that 'compname' and 'comptype' are bytes.

parent a3b0d20a
...@@ -74,14 +74,16 @@ following methods: ...@@ -74,14 +74,16 @@ following methods:
.. method:: aifc.getcomptype() .. method:: aifc.getcomptype()
Return a four-character string describing the type of compression used in the Return a bytes array of length 4 describing the type of compression
audio file. For AIFF files, the returned value is ``'NONE'``. used in the audio file. For AIFF files, the returned value is
``b'NONE'``.
.. method:: aifc.getcompname() .. method:: aifc.getcompname()
Return a human-readable description of the type of compression used in the audio Return a bytes array convertible to a human-readable description
file. For AIFF files, the returned value is ``'not compressed'``. of the type of compression used in the audio file. For AIFF files,
the returned value is ``b'not compressed'``.
.. method:: aifc.getparams() .. method:: aifc.getparams()
...@@ -180,11 +182,12 @@ number of frames must be filled in. ...@@ -180,11 +182,12 @@ number of frames must be filled in.
single: A-LAW single: A-LAW
single: G.722 single: G.722
Specify the compression type. If not specified, the audio data will not be Specify the compression type. If not specified, the audio data will
compressed. In AIFF files, compression is not possible. The name parameter not be compressed. In AIFF files, compression is not possible.
should be a human-readable description of the compression type, the type The name parameter should be a human-readable description of the
parameter should be a four-character string. Currently the following compression type as a bytes array, the type parameter should be a
compression types are supported: NONE, ULAW, ALAW, G722. bytes array of length 4. Currently the following compression types
are supported: ``b'NONE'``, ``b'ULAW'``, ``b'ALAW'``, ``b'G722'``.
.. method:: aifc.setparams(nchannels, sampwidth, framerate, comptype, compname) .. method:: aifc.setparams(nchannels, sampwidth, framerate, comptype, compname)
......
...@@ -35,8 +35,6 @@ class AIFCTest(unittest.TestCase): ...@@ -35,8 +35,6 @@ class AIFCTest(unittest.TestCase):
self.assertEqual(f.getsampwidth(), 2) self.assertEqual(f.getsampwidth(), 2)
self.assertEqual(f.getframerate(), 48000) self.assertEqual(f.getframerate(), 48000)
self.assertEqual(f.getnframes(), 14400) self.assertEqual(f.getnframes(), 14400)
# XXX: are the next two correct? The docs say/imply they are supposed
# to be strings.
self.assertEqual(f.getcomptype(), b'NONE') self.assertEqual(f.getcomptype(), b'NONE')
self.assertEqual(f.getcompname(), b'not compressed') self.assertEqual(f.getcompname(), b'not compressed')
self.assertEqual( self.assertEqual(
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment