slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix up various doc issues.

Browse Source 
Change-Id: I43a8b1b982c4af093bd0bb14573f2299ae28ae94
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
This commit is contained in:
Peter Yard
2012-02-02 09:05:35 +10:00
committed by Qt by Nokia
parent d292f4a7d3
commit 4bbe267f30
11 changed files with 221 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/src/cameraoverview.qdoc
View File

@@ -152,7 +152,7 @@ well as creating a viewfinder, we will also initialize a media recorder object.
\snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera overview movie
Signals from the \i mediaRecorder can be connected to slots to react to
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
starts with the \l {QMediaRecorder::record()}{record()} function of
mediaRecorder being called, this causes the signal \l
@@ -224,17 +224,17 @@ for all of these, so you shouldn't need to adjust them unless the user wants a s
If you're taking a series of images (for example, to stitch them together for
a panoramic image), you should lock the image processing settings so that all the
images taken appear similar with \i {QCamera::lock(QCamera::LockWhiteBalance)}/
images taken appear similar with \e {QCamera::lock(QCamera::LockWhiteBalance)}/
\section3 Cancelling Asynchronous Operations
\section3 Canceling Asynchronous Operations
Various operations such as image capture and auto focusing occur
asynchrously. These operations can often be cancelled by the start of a new
asynchrously. These operations can often be canceled by the start of a new
operation as long as this is supported by the camera. For image capture,
the operation can be cancelled by calling
the operation can be canceled by calling
\l {QCameraImageCapture::cancelCapture()}{cancelCapture()}. For AutoFocus,
autoexposure or white balance cancellation can be done by calling
\i {QCamera::unlock(QCamera::LockFocus)}.
\e {QCamera::unlock(QCamera::LockFocus)}.
\section1 Examples

35
doc/src/examples/audioinput.qdoc Normal file
View File

@@ -0,0 +1,35 @@
/****************************************************************************
**
** Copyright (C) 2012 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$
**
****************************************************************************/
/*!
\example audioinput
\title Audio Input Example
*/

37
doc/src/examples/audiooutput.qdoc Normal file
View File

@@ -0,0 +1,37 @@
/****************************************************************************
**
** Copyright (C) 2012 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$
**
****************************************************************************/
/*!
\example audiooutput
\title Audio Output Example
*/

8
doc/src/examples/camera.qdoc
View File

@@ -53,9 +53,9 @@ interface object.
The Camera constructor does some basic initialization. The camera object is
set to '0', the user interface is initialized and UI signal are connected to
slots that react to the triggering event. However, most of the work is done when
the \i {setCamera()} function is called, passing in a \l {QByteArray}.
the \e {setCamera()} function is called, passing in a \l {QByteArray}.
\i {setCamera()} sets up various connections between the user interface and the functionality
\e {setCamera()} sets up various connections between the user interface and the functionality
of the Camera class using signals and slots. It also instantiates and initializes the \l {QCamera},
\l {QCameraImageCapture} and \l {QMediaRecorder} objects mentioned above. The still
and video recording visual tabs are enabled and finally the
@@ -65,10 +65,10 @@ Now that the camera is ready for user commands it waits for a suitable event.
Such an event will be the key press of either the \l {Qt::Key_CameraFocus} or
\l {Qt::Key_Camera} buttons on the application window. Camera focus will
simply display the viewfinder and lock the camera settings. Key_Camera will
either call \i {takeImage()} if the \l {QCamera::captureMode()}{captureMode()}
either call \e {takeImage()} if the \l {QCamera::captureMode()}{captureMode()}
is QCamera::CaptureStillImage, or if the capture mode is for video then one
of two actions will occur. If the recording state shows that we are currently
recording then the \i {stop()} function is called resulting in a call to
recording then the \e {stop()} function is called resulting in a call to
\l {QCamera::stop()}, whereas if we are not recording then a video recording
is started with a call to \l {QMediaRecorder::record()}.

22
doc/src/examples/declarative-camera.qdoc
View File

