Fix up a few doc issues

* lingering references to Mobility
* missing group tags on some classes meant they went missing
* put classes into functional groups as well (e.g. audio, camera)
* added some of the qdoc files to OTHER_FILES so they show up in Creator

There are still a lot of warnings since it seems like qdoc is not
processing the controls directory.

Change-Id: I036f8826ae63f8273b3e649cb32c091d964ce830
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
Michael Goddard
2012-01-16 16:27:32 +10:00
committed by Qt by Nokia
parent 53d71baed3
commit 508ca28196
89 changed files with 238 additions and 372 deletions

View File

@@ -1,18 +0,0 @@
Cpp.ignoretokens += \
QTM_BEGIN_NAMESPACE \
QTM_END_NAMESPACE \
Q_BEARER_EXPORT \
Q_PUBLISHSUBSCRIBE_EXPORT \
Q_CONTACTS_EXPORT \
Q_VERSIT_EXPORT \
Q_LOCATION_EXPORT \
Q_MULTIMEDIA_EXPORT \
Q_MESSAGING_EXPORT \
Q_SERVICEFW_EXPORT \
Q_SYSINFO_EXPORT \
Q_SENSORS_EXPORT \
Q_FEEDBACK_EXPORT \
Q_GALLERY_EXPORT \
Q_ORGANIZER_EXPORT
Cpp.ignoredirectives += \
Q_DECLARE_NDEF_RECORD

View File

@@ -1,13 +0,0 @@
include(qtmobility-project.qdocconf)
outputdir = ../ditaxml
outputformats = DITAXML
generateindex = true
url = .
macro.beginfloatleft.HTML = " "
macro.beginfloatright.HTML = " "
macro.endfloat.HTML = " "
macro.clearfloat.HTML = " "
macro.emptyspan.DITAXML = " "

View File

@@ -1,2 +0,0 @@
include(qtmobility-project.qdocconf)
include(qt-html-templates-online.qdocconf)

View File

