diff options
Diffstat (limited to 'src/multimedia/doc/src/multimedia-overview.qdoc')
| -rw-r--r-- | src/multimedia/doc/src/multimedia-overview.qdoc | 83 |
1 files changed, 25 insertions, 58 deletions
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 */ |