Doc: Several cosmetic doc fixes.

-changed title of "Qt Multimedia Overview" to "Multimedia". It follows
the other topic titles from qtdoc.
-fixed column widths of paragraphs

Change-Id: I8a12d1d9a2a9c3ca184d69ebe464c80721a117f7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
This commit is contained in:
Jerome Pasion
2013-04-23 13:13:45 +02:00
committed by The Qt Project
parent 6e8db5a671
commit 87b413ec9d
3 changed files with 65 additions and 50 deletions

View File

@@ -27,40 +27,37 @@
/*! /*!
\page multimediaoverview.html \page multimediaoverview.html
\title Qt Multimedia Overview \title Multimedia
\brief A set of APIs for working with audio, video, radio and camera devices. \brief A set of APIs for working with audio, video, radio and camera devices.
\ingroup technology-apis \ingroup technology-apis
Multimedia support in Qt is provided by the \l{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.
\section1 Overview \section1 Features
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 platforms multimedia capabilites and hardware. This
ranges from the playback and recording of audio and video content to the use
of available devices like cameras and radios.
\section2 Features
Here are some examples of what can be done with Qt Multimedia APIs: Here are some examples of what can be done with Qt Multimedia APIs:
\list \list
\li Access raw audio devices for input and output \li Access raw audio devices for input and output
\li Play low latency sound effects \li Play low latency sound effects
\li Play media files in playlists (like compressed audio, or video files) \li Play media files in playlists (such as compressed audio or video files)
\li Record audio and compress it \li Record audio and compress it
\li Tune and listen to radio stations, and receive radio program information \li Tune and listen to radio stations
\li Use a camera, including viewfinder, image capture, and movie recording \li Use a camera, including viewfinder, image capture, and movie recording
\li Play 3D positional audio with \l {Positional Audio} {QtAudioEngine} \li Play 3D positional audio with \l {Positional Audio} {QtAudioEngine}
\li Decode audio media files into memory for processing \li Decode audio media files into memory for processing
\li Accessing video frames or audio buffers as they are played or recorded \li Accessing video frames or audio buffers as they are played or recorded
\endlist \endlist
\section2 Multimedia Components \section1 Multimedia Components
All of these tasks can be broadly broken down into four main areas. More information Qt's multimedia APIs are categorized into four main components. More
(including background information and class references) are available here: information (including background information and class references) is
available here:
\list \list
\li \l {Audio Overview} \li \l {Audio Overview}
@@ -69,8 +66,9 @@ All of these tasks can be broadly broken down into four main areas. More inform
\li \l {Radio Overview} \li \l {Radio Overview}
\endlist \endlist
\section2 Multimedia Recipes \section1 Multimedia Recipes
For some quick recipes for specific tasks, look at the overviews above and consult this table:
For some quick recipes, look at the overviews above and consult this table:
\table 70% \table 70%
\header \header
@@ -85,7 +83,8 @@ For some quick recipes for specific tasks, look at the overviews above and consu
\li QSoundEffect \li QSoundEffect
\row \row
\li Playing low latency audio \li Playing low latency audio
\li \l{multimedia/audiooutput}{audioinput}, \l{multimedia/spectrum}{spectrum} \li \l{multimedia/audiooutput}{audioinput},
\l{multimedia/spectrum}{spectrum}
\li \li
\li QAudioOutput \li QAudioOutput
\row \row
@@ -95,7 +94,8 @@ For some quick recipes for specific tasks, look at the overviews above and consu
\li QMediaPlayer \li QMediaPlayer
\row \row
\li Accessing raw audio input data \li Accessing raw audio input data
\li \l{multimedia/spectrum}{spectrum}, \l {multimedia/audioinput}{audioinput} \li \l{multimedia/spectrum}{spectrum},
\l {multimedia/audioinput}{audioinput}
\li \li
\li QAudioInput \li QAudioInput
\row \row
@@ -138,12 +138,14 @@ For some quick recipes for specific tasks, look at the overviews above and consu
\li QCamera, QAbstractVideoSurface, QVideoFrame \li QCamera, QAbstractVideoSurface, QVideoFrame
\row \row
\li Capturing photos \li Capturing photos
\li \l {Camera Example}{camera}, \l {multimediawidgets/declarative-camera}{declarative-camera} \li \l {Camera Example}{camera},
\l {multimediawidgets/declarative-camera}{declarative-camera}
\li \l Camera \li \l Camera
\li QCamera, QCameraImageCapture \li QCamera, QCameraImageCapture
\row \row
\li Capturing movies \li Capturing movies
\li \l {Camera Example}{camera}, \l {multimediawidgets/declarative-camera}{declarative-camera} \li \l {Camera Example}{camera},
\l {multimediawidgets/declarative-camera}{declarative-camera}
\li \l Camera \li \l Camera
\li QCamera, QMediaRecorder \li QCamera, QMediaRecorder
\row \row
@@ -156,26 +158,26 @@ For some quick recipes for specific tasks, look at the overviews above and consu
\section1 Limitations \section1 Limitations
In many cases the Qt Multimedia APIs build upon the multimedia framework of the underlying system. The Qt Multimedia APIs build upon the multimedia framework of the underlying
This can mean that support for various codec or containers can vary between machines, platform. This can mean that support for various codecs or containers can vary
depending on what the end user has installed. between machines, depending on what the end user has installed.
\section1 Advanced Usage \section1 Advanced Usage
For developers wishing to access some platform specific settings, For developers wishing to access some platform specific settings, or to port the
or to port the Qt Multimedia APIs to a new platform or technology, Qt Multimedia APIs to a new platform or technology, see \l{Multimedia Backend
see \l{Multimedia Backend Development}. Development}.
\section1 Changes from Previous Versions \section1 Changes from Previous Versions
If you've previously used Qt Multimedia in Qt 4.x, or used Qt Multimedia Kit in Qt Mobility, please see If you previously used Qt Multimedia in Qt 4, or used Qt Multimedia Kit in
\l {Changes in Qt Multimedia} for more information on what has changed, and what you might need to Qt Mobility, please see \l {Changes in Qt Multimedia} for more information on
change when porting code. what changed, and what you might need to change when porting code.
\section1 Reference Documentation \section1 Reference Documentation
\section2 QML Types \section2 QML Types
The following types are accessed by using: The QML types are accessed by using:
\code \code
import QtMultimedia 5.0 import QtMultimedia 5.0
\endcode \endcode

View File

@@ -30,10 +30,12 @@
\title Qt Multimedia C++ Classes \title Qt Multimedia C++ Classes
\ingroup modules \ingroup modules
\brief The \l {Qt Multimedia} module provides audio, video, radio and camera functionality. \brief The \l {Qt Multimedia} module provides audio, video, radio and camera
functionality.
The C++ classes provide more control over the multimedia content than the QML alternatives. The C++ classes provide more control over the multimedia content than the
If your application is serving complex use cases such as decoding media files, accessing video or audio buffers, QML alternatives. If your application is serving complex use cases such as
use the C++ alternative. For more details about the complex audio, video, and camera use cases supported by the C++ decoding media files, accessing video or audio buffers, use the C++
classes, refer to \l {Qt Multimedia Overview}. alternative. For more details about the complex audio, video, and camera use
cases supported by the C++ classes, refer to \l {Qt Multimedia Overview}.
*/ */

