19.5.1 Wave_read Objects

Wave_read objects, as returned by open(), have the following methods:

close(

)

Close the stream, and make the instance unusable. This is called automatically on object collection.

getnchannels(

)

Returns number of audio channels (1 for mono, 2 for stereo).

getsampwidth(

)

Returns sample width in bytes.

getframerate(

)

Returns sampling frequency.

getnframes(

)

Returns number of audio frames.

getcomptype(

)

Returns compression type ('NONE' is the only supported type).

getcompname(

)

Human-readable version of getcomptype(). Usually 'not compressed' parallels 'NONE'.

getparams(

)

Returns a tuple (nchannels, sampwidth, framerate, nframes, comptype, compname), equivalent to output of the get*() methods.

readframes(

n)

Reads and returns at most n frames of audio, as a string of bytes.

rewind(

)

Rewind the file pointer to the beginning of the audio stream.

The following two methods are defined for compatibility with the aifc module, and don't do anything interesting.

getmarkers(

)

Returns None.

getmark(

id)

Raise an error.

The following two methods define a term ``position'' which is compatible between them, and is otherwise implementation dependent.

setpos(

pos)

Set the file pointer to the specified position.

tell(

)

Return current file pointer position.

See About this document... for information on suggesting changes.