@@ -1,142 +0,0 @@
include(compat.qdocconf)
include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
include(qt-defines.qdocconf)
include(qtmobility-cpp-ignore.qdocconf)
indexes = ../src/qt.index
language = Cpp
sourceencoding = UTF-8
outputencoding = UTF-8
naturallanguage = en_US
project = Qt Mobility
description = Qt Mobility Project Library Reference Documentation
versionsym =
version = 1.2
url = http://qt.nokia.com/doc/qtmobility-1.2
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.ch *.h *.h++ *.hh *.hpp *.hxx"
examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml"
examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
headerdirs = ../../src/global \
../../src/bearer \
../../src/feedback \
../../src/serviceframework \
../../src/location \
../../src/publishsubscribe \
../../src/systeminfo \
../../src/contacts \
../../src/contacts/details \
../../src/multimedia \
../../plugins/declarative/multimedia \
../../plugins/declarative/location \
../../plugins/declarative/organizer \
../../plugins/declarative/connectivity \
../../plugins/declarative/contacts \
../../plugins/declarative/contacts/details \
../../plugins/declarative/contacts/filters \
../../plugins/declarative/gallery \
../../plugins/declarative/serviceframework \
../../plugins/declarative/organizer \
../../plugins/declarative/contacts \
../../plugins/declarative/feedback \
../../plugins/declarative/messaging \
../../plugins/declarative/sensors \
../../plugins/declarative/publishsubscribe \
../../plugins/declarative/systeminfo \
../../src/messaging \
../../src/versit \
../../src/sensors \
../../src/gallery \
../../src/camera \
../../src/organizer \
../../src/versitorganizer \
../../src/connectivity \
../src
sourcedirs = ../../src/global \
../../src/bearer \
../../src/feedback \
../../src/serviceframework \
../../src/location \
../../src/publishsubscribe \
../../src/systeminfo \
../../src/contacts \
../../src/contacts/details \
../../src/multimedia \
../../plugins/declarative/multimedia \
../../plugins/declarative/location \
../../plugins/declarative/organizer \
../../plugins/declarative/connectivity \
../../plugins/declarative/contacts \
../../plugins/declarative/contacts/details \
../../plugins/declarative/contacts/filters \
../../plugins/declarative/messaging \
../../plugins/declarative/serviceframework \
../../plugins/declarative/organizer \
../../plugins/declarative/contacts \
../../plugins/declarative/feedback \
../../plugins/declarative/gallery \
../../plugins/declarative/sensors \
../../plugins/declarative/publishsubscribe \
../../plugins/declarative/systeminfo \
../../plugins/declarative/sensors \
../../src/messaging \
../../src/versit \
../../src/sensors \
../../src/gallery \
../../src/camera \
../../src/organizer \
../../src/connectivity \
../../src/versitorganizer \
../src
excludedirs = ../../src/messaging/win32wce \
../../src/publishsubscribe/symbian \
../../src/serviceframework/ipc/metaobjectbuilder47
exampledirs = ../../examples \
../../demos \
../.. \
../src
imagedirs = images \
../src/images
outputdir = ../html
tagfile = ../html/qtmobility.tags
base = file:../html
qhp.projects = QtMobility
qhp.QtMobility.file = qtmobility.qhp
qhp.QtMobility.namespace = com.nokia.qtmobility.114
qhp.QtMobility.virtualFolder = mobility
qhp.QtMobility.indexTitle = Qt Mobility Project Reference Documentation
qhp.QtMobility.indexRoot =
qhp.QtMobility.filterAttributes = qtmobility 1.2.0
qhp.QtMobility.customFilters.QtMobility.name = Qt Mobility 1.2.0
qhp.QtMobility.customFilters.QtMobility.filterAttributes = qtmobility 1.2.0
qhp.QtMobility.subprojects = classes overviews examples
qhp.QtMobility.subprojects.classes.title = Classes
qhp.QtMobility.subprojects.classes.indexTitle = All Qt Mobility Project Classes
qhp.QtMobility.subprojects.classes.selectors = class
qhp.QtMobility.subprojects.classes.sortPages = true
qhp.QtMobility.subprojects.overviews.title = Overviews
qhp.QtMobility.subprojects.overviews.indexTitle = Qt Mobility Project Overview
qhp.QtMobility.subprojects.overviews.selectors = fake:page,group
qhp.QtMobility.subprojects.overviews.sortPages = true
qhp.QtMobility.subprojects.examples.title = Examples
qhp.QtMobility.subprojects.examples.indexTitle = Qt Mobility Project Examples
qhp.QtMobility.subprojects.examples.selectors = fake:example
qhp.QtMobility.subprojects.examples.sortPages = true
qhp.QtMobility.subprojects.tutorials.title = Tutorials
qhp.QtMobility.subprojects.tutorials.indexTitle = Qt Mobility Project Tutorials
qhp.QtMobility.subprojects.tutorials.selectors = fake:tutorial
qhp.QtMobility.subprojects.tutorials.sortPages = true

View File

@@ -1,2 +0,0 @@
include(qtmobility-project.qdocconf)
include(qt-html-templates.qdocconf)

View File

@@ -33,3 +33,11 @@ QMAKE_EXTRA_TARGETS += docs dita_docs online_docs qch_docs
QMAKE_CLEAN += \
"-r $$PWD/../html" \
"-r $$PWD/../ditaxml"
OTHER_FILES += \
doc/src/multimedia.qdoc \
doc/src/camera.qdoc \
doc/src/multimediabackend.qdoc \
doc/src/radiooverview.qdoc \
doc/src/plugins/qml-multimedia.qdoc

View File

