Corrected docstrings of audio modules. writeframes() accepts bytes, not str.

This commit is contained in:
Serhiy Storchaka 2015-07-10 22:13:40 +03:00
parent e6ecea53c8
commit e0fd7ef6bb
3 changed files with 3 additions and 3 deletions

View File

@ -121,7 +121,7 @@ but when it is set to the correct value, the header does not have to
be patched up. be patched up.
It is best to first set all parameters, perhaps possibly the It is best to first set all parameters, perhaps possibly the
compression type, and then write audio frames using writeframesraw. compression type, and then write audio frames using writeframesraw.
When all frames have been written, either call writeframes('') or When all frames have been written, either call writeframes(b'') or
close() to patch up the sizes in the header. close() to patch up the sizes in the header.
Marks can be added anytime. If there are any marks, you must call Marks can be added anytime. If there are any marks, you must call
close() after all frames have been written. close() after all frames have been written.

View File

@ -97,7 +97,7 @@ but when it is set to the correct value, the header does not have to
be patched up. be patched up.
It is best to first set all parameters, perhaps possibly the It is best to first set all parameters, perhaps possibly the
compression type, and then write audio frames using writeframesraw. compression type, and then write audio frames using writeframesraw.
When all frames have been written, either call writeframes('') or When all frames have been written, either call writeframes(b'') or
close() to patch up the sizes in the header. close() to patch up the sizes in the header.
The close() method is called automatically when the class instance The close() method is called automatically when the class instance
is destroyed. is destroyed.

View File

@ -65,7 +65,7 @@ but when it is set to the correct value, the header does not have to
be patched up. be patched up.
It is best to first set all parameters, perhaps possibly the It is best to first set all parameters, perhaps possibly the
compression type, and then write audio frames using writeframesraw. compression type, and then write audio frames using writeframesraw.
When all frames have been written, either call writeframes('') or When all frames have been written, either call writeframes(b'') or
close() to patch up the sizes in the header. close() to patch up the sizes in the header.
The close() method is called automatically when the class instance The close() method is called automatically when the class instance
is destroyed. is destroyed.