QAudioDecoder Class

成员函数 文档

[explicit] QAudioDecoder::QAudioDecoder(QObject *parent = nullptr)

使用parent 构建 QAudioDecoder 实例。

[override virtual noexcept] QAudioDecoder::~QAudioDecoder()

销毁音频解码器对象。

QAudioFormat QAudioDecoder::audioFormat() const

返回解码器设置的音频格式。

另请参阅 setAudioFormat() 和formatChanged()。

bool QAudioDecoder::bufferAvailable() const

如果有缓冲区可供读取，则返回 true，否则返回 false。如果没有可用的缓冲区，调用read() 函数将返回一个无效的缓冲区。

[signal] void QAudioDecoder::bufferAvailableChanged(bool available)

表示有新缓冲区可用（如果available 为 true）。

如果available 为 false，则没有可用的缓冲区。

另请参阅 bufferAvailable() 和bufferReady()。

[signal] void QAudioDecoder::bufferReady()

表示可以读取新的解码音频缓冲区。

另请参阅 read() 和bufferAvailable()。

qint64 QAudioDecoder::duration() const

返回音频流的总持续时间（以毫秒为单位），如果没有，则返回-1。

[signal] void QAudioDecoder::durationChanged(qint64 duration)

表示解码数据的估计duration 已发生变化。

另请参阅 positionChanged().

QAudioDecoder::Error QAudioDecoder::error() const

返回QAudioDecoder 的当前错误状态。

[signal] void QAudioDecoder::error(QAudioDecoder::Error error)

发生error 情况的信号。

注意：该类重载了信号error。要使用函数指针语法连接到该信号，Qt 提供了一个方便的辅助工具来获取函数指针，如本例所示：

connect(audioDecoder, QOverload<QAudioDecoder::Error>::of(&QAudioDecoder::error),
    [=](QAudioDecoder::Error error){ /* ... */ });

另请参阅 errorString().

[signal] void QAudioDecoder::finished()

解码成功完成的信号。如果解码失败，则发出错误信号。

另请参见 start()、stop() 和error()。

[signal] void QAudioDecoder::formatChanged(const QAudioFormat &format)

表示解码器的当前音频格式已更改为format 。

另请参阅 audioFormat() 和setAudioFormat()。

bool QAudioDecoder::isSupported() const

如果该平台支持音频解码，则返回 true。

qint64 QAudioDecoder::position() const

返回从解码器读取的最后一个缓冲区的位置（以毫秒为单位），如果没有读取缓冲区，则返回-1。

[signal] void QAudioDecoder::positionChanged(qint64 position)

解码器当前position 发生变化的信号。

另请参见 durationChanged()。

QAudioBuffer QAudioDecoder::read() const

从解码器读取缓冲区（如果有的话）。如果当前没有可用的解码缓冲区，或解码失败，则返回无效缓冲区。在这两种情况下，该函数都不会阻塞。

在调用 read() 之前，应响应bufferReady() 信号或检查bufferAvailable() 函数，以确保获得有用的数据。

void QAudioDecoder::setAudioFormat(const QAudioFormat &format)

将所需的解码采样音频格式设置为format 。

此属性只能在解码器停止时设置。在其他时间设置此属性将被忽略。

如果解码器不支持此格式，error() 将被设置为FormatError 。

如果没有指定格式，则将使用解码音频本身的格式。否则，将进行一些格式转换。

如果您希望将解码格式重置为原始音频文件的格式，可以指定一个无效的format 。

另请参阅 audioFormat() 。

void QAudioDecoder::setSource(const QUrl &fileName)

将当前音频文件名称设置为fileName 。

设置此属性后，任何当前解码都将停止，任何音频缓冲区都将被丢弃。

您只能指定源文件名称或源QIODevice 。设置一个将取消另一个。

另请参阅 source() 。

void QAudioDecoder::setSourceDevice(QIODevice *device)

将当前音频QIODevice 设置为device 。

设置此属性后，当前的解码将停止，任何音频缓冲区都将被丢弃。

您只能指定源文件名称或源QIODevice 。设置一个将取消另一个。

另请参阅 sourceDevice() 。

QUrl QAudioDecoder::source() const

返回当前要解码的文件名。如果调用了setSourceDevice ，则为空。

另请参阅 setSource().

[signal] void QAudioDecoder::sourceChanged()

解码器的电流源发生变化的信号。

另请参阅 source() 和sourceDevice()。

QIODevice *QAudioDecoder::sourceDevice() const

返回当前源QIODevice （如果已设置）。如果调用了setSource() ，则返回 nullptr。

另请参见 setSourceDevice()。

[slot] void QAudioDecoder::start()

开始解码音频资源。

随着数据的解码，当解码的数据足够多时，bufferReady() 信号就会发出。然后，调用read() 将返回一个音频缓冲区，而不会阻塞。

如果在缓冲区就绪之前调用read() ，将返回一个无效的缓冲区，同样不会阻塞。

另请参阅 read()。

[slot] void QAudioDecoder::stop()

停止解码音频。再次调用start() 将从头开始恢复解码。