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
41#ifndef QAUDIO_H
42#define QAUDIO_H
43
44#include <QtMultimedia/qtmultimediaglobal.h>
45#include <QtMultimedia/qmultimedia.h>
46
47#include <QtCore/qmetatype.h>
48
49QT_BEGIN_NAMESPACE
50
51//QTM_SYNC_HEADER_EXPORT QAudio
52
53// Class forward declaration required for QDoc bug
54class QString;
55namespace QAudio
56{
57 enum Error { NoError, OpenError, IOError, UnderrunError, FatalError };
58 enum State { ActiveState, SuspendedState, StoppedState, IdleState, InterruptedState };
59 enum Mode { AudioInput, AudioOutput };
60
61 enum Role {
62 UnknownRole,
63 MusicRole,
64 VideoRole,
65 VoiceCommunicationRole,
66 AlarmRole,
67 NotificationRole,
68 RingtoneRole,
69 AccessibilityRole,
70 SonificationRole,
71 GameRole,
72 CustomRole
73 };
74
75 enum VolumeScale {
76 LinearVolumeScale,
77 CubicVolumeScale,
78 LogarithmicVolumeScale,
79 DecibelVolumeScale
80 };
81
82 Q_MULTIMEDIA_EXPORT qreal convertVolume(qreal volume, VolumeScale from, VolumeScale to);
83}
84
85#ifndef QT_NO_DEBUG_STREAM
86Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QAudio::Error error);
87Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QAudio::State state);
88Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QAudio::Mode mode);
89Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QAudio::Role role);
90Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QAudio::VolumeScale role);
91#endif
92
93QT_END_NAMESPACE
94
95Q_DECLARE_METATYPE(QAudio::Error)
96Q_DECLARE_METATYPE(QAudio::State)
97Q_DECLARE_METATYPE(QAudio::Mode)
98Q_DECLARE_METATYPE(QAudio::Role)
99Q_DECLARE_METATYPE(QAudio::VolumeScale)
100
101#endif // QAUDIO_H
102