Qt 5.13 | Qt Multimedia

Qt 5.13.2 Reference Documentation

# 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 Multimedia | Provides API for multimedia-specific use cases.
Qt Multimedia Widgets | Provides 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.13

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:

Type | Description
--- | ---
Audio | Add audio playback functionality to a scene
Playlist | For specifying a list of media to be played.
Camera | Access camera viewfinder frames
MediaPlayer | Add media playback functionality to a scene. It is same as Audio type, but can be used for video playback with the VideoOutput type.
Radio | Access radio functionality
Video | Add Video playback functionality to a scene. It uses MediaPlayer and VideoOutput types to provide video playback functionality.

Class | Description
--- | ---
QAudioOutput | Sends audio data to an audio output device
QAudioRecorder | Record media content from an audio source.
QCamera | Access camera viewfinder.
QCameraImageCapture | Capture still images with a camera.
QMediaRecorder | Record media content from a camera or radio tuner source.
QMediaPlayer | Playback media from a source.
QMediaPlaylist | List of media to be played.
QRadioTuner | Access radio device.
QAbstractVideoSurface | Base 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.

## Related Information

### Guides

- Multimedia - overview of multimedia support in Qt
- Audio Overview
- Video Overview
- Camera Overview
- Radio Overview

### 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.

- Windows
- iOS

### Reference

- Qt Multimedia
  - QML Types
  - C++ Classes

- Qt Audio Engine
  - QML Types

### Examples

- Qt Multimedia Examples