+++ /dev/null
-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
+++ /dev/null
-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 = " "
+++ /dev/null
-include(qtmobility-project.qdocconf)
-include(qt-html-templates-online.qdocconf)
+++ /dev/null
-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
+++ /dev/null
-include(qtmobility-project.qdocconf)
-include(qt-html-templates.qdocconf)
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
+++ /dev/null
-
-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
\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
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
\section1 Classes
-\annotatedlist camera
+\annotatedlist multimedia_camera
*/
+++ /dev/null
-/****************************************************************************
-**
-** 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.
-*/
\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
-*/
+*
+***/
\section2 Classes for service implementers.
-\annotatedlist multimedia-serv
+\annotatedlist multimedia_control
*/
/*!
\group qml-multimedia
\title QML Multimedia Plugin
- QML Support for the QtMobility Project Multimedia API.
+ QML Support for the Qt Multimedia API.
*/
/*!
\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.
\section1 Multimedia QML Elements
- \annotatedlist qml-multimedia
+ \annotatedlist multimedia_qml
*/
\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.
/*!
\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.
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)
/*!
\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.
*/
/*!
+ \internal
\class QDeclarativeCameraExposure
\brief The CameraExposure element provides interface for exposure related camera settings.
+
*/
/*!
/*!
\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.
/*!
\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.
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)
{
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)
{
/*!
\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.
/*!
\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.
\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.
\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.
\brief The QAudio namespace contains enums used by the audio classes.
\inmodule QtMultimedia
\ingroup multimedia
+ \ingroup multimedia_audio
*/
/*
\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.
\brief The QAudioFormat class stores audio stream parameter information.
\inmodule QtMultimedia
- \ingroup multimedia
+ \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
\brief The QAudioInput class provides an interface for receiving audio data from an audio input device.
\inmodule QtMultimedia
- \ingroup multimedia
+ \ingroup multimedia
+ \ingroup multimedia_audio
You can construct an audio input with the system's
\l{QAudioDeviceInfo::defaultInputDevice()}{default audio input
\brief The QAudioOutput class provides an interface for sending audio data to an audio output device.
\inmodule QtMultimedia
- \ingroup multimedia
+ \ingroup multimedia
+ \ingroup multimedia_audio
You can construct an audio output with the system's
\l{QAudioDeviceInfo::defaultOutputDevice()}{default audio output
\brief The QAbstractAudioDeviceInfo class is a base class for audio backends.
\ingroup multimedia
+ \ingroup multimedia_audio
\inmodule QtMultimedia
\internal
\brief The QAudioSystemPlugin class provides an abstract base for audio plugins.
\ingroup multimedia
+ \ingroup multimedia_audio
\inmodule QtMultimedia
\internal
\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
\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.
*/
/*!
+ \class QSoundEffect
+ \brief The QSoundEffect provides a way to play low latency sound effects.
+
+ \ingroup multimedia
+ \ingroup multimedia_audio
+
+*/
+
+
+
+/*!
\qmlproperty url SoundEffect::source
This property provides a way to control the sound to play.
\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.
\brief The QCameraExposure class provides interface for exposure related camera settings.
\inmodule QtMultimedia
- \ingroup camera
+ \ingroup multimedia
+ \ingroup multimedia_camera
*/
\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
/*!
\class QCameraImageCapture
\inmodule QtMultimedia
- \ingroup camera
+ \ingroup multimedia
+ \ingroup multimedia_camera
\brief The QCameraImageCapture class is used for the recording of media content.
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
/*!
\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.
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.
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.
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.
\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.
\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.
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.
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.
/*!
\class QCameraImageProcessingControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QCameraImageProcessingControl class provides an abstract class
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.
\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.
/*!
\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.
\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
/*!
\class QMediaGaplessPlaybackControl
\inmodule QtMultimedia
+
\ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaGaplessPlaybackControl class provides access to the gapless playback
related control of a QMediaService.
/*!
\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.
/*!
\class QMediaPlayerControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaPlayerControl class provides access to the media playing
/*!
\class QMediaPlaylistControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaPlaylistControl class provides access to the playlist
/*!
\class QMediaPlaylistSourceControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMediaPlaylistSourceControl class provides access to the playlist playback
/*!
\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.
/*!
\class QMediaStreamsControl
- \preliminary
-
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
+
\brief The QMediaStreamsControl class provides a media stream selection control.
/*!
\class QMetaDataReaderControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMetaDataReaderControl class provides read access to the
/*!
\class QMetaDataWriterControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QMetaDataWriterControl class provides write access to the
/*!
\class QRadioDataControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QRadioDataControl class provides access to the RDS functionality of the
/*!
\class QRadioTunerControl
\inmodule QtMultimedia
- \ingroup multimedia-serv
+
+ \ingroup multimedia
+ \ingroup multimedia_control
\brief The QRadioTunerControl class provides access to the radio tuning
\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
\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.
/*!
\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
\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
\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
\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
\class QMediaPlaylist
\inmodule QtMultimedia
\ingroup multimedia
+ \ingroup multimedia_playback
\brief The QMediaPlaylist class provides a list of media content to play.
\brief The QMediaPlaylistReader class provides an interface for reading a playlist file.
\inmodule QtMultimedia
+ \ingroup multimedia
+ \ingroup multimedia_playback
+
\sa QMediaPlaylistIOPlugin
*/
\brief The QMediaPlaylistNavigator class provides navigation for a media playlist.
\inmodule QtMultimedia
\ingroup multimedia
+ \ingroup multimedia_playback
\sa QMediaPlaylist, QMediaPlaylistProvider
*/
\brief The QMediaPlaylistProvider class provides an abstract list of media.
\inmodule QtMultimedia
+ \ingroup multimedia
+ \ingroup multimedia_playback
+
\sa QMediaPlaylist
*/
\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
/*!
\class QMediaBindableInterface
\inmodule QtMultimedia
+
\ingroup multimedia
+ \ingroup multimedia_core
\brief The QMediaBindableInterface class is the base class for objects extending media objects functionality.
/*!
\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.
\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
\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
\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.
*/
/*!
\class QMediaServiceProvider
+ \ingroup multimedia
+ \ingroup multimedia_control
+ \ingroup multimedia_core
\brief The QMediaServiceProvider class provides an abstract allocator for media services.
*/
\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
\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,
\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().
\inmodule QtMultimedia
\ingroup multimedia
+ \ingroup multimedia_radio
You can control the systems analog radio device using this interface, for example:
\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.
\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
\class QMediaRecorder
\inmodule QtMultimedia
\ingroup multimedia
-
+ \ingroup multimedia_recording
\brief The QMediaRecorder class is used for the recording of media content.
\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
\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
\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
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.
projects / platform / upstream / qtmultimedia.git / commitdiff