@@ -39,25 +39,25 @@ plugin provides access to the API functionality for camera settings and
capturing an image.
Most of the QML code supports the user interface for this application with the
Camera elements being mostly found in \i {declarative-camera.qml} and
\i {CaptureControls.qml}.
Camera elements being mostly found in \e {declarative-camera.qml} and
\e {CaptureControls.qml}.
In \i {declarative-camera.qml} the Camera element is initialized with an id
of \i {camera }, a photo preview is setup, states are implemented for image
In \e {declarative-camera.qml} the Camera element is initialized with an id
of \e {camera }, a photo preview is setup, states are implemented for image
preview or capture and a CaptureControls element is initialized. The initial
\i state is \i PhotoCapture. The camera element includes a handler, \i onImageCaptured,
\e state is \e PhotoCapture. The camera element includes a handler, \e onImageCaptured,
for the \l {imageCaptured} signal. The handler sets up the application to process
the preview including a change in the user interface state. The PhotoPreview
element now becomes visible with any key press being picked up by the handler
in PhotoPreview and returning the state to \i PhotoCapture.
in PhotoPreview and returning the state to \e PhotoCapture.
The \i CaptureControls element, which is implemented in \i {CaptureControls.qml},
The \e CaptureControls element, which is implemented in \e {CaptureControls.qml},
generates a column on the right hand side of the screen which includes control
buttons for \i focus (not initially visible), \i {capture}, \i {flash modes},
\i {white balance}, \i {exposure compensation}, and if a preview is
available a \i {preview} button. The last button exits from the application.
buttons for \e focus (not initially visible), \e {capture}, \e {flash modes},
\e {white balance}, \e {exposure compensation}, and if a preview is
available a \e {preview} button. The last button exits from the application.
When the Capture button is pressed the \i onClicked handler calls
When the Capture button is pressed the \e onClicked handler calls
\l {Camera::captureImage()}{captureImage()}

35
doc/src/examples/declarative-radio.qdoc Normal file
View File

@@ -0,0 +1,35 @@
/****************************************************************************
**
** Copyright (C) 2012 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$
**
****************************************************************************/
/*!
\example declarative-radio
\title Declarative Radio Example
*/

35
doc/src/examples/spectrum.qdoc Normal file
View File

@@ -0,0 +1,35 @@
/****************************************************************************
**
** Copyright (C) 2012 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$
**
****************************************************************************/
/*!
\example spectrum
\title Spectrum Example
*/

52
doc/src/legal/3rdparty.qdoc
View File