@@ -1,31 +0,0 @@
win32:!win32-g++ {
unixstyle = false
} else:win32-g++:isEmpty(QMAKE_SH) {
unixstyle = false
} else {
unixstyle = true
}
LINE_SEP=$$escape_expand(\\n\\t)
GENERATOR = $$[QT_INSTALL_BINS]/qhelpgenerator
QDOC = $$[QT_INSTALL_BINS]/qdoc3
MOBILITY_DOCUMENTATION = $$QDOC $${QT_MOBILITY_SOURCE_TREE}/doc/config/qtmobility.qdocconf $$LINE_SEP \
cd $${QT_MOBILITY_SOURCE_TREE} && \
$$GENERATOR doc/html/qtmobility.qhp -o doc/qch/qtmobility.qch
ONLINE_MOBILITY_DOCUMENTATION = $$QDOC $${QT_MOBILITY_SOURCE_TREE}/doc/config/qtmobility-online.qdocconf $$LINE_SEP \
cd $${QT_MOBILITY_SOURCE_TREE} && \
$$GENERATOR doc/html/qtmobility.qhp -o doc/qch/qtmobility.qch
contains(unixstyle, false):MOBILITY_DOCUMENTATION = $$replace(MOBILITY_DOCUMENTATION, "/", "\\")
# Build rules
qch_docs.commands = $$MOBILITY_DOCUMENTATION
qch_onlinedocs.commands = $$ONLINE_MOBILITY_DOCUMENTATION
docs.depends = qch_docs
onlinedocs.depends = qch_onlinedocs
QMAKE_EXTRA_TARGETS += qch_docs qch_onlinedocs docs onlinedocs

View File

@@ -37,15 +37,6 @@ for still or video image capture with sound support.
\tableofcontents
\section1 Namespace
The QtMobility APIs are placed into the \i{QtMobility} namespace. This is done
to facilitate the future migration of QtMobility APIs into Qt. See the
\l {Quickstart guide} for an example on how the
namespace impacts on application development.
\section1 Overview
The Camera API allows high level control of various aspects of still images
@@ -53,8 +44,6 @@ and video. Camera is a part of the Multimedia API and this relationship is
apparent when you notice that certain core classes are subclassed from some
Multimedia base classes including \l QMediaObject and \l QMediaControl.
\section1 Still Images
In order to capture an image we need to create a \l QCamera object and use
@@ -173,7 +162,7 @@ autoexposure or white balance cancellation can be done by calling
\section1 Classes
\annotatedlist camera
\annotatedlist multimedia_camera
*/

View File

@@ -1,73 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** 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 hapticsplayer
\title Haptics Player
\tableofcontents
\section1 Overview
This example shows how to use various haptic effects in an application via
the \l{Feedback}{QtMobility Feedback API}.
It provides an example of how to use the QtMobility libraries to:
\list
\o play "system theme" haptic effects corresponding to certain predefined events
\o play a dynamic custom effect, single or repeating
\o play a custom effect which is stored in a file
\endlist
\section2 Use Case
This example is more feature complete than the \l{hapticsquare}{Haptic Square} example,
but is intended more as a way to test the haptics provider plugins which
are available on a system, than as an example for application developers.
It is useful for people who wish to learn how to use the API to create and
play custom effects dynamically, or to allow users of an application to
select which haptic effect to play when a particular event occurs. It is also useful
to test how effects are implemented on specific devices.
It is a more complex example than the \l{hapticsquare}{Haptic Square} example, so it is
suggested that developers look at that example first.
\section2 Interface
The application is designed to work on desktop and mobile platforms with
minimal differences in code between the platforms. The interface consists
of three tabs which allow the user to select and play different custom,
system theme, and file effects, respectively. The custom effect tab also
allows the user to modify the custom effect dynamically, and see the effect
of attack and fade, intensity and duration, and periodicity, on the user
experience.
\section2 Known Issues
The example will not work correctly on platforms which do not have a
QFeedbackHapticInterface (haptic effect provider) plugin loaded. On such
platforms, the example will do nothing.
*/

View File

@@ -344,26 +344,46 @@ displayed around the video content pane.
\section1 Reference documentation
\section2 Main audio and video classes
\section2 Core classes
\annotatedlist multimedia
\annotatedlist multimedia_core
\section2 Media playback classes
\annotatedlist multimedia_playback
\section2 Camera classes
\annotatedlist camera
\annotatedlist multimedia_camera
\section2 Radio classes
\annotatedlist multimedia_radio
\section2 Media recording classes
\annotatedlist multimedia_recording
\section2 Low level Audio related classes
\annotatedlist multimedia_audio
\section2 Low level Video related classes
\annotatedlist multimedia_video
\section2 QML Elements
\annotatedlist multimedia_qml
See also \l{Multimedia QML Plugin}
\section2 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}.
\section2 QML Elements
\list
\o \l {SoundEffect}{SoundEffect: Low Latency Sound Effects}
\o \l {Audio}{Audio: Music playback}
\o \l {Video}{Video: Video playback}
\endlist
*/
*
***/

