1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
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 https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSOUNDEFFECT_H
41#define QSOUNDEFFECT_H
42
43#include <QtMultimedia/qtmultimediaglobal.h>
44#include <QtCore/qobject.h>
45#include <QtCore/qurl.h>
46#include <QtCore/qstringlist.h>
47
48
49QT_BEGIN_NAMESPACE
50
51
52class QSoundEffectPrivate;
53class QAudioDeviceInfo;
54
55class Q_MULTIMEDIA_EXPORT QSoundEffect : public QObject
56{
57 Q_OBJECT
58 Q_CLASSINFO("DefaultMethod", "play()")
59 Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
60 Q_PROPERTY(int loops READ loopCount WRITE setLoopCount NOTIFY loopCountChanged)
61 Q_PROPERTY(int loopsRemaining READ loopsRemaining NOTIFY loopsRemainingChanged)
62 Q_PROPERTY(qreal volume READ volume WRITE setVolume NOTIFY volumeChanged)
63 Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged)
64 Q_PROPERTY(bool playing READ isPlaying NOTIFY playingChanged)
65 Q_PROPERTY(Status status READ status NOTIFY statusChanged)
66 Q_PROPERTY(QString category READ category WRITE setCategory NOTIFY categoryChanged)
67 Q_ENUMS(Loop)
68 Q_ENUMS(Status)
69
70public:
71 enum Loop
72 {
73 Infinite = -2
74 };
75
76 enum Status
77 {
78 Null,
79 Loading,
80 Ready,
81 Error
82 };
83
84 explicit QSoundEffect(QObject *parent = nullptr);
85 explicit QSoundEffect(const QAudioDeviceInfo &audioDevice, QObject *parent = nullptr);
86 ~QSoundEffect();
87
88 static QStringList supportedMimeTypes();
89
90 QUrl source() const;
91 void setSource(const QUrl &url);
92
93 int loopCount() const;
94 int loopsRemaining() const;
95 void setLoopCount(int loopCount);
96
97 qreal volume() const;
98 void setVolume(qreal volume);
99
100 bool isMuted() const;
101 void setMuted(bool muted);
102
103 bool isLoaded() const;
104
105 bool isPlaying() const;
106 Status status() const;
107
108 QString category() const;
109 void setCategory(const QString &category);
110
111Q_SIGNALS:
112 void sourceChanged();
113 void loopCountChanged();
114 void loopsRemainingChanged();
115 void volumeChanged();
116 void mutedChanged();
117 void loadedChanged();
118 void playingChanged();
119 void statusChanged();
120 void categoryChanged();
121
122public Q_SLOTS:
123 void play();
124 void stop();
125
126private:
127 Q_DISABLE_COPY(QSoundEffect)
128 QSoundEffectPrivate *d = nullptr;
129};
130
131QT_END_NAMESPACE
132
133
134#endif // QSOUNDEFFECT_H
135

source code of qtmultimedia/src/multimedia/audio/qsoundeffect.h