View File

@@ -28,37 +28,46 @@
/*! /*!
\page qtmultimedia-index.html \page qtmultimedia-index.html
\title Qt Multimedia \title Qt Multimedia
\brief The Qt Multimedia module provides APIs for audio, video, radio and camera-related functionality. \brief The Qt Multimedia module provides APIs for audio, video, radio, and
camera-related functionality.
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. 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 \l{Qt Multimedia Widgets} module provides widget based multimedia classes. The \l{Qt Multimedia Widgets} module provides widget based multimedia
classes.
\section1 Getting started \section1 Getting Started
The QML types can be imported into your applciation using the following import statement in your \c {.qml} file. The QML types can be imported into your applciation using the following
import statement in your \c {.qml} file.
\code \code
import QtMultimedia 5.0 import QtMultimedia 5.0
\endcode \endcode
If you intend to use the C++ classes in your application, include the C++ definitions using the following directive: If you intend to use the C++ classes in your application, include the C++
definitions using the following directive:
\code \code
#include <QtMultimedia> #include <QtMultimedia>
\endcode \endcode
\note If you are using a few classes from this module, we recommend including those specific classes only instead of the module. \note If you are using a few classes from this module, we recommend
including those specific classes only instead of the module.
To link against the corresponding C++ libraries, add the following to your \c {qmake} project file: To link against the corresponding C++ libraries, add the following to your
\c {qmake} project file:
\code \code
QT += multimedia QT += multimedia
\endcode \endcode
\section1 QML types and C++ classes \section1 QML Types and C++ Classes
The following is a list of important QML types and C++ classes provided by this module: The following is a list of important QML types and C++ classes provided by
this module:
\table \table
\header \header
@@ -72,13 +81,15 @@
\li Access camera viewfinder frames \li Access camera viewfinder frames
\row \row
\li MediaPlayer \li MediaPlayer
\li Add media playback functionality to a scene. It is same as Audio type, but can be used for video playback with the VideoOutput type. \li Add media playback functionality to a scene. It is same as Audio type,
but can be used for video playback with the VideoOutput type.
\row \row
\li \l {QtMultimedia5::Radio}{Radio} \li \l {QtMultimedia5::Radio}{Radio}
\li Access radio functionality \li Access radio functionality
\row \row
\li \l {QtMultimedia5::Video}{Video} \li \l {QtMultimedia5::Video}{Video}
\li Add Video playback functionality to a scene. It uses MediaPlayer and VideoOutput types to provide video playback functionality. \li Add Video playback functionality to a scene. It uses MediaPlayer and
VideoOutput types to provide video playback functionality.
\endtable \endtable
\table \table
@@ -105,11 +116,11 @@
\li Control video data. \li Control video data.
\endtable \endtable
\section1 Related information \section1 Related Information
\section2 Guides \section2 Guides
\list \list
\li \l{Qt Multimedia Overview} \li \l Multimedia - overview of multimedia support in Qt
\li \l{Audio Overview} \li \l{Audio Overview}
\li \l{Positional Audio} \li \l{Positional Audio}
\li \l{Video Overview} \li \l{Video Overview}