View File

@@ -119,7 +119,7 @@ The choice of what needs to be done depends on what the developer wishes to do w
\section2 Classes for service implementers.
\annotatedlist multimedia-serv
\annotatedlist multimedia_control
*/

View File

@@ -28,7 +28,7 @@
/*!
\group qml-multimedia
\title QML Multimedia Plugin
QML Support for the QtMobility Project Multimedia API.
QML Support for the Qt Multimedia API.
*/
/*!
@@ -36,19 +36,19 @@
\title Multimedia QML Plugin
\brief A QML plugin for the QtMobility Project Multimedia API.
\brief A QML plugin for the Qt Multimedia API.
\section1 Overview
The Multimedia API in the QtMobility Project gives developers a simplified way to use audio and video playback, and access camera functionality. The Multimedia QML Plugin provides a QML friendly interface to these features.
The Qt Multimedia API gives developers a simplified way to use audio and video playback, and access camera functionality. The Multimedia QML Plugin provides a QML friendly interface to these features.
\section1 Elements
\section2 Audio
The \l Audio element is an easy way to add audio playback to a Qt Quick
scene. QtMobility provides properties for control, methods (functions) and signals.
scene. QtMultimedia provides properties for control, methods (functions) and signals.
The code extract below shows the creation and use of an audio element.
@@ -285,7 +285,7 @@
\section1 Multimedia QML Elements
\annotatedlist qml-multimedia
\annotatedlist multimedia_qml
*/

View File

@@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
\qmlclass Audio QDeclarativeAudio
\brief The Audio element allows you to add audio playback to a scene.
\ingroup qml-multimedia
\ingroup multimedia_qml
This element is part of the \bold{QtMultimedia 5.0} module.

View File

@@ -71,7 +71,8 @@ void QDeclarativeCamera::_q_updateState(QCamera::State state)
/*!
\qmlclass Camera QDeclarativeCamera
\brief The Camera element allows you to add camera viewfinder to a scene.
\ingroup qml-multimedia
\ingroup multimedia_qml
\inherits Item
This element is part of the \bold{QtMultimedia 5.0} module.

View File

@@ -49,6 +49,14 @@
QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraCapture QDeclarativeCameraCapture
\brief The CameraCapture element provides an interface for camera capture related settings
\ingroup multimedia_qml
Documentation to be written.
*/
QDeclarativeCameraCapture::QDeclarativeCameraCapture(QCamera *camera, QObject *parent) :
QObject(parent),
m_camera(camera)

View File

