FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

GH-145450: Document missing `wave.Wave_write` getter methods by mbeijen · Pull Request #145451 · python/cpython · GitHub

Repository navigation

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .rst  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
37 changes: 37 additions & 0 deletions Doc/library/wave.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -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*.
Expand All @@ -195,26 +205,53 @@ 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
of frames actually written is different (this update attempt will
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,
compname)``, with values valid for the ``set*()`` methods. Sets all
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
Expand Down
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document missing public :class:`wave.Wave_write` getter methods.
Loading

Back | FazBrowse Home | New Git URL