summaryrefslogtreecommitdiff
path: root/doc/src/multimedia.qdoc
blob: 3f6aeeb12bf5404c8bb291dfd61de3914e59ca0f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!

\page multimediaoverview.html
\title Multimedia Overview
\brief A set of APIs for working with audio, video, radio and camera devices.

\section1 Multimedia Features

Qt Multimedia offers APIs for doing many multimedia related tasks:

\list
\o Accessing raw audio devices for input and output
\o Play low latency sound effects
\o Play media files in playlists (like compressed audio, or video files)
\o Record audio and compress it
\o Tune and listen to radio stations, and receive radio program information
\o Use a camera, including viewfinder, image capture, and movie recording
\endlist

\section1 Multimedia Components

All of these tasks can be broadly broken down into four main areas.  More information
(including background information and class references) are available here:

\list
\o \l {Audio Overview}
\o \l {Video Overview}
\o \l {Camera Overview}
\o \l {Radio Overview}
\endlist

\section1 Multimedia recipes
For some quick recipes for specific tasks, look at the overviews above and consult this table:

\table 70%
    \header
        \o Use case
        \o Examples
        \o QML Classes
        \o C++ Classes
    \row
        \o Playing a sound effect
        \o TBD
        \o SoundEffect
        \o QSoundEffect
    \row
        \o Playing low latency audio
        \o audiooutput, spectrum
        \o
        \o QAudioOutput
    \row
        \o Playing encoded audio (MP3, AAC etc)
        \o player
        \o Audio, MediaPlayer
        \o QMediaPlayer
    \row
        \o Accessing raw audio input data
        \o spectrum, audioinput
        \o
        \o QAudioInput
    \row
        \o Recording encoded audio data
        \o audiorecorder
        \o
        \o QAudioRecorder
    \row
        \o Discovering raw audio devices
        \o audiodevices
        \o
        \o QAudioDeviceInfo
    \row
        \o Video Playback
        \o player, qmlvideo, qmlvideofx
        \o MediaPlayer, VideoOutput, Video
        \o QMediaPlayer, QVideoWidget, QGraphicsVideoItem
    \row
        \o Video Processing
        \o qmlvideofx
        \o MediaPlayer, VideoOutput
        \o QMediaPlayer, QAbstractVideoSurface, QVideoFrame
    \row
        \o Listening to the radio
        \o radio, declarative-radio
        \o Radio, RadioData
        \o QRadioTuner, QRadioData
    \row
        \o Accessing camera viewfinder
        \o camera, declarative-camera
        \o Camera, VideoOutput
        \o QCamera, QVideoWidget, QGraphicsVideoItem
    \row
        \o Viewfinder processing
        \o
        \o Camera, VideoOutput
        \o QCamera, QAbstractVideoSurface, QVideoFrame
    \row
        \o Capturing photos
        \o camera, declarative-camera
        \o Camera
        \o QCamera, QCameraImageCapture
    \row
        \o Capturing movies
        \o camera, declarative-camera
        \o Camera
        \o QCamera, QMediaRecorder
\endtable

\section1 Multimedia Limitations

In many cases the Qt Multimedia APIs build upon the multimedia framework of the underlying system.
This can mean that support for various codec or containers can vary between machines,
depending on what the end user has installed.  See \l {Multimedia Platform Support} for more
information on what frameworks are used and what this can mean.

\section1 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 \l{Multimedia Backend Development}.

\section1 Changes from previous versions

If you've previously used QtMultimedia in Qt 4.x, or used QtMultimediaKit in QtMobility, please see
\l {Changes in QtMultimedia} for more information on what has changed, and what you might need to
change when porting code.

\section1 Reference Documentation

\section2 QML Elements

\annotatedlist multimedia_qml

\section2 Multimedia Classes

\annotatedlist multimedia

*/