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 PySide2.QtTextToSpeech.QTextToSpeech([parent=None])¶

PySide2.QtTextToSpeech.QTextToSpeech(engine[, parent=None])

param parent:

PySide2.QtCore.QObject

param engine:

str

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()

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:: PySide2.QtCore.QLocale

This property holds the current locale in use. By default, the system locale is used.

PySide2.QtTextToSpeech.QTextToSpeech.localeChanged(locale)¶

Parameters:: locale – PySide2.QtCore.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.

Table of Contents

Previous topic

Next topic

QTextToSpeech¶

Synopsis¶

Functions¶

Slots¶

Signals¶

Static functions¶

Detailed Description¶