summaryrefslogtreecommitdiffstats
path: root/src/multimedia/qmediadevices.cpp
blob: 52ea22c9988624ce5ca98204a4f7ec27b12d5883 (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmediadevices.h"
#include "private/qplatformmediaintegration_p.h"
#include "private/qplatformmediadevices_p.h"

#include <qaudiodeviceinfo.h>
#include <qcamerainfo.h>

QT_BEGIN_NAMESPACE

class QMediaDevicesPrivate
{
public:
    ~QMediaDevicesPrivate()
    {
    }
    QPlatformMediaDevices *platformDevices() {
        if (!platform)
            platform = QPlatformMediaIntegration::instance()->devices();
        return platform;
    }

private:
    QPlatformMediaDevices *platform = nullptr;

} priv;

/*!
    \class QMediaDevices
    \brief The QMediaDevices class provides information about available
    multimedia input and output devices.
    \ingroup multimedia
    \inmodule QtMultimedia

    The QMediaDevices class helps in managing the available multimedia
    input and output devices. It manages three types of devices:
    \list
    \li Audio input devices (Microphones)
    \li Audio output devices (Speakers, Headsets)
    \li Video input devices (Cameras)
    \endlist

    QMediaDevices allows listing all available devices and will emit
    signals when the list of available devices has changed.

    While using the default input and output devices is often sufficient for
    playing back or recording multimedia, there is often a need to explicitly
    select the device to be used.

    QMediaDevices is a singleton object and all getters are thread-safe.
*/

/*!
    Returns a list of available audio input devices on the system.

    Those devices are usually microphones, either built-in, or connected to
    the device through e.g. USB or Bluetooth.
*/
QList<QAudioDeviceInfo> QMediaDevices::audioInputs()
{
    return priv.platformDevices()->audioInputs();
}

/*!
    Returns a list of available audio input devices on the system.

    Those devices are usually loudspeakers or head sets, either built-in,
    or connected to the device through e.g. USB or Bluetooth.
*/
QList<QAudioDeviceInfo> QMediaDevices::audioOutputs()
{
    return priv.platformDevices()->audioOutputs();
}

/*!
    Returns a list of available cameras on the system.
*/
QList<QCameraInfo> QMediaDevices::videoInputs()
{
    return priv.platformDevices()->videoInputs();
}

/*!
    Returns the default audio input device.

    The default device can change during the runtime of the application. The audioInputsChanged()
    signal will get emitted in that case.
*/
QAudioDeviceInfo QMediaDevices::defaultAudioInput()
{
    const auto inputs = audioInputs();
    for (const auto &info : inputs)
        if (info.isDefault())
            return info;
    return inputs.value(0);
}

/*!
    Returns the default audio output device.

    The default device can change during the runtime of the application. The audioOutputsChanged()
    signal will get emitted in that case.
*/
QAudioDeviceInfo QMediaDevices::defaultAudioOutput()
{
    const auto outputs = audioOutputs();
    for (const auto &info : outputs)
        if (info.isDefault())
            return info;
    return outputs.value(0);
}

/*!
    Returns the default camera on the system.

    The returned object should be checked using isNull() before being used, in case there is no
    default camera or no cameras at all.

    The default device can change during the runtime of the application. The videoInputsChanged()
    signal will get emitted in that case.

    \sa availableCameras()
*/
QCameraInfo QMediaDevices::defaultVideoInput()
{
    const auto inputs = videoInputs();
    for (const auto &info : inputs)
        if (info.isDefault())
            return info;
    return inputs.value(0);
}

/*!
    \internal
*/
QMediaDevices::QMediaDevices(QObject *parent)
    : QObject(parent)
{
    priv.platformDevices()->addDevices(this);
}

/*!
    \internal
*/
QMediaDevices::~QMediaDevices()
{
    priv.platformDevices()->removeDevices(this);
}


QT_END_NAMESPACE

#include "moc_qmediadevices.cpp"