QTextToSpeech 类

    connect(ui.speakButton, &QPushButton::clicked, m_speech, [this]{
        m_speech->say(ui.plainTextEdit->toPlainText());
    });
    connect(ui.stopButton, &QPushButton::clicked, m_speech, [this]{
        m_speech->stop();
    });
    connect(ui.pauseButton, &QPushButton::clicked, m_speech, [this]{
        m_speech->pause();
    });
    connect(ui.resumeButton, &QPushButton::clicked, m_speech, &QTextToSpeech::resume);
					

特性文档编制

[since 6.4] engine : QString

This property holds the engine used to synthesize text to speech.

Changing the engine stops any ongoing speech.

On most platforms, changing the engine will update the list of available locales and available voices .

该特性在 Qt 6。4 引入。

访问函数：

QString	engine () const
bool	setEngine (const QString & engine , const QVariantMap & params = QVariantMap())	[see note below]

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

通知程序信号：

void	engineChanged (const QString & engine )

[read-only, since 6.6] engineCapabilities : const Capabilities

This property holds the capabilities implemented by the current engine

This property was introduced in Qt 6.6.

访问函数：

QTextToSpeech::Capabilities

engineCapabilities () const

通知程序信号：

void	engineChanged (const QString & engine )

另请参阅 engine .

locale : QLocale

This property holds the current locale in use.

By default, the system locale is used.

On some platforms, changing the locale will update the list of available voices , and if the current voice is not available with the new locale, a new voice will be set.

访问函数：

QLocale	locale () const
void	setLocale (const QLocale & locale )

通知程序信号：

void	localeChanged (const QLocale & locale )

另请参阅 voice and findVoices ().

pitch : double

This property holds the voice pitch, ranging from -1.0 to 1.0.

The default of 0.0 is the normal speech pitch.

访问函数：

double	pitch () const
void	setPitch (double pitch )

通知程序信号：

void	pitchChanged (double pitch )

rate : double

This property holds the current voice rate, ranging from -1.0 to 1.0.

The default value of 0.0 is normal speech flow.

访问函数：

double	rate () const
void	setRate (double rate )

通知程序信号：

void	rateChanged (double rate )

[read-only] state : const State

This property holds the current state of the speech synthesizer.

void MainWindow::stateChanged(QTextToSpeech::State state)
{
    switch (state) {
    case QTextToSpeech::Speaking:
        ui.statusbar->showMessage(tr("Speech started..."));
        break;
    case QTextToSpeech::Ready:
        ui.statusbar->showMessage(tr("Speech stopped..."), 2000);
        break;
    case QTextToSpeech::Paused:
        ui.statusbar->showMessage(tr("Speech paused..."));
        break;
    default:
        ui.statusbar->showMessage(tr("Speech error!"));
        break;
    }
    ui.pauseButton->setEnabled(state == QTextToSpeech::Speaking);
    ui.resumeButton->setEnabled(state == QTextToSpeech::Paused);
    ui.stopButton->setEnabled(state == QTextToSpeech::Speaking || state == QTextToSpeech::Paused);
}
					

使用 say () to start synthesizing text with the current voice and locale .

访问函数：

QTextToSpeech::State

state () const

通知程序信号：

void	stateChanged (QTextToSpeech::State state )

voice : QVoice

This property holds the voice that will be used for the speech.

The voice needs to be one of the voices available for the engine.

On some platforms, setting the voice changes other voice attributes such as locale , pitch , and so on. These changes trigger the emission of signals.

访问函数：

QVoice	voice () const
void	setVoice (const QVoice & voice )

通知程序信号：

void	voiceChanged (const QVoice & voice )

另请参阅 findVoices ().

volume : double

This property holds the current volume, ranging from 0.0 to 1.0.

The default value is the platform's default volume.

访问函数：

double	volume () const
void	setVolume (double volume )

通知程序信号：

