QAudioDecoder#

The QAudioDecoder class implements decoding audio. More…

Synopsis#

Functions#

def audioFormat ()
def bufferAvailable ()
def duration ()
def error ()
def errorString ()
def isDecoding ()
def isSupported ()
def position ()
def read ()
def setAudioFormat (format)
def setSource (fileName)
def setSourceDevice (device)
def source ()
def sourceDevice ()

Slots#

def start ()
def stop ()

Signals#

def bufferAvailableChanged (arg__1)
def bufferReady ()
def durationChanged (duration)
def error (error)
def finished ()
def formatChanged (format)
def isDecodingChanged (arg__1)
def positionChanged (position)
def sourceChanged ()

Detailed Description#

The QAudioDecoder class is a high level class for decoding audio media files. It is similar to the QMediaPlayer class except that audio is provided back through this API rather than routed directly to audio hardware.

See also

QAudioBuffer

class PySide6.QtMultimedia.QAudioDecoder([parent=None])#

Parameters: parent – PySide6.QtCore.QObject

Construct an QAudioDecoder instance with parent.

PySide6.QtMultimedia.QAudioDecoder.Error#

Defines a media player error condition.

Constant

Description

QAudioDecoder.NoError

No error has occurred.

QAudioDecoder.ResourceError

A media resource couldn’t be resolved.

QAudioDecoder.FormatError

The format of a media resource isn’t supported.

QAudioDecoder.AccessDeniedError

There are not the appropriate permissions to play a media resource.

QAudioDecoder.NotSupportedError

QAudioDecoder is not supported on this platform

Constant	Description
QAudioDecoder.NoError	No error has occurred.
QAudioDecoder.ResourceError	A media resource couldn’t be resolved.
QAudioDecoder.FormatError	The format of a media resource isn’t supported.
QAudioDecoder.AccessDeniedError	There are not the appropriate permissions to play a media resource.
QAudioDecoder.NotSupportedError	`QAudioDecoder` is not supported on this platform

PySide6.QtMultimedia.QAudioDecoder.audioFormat()#

Return type: PySide6.QtMultimedia.QAudioFormat

Returns the audio format the decoder is set to.

Note

This may be different than the format of the decoded samples, if the audio format was set to an invalid one.

See also

setAudioFormat() formatChanged()

PySide6.QtMultimedia.QAudioDecoder.bufferAvailable()#

Return type: bool

This property holds whether there is a decoded audio buffer available.

PySide6.QtMultimedia.QAudioDecoder.bufferAvailableChanged(arg__1)#

Parameters: arg__1 – bool

Signals the availability (if available is true) of a new buffer.

If available is false, there are no buffers available.

See also

bufferAvailable() bufferReady()

PySide6.QtMultimedia.QAudioDecoder.bufferReady()#

Signals that a new decoded audio buffer is available to be read.

See also

read() bufferAvailable()

PySide6.QtMultimedia.QAudioDecoder.duration()#

Return type: int

Returns total duration (in milliseconds) of the audio stream or -1 if not available.

PySide6.QtMultimedia.QAudioDecoder.durationChanged(duration)#

Parameters: duration – int

Signals that the estimated duration of the decoded data has changed.

See also

positionChanged()

PySide6.QtMultimedia.QAudioDecoder.error(error)#

Parameters: error – Error

Signals that an error condition has occurred.

See also

errorString()

PySide6.QtMultimedia.QAudioDecoder.error()

Return type: Error

Returns the current error state of the QAudioDecoder .

PySide6.QtMultimedia.QAudioDecoder.errorString()#

Return type: str

Returns a human readable description of the current error, or an empty string is there is no error.

PySide6.QtMultimedia.QAudioDecoder.finished()#

Signals that the decoding has finished successfully. If decoding fails, error signal is emitted instead.

See also

start() stop() error()

PySide6.QtMultimedia.QAudioDecoder.formatChanged(format)#

Parameters: format – PySide6.QtMultimedia.QAudioFormat

Signals that the current audio format of the decoder has changed to format.

See also

audioFormat() setAudioFormat()

PySide6.QtMultimedia.QAudioDecoder.isDecoding()#

Return type: bool

This property holds true if the decoder is currently running and decoding audio data..

PySide6.QtMultimedia.QAudioDecoder.isDecodingChanged(arg__1)#

Parameters: arg__1 – bool

PySide6.QtMultimedia.QAudioDecoder.isSupported()#

Return type: bool

Returns true is audio decoding is supported on this platform.

PySide6.QtMultimedia.QAudioDecoder.position()#

Return type: int

Returns position (in milliseconds) of the last buffer read from the decoder or -1 if no buffers have been read.

PySide6.QtMultimedia.QAudioDecoder.positionChanged(position)#

Parameters: position – int

Signals that the current position of the decoder has changed.

See also

durationChanged()

PySide6.QtMultimedia.QAudioDecoder.read()#

Return type: PySide6.QtMultimedia.QAudioBuffer

Read a buffer from the decoder, if one is available. Returns an invalid buffer if there are no decoded buffers currently available, or on failure. In both cases this function will not block.

You should either respond to the bufferReady() signal or check the bufferAvailable() function before calling read() to make sure you get useful data.

PySide6.QtMultimedia.QAudioDecoder.setAudioFormat(format)#

Parameters: format – PySide6.QtMultimedia.QAudioFormat

Set the desired audio format for decoded samples to format.

This property can only be set while the decoder is stopped. Setting this property at other times will be ignored.

If the decoder does not support this format, error() will be set to FormatError.

If you do not specify a format, the format of the decoded audio itself will be used. Otherwise, some format conversion will be applied.

If you wish to reset the decoded format to that of the original audio file, you can specify an invalid format.

Warning

Setting a desired audio format is not yet supported on Android.