diff options
Diffstat (limited to 'src/multimedia/qmediadevices.cpp')
| -rw-r--r-- | src/multimedia/qmediadevices.cpp | 222 |
1 files changed, 168 insertions, 54 deletions
diff --git a/src/multimedia/qmediadevices.cpp b/src/multimedia/qmediadevices.cpp index 81536b276..1d77f4de8 100644 --- a/src/multimedia/qmediadevices.cpp +++ b/src/multimedia/qmediadevices.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qmediadevices.h" #include "private/qplatformmediaintegration_p.h" @@ -53,16 +17,38 @@ QT_BEGIN_NAMESPACE \ingroup multimedia \inmodule QtMultimedia - The QMediaDevices class helps in managing the available multimedia - input and output devices. It manages three types of devices: + The QMediaDevices class provides information about the available multimedia + devices and the system defaults. It monitors the following three groups: \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. + QMediaDevices provides a separate list for each device group. If it detects that a + new device has been connected to the system or an attached device has been disconnected + from the system, it will update the corresponding device list and emit a signal + notifying about the change. + + The QMediaDevices::audioInputs and QMediaDevices::audioOutputs functions can be used + to enumerate all microphones and speakers/headsets on the system. This example first + gets a list of all connected microphones, and then prints their identifier, description, + and if it is the default device or not. + + \snippet multimedia-snippets/devices.cpp Media Audio Input Device Enumeration + + Similarly, the QMediaDevices::videoInputs will return a list of all connected cameras. + In this example we list all connected cameras and their identifier, description, and + if it is the default camera or not. + + \snippet multimedia-snippets/devices.cpp Media Video Input Device Enumeration + + QMediaDevices monitors the system defaults for each device group. It will notify about + any changes done through the system settings. For example, if the user selects a new + default audio output in the system settings, QMediaDevices will update the default audio + output accordingly and emit a signal. If the system does not provide a default for a + camera or an audio input, QMediaDevices will select the first device from the list as + the default device. While using the default input and output devices is often sufficient for playing back or recording multimedia, there is often a need to explicitly @@ -72,36 +58,125 @@ QT_BEGIN_NAMESPACE */ /*! + \qmltype MediaDevices + \since 6.2 + \instantiates QMediaDevices + \brief MediaDevices provides information about available + multimedia input and output devices. + \inqmlmodule QtMultimedia + \ingroup multimedia_qml + + The MediaDevices type provides information about the available multimedia + devices and the system defaults. It monitors the following three groups: + \list + \li Audio input devices (Microphones) + \li Audio output devices (Speakers, Headsets) + \li Video input devices (Cameras) + \endlist + + MediaDevices provides a separate list for each device group. If it detects that a + new device has been connected to the system or an attached device has been disconnected + from the system, it will update the corresponding device list and emit a signal + notifying about the change. + + MediaDevices monitors the system defaults for each device group. It will notify about + any changes done through the system settings. For example, if the user selects a new + default audio output in the system settings, MediaDevices will update the default audio + output accordingly and emit a signal. If the system does not provide a default for a + camera or an audio input, MediaDevices will select the first device from the list as + the default device. + + 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. + + For example, the snippet below will ensure that the media player always uses + the systems default audio output device for playback: + + \qml + MediaDevices { + id: devices + } + MediaPlayer { + ... + audioOutput: AudioOutput { + device: devices.defaultAudioOutput + } + } + \endqml + + \sa Camera, AudioInput, VideoOutput +*/ + +/*! + \qmlproperty list<audioDevice> QtMultimedia::MediaDevices::audioInputs + Contains a list of available audio input devices on the system. + + Those devices are usually microphones. Devices can be either built-in, or + connected through for example USB or Bluetooth. +*/ + +/*! + \property QMediaDevices::audioInputs + Returns a list of available audio input devices on the system. - Those devices are usually microphones. Devices are either built-in, or - connected to the device through USB or Bluetooth. + Those devices are usually microphones. Devices can be either built-in, or + connected through for example USB or Bluetooth. */ QList<QAudioDevice> QMediaDevices::audioInputs() { - return QPlatformMediaIntegration::instance()->devices()->audioInputs(); + return QPlatformMediaIntegration::instance()->mediaDevices()->audioInputs(); } /*! + \qmlproperty list<audioDevice> QtMultimedia::MediaDevices::audioOutputs + Contains a list of available audio output devices on the system. + + Those devices are usually loudspeakers or head sets. Devices can be either + built-in, or connected through for example USB or Bluetooth. +*/ + +/*! + \property QMediaDevices::audioOutputs + Returns a list of available audio output devices on the system. - Those devices are usually loudspeakers or head sets. Devices are either - built-in, or connected to the device through USB or Bluetooth. + Those devices are usually loudspeakers or head sets. Devices can be either + built-in, or connected through for example USB or Bluetooth. */ QList<QAudioDevice> QMediaDevices::audioOutputs() { - return QPlatformMediaIntegration::instance()->devices()->audioOutputs(); + return QPlatformMediaIntegration::instance()->mediaDevices()->audioOutputs(); } /*! + \qmlproperty list<cameraDevice> QtMultimedia::MediaDevices::videoInputs + Contains a list of cameras on the system. +*/ + +/*! + \property QMediaDevices::videoInputs + Returns a list of available cameras on the system. */ QList<QCameraDevice> QMediaDevices::videoInputs() { - return QPlatformMediaIntegration::instance()->devices()->videoInputs(); + QPlatformMediaIntegration::instance()->mediaDevices()->initVideoDevicesConnection(); + return QPlatformMediaIntegration::instance()->videoInputs(); } /*! + \qmlproperty audioDevice QtMultimedia::MediaDevices::defaultAudioInput + Returns the default audio input device. + + The default device can change during the runtime of the application. The value + of this property will automatically adjust itself to such changes. +*/ + +/*! + \property QMediaDevices::defaultAudioInput + Returns the default audio input device. The default device can change during the runtime of the application. @@ -110,6 +185,8 @@ QList<QCameraDevice> QMediaDevices::videoInputs() QAudioDevice QMediaDevices::defaultAudioInput() { const auto inputs = audioInputs(); + if (inputs.isEmpty()) + return {}; for (const auto &info : inputs) if (info.isDefault()) return info; @@ -117,6 +194,16 @@ QAudioDevice QMediaDevices::defaultAudioInput() } /*! + \qmlproperty audioDevice QtMultimedia::MediaDevices::defaultAudioOutput + Returns the default audio output device. + + The default device can change during the runtime of the application. The value + of this property will automatically adjust itself to such changes. +*/ + +/*! + \property QMediaDevices::defaultAudioOutput + Returns the default audio output device. The default device can change during the runtime of the application. The @@ -125,6 +212,8 @@ QAudioDevice QMediaDevices::defaultAudioInput() QAudioDevice QMediaDevices::defaultAudioOutput() { const auto outputs = audioOutputs(); + if (outputs.isEmpty()) + return {}; for (const auto &info : outputs) if (info.isDefault()) return info; @@ -132,9 +221,22 @@ QAudioDevice QMediaDevices::defaultAudioOutput() } /*! + \qmlproperty cameraDevice QtMultimedia::MediaDevices::defaultVideoInput Returns the default camera on the system. - /note The returned object should be checked using isNull() before being used, + \note The returned object should be checked using isNull() before being used, + in case there is no camera available. + + The default device can change during the runtime of the application. The value + of this property will automatically adjust itself to such changes. +*/ + +/*! + \property QMediaDevices::defaultVideoInput + + Returns the default camera on the system. + + \note 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 @@ -145,6 +247,8 @@ QAudioDevice QMediaDevices::defaultAudioOutput() QCameraDevice QMediaDevices::defaultVideoInput() { const auto inputs = videoInputs(); + if (inputs.isEmpty()) + return {}; for (const auto &info : inputs) if (info.isDefault()) return info; @@ -157,17 +261,27 @@ QCameraDevice QMediaDevices::defaultVideoInput() QMediaDevices::QMediaDevices(QObject *parent) : QObject(parent) { - QPlatformMediaIntegration::instance()->devices()->addDevices(this); + auto platformDevices = QPlatformMediaIntegration::instance()->mediaDevices(); + connect(platformDevices, &QPlatformMediaDevices::videoInputsChanged, this, + &QMediaDevices::videoInputsChanged); + connect(platformDevices, &QPlatformMediaDevices::audioInputsChanged, this, + &QMediaDevices::audioInputsChanged); + connect(platformDevices, &QPlatformMediaDevices::audioOutputsChanged, this, + &QMediaDevices::audioOutputsChanged); } /*! \internal */ -QMediaDevices::~QMediaDevices() +QMediaDevices::~QMediaDevices() = default; + +void QMediaDevices::connectNotify(const QMetaMethod &signal) { - QPlatformMediaIntegration::instance()->devices()->removeDevices(this); -} + if (signal == QMetaMethod::fromSignal(&QMediaDevices::videoInputsChanged)) + QPlatformMediaIntegration::instance()->mediaDevices()->initVideoDevicesConnection(); + QObject::connectNotify(signal); +} QT_END_NAMESPACE |