Qt Multimedia

Qt Multimedia is an essential module that provides a rich set of QML types and C++ classes to handle multimedia content. It also provides necessary APIs to access the camera and radio functionality. The included Qt Audio Engine provides types for 3D positional audio playback and content management.

The functionality of this module is divided into the following submodules:

Qt MultimediaProvides API for multimedia-specific use cases.
Qt Multimedia WidgetsProvides the widget-based multimedia API.

Getting Started

The QML types can be imported into your applciation using the following import statement in your .qml file.

import QtMultimedia 5.12

If you intend to use the C++ classes in your application, include the C++ definitions using the following directive:

#include <QtMultimedia>
#include <QtMultimediaWidgets>

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 corresponding C++ libraries, add the following to your qmake project file:

QT += multimedia multimediawidgets

QML Types and C++ Classes

The following is a list of important QML types and C++ classes provided by this module:

TypeDescription
AudioAdd audio playback functionality to a scene
PlaylistFor specifying a list of media to be played.
CameraAccess camera viewfinder frames
MediaPlayerAdd media playback functionality to a scene. It is same as Audio type, but can be used for video playback with the VideoOutput type.
RadioAccess radio functionality
VideoAdd Video playback functionality to a scene. It uses MediaPlayer and VideoOutput types to provide video playback functionality.
ClassDescription
QAudioOutputSends audio data to an audio output device
QAudioRecorderRecord media content from an audio source.
QCameraAccess camera viewfinder.
QCameraImageCaptureCapture still images with a camera.
QMediaRecorderRecord media content from a camera or radio tuner source.
QMediaPlayerPlayback media from a source.
QMediaPlaylistList of media to be played.
QRadioTunerAccess radio device.
QAbstractVideoSurfaceBase class for video presentation.

Licenses and Attributions

The Qt Quick Multimedia module is available under commercial licenses from The Qt Company. In addition, it is available under free software licenses. Since Qt 5.4, these free software licenses are GNU Lesser General Public License, version 3, or the GNU General Public License, version 2. See Qt Licensing for further details.

Guides

Platform Notes

The Qt Multimedia Backends wiki provides a summary of features supported by each platform plugin made available by this module. The following topics provide more platform-specific information.

Reference

Examples

© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.