QTextToSpeechPlugin Class

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

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

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.

© 2020 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.