mirror of
https://github.com/python/cpython.git
synced 2026-04-13 15:20:52 +00:00
GH-145450: Document missing wave.Wave_write getter methods (GH-145451)
This commit is contained in:
parent
a929e80b9e
commit
db41717cd5
2 changed files with 38 additions and 0 deletions
|
|
@ -181,11 +181,21 @@ Wave_write Objects
|
|||
Set the number of channels.
|
||||
|
||||
|
||||
.. method:: getnchannels()
|
||||
|
||||
Return the number of channels.
|
||||
|
||||
|
||||
.. method:: setsampwidth(n)
|
||||
|
||||
Set the sample width to *n* bytes.
|
||||
|
||||
|
||||
.. method:: getsampwidth()
|
||||
|
||||
Return the sample width in bytes.
|
||||
|
||||
|
||||
.. method:: setframerate(n)
|
||||
|
||||
Set the frame rate to *n*.
|
||||
|
|
@ -195,6 +205,11 @@ Wave_write Objects
|
|||
integer.
|
||||
|
||||
|
||||
.. method:: getframerate()
|
||||
|
||||
Return the frame rate.
|
||||
|
||||
|
||||
.. method:: setnframes(n)
|
||||
|
||||
Set the number of frames to *n*. This will be changed later if the number
|
||||
|
|
@ -202,12 +217,27 @@ Wave_write Objects
|
|||
raise an error if the output stream is not seekable).
|
||||
|
||||
|
||||
.. method:: getnframes()
|
||||
|
||||
Return the number of audio frames written so far.
|
||||
|
||||
|
||||
.. method:: setcomptype(type, name)
|
||||
|
||||
Set the compression type and description. At the moment, only compression type
|
||||
``NONE`` is supported, meaning no compression.
|
||||
|
||||
|
||||
.. method:: getcomptype()
|
||||
|
||||
Return the compression type (``'NONE'``).
|
||||
|
||||
|
||||
.. method:: getcompname()
|
||||
|
||||
Return the human-readable compression type name.
|
||||
|
||||
|
||||
.. method:: setparams(tuple)
|
||||
|
||||
The *tuple* should be ``(nchannels, sampwidth, framerate, nframes, comptype,
|
||||
|
|
@ -215,6 +245,13 @@ Wave_write Objects
|
|||
parameters.
|
||||
|
||||
|
||||
.. method:: getparams()
|
||||
|
||||
Return a :func:`~collections.namedtuple`
|
||||
``(nchannels, sampwidth, framerate, nframes, comptype, compname)``
|
||||
containing the current output parameters.
|
||||
|
||||
|
||||
.. method:: tell()
|
||||
|
||||
Return current position in the file, with the same disclaimer for the
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
Document missing public :class:`wave.Wave_write` getter methods.
|
||||
Loading…
Add table
Add a link
Reference in a new issue