QAudioBuffer

The QAudioBuffer class represents a collection of audio samples with a specific format and sample rate. More…

Synopsis

Functions

• def byteCount ()

• def constData ()

• def data ()

• def duration ()

• def format ()

• def frameCount ()

• def isValid ()

• def sampleCount ()

• def startTime ()

Detailed Description

class PySide2.QtMultimedia.QAudioBuffer

PySide2.QtMultimedia.QAudioBuffer(other)

PySide2.QtMultimedia.QAudioBuffer(data, format[, startTime=-1])

PySide2.QtMultimedia.QAudioBuffer(numFrames, format[, startTime=-1])

param format:

PySide2.QtMultimedia.QAudioFormat

param other:

PySide2.QtMultimedia.QAudioBuffer

param startTime:

int

param data:

PySide2.QtCore.QByteArray

param numFrames:

int

Create a new, empty, invalid buffer.

PySide2.QtMultimedia.QAudioBuffer.byteCount()

Return type:

int

Returns the size of this buffer, in bytes.

PySide2.QtMultimedia.QAudioBuffer.constData()

Return type:

void

Returns a pointer to this buffer’s data. You can only read it.

This method is preferred over the const version of data() to prevent unnecessary copying.

There is also a templatized version of this function that allows you to retrieve a specific type of read-only pointer to the data. Note that there is no checking done on the format of the audio buffer - this is simply a convenience function.

// With a 16bit sample buffer:
const quint16 *data = buffer->constData<quint16>();

PySide2.QtMultimedia.QAudioBuffer.data()

Return type:

void

Returns a pointer to this buffer’s data. You can only read it.

You should use the constData() function rather than this to prevent accidental deep copying.

There is also a templatized version of this function that allows you to retrieve a specific type of read-only pointer to the data. Note that there is no checking done on the format of the audio buffer - this is simply a convenience function.

// With a 16bit sample const buffer:
const quint16 *data = buffer->data<quint16>();

PySide2.QtMultimedia.QAudioBuffer.duration()

Return type:

int

Returns the duration of audio in this buffer, in microseconds.

This depends on the format() , and the frameCount() .

PySide2.QtMultimedia.QAudioBuffer.format()

Return type:

PySide2.QtMultimedia.QAudioFormat

Returns the format of this buffer.

Several properties of this format influence how the duration() or byteCount() are calculated from the frameCount() .

PySide2.QtMultimedia.QAudioBuffer.frameCount()

Return type:

int

Returns the number of complete audio frames in this buffer.

An audio frame is an interleaved set of one sample per channel for the same instant in time.

PySide2.QtMultimedia.QAudioBuffer.isValid()

Return type:

bool

Returns true if this is a valid buffer. A valid buffer has more than zero frames in it and a valid format.

PySide2.QtMultimedia.QAudioBuffer.sampleCount()

Return type:

int

Returns the number of samples in this buffer.

If the format of this buffer has multiple channels, then this count includes all channels. This means that a stereo buffer with 1000 samples in total will have 500 left samples and 500 right samples (interleaved), and this function will return 1000.

See also

frameCount()

PySide2.QtMultimedia.QAudioBuffer.startTime()

Return type:

int

Returns the time in a stream that this buffer starts at (in microseconds).

If this buffer is not part of a stream, this will return -1.