summaryrefslogtreecommitdiffstats
path: root/src/tts/qtexttospeechplugin.cpp
blob: 13dfa5a16519ba9405874b09dd70cec58a7b91c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Speech module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/

#include "qtexttospeechplugin.h"

QT_BEGIN_NAMESPACE

/*!
  \class QTextToSpeechPlugin
  \inmodule QtSpeech
  \brief The QTextToSpeechPlugin class is the base for all text-to-speech plug-ins.

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

/*!
  Factory method that is triggered by a call to \l 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 \a parameters is currently always empty.

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

  If \a parent is 0, the caller takes the ownership of the returned engine instance.
*/
QTextToSpeechEngine *QTextToSpeechPlugin::createTextToSpeechEngine(
        const QVariantMap &parameters,
        QObject *parent,
        QString *errorString) const
{
    Q_UNUSED(parameters)
    Q_UNUSED(parent)
    Q_UNUSED(errorString)

    return 0;
}

QT_END_NAMESPACE