void	volumeChanged (double volume )

成员函数文档编制

[since 6.6] template <typename Functor> void QTextToSpeech:: synthesize (const QString & text , Functor && functor )

[since 6.6] template <typename Functor> void QTextToSpeech:: synthesize (const QString & text , const QObject * context , Functor && functor )

Synthesizes the text into raw audio data.

This function synthesizes the speech asynchronously into raw audio data. When data is available, the functor 将被调用如 functor(QAudioFormat format, QByteArray bytes) ，采用 format describing the format of the data in bytes ; or as functor(QAudioBuffer &buffer) .

The state property is set to Synthesizing when the synthesis starts, and to Ready once the synthesis is finished. While synthesizing, the functor might be called multiple times, possibly with changing values for format .

The functor can be a callable, like a lambda or free function, with an optional context 对象：

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

or a member function of the 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 is destroyed, then the functor will no longer get called.

注意： This API requires that the engine has the Synthesize 能力。

该函数在 Qt 6.6 引入。

另请参阅 say () 和 stop ().

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

Loads a text-to-speech engine from a plug-in that uses the default engine plug-in and constructs a QTextToSpeech object as the child of parent .

The default engine is platform-specific.

If the engine initializes correctly, then the state of the engine will change to QTextToSpeech::Ready ; note that this might happen asynchronously. If the plugin fails to load, then state will be set to QTextToSpeech::Error .

另请参阅 availableEngines ().

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

Loads a text-to-speech engine from a plug-in that matches parameter engine and constructs a QTextToSpeech object as the child of parent .

若 engine is empty, the default engine plug-in is used. The default engine is platform-specific.

If the engine initializes correctly, the state of the engine will be set to QTextToSpeech::Ready . If the plugin fails to load, or if the engine fails to initialize, the engine's state will be set to QTextToSpeech::Error .

另请参阅 availableEngines ().

[explicit, since 6.4] QTextToSpeech:: QTextToSpeech (const QString & engine , const QVariantMap & params , QObject * parent = nullptr)

Loads a text-to-speech engine from a plug-in that matches parameter engine and constructs a QTextToSpeech object as the child of parent , passing params through to the engine.

若 engine is empty, the default engine plug-in is used. The default engine is platform-specific. Which key/value pairs in params are supported depends on the engine. See the engine documentation for details. Unsupported entries will be ignored.

If the engine initializes correctly, the state of the engine will be set to QTextToSpeech::Ready . If the plugin fails to load, or if the engine fails to initialize, the engine's state will be set to QTextToSpeech::Error .

该函数在 Qt 6.4 引入。

另请参阅 availableEngines ().

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

销毁此 QTextToSpeech object, stopping any speech.

[signal, since 6.6] void QTextToSpeech:: aboutToSynthesize ( qsizetype id )

This signal gets emitted just before the engine starts to synthesize the speech audio for id 。 id is the value returned by a call to enqueue (), Applications can use this signal to make last-minute changes to voice attributes, or to track the process of text enqueued via enqueue ().

该函数在 Qt 6.6 引入。

另请参阅 enqueue (), synthesize ()，和 voice .

[static invokable] QStringList QTextToSpeech:: availableEngines ()

Gets the list of supported text-to-speech engine plug-ins.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

另请参阅 engine .

[invokable] QList < QLocale > QTextToSpeech:: availableLocales () const

Returns the list of locales that are supported by the active engine .

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

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

[invokable] QList < QVoice > QTextToSpeech:: availableVoices () const

Returns the list of voices available for the current locale .

注意： If no locale has been set, the system locale is used.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

另请参阅 availableLocales () 和 findVoices ().

[slot, since 6.6] qsizetype QTextToSpeech:: enqueue (const QString & utterance )

添加 utterance to the queue of texts to be spoken, and starts speaking. Returns the index of the text in the queue, or -1 in case of an error.

