QTextToSpeech

The QTextToSpeech class provides a convenient access to text-to-speech engines. More…

Synopsis

Functions

• def availableLocales ()

• def availableVoices ()

• def locale ()

• def pitch ()

• def rate ()

• def state ()

• def voice ()

• def volume ()

Slots

• def pause ()

• def resume ()

• def say (text)

• def setLocale (locale)

• def setPitch (pitch)

• def setRate (rate)

• def setVoice (voice)

• def setVolume (volume)

• def stop ()

Signals

• def localeChanged (locale)

• def pitchChanged (pitch)

• def rateChanged (rate)

• def stateChanged (state)

• def voiceChanged (voice)

• def volumeChanged (volume)

• def volumeChanged (volume)

Static functions

• def availableEngines ()

Detailed Description

Use say() to start synthesizing text. It is possible to specify the language with setLocale() . To select between the available voices use setVoice() . The languages and voices depend on the available synthesizers on each platform. On Linux, speech-dispatcher is used by default.

class QTextToSpeech([parent=None])

QTextToSpeech(engine[, parent=None])

param parent

QObject

param engine

unicode

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 may be platform-specific.

If the plugin fails to load, state() returns BackendError .

See also

availableEngines()

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

If engine is empty, the default engine plug-in is used. The default engine may be platform-specific.

If the plugin fails to load, state() returns BackendError .

See also

availableEngines()

PySide2.QtTextToSpeech.QTextToSpeech.State

Constant	Description
QTextToSpeech.Ready	The synthesizer is ready to start a new text. This is also the state after a text was finished.
QTextToSpeech.Speaking	The current text is being spoken.
QTextToSpeech.Paused	The synthesis was paused and can be resumed with resume() .
QTextToSpeech.BackendError	The backend was unable to synthesize the current string.

static PySide2.QtTextToSpeech.QTextToSpeech.availableEngines()

Return type

list of strings

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

PySide2.QtTextToSpeech.QTextToSpeech.availableLocales()

Return type

Gets a vector of locales that are currently supported.

Note

On some platforms these can change, for example, when the backend changes synthesizers.

PySide2.QtTextToSpeech.QTextToSpeech.availableVoices()

Return type

Gets a vector of voices available for the current locale.

Note

if no locale has been set, the system locale is used.

PySide2.QtTextToSpeech.QTextToSpeech.locale()

Return type

QLocale

See also

setLocale()

PySide2.QtTextToSpeech.QTextToSpeech.localeChanged(locale)

Parameters

locale – QLocale

PySide2.QtTextToSpeech.QTextToSpeech.pause()

Pauses the current speech.

Note:

• This function depends on the platform and the backend. It may not work at all, it may take several seconds before it takes effect, or it may pause instantly. Some synthesizers will look for a break that they can later resume from, such as a sentence end.

• Due to Android platform limitations, stops what is presently being said, while resume() starts the previously queued sentence from the beginning.

See also

resume()

PySide2.QtTextToSpeech.QTextToSpeech.pitch()

Return type

double

See also

setPitch()

PySide2.QtTextToSpeech.QTextToSpeech.pitchChanged(pitch)

Parameters

pitch – double

PySide2.QtTextToSpeech.QTextToSpeech.rate()

Return type

double

See also

setRate()

PySide2.QtTextToSpeech.QTextToSpeech.rateChanged(rate)

Parameters

rate – double

PySide2.QtTextToSpeech.QTextToSpeech.resume()

Resume speaking after pause() has been called.

See also

pause()

PySide2.QtTextToSpeech.QTextToSpeech.say(text)

Parameters

text – unicode

Start synthesizing the text . This function will start the asynchronous reading of the text. The current state is available using the state property. Once the synthesis is done, a stateChanged() signal with the Ready state is emitted.

PySide2.QtTextToSpeech.QTextToSpeech.setLocale(locale)

Parameters

locale – QLocale

Sets the locale to a given locale if possible. The default is the system locale.

See also

locale()

PySide2.QtTextToSpeech.QTextToSpeech.setPitch(pitch)

Parameters

pitch – double

See also

pitch()

PySide2.QtTextToSpeech.QTextToSpeech.setRate(rate)

Parameters

rate – double

See also

rate()

PySide2.QtTextToSpeech.QTextToSpeech.setVoice(voice)

Parameters

voice – QVoice

Sets the voice to use.

Note

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

See also

voice()

PySide2.QtTextToSpeech.QTextToSpeech.setVolume(volume)

Parameters

volume – double

See also

volume()

PySide2.QtTextToSpeech.QTextToSpeech.state()

Return type

State

PySide2.QtTextToSpeech.QTextToSpeech.stateChanged(state)

Parameters

state – State

PySide2.QtTextToSpeech.QTextToSpeech.stop()

Stop the text that is being read.

PySide2.QtTextToSpeech.QTextToSpeech.voice()

Return type

QVoice

See also

setVoice()

PySide2.QtTextToSpeech.QTextToSpeech.voiceChanged(voice)

Parameters

voice – QVoice

PySide2.QtTextToSpeech.QTextToSpeech.volume()

Return type

double

See also

setVolume()

PySide2.QtTextToSpeech.QTextToSpeech.volumeChanged(volume)

Parameters

volume – double

PySide2.QtTextToSpeech.QTextToSpeech.volumeChanged(volume)

Parameters

volume – int