QTextToSpeech 类

成员函数文档

将文本合成成原始音频数据。

此函数以异步方式将语音合成成原始音频数据。当数据可用时，functor 将被调用为 functor(QAudioFormat format, QByteArray bytes)，其中 format 描述了 bytes 中数据的 格式；或者 functor(QAudioBuffer &buffer)。

开始合成时，将 state 属性设置为 Synthesizing，完成合成后设置为 Ready。在合成过程中，functor 可能会被调用多次，format 的值可能发生变化。

functor 可以是一个可调用的，如 lambda 或 free 函数，带有可选的 context 对象

tts.synthesize("Hello world", [](const QAudioFormat &format, const QByteArray &bytes){
    // process data according to format
});

或 context 对象的成员函数

struct PCMProcessor : QObject
{
    void processData(const QAudioFormat &format, const QByteArray &bytes)
    {
        // process data according to format
    }
} processor;
tts.synthesize("Hello world", &processor, &PCMProcessor::processData);

如果 context 被销毁，则 functor 将不再被调用。

此功能是在 Qt 6.6 中引入的。

另请参阅say() 和 stop。

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

从使用默认引擎插件的对象中加载数文到语音引擎，并以 parent 作为其子对象构造 QTextToSpeech 对象。

默认引擎是平台特定的。

如果引擎初始化正确，则引擎的 state 将更改为 QTextToSpeech::Ready；注意这可能会异步发生。如果插件加载失败，则 state 将设置为 QTextToSpeech::Error。

另请参阅 availableEngines().

[显式] QTextToSpeech::QTextToSpeech(const QString &engine, QObject *parent = nullptr)

从与参数engine匹配的插件中加载文本到语音引擎，并将QTextToSpeech对象构造为parent的子对象。

如果engine为空，则使用默认的引擎插件。默认引擎是平台特定的。

如果引擎正确初始化，则引擎的state将被设置为QTextToSpeech::Ready。如果插件加载失败，或引擎初始化失败，则引擎的state将设置为QTextToSpeech::Error。

另请参阅 availableEngines().

[显式，自6.4以来] QTextToSpeech::QTextToSpeech(const QString &engine, const QVariantMap &params, QObject *parent = nullptr)

从与参数engine匹配的插件中加载文本到语音引擎，并将QTextToSpeech对象构造为parent的子对象，将参数params传递给引擎。

如果engine为空，则使用默认的引擎插件。默认引擎是平台特定的。支持的键值对取决于引擎。有关详细信息，请参阅引擎文档。不支持的条目将被忽略。

如果引擎正确初始化，则引擎的state将被设置为QTextToSpeech::Ready。如果插件加载失败，或引擎初始化失败，则引擎的state将设置为QTextToSpeech::Error。

此函数自Qt 6.4版本引入。

另请参阅 availableEngines().

[重写虚函数noexcept] QTextToSpeech::~QTextToSpeech()

销毁此QTextToSpeech对象，停止任何语音。

[信号，自6.6以来] void QTextToSpeech::aboutToSynthesize(qsizetype id)

在引擎开始为id音频生成合成语音之前发出此信号。 id是调用enqueue()返回的值。应用程序可以在此信号的帮助下对voice属性进行最后时刻的修改，或跟踪通过enqueue()入队的文本的过程。

此功能是在 Qt 6.6 中引入的。

另请参阅 enqueue()，synthesize()和voice。

[静态可调用] QStringList QTextToSpeech::availableEngines()

获取支持的文本到语音引擎插件的列表。

另请参阅engine。

[可调用] QList<QLocale> QTextToSpeech::availableLocales() const

返回活动engine支持的区域列表。

另请参阅 availableVoices()和findVoices()。

[可调用] QList<QVoice> QTextToSpeech::availableVoices() const

返回当前地区可用的语音列表。

另请参阅：availableLocales() 和 findVoices()。

[槽，自6.6版本以来] qsizetype QTextToSpeech::enqueue(const QString &utterance)

将utterance添加到待读文本队列中，并开始朗读。返回文本在队列中的索引，或在出错时返回-1。