If the engine's state is currently Ready , utterance will be spoken immediately. Otherwise, the engine will start to speak utterance once it has finished speaking the current text.

Each time the engine proceeds to the next text entry in the queue, the aboutToSynthesize () signal gets emitted. This allows applications to keep track of the progress, and to make last-minute changes to voice attributes.

调用 stop () clears the queue. To pause the engine at the end of a text, use the Utterance boundary hint.

该函数在 Qt 6.6 引入。

另请参阅 say (), stop (), aboutToSynthesize ()，和 synthesize ().

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

This signal is emitted after an error occurred and the state has been set to QTextToSpeech::Error 。 reason parameter specifies the type of error, and the errorString provides a human-readable error description.

QTextToSpeech::ErrorReason 不是注册 Metatype (元类型)，因此，对于队列化连接而言，必须注册它采用 Q_DECLARE_METATYPE () 和 qRegisterMetaType ().

另请参阅 errorReason (), errorString ()，和 创建自定义 Qt 类型 .

[invokable] QTextToSpeech::ErrorReason QTextToSpeech:: errorReason () const

Returns the reason why the engine has reported an error.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

另请参阅 state and errorOccurred ().

[invokable] QString QTextToSpeech:: errorString () const

Returns the current engine error message.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

另请参阅 errorOccurred ().

[since 6.6] template <typename Args> QList < QVoice > QTextToSpeech:: findVoices ( Args &&... args ) const

Returns the list of voices that match the criteria in args .

The arguments in args are processed in order to assemble the list of voices that match all of them. An argument of type QString is matched against the name , of the voice, an argument of type QLocale is matched agains the voice's locale , etc. It is possible to specify only the 语言 or Territory of the desired voices, and the name can be matched against a regular expression .

This function returns all voices if the list of criteria is empty. Multiple criteria of the same type are not possible and will result in a compile-time error.

注意： 除非 args includes the current locale , this function might need to change the locale of the engine to get the list of all voices. This is engine specific, but might impact ongoing speech synthesis. It is therefore advisable to not call this function unless the state is Ready .

该函数在 Qt 6.6 引入。

另请参阅 availableVoices ().

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

Pauses the current speech at boundaryHint .

是否 boundaryHint is respected depends on the engine .

另请参阅 resume () 和 PauseResume .

[slot] void QTextToSpeech:: resume ()

Resume speaking after pause () 被调用。

注意： On Android, resuming paused speech will restart from the beginning. This is a limitation of the underlying text-to-speech engine.

另请参阅 pause ().

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

Starts speaking the text .

This function starts sythesizing the speech asynchronously, and reads the text to the default audio output device.

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

注意： All in-progress readings are stopped before beginning to read the recently synthesized text.

The current state is available using the state property, and is set to Speaking once the reading starts. When the reading is done, state will be set to Ready .

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

[signal, since 6.6] void QTextToSpeech:: sayingWord (const QString & word , qsizetype id , qsizetype start , qsizetype length )

此信号被发射当 word , which is the slice of text indicated by start and length in the utterance id , gets played to the audio device.

注意： This signal requires that the engine has the WordByWordProgress 能力。

该函数在 Qt 6.6 引入。

另请参阅 Capability and say ().

[invokable, since 6.4] bool QTextToSpeech:: setEngine (const QString & engine , const QVariantMap & params = QVariantMap())

Sets the engine used by this QTextToSpeech 对象到 engine , passing params through to the engine constructor.

返回是否 engine could be set successfully.

Which key/value pairs in params are supported depends on the engine. See the engine documentation for details. Unsupported entries will be ignored.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

注意： Setter 函数对于特性 engine .

该函数在 Qt 6.4 引入。

另请参阅 engine ().

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

Stops the current reading at boundaryHint , and clears the queue of pending texts.

The reading cannot be resumed. Whether the boundaryHint is respected depends on the engine.

另请参阅 say (), enqueue ()，和 pause ().