Skip to content

Commit db41717

Browse files
authored
GH-145450: Document missing wave.Wave_write getter methods (GH-145451)
1 parent a929e80 commit db41717

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

Doc/library/wave.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,11 +181,21 @@ Wave_write Objects
181181
Set the number of channels.
182182

183183

184+
.. method:: getnchannels()
185+
186+
Return the number of channels.
187+
188+
184189
.. method:: setsampwidth(n)
185190

186191
Set the sample width to *n* bytes.
187192

188193

194+
.. method:: getsampwidth()
195+
196+
Return the sample width in bytes.
197+
198+
189199
.. method:: setframerate(n)
190200

191201
Set the frame rate to *n*.
@@ -195,26 +205,53 @@ Wave_write Objects
195205
integer.
196206

197207

208+
.. method:: getframerate()
209+
210+
Return the frame rate.
211+
212+
198213
.. method:: setnframes(n)
199214

200215
Set the number of frames to *n*. This will be changed later if the number
201216
of frames actually written is different (this update attempt will
202217
raise an error if the output stream is not seekable).
203218

204219

220+
.. method:: getnframes()
221+
222+
Return the number of audio frames written so far.
223+
224+
205225
.. method:: setcomptype(type, name)
206226

207227
Set the compression type and description. At the moment, only compression type
208228
``NONE`` is supported, meaning no compression.
209229

210230

231+
.. method:: getcomptype()
232+
233+
Return the compression type (``'NONE'``).
234+
235+
236+
.. method:: getcompname()
237+
238+
Return the human-readable compression type name.
239+
240+
211241
.. method:: setparams(tuple)
212242

213243
The *tuple* should be ``(nchannels, sampwidth, framerate, nframes, comptype,
214244
compname)``, with values valid for the ``set*()`` methods. Sets all
215245
parameters.
216246

217247

248+
.. method:: getparams()
249+
250+
Return a :func:`~collections.namedtuple`
251+
``(nchannels, sampwidth, framerate, nframes, comptype, compname)``
252+
containing the current output parameters.
253+
254+
218255
.. method:: tell()
219256

220257
Return current position in the file, with the same disclaimer for the
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document missing public :class:`wave.Wave_write` getter methods.

0 commit comments

Comments
 (0)