QTextToSpeechPlugin Class | Qt Speech 5.9

Qt 5.9 | Qt Speech | C++ Classes | QTextToSpeechPlugin

Qt 5.9.3 Reference Documentation

# QTextToSpeechPlugin Class

The QTextToSpeechPlugin class is the base for all text-to-speech plug-ins. More...

Header: | #include <QTextToSpeechPlugin>
qmake: | QT += texttospeech

- List of all members, including inherited members

## Public Functions

virtual | ~QTextToSpeechPlugin()
virtual QTextToSpeechEngine * | createTextToSpeechEngine(const QVariantMap &parameters, QObject *parent, QString *errorString) const

## Detailed Description

The QTextToSpeechPlugin class is the base for all text-to-speech plug-ins.

A plug-in implementation should derive from QTextToSpeechPlugin and re-implement createTextToSpeechEngine().

## Member Function Documentation

### `[virtual]` QTextToSpeechPlugin::~QTextToSpeechPlugin()

Destroys the instance of QTextToSpeechPlugin. The destructor is virtual.

### `[virtual]` QTextToSpeechEngine *QTextToSpeechPlugin::createTextToSpeechEngine(const QVariantMap &parameters, QObject *parent, QString *errorString) const

Factory method that is triggered by a call to QTextToSpeech::QTextToSpeech() when a provider name is given in the constructor and a text-to-speech plug-in matching the provider name was successfully loaded.

Value of parameters is currently always empty.

If an error occurs, the method should return 0 and (optionally) give a description of the error in errorString. In this case, QTextToSpeech::state() will return QTextToSpeech::BackendError.

If parent is 0, the caller takes the ownership of the returned engine instance.