@@ -63,7 +63,7 @@
\section1 DES (\c des.cpp)
\i{Implementation of DES encryption for NTLM\br
\e {Implementation of DES encryption for NTLM\br
Copyright 1997-2005 Simon Tatham.\br
This software is released under the MIT license.}
@@ -72,7 +72,7 @@
\section1 FreeType 2 (\c freetype) version 2.3.6
\i{The FreeType project is a team of volunteers who develop free, portable
\e {The FreeType project is a team of volunteers who develop free, portable
and high-quality software solutions for digital typography. We specifically
target embedded systems and focus on bringing small, efficient and
ubiquitous products.} -- quoted from \c 3rdparty/freetype/docs/freetype2.html.
@@ -106,9 +106,9 @@
\section1 HarfBuzz (\c harfbuzz)
\i{This is HarfBuzz, an OpenType Layout engine.}
\e {This is HarfBuzz, an OpenType Layout engine.}
\i{It was derived originally from the OpenType code in FreeType-1.x, ported to
\e {It was derived originally from the OpenType code in FreeType-1.x, ported to
FreeType2. (This code has been abandoned for FreeType2, but until something
better comes along, should serve our purposes.) In addition to porting to
FreeType-2, it has been modified in various other ways.} -- quoted from
@@ -119,7 +119,7 @@
\section1 The Independent JPEG Group's JPEG Software (\c libjpeg) version 6b
\i{This package contains C software to implement JPEG image compression and
\e {This package contains C software to implement JPEG image compression and
decompression. JPEG (pronounced "jay-peg") is a standardized compression
method for full-color and gray-scale images. JPEG is intended for compressing
"real-world" scenes; line drawings, cartoons and other non-realistic images
@@ -131,7 +131,7 @@
\section1 MD4 (\c md4.cpp and \c md4.h)
\i{MD4 (RFC-1320) message digest.\br
\e {MD4 (RFC-1320) message digest.\br
Modified from MD5 code by Andrey Panin <pazke@donpac.ru>\br\br
Written by Solar Designer <solar@openwall.com> in 2001, and placed in\br
the public domain. There's absolutely no warranty.}
@@ -142,7 +142,7 @@
\section1 MD5 (\c md5.cpp and \c md5.h)
\i{This code implements the MD5 message-digest algorithm.
\e {This code implements the MD5 message-digest algorithm.
The algorithm is due to Ron Rivest. This code was
written by Colin Plumb in 1993, no copyright is claimed.
This code is in the public domain; do with it what you wish.} -- quoted from
@@ -154,7 +154,7 @@
\section1 MNG Library (\c libmng) version 1.0.10
\i{The libmng library supports decoding, displaying, encoding, and various
\e {The libmng library supports decoding, displaying, encoding, and various
other manipulations of the Multiple-image Network Graphics (MNG) format
image files. It uses the zlib compression library, and optionally the
JPEG library by the Independant JPEG Group (IJG) and/or
@@ -165,7 +165,7 @@
\section1 PNG Reference Library (\c libpng) version 1.2.29
\i{Libpng was written as a companion to the PNG specification, as a way
\e {Libpng was written as a companion to the PNG specification, as a way
of reducing the amount of time and effort it takes to support the PNG
file format in application programs.} -- quoted from \c
src/3rdparty/libpng/libpng.txt.
@@ -174,7 +174,7 @@
\section1 The ptmalloc memory allocator (\c ptmalloc3) version 1.8
\i ptmcalloc3 is a scalable concurrent memory allocator suitable
\e ptmcalloc3 is a scalable concurrent memory allocator suitable
for use in multi-threaded programs.
\hr
@@ -205,7 +205,7 @@
\section1 SHA-1 (\c sha1.cpp)
\i{Based on the public domain implementation of the SHA-1 algorithm\br
\e {Based on the public domain implementation of the SHA-1 algorithm\br
Copyright (C) Dominik Reichl <dominik.reichl@t-online.de>}
See \c src/3rdparty/sha1/sha1.cpp for more information about the terms and
@@ -213,7 +213,7 @@
\section1 SQLite (\c sqlite) version 3.5.9
\i{SQLite is a small C library that implements a
\e {SQLite is a small C library that implements a
self-contained, embeddable, zero-configuration SQL database engine.}
-- quoted from \l{http://www.sqlite.org/}{www.sqlite.org}.
@@ -224,7 +224,7 @@
\section1 TIFF Software Distribution (\c libtiff) version 3.8.2
\i {libtiff is a set of C functions (a library) that support the
\e {libtiff is a set of C functions (a library) that support the
manipulation of TIFF image files.} -- quoted from \c
src/libtiff/html/libtiff.html
@@ -235,7 +235,7 @@
Copyright (C) 2004, Andrey Kiselev <dron@ak4719.spb.edu>\br
Copyright (c) 1997 Greg Ward Larson
Permission to use, copy, modify, distribute, and sell this software and
Permission to use, copy, modify, distribute, and sell this software and
its documentation for any purpose is hereby granted without fee, provided
that (i) the above copyright notices and this permission notice appear in
all copies of the software and related documentation, and (ii) the names of
@@ -243,15 +243,15 @@
publicity relating to the software without the specific, prior written
permission of Sam Leffler and Silicon Graphics.
THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
OF THIS SOFTWARE.
\hr
@@ -259,7 +259,7 @@
Copyright (c) 1996-1997 Sam Leffler\br
Copyright (c) 1996 Pixar
Permission to use, copy, modify, distribute, and sell this software and
Permission to use, copy, modify, distribute, and sell this software and
its documentation for any purpose is hereby granted without fee, provided
that (i) the above copyright notices and this permission notice appear in
all copies of the software and related documentation, and (ii) the names of
@@ -267,15 +267,15 @@
publicity relating to the software without the specific, prior written
permission of Pixar, Sam Leffler and Silicon Graphics.
THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
IN NO EVENT SHALL PIXAR, SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
OF THIS SOFTWARE.
\hr
@@ -291,7 +291,7 @@
\section1 Data Compression Library (\c zlib) version 1.2.3
\i{zlib is a general purpose data compression library. All the code
\e {zlib is a general purpose data compression library. All the code
is thread safe. The data format used by the zlib library is described
by RFCs (Request for Comments) 1950 to 1952} -- quoted from \c
src/3rdparty/zlib/README.

53
doc/src/multimedia.qdoc
View File

@@ -28,10 +28,15 @@
/*!
\page multimediaoverview.html
\title Multimedia Overview
\title Qt Multimedia
\brief A set of APIs for working with audio, video, radio and camera devices.
\section1 Multimedia Features
\ingroup technology-apis
\section1 Multimedia Overview
\section2 Features
Qt Multimedia offers APIs for doing many multimedia related tasks:
@@ -44,7 +49,7 @@ Qt Multimedia offers APIs for doing many multimedia related tasks:
\o Use a camera, including viewfinder, image capture, and movie recording
\endlist
\section1 Multimedia Components
\section2 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:
@@ -56,7 +61,7 @@ All of these tasks can be broadly broken down into four main areas. More inform
\o \l {Radio Overview}
\endlist
\section1 Multimedia recipes
\section2 Multimedia recipes
For some quick recipes for specific tasks, look at the overviews above and consult this table:
\table 70%
@@ -68,67 +73,67 @@ For some quick recipes for specific tasks, look at the overviews above and consu
\row
\o Playing a sound effect
\o TBD
\o SoundEffect
\o \l SoundEffect
\o QSoundEffect
\row
\o Playing low latency audio
\o audiooutput, spectrum
\o \l{audiooutput}, \l{spectrum}
\o
\o QAudioOutput
\row
\o Playing encoded audio (MP3, AAC etc)
\o player
\o Audio, MediaPlayer
\o \l{player}
\o \l Audio, \l {MediaPlayer}
\o QMediaPlayer
\row
\o Accessing raw audio input data
\o spectrum, audioinput
\o \l{spectrum}, \l audioinput
\o
\o QAudioInput
\row
\o Recording encoded audio data
\o audiorecorder
\o \l audiorecorder
\o
\o QAudioRecorder
\row
\o Discovering raw audio devices
\o audiodevices
\o \l audiodevices
\o
\o QAudioDeviceInfo
\row
\o Video Playback
\o player, qmlvideo, qmlvideofx
\o MediaPlayer, VideoOutput, Video
\o \l {player}, \l {video/qmlvideo}{qmlvideo}, \l{video/qmlvideofx}{qmlvideofx}
\o \l MediaPlayer, \l VideoOutput, \l Video
\o QMediaPlayer, QVideoWidget, QGraphicsVideoItem
\row
\o Video Processing
\o qmlvideofx
\o MediaPlayer, VideoOutput
\o \l {video/qmlvideofx}{qmlvideofx}
\o \l {MediaPlayer}, \l VideoOutput
\o QMediaPlayer, QAbstractVideoSurface, QVideoFrame
\row
\o Listening to the radio
\o radio, declarative-radio
\o Radio, RadioData
\o \l radio, \l declarative-radio
\o \l Radio, \l RadioData
\o QRadioTuner, QRadioData
\row
\o Accessing camera viewfinder
\o camera, declarative-camera
\o Camera, VideoOutput
\o \l camera, \l declarative-camera
\o \l Camera, \l VideoOutput
\o QCamera, QVideoWidget, QGraphicsVideoItem
\row
\o Viewfinder processing
\o
\o Camera, VideoOutput
\o \l Camera, \l VideoOutput
\o QCamera, QAbstractVideoSurface, QVideoFrame
\row
\o Capturing photos
\o camera, declarative-camera
\o Camera
\o \l camera, \l declarative-camera
\o \l Camera
\o QCamera, QCameraImageCapture
\row
\o Capturing movies
\o camera, declarative-camera
\o Camera
\o \l camera, \l declarative-camera
\o \l Camera
\o QCamera, QMediaRecorder
\endtable

2
doc/src/multimediabackend.qdoc
View File

@@ -77,7 +77,7 @@ provider, the service it provides and the control used to manipulate the
service. Since our MyPlayer object has instances of the service and its
control then it would be possible for these to be used by associated classes
that could do additional actions, perhaps with their own control since the
parameter to requestControl() is a c-type string, \i {const char *}, for the
parameter to requestControl() is a c-type string, \e {const char *}, for the
interface.

4
doc/src/plugins/qml-multimedia.qdoc
View File

@@ -71,7 +71,7 @@
\endqml
The snippet above shows how the inclusion of \i playMusic enables audio features on the element that contains it. So that when the parent's MouseArea is clicked the \l {Audio::play()}{play()} method of the audio element is run. Other typical audio control methods are available such as \l {Audio::pause}{pause()} and \l {Audio::stop()}{stop()}.
The snippet above shows how the inclusion of \e playMusic enables audio features on the element that contains it. So that when the parent's MouseArea is clicked the \l {Audio::play()}{play()} method of the audio element is run. Other typical audio control methods are available such as \l {Audio::pause}{pause()} and \l {Audio::stop()}{stop()}.
Much of the getting / setting of \l Audio parameters is done through properties. These include
\table 70%
@@ -179,7 +179,7 @@
\endqml
Notice that the slot for the \l {Camera::imageCaptured()}{imageCaptured()}
signal is implemented in \i onImageCaptured. However, this code only
signal is implemented in \e onImageCaptured. However, this code only
changes some state information to allow previewing.
The capture call itself is part of the implementation of the button