<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtmultimedia-index.qdoc -->
<title>Qt Multimedia 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td >Qt Multimedia</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#getting-started">Getting Started</a></li>
<li class="level1"><a href="#qml-types-and-c-classes">QML Types and C++ Classes</a></li>
<li class="level1"><a href="#related-information">Related Information</a></li>
<li class="level2"><a href="#guides">Guides</a></li>
<li class="level2"><a href="#platform-notes">Platform Notes</a></li>
<li class="level2"><a href="#reference">Reference</a></li>
<li class="level2"><a href="#examples">Examples</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Multimedia</h1>
<span class="subtitle"></span>
<!-- $$$qtmultimedia-index.html-description -->
<div class="descr"> <a name="details"></a>
<p>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 <a href="qtaudioengine-qmlmodule.html">Qt Audio Engine</a> provides types for 3D positional audio playback and content management.</p>
<p>The functionality of this module is divided into the following submodules:</p>
<div class="table"><table class="generic">
<tr valign="top" class="odd"><td ><a href="qtmultimedia-module.html">Qt Multimedia</a></td><td >Provides API for multimedia-specific use cases.</td></tr>
<tr valign="top" class="even"><td ><a href="qtmultimediawidgets-module.html">Qt Multimedia Widgets</a></td><td >Provides the widget-based multimedia API.</td></tr>
</table></div>
<a name="getting-started"></a>
<h2 id="getting-started">Getting Started</h2>
<p>The QML types can be imported into your applciation using the following import statement in your <code>.qml</code> file.</p>
<pre class="cpp">
import <span class="type">QtMultimedia</span> <span class="number">5.8</span>
</pre>
<p>If you intend to use the C++ classes in your application, include the C++ definitions using the following directive:</p>
<pre class="cpp">
<span class="preprocessor">#include <QtMultimedia></span>
<span class="preprocessor">#include <QtMultimediaWidgets></span>
</pre>
<p><b>Note: </b>If you are using a few classes from this module, we recommend including those specific classes only instead of the module.</p><p>To link against the corresponding C++ libraries, add the following to your <code>qmake</code> project file:</p>
<pre class="cpp">
QT <span class="operator">+</span><span class="operator">=</span> multimedia multimediawidgets
</pre>
<a name="qml-types-and-c-classes"></a>
<h2 id="qml-types-and-c-classes">QML Types and C++ Classes</h2>
<p>The following is a list of important QML types and C++ classes provided by this module:</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Type</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td ><a href="qml-qtmultimedia-audio.html">Audio</a></td><td >Add audio playback functionality to a scene</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtmultimedia-playlist.html">Playlist</a></td><td >For specifying a list of media to be played.</td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtmultimedia-camera.html">Camera</a></td><td >Access camera viewfinder frames</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtmultimedia-mediaplayer.html">MediaPlayer</a></td><td >Add media playback functionality to a scene. It is same as Audio type, but can be used for video playback with the <a href="qml-qtmultimedia-videooutput.html">VideoOutput</a> type.</td></tr>
<tr valign="top" class="odd"><td ><a href="qml-qtmultimedia-radio.html">Radio</a></td><td >Access radio functionality</td></tr>
<tr valign="top" class="even"><td ><a href="qml-qtmultimedia-video.html">Video</a></td><td >Add Video playback functionality to a scene. It uses <a href="qml-qtmultimedia-mediaplayer.html">MediaPlayer</a> and <a href="qml-qtmultimedia-videooutput.html">VideoOutput</a> types to provide video playback functionality.</td></tr>
</table></div>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Class</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td ><a href="qaudiooutput.html">QAudioOutput</a></td><td >Sends audio data to an audio output device</td></tr>
<tr valign="top" class="even"><td ><a href="qaudiorecorder.html">QAudioRecorder</a></td><td >Record media content from an audio source.</td></tr>
<tr valign="top" class="odd"><td ><a href="qcamera.html">QCamera</a></td><td >Access camera viewfinder.</td></tr>
<tr valign="top" class="even"><td ><a href="qcameraimagecapture.html">QCameraImageCapture</a></td><td >Capture still images with a camera.</td></tr>
<tr valign="top" class="odd"><td ><a href="qmediarecorder.html">QMediaRecorder</a></td><td >Record media content from a camera or radio tuner source.</td></tr>
<tr valign="top" class="even"><td ><a href="qmediaplayer.html">QMediaPlayer</a></td><td >Playback media from a source.</td></tr>
<tr valign="top" class="odd"><td ><a href="qmediaplaylist.html">QMediaPlaylist</a></td><td >List of media to be played.</td></tr>
<tr valign="top" class="even"><td ><a href="qradiotuner.html">QRadioTuner</a></td><td >Access radio device.</td></tr>
<tr valign="top" class="odd"><td ><a href="qabstractvideosurface.html">QAbstractVideoSurface</a></td><td >Base class for video presentation.</td></tr>
</table></div>
<a name="related-information"></a>
<h2 id="related-information">Related Information</h2>
<a name="guides"></a>
<h3 >Guides</h3>
<ul>
<li><a href="multimediaoverview.html">Multimedia</a> - overview of multimedia support in Qt</li>
<li><a href="audiooverview.html">Audio Overview</a></li>
<li><a href="videooverview.html">Video Overview</a></li>
<li><a href="cameraoverview.html">Camera Overview</a></li>
<li><a href="radiooverview.html">Radio Overview</a></li>
</ul>
<a name="platform-notes"></a>
<h3 >Platform Notes</h3>
<p>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.</p>
<ul>
<li><a href="qtmultimedia-windows.html">Windows</a></li>
<li><a href="qtmultimedia-ios.html">iOS</a></li>
</ul>
<a name="reference"></a>
<h3 >Reference</h3>
<ul>
<li>Qt Multimedia<ul>
<li><a href="qtmultimedia-qmlmodule.html">QML Types</a></li>
<li><a href="qtmultimedia-modules.html">C++ Classes</a></li>
</ul>
</li>
</ul>
<ul>
<li>Qt Audio Engine<ul>
<li><a href="qtaudioengine-qmlmodule.html">QML Types</a></li>
</ul>
</li>
</ul>
<a name="examples"></a>
<h3 >Examples</h3>
<ul>
<li><a href="multimedia-examples.html">Qt Multimedia Examples</a></li>
</ul>
</div>
<!-- @@@qtmultimedia-index.html -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> 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. </p>
</div>
</body>
</html>
