diff options
Diffstat (limited to 'src/multimedia/doc')
29 files changed, 440 insertions, 931 deletions
diff --git a/src/multimedia/doc/QtMultimediaDoc b/src/multimedia/doc/QtMultimediaDoc index 13b8e7229..e57c3595b 100644 --- a/src/multimedia/doc/QtMultimediaDoc +++ b/src/multimedia/doc/QtMultimediaDoc @@ -1,9 +1,2 @@ #include <QtMultimedia/QtMultimedia> #include <QtMultimediaWidgets/QtMultimediaWidgets> - -#include "../audio/qaudiosystem_p.h" -#include "../platform/qplatformaudiodecoder_p.h" -#include "../platform/qplatformcamera_p.h" -#include "../platform/qplatformmediarecorder_p.h" -#include "../platform/qplatformimagecapture_p.h" -#include "../platform/qplatformvideosink_p.h" diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf index f93091179..97e6dc696 100644 --- a/src/multimedia/doc/qtmultimedia.qdocconf +++ b/src/multimedia/doc/qtmultimedia.qdocconf @@ -1,6 +1,5 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) include($QT_INSTALL_DOCS/config/exampleurl-qtmultimedia.qdocconf) -include(../../../examples/multimedia/video/mediaplayer/doc/qmlmediaplayer.qdocconf) project = QtMultimedia description = Qt Multimedia Documentation @@ -9,6 +8,8 @@ version = $QT_VERSION moduleheader = QtMultimediaDoc includepaths += . +examplesinstallpath = multimedia + # The following parameters are for creating a qhp file, the qhelpgenerator # program can convert the qhp file into a qch file which can be opened in # Qt Assistant and/or Qt Creator. @@ -37,7 +38,7 @@ qhp.QtMultimedia.subprojects.widgetclasses.sortPages = true qhp.QtMultimedia.subprojects.qmltypes.title = QML Types qhp.QtMultimedia.subprojects.qmltypes.indexTitle = Qt Multimedia QML Types -qhp.QtMultimedia.subprojects.qmltypes.selectors = qmlclass +qhp.QtMultimedia.subprojects.qmltypes.selectors = qmltype qhp.QtMultimedia.subprojects.qmltypes.sortPages = true qhp.QtMultimedia.subprojects.examples.title = Examples @@ -45,24 +46,22 @@ qhp.QtMultimedia.subprojects.examples.indexTitle = Qt Multimedia Examples qhp.QtMultimedia.subprojects.examples.selectors = doc:example qhp.QtMultimedia.subprojects.examples.sortPages = true -exampledirs += ../../../examples \ +exampledirs += ../../../examples/multimedia \ + ../../../examples/multimediawidgets \ snippets \ ../../multimediawidgets/doc/snippets -manifestmeta.highlighted.names = "QtMultimedia/QML Media Player Example" \ - "QtMultimedia/Media Player Example" \ - "QtMultimedia/Camera Example" \ - "QtMultimedia/QML Recorder Example" \ - -headerdirs += ../.. +headerdirs += .. \ + ../../multimediawidgets \ + ../../multimediaquick imagedirs += src/images \ -sourcedirs += ../.. - -excludedirs += ../../gsttools +sourcedirs += .. \ + ../../multimediawidgets \ + ../../multimediaquick -depends += qtcore qtdoc qtgui qtquick qtqml qtwidgets qtnetwork qmake qtcmake qtquickcontrols +depends += qtcore qtdoc qtgui qtquick qtqml qtwidgets qtnetwork qmake qtcmake qtquickcontrols qtspatialaudio # Ignore \since commands for versions earlier than 6.3 ignoresince = 6.3 @@ -71,5 +70,13 @@ navigation.landingpage = "Qt Multimedia" navigation.cppclassespage = "Qt Multimedia C++ Classes" navigation.qmltypespage = "Qt Multimedia QML Types" +# Highlighted examples in Graphics & Multimedia category +manifestmeta.highlighted.names = \ + "QtMultimedia/Screen Capture Example" \ + "QtMultimedia/QML Video Recorder" + +# Highlighted examples in Mobile category +manifestmeta.highlighted.names += "QtMultimedia/QML Camera Application" + # Fail the documentation build if there are more warnings than the limit warninglimit = 0 diff --git a/src/multimedia/doc/snippets/CMakeLists.txt b/src/multimedia/doc/snippets/CMakeLists.txt index e178b6c10..c3937477b 100644 --- a/src/multimedia/doc/snippets/CMakeLists.txt +++ b/src/multimedia/doc/snippets/CMakeLists.txt @@ -1,3 +1,6 @@ +# Copyright (C) 2022 The Qt Company Ltd. +# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + cmake_minimum_required(VERSION 3.16) project(multimedia_cppsnippets) diff --git a/src/multimedia/doc/snippets/doc_src_qtmultimedia.cpp b/src/multimedia/doc/snippets/doc_src_qtmultimedia.cpp deleted file mode 100644 index a56283474..000000000 --- a/src/multimedia/doc/snippets/doc_src_qtmultimedia.cpp +++ /dev/null @@ -1,53 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2018 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:BSD$ -** 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. -** -** BSD License Usage -** Alternatively, you may use this file under the terms of the BSD license -** as follows: -** -** "Redistribution and use in source and binary forms, with or without -** modification, are permitted provided that the following conditions are -** met: -** * Redistributions of source code must retain the above copyright -** notice, this list of conditions and the following disclaimer. -** * Redistributions in binary form must reproduce the above copyright -** notice, this list of conditions and the following disclaimer in -** the documentation and/or other materials provided with the -** distribution. -** * Neither the name of The Qt Company Ltd nor the names of its -** contributors may be used to endorse or promote products derived -** from this software without specific prior written permission. -** -** -** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -//! [0] -#include <QtMultimedia> -//! [0] diff --git a/src/multimedia/doc/snippets/multimedia-snippets/audio.cpp b/src/multimedia/doc/snippets/multimedia-snippets/audio.cpp index 24045adab..565f7b29b 100644 --- a/src/multimedia/doc/snippets/multimedia-snippets/audio.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/audio.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 Mobility Components. -** -** $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 BSD-3-Clause /* Audio related snippets */ #include <QFile> @@ -87,9 +51,9 @@ void AudioInputExample::setup() } audio = new QAudioSource(format, this); - connect(audio, SIGNAL(stateChanged(QAudio::State)), this, SLOT(handleStateChanged(QAudio::State))); + connect(audio, &QAudioSource::stateChanged, this, &AudioInputExample::handleStateChanged); - QTimer::singleShot(3000, this, SLOT(stopRecording())); + QTimer::singleShot(3000, this, &AudioInputExample::stopRecording); audio->start(&destinationFile); // Records audio for 3000ms } @@ -135,6 +99,7 @@ public: public Q_SLOTS: void handleStateChanged(QAudio::State newState); + void stopAudioOutput(); private: //! [Audio output class members] @@ -156,27 +121,34 @@ void AudioOutputExample::setup() format.setChannelCount(1); format.setSampleFormat(QAudioFormat::UInt8); - QAudioDevice info(QAudioDevice::defaultOutputDevice()); + QAudioDevice info(QMediaDevices::defaultAudioOutput()); if (!info.isFormatSupported(format)) { qWarning() << "Raw audio format not supported by backend, cannot play audio."; return; } audio = new QAudioSink(format, this); - connect(audio, SIGNAL(stateChanged(QAudio::State)), this, SLOT(handleStateChanged(QAudio::State))); + connect(audio, QAudioSink::stateChanged, this, &AudioInputExample::handleStateChanged); audio->start(&sourceFile); } //! [Audio output setup] +//! [Audio output stop] +void AudioOutputExample::stopAudioOutput() +{ + audio->stop(); + sourceFile.close(); + delete audio; +} +//! [Audio output stop] + //! [Audio output state changed] void AudioOutputExample::handleStateChanged(QAudio::State newState) { switch (newState) { case QAudio::IdleState: // Finished playing (no more data) - audio->stop(); - sourceFile.close(); - delete audio; + AudioOutputExample::stopAudioOutput(); break; case QAudio::StoppedState: @@ -203,9 +175,9 @@ void AudioDeviceInfo() //! [Setting audio format] //! [Dumping audio formats] - const auto deviceInfos = QMediaDevices::availableDevices(QAudioDevice::Output); - for (const QAudioDevice &deviceInfo : deviceInfos) - qDebug() << "Device: " << deviceInfo.description(); + const auto devices = QMediaDevices::audioOutputs(); + for (const QAudioDevice &device : devices) + qDebug() << "Device: " << device.description(); //! [Dumping audio formats] } @@ -231,7 +203,7 @@ void AudioDecodingExample::decode() decoder->setAudioFormat(desiredFormat); decoder->setSource("level1.mp3"); - connect(decoder, SIGNAL(bufferReady()), this, SLOT(readBuffer())); + connect(decoder, &QAudioDecoder::bufferReady, this, &AudioDecodingExample::readBuffer); decoder->start(); // Now wait for bufferReady() signal and call decoder->read() @@ -245,9 +217,9 @@ void applyVolume(int volumeSliderValue) { // volumeSliderValue is in the range [0..100] - qreal linearVolume = QAudio::convertVolume(volumeSliderValue / qreal(100.0), - QAudio::LogarithmicVolumeScale, - QAudio::LinearVolumeScale); + qreal linearVolume = QtAudio::convertVolume(volumeSliderValue / qreal(100.0), + QtAudio::LogarithmicVolumeScale, + QtAudio::LinearVolumeScale); player.setVolume(qRound(linearVolume * 100)); } diff --git a/src/multimedia/doc/snippets/multimedia-snippets/camera.cpp b/src/multimedia/doc/snippets/multimedia-snippets/camera.cpp index 7c7b5e5a0..053af088f 100644 --- a/src/multimedia/doc/snippets/multimedia-snippets/camera.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/camera.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 Mobility Components. -** -** $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 BSD-3-Clause /* Camera snippets */ @@ -201,8 +165,6 @@ void camera_info() qDebug() << "The camera is on the front face of the hardware system."; else if (cameraDevice.position() == QCameraDevice::BackFace) qDebug() << "The camera is on the back face of the hardware system."; - - qDebug() << "The camera sensor orientation is " << cameraDevice.orientation() << " degrees."; //! [Camera info] } diff --git a/src/multimedia/doc/snippets/multimedia-snippets/devices.cpp b/src/multimedia/doc/snippets/multimedia-snippets/devices.cpp new file mode 100644 index 000000000..652400364 --- /dev/null +++ b/src/multimedia/doc/snippets/multimedia-snippets/devices.cpp @@ -0,0 +1,38 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + +#include <QAudioDevice> +#include <QCameraDevice> +#include <QMediaDevices> +#include <QString> +#include <QTextStream> + +int main(int argc, char *argv[]) +{ + Q_UNUSED(argc); + Q_UNUSED(argv); + + QTextStream out(stdout); + + //! [Media Audio Input Device Enumeration] + const QList<QAudioDevice> audioDevices = QMediaDevices::audioInputs(); + for (const QAudioDevice &device : audioDevices) + { + out << "ID: " << device.id() << Qt::endl; + out << "Description: " << device.description() << Qt::endl; + out << "Is default: " << (device.isDefault() ? "Yes" : "No") << Qt::endl; + } + //! [Media Audio Input Device Enumeration] + + //! [Media Video Input Device Enumeration] + const QList<QCameraDevice> videoDevices = QMediaDevices::videoInputs(); + for (const QCameraDevice &device : videoDevices) + { + out << "ID: " << device.id() << Qt::endl; + out << "Description: " << device.description() << Qt::endl; + out << "Is default: " << (device.isDefault() ? "Yes" : "No") << Qt::endl; + } + //! [Media Video Input Device Enumeration] + + return 0; +} diff --git a/src/multimedia/doc/snippets/multimedia-snippets/media.cpp b/src/multimedia/doc/snippets/multimedia-snippets/media.cpp index 634c5dd2b..a4b9a9fb5 100644 --- a/src/multimedia/doc/snippets/multimedia-snippets/media.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/media.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 Mobility Components. -** -** $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 BSD-3-Clause /* Media related snippets */ #include <QFile> @@ -112,7 +76,7 @@ void MediaExample::MediaPlayer() player = new QMediaPlayer; audioOutput = new QAudioOutput; player->setAudioOutput(audioOutput); - connect(player, SIGNAL(positionChanged(qint64)), this, SLOT(positionChanged(qint64))); + connect(player, &QMediaPlayer::positionChanged, this, &MediaExample::positionChanged); player->setSource(QUrl::fromLocalFile("/Users/me/Music/coolsong.mp3")); audioOutput->setVolume(50); player->play(); diff --git a/src/multimedia/doc/snippets/multimedia-snippets/multiple-videooutputs.qml b/src/multimedia/doc/snippets/multimedia-snippets/multiple-videooutputs.qml index f50c9f169..0c673cc42 100644 --- a/src/multimedia/doc/snippets/multimedia-snippets/multiple-videooutputs.qml +++ b/src/multimedia/doc/snippets/multimedia-snippets/multiple-videooutputs.qml @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2020 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) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause import QtQuick import QtQuick.Window diff --git a/src/multimedia/doc/snippets/multimedia-snippets/qsound.cpp b/src/multimedia/doc/snippets/multimedia-snippets/qsound.cpp index 246589767..644dcb228 100644 --- a/src/multimedia/doc/snippets/multimedia-snippets/qsound.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/qsound.cpp @@ -1,52 +1,5 @@ - /**************************************************************************** -** -** Copyright (C) 2017 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:BSD$ -** 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. -** -** BSD License Usage -** Alternatively, you may use this file under the terms of the BSD license -** as follows: -** -** "Redistribution and use in source and binary forms, with or without -** modification, are permitted provided that the following conditions are -** met: -** * Redistributions of source code must retain the above copyright -** notice, this list of conditions and the following disclaimer. -** * Redistributions in binary form must reproduce the above copyright -** notice, this list of conditions and the following disclaimer in -** the documentation and/or other materials provided with the -** distribution. -** * Neither the name of The Qt Company Ltd nor the names of its -** contributors may be used to endorse or promote products derived -** from this software without specific prior written permission. -** -** -** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2017 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause #include "qpushbutton.h" #include "qsoundeffect.h" diff --git a/src/multimedia/doc/snippets/multimedia-snippets/qtvideosink.qml b/src/multimedia/doc/snippets/multimedia-snippets/qtvideosink.qml index 842b3138c..eeac9c28e 100644 --- a/src/multimedia/doc/snippets/multimedia-snippets/qtvideosink.qml +++ b/src/multimedia/doc/snippets/multimedia-snippets/qtvideosink.qml @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2019 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) 2019 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause import QtQuick import QtMultimedia diff --git a/src/multimedia/doc/snippets/multimedia-snippets/soundeffect.qml b/src/multimedia/doc/snippets/multimedia-snippets/soundeffect.qml index 501443d25..e91e54e3c 100644 --- a/src/multimedia/doc/snippets/multimedia-snippets/soundeffect.qml +++ b/src/multimedia/doc/snippets/multimedia-snippets/soundeffect.qml @@ -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 BSD-3-Clause import QtQuick import QtMultimedia diff --git a/src/multimedia/doc/snippets/multimedia-snippets/video.cpp b/src/multimedia/doc/snippets/multimedia-snippets/video.cpp index ce35d6e74..8cc3b41b3 100644 --- a/src/multimedia/doc/snippets/multimedia-snippets/video.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/video.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 Mobility Components. -** -** $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 BSD-3-Clause /* Video related snippets */ #include "qvideorenderercontrol.h" diff --git a/src/multimedia/doc/src/audiooverview.qdoc b/src/multimedia/doc/src/audiooverview.qdoc index d47df5566..40a6318a6 100644 --- a/src/multimedia/doc/src/audiooverview.qdoc +++ b/src/multimedia/doc/src/audiooverview.qdoc @@ -1,47 +1,12 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt for Multimedia module 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) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page audiooverview.html \title Audio Overview \inlineimage sound-wave-small.jpg \brief Playback, recording and processing of Audio. +\ingroup explanations-graphicsandmultimedia \section1 Audio Features @@ -156,13 +121,10 @@ Here's an example of decoding a local file: \snippet multimedia-snippets/audio.cpp Local audio decoding -\section1 Examples +\section2 Spatial Audio -There are both C++ and QML examples available. - -\section2 C++ Examples - -\annotatedlist audio_examples +The \l {Qt Spatial Audio} module provides an API for implementation sound +fields in 3D space. \section1 Reference Documentation @@ -174,5 +136,8 @@ There are both C++ and QML examples available. \annotatedlist multimedia_audio_qml +\section2 Examples + +\annotatedlist audio_examples */ diff --git a/src/multimedia/doc/src/cameraoverview.qdoc b/src/multimedia/doc/src/cameraoverview.qdoc index 8753d86e0..b93954d6d 100644 --- a/src/multimedia/doc/src/cameraoverview.qdoc +++ b/src/multimedia/doc/src/cameraoverview.qdoc @@ -1,46 +1,11 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt for Multimedia module 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) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page cameraoverview.html \title Camera Overview \brief Camera viewfinder, still image capture, and video recording. +\ingroup explanations-graphicsandmultimedia The Qt Multimedia API provides a number of camera related classes, so you can access images and videos from mobile device cameras or web cameras. diff --git a/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc b/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc index f531e613a..34f7df319 100644 --- a/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc +++ b/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc @@ -2,7 +2,7 @@ The QML painting rate is calculated by the FrequencyMonitor class, which turns a stream of events (received via the notify() slot), into an instantaneous and an averaged frequency: -\quotefromfile multimedia/video/qmlvideo/frequencymonitor.h +\quotefromfile video/qmlvideo/frequencymonitor.h \skipto class FrequencyMonitor : public QObject \printuntil Q_OBJECT \skipto Q_PROPERTY(qreal instantaneousFrequency @@ -19,13 +19,13 @@ instantaneous and an averaged frequency: The FrequencyMonitor class is exposed to QML like this -\quotefromfile multimedia/video/qmlvideo/frequencymonitordeclarative.cpp +\quotefromfile video/qmlvideo/frequencymonitordeclarative.cpp \skipto FrequencyMonitor::qmlRegisterType \printuntil } and its data is displayed by defining a QML item called FrequencyItem, like this: -\quotefromfile multimedia/video/qmlvideo/qml/frequencymonitor/FrequencyItem.qml +\quotefromfile video/qmlvideo/frequencymonitor/FrequencyItem.qml \skipto import FrequencyMonitor \printuntil id: root \dots diff --git a/src/multimedia/doc/src/images/camera_correctionAngle_90.png b/src/multimedia/doc/src/images/camera_correctionAngle_90.png Binary files differnew file mode 100644 index 000000000..7a3c169a5 --- /dev/null +++ b/src/multimedia/doc/src/images/camera_correctionAngle_90.png diff --git a/src/multimedia/doc/src/multimedia-overview.qdoc b/src/multimedia/doc/src/multimedia-overview.qdoc index 2d6cebaec..6da54a7e2 100644 --- a/src/multimedia/doc/src/multimedia-overview.qdoc +++ b/src/multimedia/doc/src/multimedia-overview.qdoc @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt for Multimedia module 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) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only @@ -43,6 +7,7 @@ \page multimediaoverview.html \title Multimedia Overview \brief A set of APIs for working with audio, video and camera devices. +\ingroup explanations-graphicsandmultimedia Multimedia support in Qt is provided by the \l{Qt Multimedia} module. The Qt Multimedia module provides a rich feature set that enables you to easily take @@ -56,6 +21,7 @@ Here are some things you can do with the Qt Multimedia APIs: \list \li Access raw audio devices for input and output. \li Play low latency sound effects. +\li Play 3D spatial audio. \li Play media files in playlists (such as compressed audio or video files). \li Record audio and compress it. \li Use a camera, including viewfinder, image capture, and movie recording @@ -72,7 +38,7 @@ can also take a look at some \l{Multimedia Recipes}{recipes}. \li \l {Audio Overview} \li \l {Video Overview} \li \l {Camera Overview} -\li \l {Spatial Audio Overview} +\li \l {Spatial Audio Overview} (Technology Preview) \endlist \section1 Multimedia Recipes @@ -91,13 +57,18 @@ For some quick recipes, see this table: \li \l{SoundEffect} \li QSoundEffect \row + \li Playing 3D sound + \li \l{Spatial Audio Panning Example}{audiopanning} + \li SpatialSound, AudioEngine + \li QSpatialSound, QAudioEngine + \row \li Playing encoded audio (MP3, AAC etc) \li \l{Media Player Example}{player} \li \l{MediaPlayer} \li QMediaPlayer \row \li Playing raw audio data with low latency - \li \l{Audio Output Example}{audiooutput}, + \li \l{Audio Output Example}{audiooutput} \li \li QAudioSink \row @@ -125,26 +96,21 @@ For some quick recipes, see this table: \row \li Capturing audio and video \li \l {Camera Example}{camera}, - \l {QML Recorder Example}{recorder} + \l {QML Video Recorder}{recorder} \li \l CaptureSession, \l Camera, \l AudioInput \l VideoOutput \li QMediaCaptureSession, QCamera, QAudioInput, QVideoWidget \row \li Capturing photos \li \l {Camera Example}{camera}, - \l {QML Recorder Example}{recorder} + \l {QML Video Recorder}{recorder} \li \l CaptureSession, \l Camera, \l ImageCapture \li QMediaCaptureSession, QCamera, QImageCapture \row \li Capturing movies \li \l {Camera Example}{camera}, - \l {QML Recorder Example}{recorder} + \l {QML Video Recorder}{recorder} \li \l CaptureSession, \l Camera, \l MediaRecorder \li QMediaCaptureSession, QCamera, QMediaRecorder - \row - \li Spatial Audio - \li \l {Spatial Audio example}{spatialaudio}, - \li \l SpatialAudioEngine, \l SpatialAudioListener, \l SpatialAudioSoundSource - \li QSpatialAudioEngine, QSpatialAudioListener, QSpatialAudioSoundSource \endtable \section1 Limitations @@ -154,6 +120,13 @@ platform. This can mean that support for various codecs, or containers will vary between machines. This support depends on what the end user has installed. See \l{Supported Media Formats} for more detail. +\note Qt Multimedia APIs depend on functionality provided by QCoreApplication, +and multimedia objects created using the Qt Multimedia APIs can only be used +during the lifetime of this application object. It is therefore important to +create a QCoreApplication, QGuiApplication, or QApplication before accessing +any of the Qt Multimedia APIs. If the application object is recreated, make +sure that any Qt Multimedia objects are also recreated. + \section1 Changes from Previous Versions If you previously used Qt Multimedia in Qt 5, see @@ -162,14 +135,8 @@ you might need to change when porting code to Qt 6. \section1 Reference Documentation -\section2 QML Types -The QML types are accessed by using: -\code -import QtMultimedia -\endcode - -\section2 Multimedia Classes - -\annotatedlist multimedia - +\list + \li \l{Qt Multimedia C++ Classes}{C++ Classes} + \li \l{Qt Multimedia QML Types}{QML Types} +\endlist */ diff --git a/src/multimedia/doc/src/platform-notes-apple.qdoc b/src/multimedia/doc/src/platform-notes-apple.qdoc index bd8636ee4..a9bca07c2 100644 --- a/src/multimedia/doc/src/platform-notes-apple.qdoc +++ b/src/multimedia/doc/src/platform-notes-apple.qdoc @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the FOO module 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) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page qtmultimedia-apple.html diff --git a/src/multimedia/doc/src/platform-notes-wasm.qdoc b/src/multimedia/doc/src/platform-notes-wasm.qdoc new file mode 100644 index 000000000..d1a942c9f --- /dev/null +++ b/src/multimedia/doc/src/platform-notes-wasm.qdoc @@ -0,0 +1,35 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! +\page qtmultimedia-wasm.html +\title Qt Multimedia on WebAssembly +\brief Platform notes for WebAssembly + +This page covers the availability of Qt Multimedia features on WebAssembly. + +\section1 Limitations + +Due to the asynchronous nature of javascript, some features such as getting the list of +QMediaDevices, will not be readily available and may take some time to request permissions and +gather the list of devices. The audioInputsChanged, audioOutputsChanged and +videoInputChanged signals from QMediaDevices class will be emitted when they are available. + +Playing video currently works by using a html 2d context, so all operations are on the CPU. + +Performance is acceptable, although there is a copy on every frame, so it may be +less performant than desktop platforms when playing hi-def video. + +Using and selecting different Codecs/video formats have not yet been tested, but whatever +video formats the browser supports will most likely work. + +Playing data from a stream (using \c {setSourceDevice(QIODevice*)}), instead +of fetching a URL, isn't supported. + +Some advanced features may or may not work at this time. + +Files can be served from the/any web server, respective +of \l{https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS}{CORS}. Because of +the limited size of local file storage, playing local files is discouraged. + + */ diff --git a/src/multimedia/doc/src/qm-external-pages.qdoc b/src/multimedia/doc/src/qm-external-pages.qdoc index dcd5e9138..8a28780c0 100644 --- a/src/multimedia/doc/src/qm-external-pages.qdoc +++ b/src/multimedia/doc/src/qm-external-pages.qdoc @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the FOO module 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) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \externalpage https://gstreamer.freedesktop.org @@ -228,7 +192,7 @@ /*! \externalpage https://en.wikipedia.org/wiki/Motion_JPEG - \title Motion JPEG + \title MotionJPEG */ /*! diff --git a/src/multimedia/doc/src/qt6-changes.qdoc b/src/multimedia/doc/src/qt6-changes.qdoc index dd37a1355..ad5ebab74 100644 --- a/src/multimedia/doc/src/qt6-changes.qdoc +++ b/src/multimedia/doc/src/qt6-changes.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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 Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page qtmultimedia-changes-qt6.html diff --git a/src/multimedia/doc/src/qtmultimedia-building-from-source.qdoc b/src/multimedia/doc/src/qtmultimedia-building-from-source.qdoc new file mode 100644 index 000000000..df434c699 --- /dev/null +++ b/src/multimedia/doc/src/qtmultimedia-building-from-source.qdoc @@ -0,0 +1,94 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! +\page qtmultimedia-building-from-source.html +\title Building Qt Multimedia from sources +\brief This document describes how to build Qt Multimedia with full +feature support from source code. + +This page describes the process of configuring and building \l{Qt +Multimedia}. This description assumes familiarity with \l{Building Qt +Sources} which specifies build requirements for your platform, as well +as an overview of \l{Qt Configure Options}. For platform-specific +considerations related to the Qt Multimedia module, see \l{Platform +Notes} below. + +\section1 Building from source + +Building Qt Multimedia with full feature support depends on \l +{https://ffmpeg.org/}{FFmpeg} headers and libraries on most platforms. +It is possible to build Qt Multimedia without the Qt Multimedia FFmpeg +media backend, but this is only recommended when building for platforms +where the FFmpeg backend is not supported. + +FFmpeg developer libraries required to build Qt Multimedia can be built +from sources or downloaded as binary packages. Qt Multimedia can use +either static linking or dynamic linking to FFmpeg libraries. We +recommend using the same major version of FFmpeg that is listed in +\l{FFmpeg as the default backend}. + +To build Qt Multimedia with FFmpeg support, specify the \c{-DFFMPEG_DIR} +CMake variable on the configure command line when building Qt. Note the +\c{--} separator which separates ordinary configure arguments from CMake +parameters. + +\badcode +qt-source/configure -- -DFFMPEG_DIR=<FFMPEG_DIR> +\endcode + +Here, \c{<FFMPEG_DIR>} is the directory containing the FFmpeg include, +lib, and bin directories. To build Qt Multimedia without FFmpeg, omit +the \c{<FFMPEG_DIR>} variable or specify the \c{-no-feature-ffmpeg} +configure option. + +If you prefer not to build all Qt's submodules, you can reduce configure +and build times using the \c{-submodules} configure option. This will +configure a build that only builds Qt Multimedia and its dependencies. + +\badcode +qt-source/configure -submodules qtmultimedia -- -DFFMPEG_DIR=<FFMPEG_DIR> +\endcode + +If you configure Qt Multimedia against FFmpeg built with shared +libraries (dynamic linking), the FFmpeg shared libraries must be in the +module loader's search path to run tests or use examples. + +\note Qt Multimedia requires the FFmpeg avformat, avcodec, swresample, +swscale, and avutil libraries during runtime to be able to use the +FFmpeg media backend. If one or more of these dynamic libraries are not +found during application startup, the FFmpeg media backend will fail to +load, and the system will attempt to load the native backend. Qt +Multimedia doesn't support as many features on native backends. + +If you don't already have these libraries in the \c{path}, specify the +\c{-DQT_DEPLOY_FFMPEG=ON} configure option. With this option enabled, +the necessary FFmpeg binaries will be copied to Qt's install directory +during the build and install steps: + +\badcode +qt-source/configure -submodules qtmultimedia -- -DFFMPEG_DIR=<FFMPEG_DIR> -DQT_DEPLOY_FFMPEG=ON +\endcode + +After configuring Qt Multimedia, carefully review the configure summary +(found in the config.summary file). You can verify that FFmpeg is found +under the "Plugin" section. Then follow the regular build and install +steps described in \l{Building Qt Sources}. + +\section1 Platform Notes + +\section2 Linux + +\list + \li When configuring Qt Multimedia with FFmpeg enabled, the + pulseaudio development package is required. Without this + package, FFmpeg will not be recognized. + \li When using a version of FFmpeg that is built with VAAPI support, + we recommend building Qt Multimedia with VAAPI support as well + to make hardware texture conversion possible. To configure Qt + Multimedia with VAAPI support, VAAPI developer libraries must be + installed on your system. Review the config.summary file to + verify that VAAPI support is enabled under the "Hardware + acceleration and features" section. +\endlist +*/ diff --git a/src/multimedia/doc/src/qtmultimedia-cpp.qdoc b/src/multimedia/doc/src/qtmultimedia-cpp.qdoc index 01d5579af..b0c4ea732 100644 --- a/src/multimedia/doc/src/qtmultimedia-cpp.qdoc +++ b/src/multimedia/doc/src/qtmultimedia-cpp.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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 Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2015 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \module QtMultimedia @@ -35,13 +11,11 @@ \brief The \l {Qt Multimedia} module provides audio, video and camera functionality. - To enable Qt Multimedia in a project, add this directive into your - C++ files: - - \snippet doc_src_qtmultimedia.cpp 0 - \include module-use.qdocinc using qt module - \snippet ../src/multimedia/doc/snippets/CMakeLists.txt 0 + \code + find_package(Qt6 REQUIRED COMPONENTS Multimedia) + target_link_libraries(mytarget PRIVATE Qt6::Multimedia) + \endcode */ /*! @@ -65,4 +39,7 @@ \section2 Qt Multimedia Widgets Module \generatelist {classesbymodule QtMultimediaWidgets} + + \section2 Qt Spatial Audio Module + \generatelist {classesbymodule QtSpatialAudio} */ diff --git a/src/multimedia/doc/src/qtmultimedia-examples.qdoc b/src/multimedia/doc/src/qtmultimedia-examples.qdoc index 40e69efbd..e53eed32f 100644 --- a/src/multimedia/doc/src/qtmultimedia-examples.qdoc +++ b/src/multimedia/doc/src/qtmultimedia-examples.qdoc @@ -1,33 +1,8 @@ -/**************************************************************************** -** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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 Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2015 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \group multimedia_examples - \ingroup all-examples \title Qt Multimedia Examples \brief Demonstrates the multimedia functionality provided by Qt. diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc index 74db2036e..74646b84c 100644 --- a/src/multimedia/doc/src/qtmultimedia-index.qdoc +++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt for Multimedia module 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) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page qtmultimedia-index.html @@ -47,7 +11,7 @@ Qt Multimedia is an add-on module that provides a rich set of QML types and C++ classes to handle multimedia content. It contains an easy to use API for playing back audio and video files and rendering those on screen, as - well as a comprehensive API for recording audio and video from the systems + well as a comprehensive API for recording audio and video from the system's cameras and microphones. The functionality of this module is divided into the following submodules: @@ -55,10 +19,13 @@ \table \row \li \l{Multimedia Overview}{Qt Multimedia} - \li Provides API for multimedia-specific use cases. + \li Provides an API for multimedia-specific use cases. \row \li \l{Qt Multimedia Widgets} - \li Provides the widget-based multimedia API. + \li Provides a widget-based multimedia API. + \row + \li \l{Qt Spatial Audio} + \li Provides an API for implementing sound fields in 3D space. \endtable \section1 Getting started @@ -72,17 +39,6 @@ import QtMultimedia \endqml - If you want to use the C++ classes in your application, include the C++ - definitions using the following directive: - - \code - #include <QtMultimedia> - #include <QtMultimediaWidgets> - \endcode - - \note If you are using a few classes from this module, we recommend - including those specific classes only instead of the module. - To link against the C++ libraries, add the following to your project's \c CMakeLists.txt file. Substitute \c my_project with the name of your project. @@ -92,18 +48,22 @@ target_link_libraries(my_project PRIVATE Qt6::Multimedia) \endcode - \section1 Overviews and Important Topics + See \l {Building Qt Multimedia from sources} for guidance on building + Qt Multimedia from sources. + + \section1 Overviews and important topics \list \li \l{Changes to Qt Multimedia}{Changes in Qt 6} \li \l{Multimedia Overview} \li \l{Audio Overview} + \li \l{Spatial Audio Overview} \li \l{Video Overview} \li \l{Camera Overview} \li \l{Supported Media Formats} \endlist - \section1 QML Types + \section1 QML types The following table outlines some important QML types. @@ -139,11 +99,17 @@ \li \l {QtMultimedia::Video}{Video} \li Add Video playback functionality to a scene. Uses MediaPlayer and VideoOutput types to provide video playback functionality. + \row + \li \l {QtMultimedia::ScreenCapture}{ScreenCapture} + \li Captures a screen. + \row + \li \l {QtMultimedia::WindowCapture}{WindowCapture} + \li Captures a top-level window. \endtable - \section1 C++ Classes + \section1 C++ classes - The following table outlines some important C++ Classes + The following table outlines some important C++ classes \table \header @@ -179,13 +145,19 @@ \row \li QAudioSink \li Sends raw audio data to an audio output device. + \row + \li QScreenCapture + \li Captures a screen. + \row + \li QWindowCapture + \li Captures a top-level window. \endtable For playback QMediaPlayer, QAudioOutput and QVideoOutput contain all the required functionality. The other classes are used for capturing audio and video content, where the QMediaCaptureSession is the central class managing the whole capture/recording process. - \section1 Licenses and Attributions + \section1 Licenses and attributions The Qt Multimedia module is available under commercial licenses from \l{The Qt Company}. @@ -195,31 +167,119 @@ the \l{GNU General Public License, version 2}. See \l{Qt Licensing} for further details. - Furthermore, Qt Multimedia in Qt \QtVersion may contain third party - modules under the following permissive licenses: + Furthermore, Qt Multimedia in Qt \QtVersion may contain third-party modules + under following permissive licenses: \generatelist{groupsbymodule attributions-qtmultimedia} - \section1 Platform Notes + Note that video compression standards, such as the H.264 media compression + standard, may be covered by patents and can incur royalty fees. This can + apply to any implementation, also if the implementation is provided as an + operating system service, through a third party library, or through any of + Qt Multimedia's backends. Such fees are not covered by the Qt licenses. + + \section1 Target platform and backend notes + We aim to align the behavior on all the platforms but there are some issues + to consider. + + \section2 Backends + On most platforms, there are two different backends that can be used for + Qt Multimedia. + + \section3 FFmpeg as the default backend + In this release the \l {http://ffmpeg.org}{FFmpeg framework} is set as the + default backend on Windows, macOS, Android, and Linux except Yocto distribution. - For most features, Qt Multimedia builds upon the multimedia framework of the - underlying operating system. Therefore there are several multimedia back ends - based on different technologies and APIs. + The version shipped with Qt binary packages is \b{FFmpeg 6.1.1} and is tested + by the maintainers. - While we try to support our full API on all platforms, platform specific limitations do - exist in a few places. This is due to the fact that the feature set supported by those - frameworks varies, implying that some functionality - might not be available on all platforms. This is especially true for the set of - supported file formats and codecs, as well as advanced camera functionality. + \note On the Windows and macOS platforms, Qt's FFmpeg media backend + uses dynamic linking to the FFmpeg libraries. Windows and macOS + applications must therefore bundle FFmpeg binaries in their + installer, and make them visible to the application at runtime. On + Windows, we recommend to store the FFmpeg dlls in the same directory + as the application's executable file, because this guarantees that + the correct build of FFmpeg is being used if multiple versions are + available on the system. All necessary FFmpeg libraries are shipped + with the Qt Online Installer and are automatically deployed if the + windeployqt or macdeployqt tools are used to create the deployment. + Applications can also deploy their own build of FFmpeg, as long as + the FFmpeg major version matches the version used by Qt. - Where limitations exist, we aim to document those in the respective classes and - methods. + \note See \l{Licenses and Attributions} regarding what components are removed + in the package shipped by Qt. + + \section3 Native backends + These are: + \list + \li gstreamer on Linux + \li AVFoundation on macOS and iOS + \li WMF Windows + \li MediaCodec framework on Android + \endlist + + \note These are still available but with \b limited support. The gstreamer + backend is only available on Linux. + \note MediaCodec on Android is deprecated as of Qt 6.8 and will be removed + in Qt 7.0. + + \section2 Backend support + Maintainers will strive to fix critical issues with the native backends but + don't guarantee fixing minor issues and won't implement new features for the + native backends. Furthermore, even some major issues with the gstreamer + backend (on Linux) won't be fixed since gstreamer is difficult to debug and + is further complicated as it is dependent on Linux distributions. + + We aim to align the behavior on all the platforms, especially, with the + FFmpeg backend. Despite this fact we still have platform-dependent issues + with formats, codecs, advanced camera features, and screen capturing due to + the Qt Multimedia API relying on target platform APIs. For example, with FFmpeg, + there are specific problems with hardware acceleration on Linux targets with + ARM architectures. + + Backend-dependent limitations will be documented and their status maintained + in the respective classes. + + \section2 Changing backends + + In the case of issues with the default FFmpeg backend, we suggest testing with a native backend. + You can switch to native backends by setting the \c{QT_MEDIA_BACKEND} environment variable + to \c windows, \c gstreamer (on Linux), \c darwin (on macOS and iOS), or \c android: + + \code + export QT_MEDIA_BACKEND=darwin + \endcode + + In order to force assign FFmpeg as the used backend, set the variable to \c ffmpeg: + + \code + export QT_MEDIA_BACKEND=ffmpeg + \endcode + + On the Qt Multimedia compilation stage the default media backend can be configured + via cmake variable \c{QT_DEFAULT_MEDIA_BACKEND}. + + \section2 Target platform notes + The following pages list issues for specific target platforms that are not + related to the multimedia backed. \list \li \l{Qt Multimedia on macOS and iOS}{macOS and iOS} + \li \l{Qt Multimedia on WebAssembly}{WebAssembly} \endlist - \section1 Reference and Examples + \section1 Permissions + + Starting from Qt 6.6, the Qt Multimedia module uses new \l QPermission API + to handle \l {QCameraPermission}{camera} and + \l {QMicrophonePermission}{microphone} permissions. This means that Qt + itself no longer queries for these permissions, so this needs to be done + directly from the client application. + + Please refer to the \l {Application Permissions} page for an example of how + to integrate the new \l QPermission API into the application. + + \section1 Reference and examples \list \li \l{Qt Multimedia QML Types}{QML Types} \li \l{Qt Multimedia C++ Classes}{C++ Classes} diff --git a/src/multimedia/doc/src/qtmultimedia-qml-types.qdoc b/src/multimedia/doc/src/qtmultimedia-qml-types.qdoc index 16e0e581b..0d61a8917 100644 --- a/src/multimedia/doc/src/qtmultimedia-qml-types.qdoc +++ b/src/multimedia/doc/src/qtmultimedia-qml-types.qdoc @@ -1,32 +1,9 @@ -/**************************************************************************** -** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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 Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2015 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \qmlmodule QtMultimedia +\noautolist \title Qt Multimedia QML Types \ingroup qmlmodules \brief Provides QML types for multimedia support. @@ -44,11 +21,25 @@ The QML types for \l{Qt Multimedia} support the basic use cases such as: Qt Multimedia QML types can be imported into your application using the following import statement in your .qml file: -\qml \QtMinorVersion +\qml import QtMultimedia \endqml \generatelist qmltypesbymodule QtMultimedia -\noautolist +The \QtMultimedia import provides also the following +\l [QtQml]{QML Value Types}{value types}: + +\generatelist qmlvaluetypesbymodule QtMultimedia + +\section2 Qt Spatial Audio Module + +Qt Spatial Audio QML types can be imported into your application using the +following import statement in your .qml file: + +\qml +import QtQuick3D.SpatialAudio +\endqml + +\generatelist qmltypesbymodule QtQuick3D.SpatialAudio */ diff --git a/src/multimedia/doc/src/spatialaudiooverview.qdoc b/src/multimedia/doc/src/spatialaudiooverview.qdoc deleted file mode 100644 index 1502829f2..000000000 --- a/src/multimedia/doc/src/spatialaudiooverview.qdoc +++ /dev/null @@ -1,96 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2022 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt for Multimedia module 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$ -** -****************************************************************************/ - -/*! -\page spatialaudiooverview.html -\title Spatial Audio Overview -\brief Support for spatial audio. - -The Qt Multimedia API provides a number of classes that allow the creation of -three dimensional sound scene. It is defined by objects located in 3D space -that emit sound and surrounding geometry that can be modelled using -one or several rooms. Finally a listener can be placed into this -sound scene at a specified position and orientation. - -There are both C++ and QML APIs that can be used. - -\section1 Creating a sound scene - -To create the sound scene, one first instantiates a \l QSpatialAudioEngine. This engine -processes input sound data and geometries to create a realistic -representation of the sound scene as it would be experienced by a person placed -at a specific location inside the scene. - -The \l QSpatialAudioEngine::OutputMode property can be used to optimize the output either -for headphones using binaural (virtual 3D) rendering or for a stereo or surround speaker -configuration. - -The output device can be selected using \l QSpatialAudioEngine::outputDevice property. - -Once the engine is set up, we can place various sound objects into the scene by creating -\l QSpatialAudioSoundSource objects and specifying a url to a sound file using the \l -QSpatialAudioSoundSource::source property. - -\l QSpatialAudioListener can be used to define the position and orientation of a person -listening to the sound scene. At max one listener per engine can be used. If no listener -is specified, the engine assumes that the listener is at the origin of the coordinate system -facing into a positive z direction, with positive y pointing upwards. - -In addition to sound sources and a listener, you can define a geometry that influences how the -sound is being experienced by the listener through a set of \l QSpatialAudioRoom objects. Rooms -are rectangular and support a wide variety of materials for each wall giving a different experience -with different sound reflections and reverb. Room effects will get applied if the listener is -located inside one of the rooms. If he is inside multiple rooms, the room with the smallest -geometrical volume will take precedence. - -If you need some stereo overlay that is independent of the position and orientation of -the listener (such as background music or a voice-over), you can use -\l QSpatialAudioStereoSource to create the sound overlay. - -\section1 Reference Documentation - -\section2 C++ Classes - -\annotatedlist multimedia_spatialaudio - -\section2 QML Types - -\annotatedlist quick3d_spatialaudio - -*/ diff --git a/src/multimedia/doc/src/videooverview.qdoc b/src/multimedia/doc/src/videooverview.qdoc index 2988c6e7f..3185c9a02 100644 --- a/src/multimedia/doc/src/videooverview.qdoc +++ b/src/multimedia/doc/src/videooverview.qdoc @@ -1,35 +1,12 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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 Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page videooverview.html \title Video Overview \brief Video playback +\ingroup explanations-graphicsandmultimedia \section1 Video Features |
