| 1 | // Copyright (C) 2022 The Qt Company Ltd. |
|---|
| 2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only |
|---|
| 3 | |
|---|
| 4 | #include "qtexttospeechplugin.h" |
|---|
| 5 | |
|---|
| 6 | QT_BEGIN_NAMESPACE |
|---|
| 7 | |
|---|
| 8 | /*! |
|---|
| 9 | \class QTextToSpeechPlugin |
|---|
| 10 | \inmodule QtTextToSpeech |
|---|
| 11 | \brief The QTextToSpeechPlugin class is the base for all text-to-speech plug-ins. |
|---|
| 12 | \internal |
|---|
| 13 | |
|---|
| 14 | A plug-in implementation should derive from QTextToSpeechPlugin and re-implement |
|---|
| 15 | \l createTextToSpeechEngine(). |
|---|
| 16 | */ |
|---|
| 17 | |
|---|
| 18 | /*! |
|---|
| 19 | Factory method that is triggered by a call to \l QTextToSpeech::QTextToSpeech() |
|---|
| 20 | when a provider name is given in the constructor and a text-to-speech plug-in |
|---|
| 21 | matching the provider name was successfully loaded. |
|---|
| 22 | |
|---|
| 23 | Value of \a parameters is currently always empty. |
|---|
| 24 | |
|---|
| 25 | If an error occurs, the method should return 0 and (optionally) give a description |
|---|
| 26 | of the error in \a errorString. In this case, QTextToSpeech::state() will return |
|---|
| 27 | QTextToSpeech::Error. |
|---|
| 28 | |
|---|
| 29 | If \a parent is 0, the caller takes the ownership of the returned engine instance. |
|---|
| 30 | */ |
|---|
| 31 | QTextToSpeechEngine *QTextToSpeechPlugin::createTextToSpeechEngine( |
|---|
| 32 | const QVariantMap ¶meters, |
|---|
| 33 | QObject *parent, |
|---|
| 34 | QString *errorString) const |
|---|
| 35 | { |
|---|
| 36 | Q_UNUSED(parameters); |
|---|
| 37 | Q_UNUSED(parent); |
|---|
| 38 | Q_UNUSED(errorString); |
|---|
| 39 | |
|---|
| 40 | return 0; |
|---|
| 41 | } |
|---|
| 42 | |
|---|
| 43 | QT_END_NAMESPACE |
|---|
| 44 | |
|---|
