Multimedia

Multimedia support in Qt is provided by the Qt Multimedia module. The Qt Multimedia module provides a rich feature set that enables you to easily take advantage of a platform's multimedia capabilities such as media playback and the use of camera and radio devices.

Features

Here are some examples of what can be done with Qt Multimedia APIs:

  • Access raw audio devices for input and output
  • Play low latency sound effects
  • Play media files in playlists (such as compressed audio or video files)
  • Record audio and compress it
  • Tune and listen to radio stations
  • Use a camera, including viewfinder, image capture, and movie recording
  • Play 3D positional audio with Qt Audio Engine
  • Decode audio media files into memory for processing
  • Accessing video frames or audio buffers as they are played or recorded

Multimedia Components

Qt's multimedia APIs are categorized into four main components. More information (including background information and class references) is available here:

Multimedia Recipes

For some quick recipes, look at the overviews above and consult this table:

Use caseExamplesQML TypesC++ Classes
Playing a sound effectQSoundEffect
Playing low latency audioaudioinput, spectrumQAudioOutput
Playing encoded audio (MP3, AAC etc)playerAudio, MediaPlayerQMediaPlayer
Accessing raw audio input dataspectrum, audioinputQAudioInput
Recording encoded audio dataaudiorecorderQAudioRecorder
Discovering raw audio devicesaudiodevicesQAudioDeviceInfo
Video Playbackplayer, qmlvideo, qmlvideofxMediaPlayer, VideoOutput, VideoQMediaPlayer, QVideoWidget, QGraphicsVideoItem
Video ProcessingqmlvideofxMediaPlayer, VideoOutputQMediaPlayer, QAbstractVideoSurface, QVideoFrame
Listening to the radiodeclarative-radioRadio, RadioDataQRadioTuner, QRadioData
Accessing camera viewfindercamera, declarative-cameraCamera, VideoOutputQCamera, QVideoWidget, QGraphicsVideoItem
Viewfinder processingCamera, VideoOutputQCamera, QAbstractVideoSurface, QVideoFrame
Capturing photoscamera, declarative-cameraCameraQCamera, QCameraImageCapture
Capturing moviescamera, declarative-cameraCameraQCamera, QMediaRecorder
3D sound sourcesAudio EngineAudioEngine, Sound

Limitations

The Qt Multimedia APIs build upon the multimedia framework of the underlying platform. This can mean that support for various codecs or containers can vary between machines, depending on what the end user has installed.

Advanced Usage

For developers wishing to access some platform specific settings, or to port the Qt Multimedia APIs to a new platform or technology, see Multimedia Backend Development.

Changes from Previous Versions

If you previously used Qt Multimedia in Qt 4, or used Qt Multimedia Kit in Qt Mobility, please see Changes in Qt Multimedia for more information on what changed, and what you might need to change when porting code.

Reference Documentation

QML Types

The QML types are accessed by using:

import QtMultimedia 5.8

Audio

Add audio playback to a scene

Camera

Access viewfinder frames, and take photos and movies

CameraCapture

An interface for capturing camera images

CameraExposure

An interface for exposure related camera settings

CameraFlash

An interface for flash related camera settings

CameraFocus

An interface for focus related camera settings

CameraImageProcessing

An interface for camera capture related settings

CameraRecorder

Controls video recording with the Camera

MediaPlayer

Add media playback to a scene

Playlist

For specifying a list of media to be played

PlaylistItem

Defines an item in a Playlist

QtMultimedia

Provides a global object with useful functions from Qt Multimedia

RadioData

Access RDS data from a QML application

SoundEffect

Type provides a way to play sound effects in QML

Torch

Simple control over torch functionality

Video

A convenience type for showing a specified video

VideoOutput

Render video or camera viewfinder

The following types are accessed by using Qt Audio Engine:

import QtAudioEngine 1.14

AttenuationModelInverse

Defines a non-linear attenuation curve for a Sound

AttenuationModelLinear

Defines a linear attenuation curve for a Sound

AudioCategory

Control all active sound instances by group

AudioEngine

Organize all your 3d audio content in one place

AudioListener

Control global listener parameters

AudioSample

Load audio samples, mostly .wav

PlayVariation

Define a playback variation for sounds. So each time the playback of the same sound can be a slightly different even with the same AudioSample

Sound

Define a variety of samples and parameters to be used for SoundInstance

SoundInstance

Play 3d audio content

Multimedia Classes

QAbstractAudioDeviceInfo

Base class for audio backends

QAbstractAudioInput

Access for QAudioInput to access the audio device provided by the plugin

QAbstractAudioOutput

Base class for audio backends

QAbstractPlanarVideoBuffer

Abstraction for planar video data

QAbstractVideoBuffer

Abstraction for video data

QAbstractVideoFilter

Represents a filter that is applied to the video frames received by a VideoOutput type

QAbstractVideoSurface

Base class for video presentation surfaces

QAudio

Contains enums used by the audio classes

QAudioBuffer

Represents a collection of audio samples with a specific format and sample rate

QAudioBuffer::StereoFrame

Simple wrapper for a stereo audio frame

QAudioDecoder

Allows decoding audio

QAudioDeviceInfo

Interface to query audio devices and their functionality

QAudioEncoderSettings

Set of audio encoder settings

QAudioFormat

Stores audio stream parameter information

QAudioInput

Interface for receiving audio data from an audio input device

QAudioOutput

Interface for sending audio data to an audio output device

QAudioProbe

Allows you to monitor audio being played or recorded

QAudioRecorder

Used for the recording of audio

QAudioSystemPlugin

Abstract base for audio plugins

QCamera

Interface for system camera devices

QCamera::FrameRateRange

A FrameRateRange represents a range of frame rates as minimum and maximum rate

QCameraExposure

Interface for exposure related camera settings

QCameraFocus

Interface for focus and zoom related camera settings

QCameraFocusZone

Information on zones used for autofocusing a camera

QCameraImageCapture

Used for the recording of media content

QCameraImageProcessing

Interface for image processing related camera settings

QCameraInfo

General information about camera devices

QCameraViewfinderSettings

Set of viewfinder settings

QGraphicsEffect

The base class for all graphics effects

QGraphicsVideoItem

Graphics item which display video produced by a QMediaObject

QImageEncoderSettings

Set of image encoder settings

QMediaBindableInterface

The base class for objects extending media objects functionality

QMediaContent

Access to the resource relating to a media content

QMediaControl

Base interface for media service controls

QMediaMetaData

Provides identifiers for meta-data attributes

QMediaObject

Common base for multimedia objects

QMediaPlayer

Allows the playing of a media source

QMediaPlaylist

List of media content to play

QMediaRecorder

Used for the recording of media content

QMediaService

Common base class for media service implementations

QMediaTimeInterval

Represents a time interval with integer precision

QMediaTimeRange

Represents a set of zero or more disjoint time intervals

QMultimedia

Contains miscellaneous identifiers used throughout the Qt Multimedia library

QSound

Method to play .wav sound files

QSoundEffect

Way to play low latency sound effects

QStaticText

Enables optimized drawing of text when the text and its layout is updated rarely

QVideoEncoderSettings

Set of video encoder settings

QVideoFilterRunnable

Represents the implementation of a filter that owns all graphics and computational resources, and performs the actual filtering or calculations

QVideoFrame

Represents a frame of video data

QVideoProbe

Allows you to monitor video frames being played or recorded

QVideoSurfaceFormat

Specifies the stream format of a video presentation surface

QVideoWidget

Widget which presents video produced by a media object

© 2020 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.