diff options
Diffstat (limited to 'src/multimedia/doc')
-rw-r--r-- | src/multimedia/doc/qtmultimedia.qdocconf | 1 | ||||
-rw-r--r-- | src/multimedia/doc/snippets/multimedia-snippets/audio.cpp (renamed from src/multimedia/doc/src/snippets/multimedia-snippets/audio.cpp) | 0 | ||||
-rw-r--r-- | src/multimedia/doc/snippets/multimedia-snippets/audiorecorder.cpp (renamed from src/multimedia/doc/src/snippets/multimedia-snippets/audiorecorder.cpp) | 0 | ||||
-rw-r--r-- | src/multimedia/doc/snippets/multimedia-snippets/camera.cpp (renamed from src/multimedia/doc/src/snippets/multimedia-snippets/camera.cpp) | 0 | ||||
-rw-r--r-- | src/multimedia/doc/snippets/multimedia-snippets/media.cpp (renamed from src/multimedia/doc/src/snippets/multimedia-snippets/media.cpp) | 0 | ||||
-rw-r--r-- | src/multimedia/doc/snippets/multimedia-snippets/multimedia-snippets.pro (renamed from src/multimedia/doc/src/snippets/multimedia-snippets/multimedia-snippets.pro) | 0 | ||||
-rw-r--r-- | src/multimedia/doc/snippets/multimedia-snippets/qsound.cpp (renamed from src/multimedia/doc/src/snippets/multimedia-snippets/qsound.cpp) | 0 | ||||
-rw-r--r-- | src/multimedia/doc/snippets/multimedia-snippets/soundeffect.qml (renamed from src/multimedia/doc/src/snippets/multimedia-snippets/soundeffect.qml) | 0 | ||||
-rw-r--r-- | src/multimedia/doc/snippets/multimedia-snippets/video.cpp (renamed from src/multimedia/doc/src/snippets/multimedia-snippets/video.cpp) | 0 | ||||
-rw-r--r-- | src/multimedia/doc/snippets/snippets.pro (renamed from src/multimedia/doc/src/snippets/snippets.pro) | 0 | ||||
-rw-r--r-- | src/multimedia/doc/src/audiooverview.qdoc | 10 | ||||
-rw-r--r-- | src/multimedia/doc/src/cameraoverview.qdoc | 8 | ||||
-rw-r--r-- | src/multimedia/doc/src/qtmultimedia-examples.qdoc | 37 | ||||
-rw-r--r-- | src/multimedia/doc/src/qtmultimedia-index.qdoc | 19 | ||||
-rw-r--r-- | src/multimedia/doc/src/videooverview.qdoc | 12 |
15 files changed, 54 insertions, 33 deletions
diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf index a6c9576b7..08a628902 100644 --- a/src/multimedia/doc/qtmultimedia.qdocconf +++ b/src/multimedia/doc/qtmultimedia.qdocconf @@ -30,6 +30,7 @@ qhp.qtmultimedia.subprojects.qmltypes.selectors = class fake:headerfile qhp.qtmultimedia.subprojects.qmltypes.sortPages = true exampledirs += ../../../examples \ + snippets headerdirs += ../.. diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/audio.cpp b/src/multimedia/doc/snippets/multimedia-snippets/audio.cpp index a39f1c7f4..a39f1c7f4 100644 --- a/src/multimedia/doc/src/snippets/multimedia-snippets/audio.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/audio.cpp diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/audiorecorder.cpp b/src/multimedia/doc/snippets/multimedia-snippets/audiorecorder.cpp index e0f136910..e0f136910 100644 --- a/src/multimedia/doc/src/snippets/multimedia-snippets/audiorecorder.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/audiorecorder.cpp diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/camera.cpp b/src/multimedia/doc/snippets/multimedia-snippets/camera.cpp index 757533be8..757533be8 100644 --- a/src/multimedia/doc/src/snippets/multimedia-snippets/camera.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/camera.cpp diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/media.cpp b/src/multimedia/doc/snippets/multimedia-snippets/media.cpp index 300ad392b..300ad392b 100644 --- a/src/multimedia/doc/src/snippets/multimedia-snippets/media.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/media.cpp diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/multimedia-snippets.pro b/src/multimedia/doc/snippets/multimedia-snippets/multimedia-snippets.pro index 9571b026e..9571b026e 100644 --- a/src/multimedia/doc/src/snippets/multimedia-snippets/multimedia-snippets.pro +++ b/src/multimedia/doc/snippets/multimedia-snippets/multimedia-snippets.pro diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/qsound.cpp b/src/multimedia/doc/snippets/multimedia-snippets/qsound.cpp index 1f7dad79f..1f7dad79f 100644 --- a/src/multimedia/doc/src/snippets/multimedia-snippets/qsound.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/qsound.cpp diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/soundeffect.qml b/src/multimedia/doc/snippets/multimedia-snippets/soundeffect.qml index 9b173a46b..9b173a46b 100644 --- a/src/multimedia/doc/src/snippets/multimedia-snippets/soundeffect.qml +++ b/src/multimedia/doc/snippets/multimedia-snippets/soundeffect.qml diff --git a/src/multimedia/doc/src/snippets/multimedia-snippets/video.cpp b/src/multimedia/doc/snippets/multimedia-snippets/video.cpp index 37dca0851..37dca0851 100644 --- a/src/multimedia/doc/src/snippets/multimedia-snippets/video.cpp +++ b/src/multimedia/doc/snippets/multimedia-snippets/video.cpp diff --git a/src/multimedia/doc/src/snippets/snippets.pro b/src/multimedia/doc/snippets/snippets.pro index 31a3a0992..31a3a0992 100644 --- a/src/multimedia/doc/src/snippets/snippets.pro +++ b/src/multimedia/doc/snippets/snippets.pro diff --git a/src/multimedia/doc/src/audiooverview.qdoc b/src/multimedia/doc/src/audiooverview.qdoc index 723afb71b..20c5342e8 100644 --- a/src/multimedia/doc/src/audiooverview.qdoc +++ b/src/multimedia/doc/src/audiooverview.qdoc @@ -50,16 +50,16 @@ may have installed. Here is how you play a local file using C++: - \snippet doc/src/snippets/multimedia-snippets/media.cpp Local playback + \snippet multimedia-snippets/media.cpp Local playback You can also put files (even remote URLs) into a playlist: - \snippet doc/src/snippets/multimedia-snippets/media.cpp Audio playlist + \snippet multimedia-snippets/media.cpp Audio playlist \section2 Recording Audio to a File For recording audio to a file, the \l {QAudioRecorder} class allows you to compress audio data from an input device and record it. - \snippet doc/src/snippets/multimedia-snippets/media.cpp Audio recorder + \snippet multimedia-snippets/media.cpp Audio recorder \section2 Low Latency Sound Effects @@ -87,7 +87,7 @@ they may arrive at a slightly different time than the media pipeline processes them. Here's an example of installing a probe during recording: - \snippet doc/src/snippets/multimedia-snippets/media.cpp Audio probe + \snippet multimedia-snippets/media.cpp Audio probe \section2 Low Level Audio Playback and Recording Qt Multimedia offers classes for raw access to audio input and output @@ -123,7 +123,7 @@ or from a QIODevice instances. Here's an example of decoding a local file: - \snippet doc/src/snippets/multimedia-snippets/audio.cpp Local audio decoding + \snippet multimedia-snippets/audio.cpp Local audio decoding Note: This API is preliminary at this time - the API may change or be removed before the final 5.0 release. diff --git a/src/multimedia/doc/src/cameraoverview.qdoc b/src/multimedia/doc/src/cameraoverview.qdoc index f6bf4f533..40c82a69a 100644 --- a/src/multimedia/doc/src/cameraoverview.qdoc +++ b/src/multimedia/doc/src/cameraoverview.qdoc @@ -118,14 +118,14 @@ In C++, your choice depends on whether you are using widgets, or QGraphicsView. The \l QVideoWidget class is used in the widgets case, and \l QGraphicsVideoItem is useful for QGraphicsView. - \snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera overview viewfinder + \snippet multimedia-snippets/camera.cpp Camera overview viewfinder For advanced usage (like processing viewfinder frames as they come, to detect objects or patterns), you can also derive from \l QAbstractVideoSurface and set that as the viewfinder for the QCamera object. In this case you will need to render the viewfinder image yourself. - \snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera overview surface + \snippet multimedia-snippets/camera.cpp Camera overview surface \section2 Still Images @@ -136,7 +136,7 @@ that things are in focus and the settings are not different from the viewfinder while the image capture occurs, capture the image, and finally unlock the camera ready for the next photo. - \snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera overview capture + \snippet multimedia-snippets/camera.cpp Camera overview capture \section2 Movies @@ -146,7 +146,7 @@ video requires the use of a \l QMediaRecorder object. To record video we need to create a camera object as before but this time as well as creating a viewfinder, we will also initialize a media recorder object. - \snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera overview movie + \snippet multimedia-snippets/camera.cpp Camera overview movie Signals from the \e mediaRecorder can be connected to slots to react to changes in the state of the recorder or error events. Recording itself diff --git a/src/multimedia/doc/src/qtmultimedia-examples.qdoc b/src/multimedia/doc/src/qtmultimedia-examples.qdoc new file mode 100644 index 000000000..4427e16f3 --- /dev/null +++ b/src/multimedia/doc/src/qtmultimedia-examples.qdoc @@ -0,0 +1,37 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** 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. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \group multimedia_examples + \ingroup all-examples + \title Qt Multimedia Examples + \brief Demonstrates the multimedia functionality provided by Qt. + + The \l{Qt Multimedia} module provides low-level audio support on Linux, + Windows and Mac OS X. It also provides audio plugin API to allow developers + implement their own audio support for custom devices and platforms. +*/ diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc index dcf438d51..e7838cfd8 100644 --- a/src/multimedia/doc/src/qtmultimedia-index.qdoc +++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc @@ -128,23 +128,6 @@ \section2 Examples \list - \li QML - \list - \li \l{video/qmlvideo}{qmlvideo} - \li \l{video/qmlvideofx}{qmlvideofx} - \li \l{declarative-camera} - \li \l{declarative-radio} - \endlist - \li C++ - \list - \li \l{audiooutput} - \li \l{audioinput} - \li \l{audiorecorder} - \li \l{audiodevices} - \li \l{spectrum} - \li \l{AudioEngine Example}{Audio Engine} - \li \l{player} - \li \l{Camera Example} - \endlist + \li \l{Qt Multimedia Examples} \endlist */ diff --git a/src/multimedia/doc/src/videooverview.qdoc b/src/multimedia/doc/src/videooverview.qdoc index f0d8de05b..45ea87f09 100644 --- a/src/multimedia/doc/src/videooverview.qdoc +++ b/src/multimedia/doc/src/videooverview.qdoc @@ -47,10 +47,10 @@ You can use the \l QMediaPlayer class to decode a video file, and display it using \l QVideoWidget, \l QGraphicsVideoItem, or a custom class. Here's an example of using QVideoWidget: - \snippet doc/src/snippets/multimedia-snippets/video.cpp Video widget + \snippet multimedia-snippets/video.cpp Video widget And an example with QGraphicsVideoItem: - \snippet doc/src/snippets/multimedia-snippets/video.cpp Video graphics item + \snippet multimedia-snippets/video.cpp Video graphics item \section2 Playing Video in QML @@ -77,12 +77,12 @@ processing, while deriving a class from \l QAbstractVideoSurface allows you to receive these frames from \l QMediaPlayer and \l QCamera. -\snippet doc/src/snippets/multimedia-snippets/video.cpp Derived Surface +\snippet multimedia-snippets/video.cpp Derived Surface and with an instance of this surface, \c myVideoSurface, you can set the surface as the \l {QMediaPlayer::setVideoOutput()}{video output} for QMediaPlayer. -\snippet doc/src/snippets/multimedia-snippets/video.cpp Setting surface in player +\snippet multimedia-snippets/video.cpp Setting surface in player Several of the built-in Qt classes offer this functionality as well, so if you decode video in your application, you can present @@ -97,7 +97,7 @@ The following snippet shows a class that has a writable \c videoSurface property and receives frames through a public slot \c onNewVideoContentReceived(). These frames are then presented on the surface set in \c setVideoSurface(). -\snippet doc/src/snippets/multimedia-snippets/video.cpp Video producer +\snippet multimedia-snippets/video.cpp Video producer \section2 Recording Video You can use the \l QMediaRecorder class in conjunction with other @@ -116,7 +116,7 @@ the video frames using this class, and they may arrive at a slightly different time than they are being rendered. Here's an example of installing a video probe while recording the camera: - \snippet doc/src/snippets/multimedia-snippets/media.cpp Video probe + \snippet multimedia-snippets/media.cpp Video probe \section1 Examples |