如果引擎的状态目前为Ready，则立即朗读utterance。否则，引擎将在完成朗读当前文本后开始朗读utterance。

每当引擎开始读取队列中的下一个文本条目时，将发出aboutToSynthesize()信号。这允许应用程序跟踪进度，并对语音属性进行最后-minute更改。

调用stop()清除队列。要在文本末尾暂停引擎，使用Utterance边界提示。

此功能是在 Qt 6.6 中引入的。

另请参阅：say()、stop()、aboutToSynthesize() 和 synthesize()。

[信号] void QTextToSpeech::errorOccurred(QTextToSpeech::ErrorReason reason, const QString &errorString)

在发生错误并将状态设置为QTextToSpeech::Error后发出此信号。参数reason指定错误类型，参数errorString提供人类可读的错误描述。

QTextToSpeech::ErrorReason不是一个已注册的元类型，因此对于排队连接，您必须使用Q_DECLARE_METATYPE() 和 qRegisterMetaType()进行注册。

另请参阅：errorReason()、errorString() 和 创建自定义Qt类型。

[可调用] QTextToSpeech::ErrorReason QTextToSpeech::errorReason() const

返回引擎报告错误的原因。

另请参阅：状态和errorOccurred。

[可调用] QString QTextToSpeech::errorString() const

返回当前的引擎错误消息。

另请参阅：errorOccurred()。

[自6.6版本以来] 模板 <typename... Args> QList<QVoice> QTextToSpeech::findVoices(Args &&... args) const

返回符合args中条件的语音列表。

将args中的参数按顺序处理，以组装符合所有参数的语音列表。类型为QString的参数与语音的name相匹配，类型为QLocale的参数与语音的locale相匹配等。可以只指定所需语音的Language或Territory，并且名称可以使用正则表达式进行匹配。

如果条件列表为空，此函数返回所有语音。不允许存在相同类型的多个条件，否则会导致编译时错误。

此功能是在 Qt 6.6 中引入的。

另请参阅availableVoices。

[slot] void QTextToSpeech::pause(QTextToSpeech::BoundaryHint boundaryHint = QTextToSpeech::BoundaryHint::Default)

在boundaryHint处暂停当前的语音。

是否尊重boundaryHint取决于engine。

另请参阅resume() 和 PauseResume。

[slot] void QTextToSpeech::resume()

在调用pause()后恢复讲话。

另请参阅pause。

[slot] void QTextToSpeech::say(const QString &text)

开始朗读text。

此函数异步开始合成语音，并将文本读入默认音频输出设备。

    connect(ui.speakButton, &QPushButton::clicked, m_speech, [this]{
        m_speech->say(ui.plainTextEdit->toPlainText());
    });

当前状态可以通过state属性获得，并在开始阅读时设置为Speaking。阅读完成后，state将设置为Ready。

另请参阅enqueue(), stop(), pause(), resume(), 和 synthesize。

[信号，自6.6起] void QTextToSpeech::sayingWord(const QString &word, qsizetype id, qsizetype start, qsizetype length)

当文本片段word在id指定的合成中，从start和length开始播放至音频设备时，将发出此信号。

此功能是在 Qt 6.6 中引入的。

另请参阅：能力 和 say。

[可调用，自6.4起] bool QTextToSpeech::setEngine(const QString &engine, const QVariantMap &params = QVariantMap())

将此QTextToSpeech对象使用的引擎设置为engine，并将params传递给引擎构造函数。

返回是否成功设置engine。

在params中哪些键值对受到支持取决于引擎。有关详细信息，请参阅引擎文档。不受支持的条目将被忽略。

此函数自Qt 6.4版本引入。

另请参阅：engine。

[槽函数] void QTextToSpeech::stop(QTextToSpeech::BoundaryHint boundaryHint = QTextToSpeech::BoundaryHint::Default)

在boundaryHint处停止当前朗读，并清除挂起的文本队列。

朗读无法继续。是否尊重boundaryHint取决于引擎。

另请参阅：say()，enqueue() 和 pause。