@@ -47,7 +47,8 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraExposure QDeclarativeCameraExposure
\brief The CameraExposure element provides interface for exposure related camera settings.
\ingroup qml-multimedia
\ingroup multimedia_qml
This element is part of the \bold{QtMultimedia 5.0} module.
@@ -68,8 +69,10 @@ QT_BEGIN_NAMESPACE
*/
/*!
\internal
\class QDeclarativeCameraExposure
\brief The CameraExposure element provides interface for exposure related camera settings.
*/
/*!

View File

@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraFlash QDeclarativeCameraFlash
\brief The CameraFlash element provides interface for flash related camera settings.
\ingroup qml-multimedia
\ingroup multimedia_qml
This element is part of the \bold{QtMultimedia 5.0} module.

View File

@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraFocus QDeclarativeCameraFocus
\brief The CameraFocus element provides interface for focus related camera settings.
\ingroup qml-multimedia
\ingroup multimedia_qml
This element is part of the \bold{QtMultimedia 5.0} module.

View File

@@ -44,6 +44,14 @@
QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraImageProcessing QDeclarativeCameraImageProcessing
\brief The CameraCapture element provides an interface for camera capture related settings
\ingroup multimedia_qml
Documentation to be written.
*/
QDeclarativeCameraImageProcessing::QDeclarativeCameraImageProcessing(QCamera *camera, QObject *parent) :
QObject(parent)
{

View File

@@ -46,6 +46,14 @@
QT_BEGIN_NAMESPACE
/*!
\qmlclass CameraRecorder QDeclarativeCameraRecorder
\brief The CameraRecorder element provides an interface for camera movie recording related settings
\ingroup multimedia_qml
Documentation to be written.
*/
QDeclarativeCameraRecorder::QDeclarativeCameraRecorder(QCamera *camera, QObject *parent) :
QObject(parent)
{

View File

@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Radio QDeclarativeRadio
\brief The Radio element allows you to access radio functionality from a QML application.
\ingroup qml-multimedia
\ingroup multimedia_qml
\inherits Item
This element is part of the \bold{QtMultimedia 5.0} module.

View File

@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass RadioData QDeclarativeRadioData
\brief The RadioData element allows you to access RDS data from a QML application.
\ingroup qml-multimedia
\ingroup multimedia_qml
\inherits Item
This element is part of the \bold{QtMultimedia 5.0} module.

View File

@@ -70,7 +70,7 @@ void QDeclarativeVideo::_q_error(int errorCode, const QString &errorString)
\qmlclass Video QDeclarativeVideo
\brief The Video element allows you to add videos to a scene.
\inherits Item
\ingroup qml-multimedia
\ingroup multimedia_qml
This element is part of the \bold{QtMultimedia 5.0} module.

View File

@@ -119,7 +119,7 @@ private:
\qmlclass VideoOutput QDeclarativeVideoOutput
\brief The VideoOutput element allows you to render video or camera viewfinder.
\ingroup qml-multimedia
\ingroup multimedia_qml
This element is part of the \bold{QtMultimedia 5.0} module.

View File

@@ -67,6 +67,7 @@ public:
\brief The QAudio namespace contains enums used by the audio classes.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_audio
*/
/*

View File

@@ -107,6 +107,7 @@ public:
\brief The QAudioDeviceInfo class provides an interface to query audio devices and their functionality.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_audio
QAudioDeviceInfo lets you query for audio devices--such as sound
cards and USB headsets--that are currently available on the system.

View File

@@ -108,6 +108,7 @@ public:
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_audio
An audio format specifies how data in an audio stream is arranged,
i.e, how the stream is to be interpreted. The encoding itself is

View File

@@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_audio
You can construct an audio input with the system's
\l{QAudioDeviceInfo::defaultInputDevice()}{default audio input

View File

@@ -56,6 +56,7 @@ QT_BEGIN_NAMESPACE
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_audio
You can construct an audio output with the system's
\l{QAudioDeviceInfo::defaultOutputDevice()}{default audio output

View File

@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
\brief The QAbstractAudioDeviceInfo class is a base class for audio backends.
\ingroup multimedia
\ingroup multimedia_audio
\inmodule QtMultimedia
\internal

View File

@@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE
\brief The QAudioSystemPlugin class provides an abstract base for audio plugins.
\ingroup multimedia
\ingroup multimedia_audio
\inmodule QtMultimedia
\internal

View File

@@ -49,7 +49,7 @@
\brief The QSound class provides a way to play .wav sound files.
\ingroup multimedia
\ingroup multimedia_audio
Qt provides the most commonly required audio operation in GUI
applications: asynchronously playing a sound file. This is most

View File

@@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE
\brief The SoundEffect element provides a way to play sound effects in QML.
\inmodule QtMultimedia
\ingroup multimedia_qml
This element is part of the \bold{QtMultimedia 5.0} module.
@@ -62,6 +63,17 @@ QT_BEGIN_NAMESPACE
\snippet doc/src/snippets/multimedia-snippets/soundeffect.qml complete snippet
*/
/*!
\class QSoundEffect
\brief The QSoundEffect provides a way to play low latency sound effects.
\ingroup multimedia
\ingroup multimedia_audio
*/
/*!
\qmlproperty url SoundEffect::source

View File

@@ -81,7 +81,8 @@ QT_BEGIN_NAMESPACE
\brief The QCamera class provides interface for system camera devices.
\inmodule QtMultimedia
\ingroup camera
\ingroup multimedia
\ingroup multimedia_camera
QCamera can be used with QVideoWidget for viewfinder display,
QMediaRecorder for video recording and QCameraImageCapture for image taking.

View File

@@ -58,7 +58,8 @@ QT_BEGIN_NAMESPACE
\brief The QCameraExposure class provides interface for exposure related camera settings.
\inmodule QtMultimedia
\ingroup camera
\ingroup multimedia
\ingroup multimedia_camera
*/

View File

@@ -110,7 +110,8 @@ public:
\brief The QCameraFocusZone class provides information on zones used for autofocusing a camera.
\inmodule QtMultimedia
\ingroup camera
\ingroup multimedia
\ingroup multimedia_camera
For cameras that support autofocusing, in order for a camera to autofocus on
part of a sensor frame, it considers different zones within the frame. Which

View File

@@ -59,7 +59,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QCameraImageCapture
\inmodule QtMultimedia
\ingroup camera
\ingroup multimedia
\ingroup multimedia_camera
\brief The QCameraImageCapture class is used for the recording of media content.

View File

@@ -74,7 +74,8 @@ QT_BEGIN_NAMESPACE
image processing related camera settings.
\inmodule QtMultimedia
\ingroup camera
\ingroup multimedia
\ingroup multimedia_camera
After capturing the data for a camera frame, the camera hardware and
software performs various image processing tasks to produce a final

View File

@@ -48,7 +48,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QAudioEncoderControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QAudioEncoderControl class provides access to the settings of a
media service that performs audio encoding.

View File

@@ -51,7 +51,8 @@ QT_BEGIN_NAMESPACE
The format is of type QVideoFrame::PixelFormat.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
The interface name of QCameraCaptureBufferFormatControl is \c com.nokia.Qt.QCameraCaptureBufferFormatControl/1.0 as
defined in QCameraCaptureBufferFormatControl_iid.

View File

@@ -52,9 +52,8 @@ QT_BEGIN_NAMESPACE
Depending on backend capabilities capture to file, buffer or both can be supported.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
The interface name of QCameraCaptureDestinationControl is \c com.nokia.Qt.QCameraCaptureDestinationControl/1.0 as
defined in QCameraCaptureDestinationControl_iid.

View File

@@ -53,7 +53,8 @@ QT_BEGIN_NAMESPACE
classes that control still cameras or video cameras.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
This service is provided by a QMediaService object via
QMediaService::control(). It is used by QCamera.

View File

@@ -50,7 +50,8 @@ QT_BEGIN_NAMESPACE
\brief The QCameraExposureControl class allows controlling camera exposure parameters.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
You can adjust a number of parameters that will affect images and video taken with
the corresponding QCamera object.

View File

@@ -49,10 +49,10 @@ QT_BEGIN_NAMESPACE
\brief The QCameraFlashControl class allows controlling a camera's flash.
\ingroup multimedia-serv
\inmodule QtMultimedia
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_control
You can set the type of flash effect used when an image is captured, and test to see
if the flash hardware is ready to fire.

View File

@@ -52,7 +52,9 @@ QT_BEGIN_NAMESPACE
focusing related camera parameters.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
The interface name of QCameraFocusControl is \c com.nokia.Qt.QCameraFocusControl/1.0 as
defined in QCameraFocusControl_iid.

View File

@@ -51,9 +51,9 @@ QT_BEGIN_NAMESPACE
for image capture services.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
The interface name of QCameraImageCaptureControl is \c com.nokia.Qt.QCameraImageCaptureControl/1.0 as
defined in QCameraImageCaptureControl_iid.

View File

@@ -59,7 +59,9 @@ namespace
/*!
\class QCameraImageProcessingControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QCameraImageProcessingControl class provides an abstract class

View File

@@ -53,7 +53,9 @@ QT_BEGIN_NAMESPACE
classes that control still cameras or video cameras.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
This service is provided by a QMediaService object via
QMediaService::control(). It is used by QCamera.

View File

@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
\class QImageEncoderControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QImageEncoderControl class provides access to the settings of a media service that
performs image encoding.

View File

@@ -48,8 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaBackgroundPlaybackControl
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia
\ingroup multimedia_control
\brief The QMediaBackgroundPlaybackControl class provides access to the background playback
related control of a QMediaService.

View File

@@ -50,7 +50,9 @@ QT_BEGIN_NAMESPACE
\brief The QMediaContainerControl class provides access to the output container format of a QMediaService
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
If a QMediaService supports writing encoded data it will implement
QMediaContainerControl. This control provides information about the output

View File

@@ -45,7 +45,9 @@
/*!
\class QMediaGaplessPlaybackControl
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_control
\brief The QMediaGaplessPlaybackControl class provides access to the gapless playback
related control of a QMediaService.

View File

@@ -45,11 +45,12 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaNetworkAccessControl
\preliminary
\brief The QMediaNetworkAccessControl class allows the setting of the Network Access Point for media related activities.
\ingroup multimedia-serv
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_control
The functionality provided by this control allows the
setting of a Network Access Point.

View File

@@ -49,7 +49,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaPlayerControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QMediaPlayerControl class provides access to the media playing

View File

@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaPlaylistControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QMediaPlaylistControl class provides access to the playlist

View File

@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaPlaylistSourceControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QMediaPlaylistSourceControl class provides access to the playlist playback

View File

@@ -47,8 +47,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaRecorderControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QMediaRecorderControl class provides access to the recording
functionality of a QMediaService.

View File

@@ -58,10 +58,11 @@ namespace
/*!
\class QMediaStreamsControl
\preliminary
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QMediaStreamsControl class provides a media stream selection control.

View File

@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMetaDataReaderControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QMetaDataReaderControl class provides read access to the

View File

@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMetaDataWriterControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QMetaDataWriterControl class provides write access to the

View File

@@ -49,7 +49,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QRadioDataControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QRadioDataControl class provides access to the RDS functionality of the

View File

@@ -49,7 +49,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QRadioTunerControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QRadioTunerControl class provides access to the radio tuning

View File

@@ -48,7 +48,9 @@ QT_BEGIN_NAMESPACE
\brief The QVideoDeviceControl class provides an video device selector media control.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
The QVideoDeviceControl class provides descriptions of the video devices
available on a system and allows one to be selected as the endpoint of a

View File

@@ -49,7 +49,9 @@ QT_BEGIN_NAMESPACE
\class QVideoEncoderControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\brief The QVideoEncoderControl class provides access to the settings
of a media service that performs video encoding.

View File

@@ -48,12 +48,10 @@ QT_BEGIN_NAMESPACE
/*!
\class QVideoRendererControl
\brief The QVideoRendererControl class provides a control for rendering
to a video surface.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
Using the surface() property of QVideoRendererControl a
QAbstractVideoSurface may be set as the video render target of a

View File

@@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE
\brief The QAudioEndpointSelector class provides an audio endpoint selector media control.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_control
The QAudioEndpointSelector class provides descriptions of the audio
endpoints available on a system and allows one to be selected as the audio

View File

@@ -89,6 +89,7 @@ private:
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_playback
QMediaContent is used within the multimedia framework as the logical handle
to media content. A QMediaContent object is composed of one or more

View File

@@ -65,8 +65,7 @@ QT_BEGIN_NAMESPACE
\brief The QMediaPlayer class allows the playing of a media source.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_playback
The QMediaPlayer class is a high level media playback class. It can be used
to playback such content as songs, movies and internet radio. The content

View File

@@ -79,6 +79,7 @@ namespace
\class QMediaPlaylist
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_playback
\brief The QMediaPlaylist class provides a list of media content to play.

View File

@@ -49,6 +49,9 @@ QT_BEGIN_NAMESPACE
\brief The QMediaPlaylistReader class provides an interface for reading a playlist file.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_playback
\sa QMediaPlaylistIOPlugin
*/

View File

@@ -196,6 +196,7 @@ int QMediaPlaylistNavigatorPrivate::previousItemPos(int steps) const
\brief The QMediaPlaylistNavigator class provides navigation for a media playlist.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_playback
\sa QMediaPlaylist, QMediaPlaylistProvider
*/

View File

@@ -52,6 +52,9 @@ QT_BEGIN_NAMESPACE
\brief The QMediaPlaylistProvider class provides an abstract list of media.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_playback
\sa QMediaPlaylist
*/

View File

@@ -66,6 +66,7 @@ namespace
\brief The QMediaResource class provides a description of a media resource.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_playback
A media resource is composed of a \l {url()}{URL} containing the
location of the resource and a set of properties that describe the

View File

@@ -46,7 +46,9 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaBindableInterface
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_core
\brief The QMediaBindableInterface class is the base class for objects extending media objects functionality.

View File

@@ -52,8 +52,10 @@ QT_BEGIN_NAMESPACE
/*!
\class QMediaControl
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\ingroup multimedia_core
\brief The QMediaControl class provides a base interface for media service controls.

View File

@@ -69,9 +69,11 @@ void QMediaObjectPrivate::_q_notify()
\class QMediaObject
\brief The QMediaObject class provides a common base for multimedia objects.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_core
QMediaObject derived classes provide access to the functionality of a
QMediaService. Each media object hosts a QMediaService and uses the

View File

@@ -53,8 +53,9 @@ QT_BEGIN_NAMESPACE
\class QMediaService
\brief The QMediaService class provides a common base class for media
service implementations.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\ingroup multimedia_core
Media services provide implementations of the functionality promised

View File

@@ -85,7 +85,10 @@ public:
\brief The QMediaServiceProviderHint class describes what is required of a QMediaService.
\inmodule QtMultimedia
\ingroup multimedia-serv
\ingroup multimedia
\ingroup multimedia_control
\ingroup multimedia_core
The QMediaServiceProvider class uses hints to select an appropriate media service.
*/
@@ -526,6 +529,9 @@ Q_GLOBAL_STATIC(QPluginServiceProvider, pluginProvider);
/*!
\class QMediaServiceProvider
\ingroup multimedia
\ingroup multimedia_control
\ingroup multimedia_core
\brief The QMediaServiceProvider class provides an abstract allocator for media services.
*/

View File

@@ -49,7 +49,9 @@ QT_BEGIN_NAMESPACE
\class QMediaTimeInterval
\brief The QMediaTimeInterval class represents a time interval with integer precision.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_core
An interval is specified by an inclusive start() and end() time. These
must be set in the constructor, as this is an immutable class. The

View File

@@ -34,6 +34,9 @@ QT_BEGIN_NAMESPACE
\ingroup multimedia
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_core
\brief The QtMultimedia namespace contains miscellaneous identifiers used throughout the Qt Media services library.
QtMultimedia is a module containing the low level, low latency,

View File

@@ -69,6 +69,7 @@ namespace
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_radio
The radio data object will emit signals for any changes in radio data. You can enable or disable
alternative frequency with setAlternativeFrequenciesEnabled().

View File

@@ -73,6 +73,7 @@ namespace
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_radio
You can control the systems analog radio device using this interface, for example:

View File

@@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE
\brief The QAudioCaptureSource class provides an interface to query and select an audio input endpoint.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_recording
QAudioCaptureSource provides access to the audio inputs available on your system.

View File

@@ -87,6 +87,7 @@ private:
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_recording
A audio encoder settings object is used to specify the audio encoder
settings used by QMediaRecorder. Audio encoder settings are selected by

View File

@@ -65,7 +65,7 @@ QT_BEGIN_NAMESPACE
\class QMediaRecorder
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_recording
\brief The QMediaRecorder class is used for the recording of media content.

View File

@@ -65,6 +65,8 @@ namespace
\class QAbstractVideoBuffer
\brief The QAbstractVideoBuffer class is an abstraction for video data.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_video
The QVideoFrame class makes use of a QAbstractVideoBuffer internally to reference a buffer of
video data. Quite often video data buffers may reside in video memory rather than system

View File

@@ -83,6 +83,9 @@ public:
\brief The QAbstractVideoSurface class is a base class for video presentation surfaces.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_video
The QAbstractVideoSurface class defines the standard interface that video producers use to
inter-operate with video presentation surfaces. You can subclass this interface to receive
video frames from sources like \l {QMediaPlayer}{decoded media} or \l {QCamera}{cameras} to

View File

@@ -126,6 +126,9 @@ private:
\brief The QVideoFrame class represents a frame of video data.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_video
A QVideoFrame encapsulates the pixel data of a video frame, and information about the frame.
Video frames can come from several places - decoded \l {QMediaPlayer}{media}, a

View File

@@ -153,6 +153,9 @@ public:
surface.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_video
A video surface presents a stream of video frames. The surface's format describes the type of
the frames and determines how they should be presented.