1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the Qt Speech module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL3$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPLv3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or later as published by the Free
28 ** Software Foundation and appearing in the file LICENSE.GPL included in
29 ** the packaging of this file. Please review the following information to
30 ** ensure the GNU General Public License version 2.0 requirements will be
31 ** met: http://www.gnu.org/licenses/gpl-2.0.html.
32 **
33 ** $QT_END_LICENSE$
34 **
35 ****************************************************************************/
36 
37 #ifndef QTEXTTOSPEECHENGINE_H
38 #define QTEXTTOSPEECHENGINE_H
39 
40 #include <QtTextToSpeech/qtexttospeech.h>
41 
42 #include <QtCore/QObject>
43 #include <QtCore/QLocale>
44 #include <QtCore/QDir>
45 
46 QT_BEGIN_NAMESPACE
47 
48 class Q_TEXTTOSPEECH_EXPORT QTextToSpeechEngine : public QObject
49 {
50     Q_OBJECT
51 
52 public:
53     explicit QTextToSpeechEngine(QObject *parent = nullptr);
54     ~QTextToSpeechEngine();
55 
56     virtual QVector<QLocale> availableLocales() const = 0;
57     virtual QVector<QVoice> availableVoices() const = 0;
58 
59     virtual void say(const QString &text) = 0;
60     virtual void stop() = 0;
61     virtual void pause() = 0;
62     virtual void resume() = 0;
63 
64     virtual double rate() const = 0;
65     virtual bool setRate(double rate) = 0;
66     virtual double pitch() const = 0;
67     virtual bool setPitch(double pitch) = 0;
68     virtual QLocale locale() const = 0;
69     virtual bool setLocale(const QLocale &locale) = 0;
70     virtual double volume() const = 0;
71     virtual bool setVolume(double volume) = 0;
72     virtual QVoice voice() const = 0;
73     virtual bool setVoice(const QVoice &voice) = 0;
74     virtual QTextToSpeech::State state() const = 0;
75 
76 protected:
77     static QVoice createVoice(const QString &name, QVoice::Gender gender, QVoice::Age age, const QVariant &data);
78     static QVariant voiceData(const QVoice &voice);
79 
80 Q_SIGNALS:
81     void stateChanged(QTextToSpeech::State state);
82 };
83 
84 QT_END_NAMESPACE
85 
86 #endif
87