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

Fix a number of doc errors and warnings.

Browse Source 
* Document a few missing classes/functions/methods
* Fix a number of QML snippets that wouldn't work as standalone snippets
* Add files to .pro so they show up in Creator..

Still the mysterious lack of controls dir documentation persists :/

Change-Id: I57162371a4d966e4db5bdb1b71d1baf9c0ca57c3
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
Michael Goddard
2012-04-10 20:19:34 +10:00
committed by Qt by Nokia
parent 9b162f9844
commit 8484b0ff9c
20 changed files with 594 additions and 327 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/doc.pro
View File

@@ -8,3 +8,27 @@ TEMPLATE = subdirs
# Doc snippets use widgets # Doc snippets use widgets
!isEmpty(QT.widgets.name): SUBDIRS += src/snippets !isEmpty(QT.widgets.name): SUBDIRS += src/snippets
OTHER_FILES += \
src/audioengineoverview.qdoc \
src/audiooverview.qdoc \
src/cameraoverview.qdoc \
src/changes.qdoc \
src/multimediabackend.qdoc \
src/multimedia.qdoc \
src/qtmultimedia5.qdoc \
src/radiooverview.qdoc \
src/videooverview.qdoc \
src/examples/audiodevices.qdoc \
src/examples/audioinput.qdoc \
src/examples/audiooutput.qdoc \
src/examples/audiorecorder.qdoc \
src/examples/camera.qdoc \
src/examples/declarative-camera.qdoc \
src/examples/declarative-radio.qdoc \
src/examples/player.qdoc \
src/examples/qmlvideofx.qdoc \
src/examples/qmlvideo.qdoc \
src/examples/spectrum.qdoc \
src/examples/videographicsitem.qdoc \
src/examples/videowidget.qdoc

1
doc/src/audioengineoverview.qdoc
View File

@@ -51,6 +51,7 @@ import QtAudioEngine 1.0
AudioEngine { AudioEngine {
//... //...
}
\endqml \endqml
\section1 Examples \section1 Examples

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

@@ -58,6 +58,10 @@
import QtMultimedia 5.0 import QtMultimedia 5.0
// ... // ...
Item {
width: 640
height: 360
Audio { Audio {
id: playMusic id: playMusic
source: "music.wav" source: "music.wav"
@@ -68,6 +72,7 @@
anchors.fill: parent anchors.fill: parent
onPressed: { playMusic.play() } onPressed: { playMusic.play() }
} }
}
\endqml \endqml
@@ -194,6 +199,9 @@
import QtQuick 2.0 import QtQuick 2.0
import QtMultimedia 5.0 import QtMultimedia 5.0
Item {
width: 640
height: 360
SoundEffect { SoundEffect {
id: effect id: effect
@@ -204,6 +212,7 @@
anchors.fill: parent anchors.fill: parent
onPressed: { effect.play() } onPressed: { effect.play() }
} }
}
\endqml \endqml

6
src/imports/multimedia/qdeclarativecamera.cpp
View File

@@ -93,6 +93,10 @@ void QDeclarativeCamera::_q_availabilityChanged(QtMultimedia::AvailabilityError
import QtQuick 2.0 import QtQuick 2.0
import QtMultimedia 5.0 import QtMultimedia 5.0
Item {
width: 640
height: 360
Camera { Camera {
id: camera id: camera
@@ -114,12 +118,14 @@ void QDeclarativeCamera::_q_availabilityChanged(QtMultimedia::AvailabilityError
VideoOutput { VideoOutput {
source: camera source: camera
anchors.fill: parent
focus : visible // to receive focus and capture key events when visible focus : visible // to receive focus and capture key events when visible
} }
Image { Image {
id: photoPreview id: photoPreview
} }
}
\endqml \endqml
The various settings and functionality of the Camera stack is spread The various settings and functionality of the Camera stack is spread

6
src/imports/multimedia/qdeclarativecameracapture.cpp
View File

@@ -67,6 +67,10 @@ QT_BEGIN_NAMESPACE
import QtQuick 2.0 import QtQuick 2.0
import QtMultimedia 5.0 import QtMultimedia 5.0
Item {
width: 640
height: 360
Camera { Camera {
id: camera id: camera
@@ -81,6 +85,7 @@ QT_BEGIN_NAMESPACE
VideoOutput { VideoOutput {
source: camera source: camera
focus : visible // to receive focus and capture key events when visible focus : visible // to receive focus and capture key events when visible
anchors.fill: parent
MouseArea { MouseArea {
anchors.fill: parent; anchors.fill: parent;
@@ -91,6 +96,7 @@ QT_BEGIN_NAMESPACE
Image { Image {
id: photoPreview id: photoPreview
} }
}
\endqml \endqml
*/ */

12
src/imports/multimedia/qdeclarativecamerafocus.cpp
View File

@@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE
import QtQuick 2.0 import QtQuick 2.0
import QtMultimedia 5.0 import QtMultimedia 5.0
Item {
width: 640
height: 360
Camera { Camera {
id: camera id: camera
@@ -74,6 +78,12 @@ QT_BEGIN_NAMESPACE
} }
} }
VideoOutput {
source: camera
anchors.fill: parent
}
}
\endqml \endqml
*/ */
@@ -232,7 +242,7 @@ void QDeclarativeCameraFocus::setCustomFocusPoint(const QPointF &point)
color: "transparent" color: "transparent"
// Map from the relative, normalized frame coordinates // Map from the relative, normalized frame coordinates
property mappedRect: viewfinder.mapNormalizedRectToItem(area); property variant mappedRect: viewfinder.mapNormalizedRectToItem(area);
x: mappedRect.x x: mappedRect.x
y: mappedRect.y y: mappedRect.y

5
src/imports/multimedia/qdeclarativeradio.cpp
View File

@@ -419,6 +419,10 @@ void QDeclarativeRadio::scanUp()
and if the user presses a station, the radio is tuned to this station. and if the user presses a station, the radio is tuned to this station.
\qml \qml
Item {
width: 640
height: 360
Radio { Radio {
id: radio id: radio
onStationFound: radioStations.append({"frequency": frequency, "stationId": stationId}) onStationFound: radioStations.append({"frequency": frequency, "stationId": stationId})
@@ -449,6 +453,7 @@ void QDeclarativeRadio::scanUp()
onClicked: radio.searchAllStations(Radio.SearchGetStationId) onClicked: radio.searchAllStations(Radio.SearchGetStationId)
} }
} }
}
\endqml \endqml
*/ */
void QDeclarativeRadio::searchAllStations(QDeclarativeRadio::SearchMode searchMode) void QDeclarativeRadio::searchAllStations(QDeclarativeRadio::SearchMode searchMode)

8
src/multimedia/audio/qaudio.cpp
View File

@@ -62,7 +62,7 @@ public:
} }
/* /*!
\namespace QAudio \namespace QAudio
\brief The QAudio namespace contains enums used by the audio classes. \brief The QAudio namespace contains enums used by the audio classes.
\inmodule QtMultimedia \inmodule QtMultimedia
@@ -70,7 +70,7 @@ public:
\ingroup multimedia_audio \ingroup multimedia_audio
*/ */
/* /*!
\enum QAudio::Error \enum QAudio::Error
\value NoError No errors have occurred \value NoError No errors have occurred
@@ -80,7 +80,7 @@ public:
\value FatalError A non-recoverable error has occurred, the audio device is not usable at this time. \value FatalError A non-recoverable error has occurred, the audio device is not usable at this time.
*/ */
/* /*!
\enum QAudio::State \enum QAudio::State
\value ActiveState Audio data is being processed, this state is set after start() is called \value ActiveState Audio data is being processed, this state is set after start() is called
@@ -92,7 +92,7 @@ public:
is set after start() is called and while no audio data is available to be processed. is set after start() is called and while no audio data is available to be processed.
*/ */
/* /*!
\enum QAudio::Mode \enum QAudio::Mode
\value AudioOutput audio output device \value AudioOutput audio output device

152
src/multimedia/audio/qaudiobuffer.cpp
View File

@@ -371,6 +371,17 @@ qint64 QAudioBuffer::startTime() const
This method is preferred over the const version of \l data() to This method is preferred over the const version of \l data() to
prevent unnecessary copying. prevent unnecessary copying.
There is also a templatized version of this constData() function that
allows you to retrieve a specific type of read-only pointer to
the data. Note that there is no checking done on the format of
the audio buffer - this is simply a convenience function.
\code
// With a 16bit sample buffer:
const quint16 *data = buffer->constData<quint16>();
\endcode
*/ */
const void* QAudioBuffer::constData() const const void* QAudioBuffer::constData() const
{ {
@@ -384,6 +395,16 @@ const void* QAudioBuffer::constData() const
You should use the \l constData() function rather than this You should use the \l constData() function rather than this
to prevent accidental deep copying. to prevent accidental deep copying.
There is also a templatized version of this data() function that
allows you to retrieve a specific type of read-only pointer to
the data. Note that there is no checking done on the format of
the audio buffer - this is simply a convenience function.
\code
// With a 16bit sample const buffer:
const quint16 *data = buffer->data<quint16>();
\endcode
*/ */
const void* QAudioBuffer::data() const const void* QAudioBuffer::data() const
{ {
@@ -392,6 +413,12 @@ const void* QAudioBuffer::data() const
return d->mProvider->constData(); return d->mProvider->constData();
} }
/*
Template data/constData functions caused override problems with qdoc,
so moved their docs into the non template versions.
*/
/*! /*!
Returns a pointer to this buffer's data. You can modify the Returns a pointer to this buffer's data. You can modify the
data through the returned pointer. data through the returned pointer.
@@ -407,6 +434,16 @@ const void* QAudioBuffer::data() const
change both buffer instances. Calling \l data() on either instance change both buffer instances. Calling \l data() on either instance
will again cause a deep copy to be made, which may invalidate will again cause a deep copy to be made, which may invalidate
the pointers returned from this function previously. the pointers returned from this function previously.
There is also a templatized version of data() allows you to retrieve
a specific type of pointer to the data. Note that there is no
checking done on the format of the audio buffer - this is
simply a convenience function.
\code
// With a 16bit sample buffer:
quint16 *data = buffer->data<quint16>(); // May cause deep copy
\endcode
*/ */
void *QAudioBuffer::data() void *QAudioBuffer::data()
{ {
@@ -447,4 +484,119 @@ void *QAudioBuffer::data()
return 0; return 0;
} }
// Template helper classes worth documenting
/*!
\class QAudioBuffer::StereoSampleDefault
\internal
Just a trait class for the default value.
*/
/*!
\class QAudioBuffer::StereoSample
\brief The StereoSample class provides a simple wrapper for a stereo audio sample.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_audio
This templatized structure lets you treat a block of individual samples as an
interleaved stereo stream. This is most useful when used with the templatized
\l {QAudioBuffer::data()}{data()} functions of QAudioBuffer. Generally the data
is accessed as a pointer, so no copying should occur.
There are some predefined instantiations of this template for working with common
stereo sample depths in a convenient way.
This structure has \e left and \e right members for accessing individual channel data.
For example:
\code
// Assuming 'buffer' is an unsigned 16 bit stereo buffer..
QAudioBuffer::S16U *sample = buffer->data<QAudioBuffer::S16U>();
for (int i=0; i < buffer->sampleCount() / 2; i++) {
qSwap(sample[i].left, sample[i].right);
}
\endcode
\sa QAudioBuffer::S8U, QAudioBuffer::S8S, QAudioBuffer::S16S, QAudioBuffer::S16U, QAudioBuffer::S32F
*/
/*!
\fn QAudioBuffer::StereoSample::StereoSample()
Constructs a new sample with the "silent" value for this
sample format (0 for signed formats and floats, 0x8* for unsigned formats).
*/
/*!
\fn QAudioBuffer::StereoSample::StereoSample(T leftSample, T rightSample)
Constructs a new sample with the supplied \a leftSample and \a rightSample values.
*/
/*!
\fn QAudioBuffer::StereoSample::operator=(const StereoSample &other)
Assigns \a other to this sample.
*/
/*!
\fn QAudioBuffer::StereoSample::average() const
Returns the arithmetic average of the left and right samples.
*/
/*! \fn QAudioBuffer::StereoSample::clear()
Sets the values of this sample to the "silent" value.
*/
/*!
\variable QAudioBuffer::StereoSample::left
\brief the left sample
*/
/*!
\variable QAudioBuffer::StereoSample::right
\brief the right sample
*/
/*!
\typedef QAudioBuffer::S8U
\relates QAudioBuffer::StereoSample
This is a predefined specialization for an unsigned stereo 8 bit sample. Each
channel is an \e {unsigned char}.
*/
/*!
\typedef QAudioBuffer::S8S
\relates QAudioBuffer::StereoSample
This is a predefined specialization for a signed stereo 8 bit sample. Each
channel is a \e {signed char}.
*/
/*!
\typedef QAudioBuffer::S16U
\relates QAudioBuffer::StereoSample
This is a predefined specialization for an unsigned stereo 16 bit sample. Each
channel is an \e {unsigned short}.
*/
/*!
\typedef QAudioBuffer::S16S
\relates QAudioBuffer::StereoSample
This is a predefined specialization for a signed stereo 16 bit sample. Each
channel is a \e {signed short}.
*/
/*!
\typedef QAudioBuffer::S32F
\relates QAudioBuffer::StereoSample
This is a predefined specialization for an 32 bit float sample. Each
channel is a \e float.
*/
QT_END_NAMESPACE QT_END_NAMESPACE

20
src/multimedia/audio/qaudiodecoder_p.cpp
View File

@@ -69,7 +69,7 @@ QT_BEGIN_NAMESPACE
directly to audio hardware, and playlists and network and streaming directly to audio hardware, and playlists and network and streaming
based media is not supported. based media is not supported.
\sa QAudioBuffer, QAudioDecoder \sa QAudioBuffer
*/ */
namespace namespace
@@ -130,7 +130,7 @@ void QAudioDecoderPrivate::_q_error(int error, const QString &errorString)
/*! /*!
Construct an QAudioDecoder instance Construct an QAudioDecoder instance
parented to \a parent and with \a flags. parented to \a parent.
*/ */
QAudioDecoder::QAudioDecoder(QObject *parent) QAudioDecoder::QAudioDecoder(QObject *parent)
: QMediaObject(*new QAudioDecoderPrivate, : QMediaObject(*new QAudioDecoderPrivate,
@@ -204,7 +204,7 @@ QString QAudioDecoder::errorString() const
Alternatively, if you wish to block until enough data has been decoded, Alternatively, if you wish to block until enough data has been decoded,
you can call read() at any time to block until a buffer is ready. you can call read() at any time to block until a buffer is ready.
\sa read(), bufferSize() \sa read()
*/ */
void QAudioDecoder::start() void QAudioDecoder::start()
{ {
@@ -267,7 +267,7 @@ void QAudioDecoder::setSourceFilename(const QString &fileName)
/*! /*!
Returns the current source QIODevice, if one was set. Returns the current source QIODevice, if one was set.
If \l setSourceFilename was called, this will be 0. If \l setSourceFilename() was called, this will be 0.
*/ */
QIODevice *QAudioDecoder::sourceDevice() const QIODevice *QAudioDecoder::sourceDevice() const
{ {
@@ -299,7 +299,7 @@ void QAudioDecoder::setSourceDevice(QIODevice *device)
Any buffers returned should have this format. Any buffers returned should have this format.
\sa setAudioFormat, audioFormatChanged \sa setAudioFormat(), formatChanged()
*/ */
QAudioFormat QAudioDecoder::audioFormat() const QAudioFormat QAudioDecoder::audioFormat() const
{ {
@@ -366,6 +366,8 @@ QtMultimedia::SupportEstimate QAudioDecoder::hasSupport(const QString &mimeType,
} }
/*! /*!
\fn QAudioDecoder::bufferAvailable() const
Returns true if a buffer is available to be read, Returns true if a buffer is available to be read,
and false otherwise. If there is no buffer available, calling and false otherwise. If there is no buffer available, calling
the \l read() function may block until a buffer is available or the \l read() function may block until a buffer is available or
@@ -471,7 +473,7 @@ QAudioBuffer QAudioDecoder::read() const
Signals that the current audio format of the decoder has changed to \a format. Signals that the current audio format of the decoder has changed to \a format.
\sa audioFormat(), setAudioFormat \sa audioFormat(), setAudioFormat()
*/ */
/*! /*!
@@ -498,7 +500,7 @@ QAudioBuffer QAudioDecoder::read() const
Signals that the decoding has finished successfully. Signals that the decoding has finished successfully.
If decoding fails, error signal is emitted instead. If decoding fails, error signal is emitted instead.
\sa start(), stop(), error \sa start(), stop(), error()
*/ */
/*! /*!
@@ -506,7 +508,7 @@ QAudioBuffer QAudioDecoder::read() const
Signals that the current \a position of the decoder has changed. Signals that the current \a position of the decoder has changed.
\sa durationChanged \sa durationChanged()
*/ */
/*! /*!
@@ -514,7 +516,7 @@ QAudioBuffer QAudioDecoder::read() const
Signals that the estimated \a duration of the decoded data has changed. Signals that the estimated \a duration of the decoded data has changed.
\sa positionChanged \sa positionChanged()
*/ */

12
src/multimedia/camera/qcameraimagecapture.cpp
View File

@@ -424,7 +424,7 @@ void QCameraImageCapture::setEncodingSettings(const QImageEncoderSettings &setti
/*! /*!
Returns the list of supported buffer image capture formats. Returns the list of supported buffer image capture formats.
\sa bufferFormat() setBufferFormat() \sa bufferFormat(), setBufferFormat()
*/ */
QList<QVideoFrame::PixelFormat> QCameraImageCapture::supportedBufferFormats() const QList<QVideoFrame::PixelFormat> QCameraImageCapture::supportedBufferFormats() const
{ {
@@ -437,7 +437,7 @@ QList<QVideoFrame::PixelFormat> QCameraImageCapture::supportedBufferFormats() co
/*! /*!
Returns the buffer image capture format being used. Returns the buffer image capture format being used.
\sa supportedBufferFormats() setBufferFormat() \sa supportedBufferFormats(), setBufferFormat()
*/ */
QVideoFrame::PixelFormat QCameraImageCapture::bufferFormat() const QVideoFrame::PixelFormat QCameraImageCapture::bufferFormat() const
{ {
@@ -450,7 +450,7 @@ QVideoFrame::PixelFormat QCameraImageCapture::bufferFormat() const
/*! /*!
Sets the buffer image capture \a format to be used. Sets the buffer image capture \a format to be used.
\sa bufferFormat() supportedBufferFormats() captureDestination() \sa bufferFormat(), supportedBufferFormats(), captureDestination()
*/ */
void QCameraImageCapture::setBufferFormat(const QVideoFrame::PixelFormat format) void QCameraImageCapture::setBufferFormat(const QVideoFrame::PixelFormat format)
{ {
@@ -461,7 +461,7 @@ void QCameraImageCapture::setBufferFormat(const QVideoFrame::PixelFormat format)
/*! /*!
Returns true if the image capture \a destination is supported; otherwise returns false. Returns true if the image capture \a destination is supported; otherwise returns false.
\sa captureDestination() setCaptureDestination() \sa captureDestination(), setCaptureDestination()
*/ */
bool QCameraImageCapture::isCaptureDestinationSupported(QCameraImageCapture::CaptureDestinations destination) const bool QCameraImageCapture::isCaptureDestinationSupported(QCameraImageCapture::CaptureDestinations destination) const
{ {
@@ -474,7 +474,7 @@ bool QCameraImageCapture::isCaptureDestinationSupported(QCameraImageCapture::Cap
/*! /*!
Returns the image capture destination being used. Returns the image capture destination being used.
\sa isCaptureDestinationSupported() setCaptureDestination() \sa isCaptureDestinationSupported(), setCaptureDestination()
*/ */
QCameraImageCapture::CaptureDestinations QCameraImageCapture::captureDestination() const QCameraImageCapture::CaptureDestinations QCameraImageCapture::captureDestination() const
{ {
@@ -487,7 +487,7 @@ QCameraImageCapture::CaptureDestinations QCameraImageCapture::captureDestination
/*! /*!
Sets the capture \a destination to be used. Sets the capture \a destination to be used.
\sa isCaptureDestinationSupported() captureDestination() \sa isCaptureDestinationSupported(), captureDestination()
*/ */
void QCameraImageCapture::setCaptureDestination(QCameraImageCapture::CaptureDestinations destination) void QCameraImageCapture::setCaptureDestination(QCameraImageCapture::CaptureDestinations destination)
{ {

19
src/multimedia/controls/qaudiodecodercontrol_p.cpp
View File

@@ -173,6 +173,15 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
Signals that a new buffer is ready for reading. Signals that a new buffer is ready for reading.
*/ */
/*!
\fn QAudioDecoderControl::bufferAvailable() const
Returns true if a buffer is available to be read,
and false otherwise. If there is no buffer available, calling
the \l read() function may block until a buffer is available or
the end of the media is reached
*/
/*! /*!
\fn QAudioDecoderControl::sourceChanged() \fn QAudioDecoderControl::sourceChanged()
@@ -186,7 +195,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
Signals that the current audio format of the decoder has changed to \a format. Signals that the current audio format of the decoder has changed to \a format.
\sa audioFormat(), setAudioFormat \sa audioFormat(), setAudioFormat()
*/ */
/*! /*!
@@ -195,7 +204,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
Signals that the decoding has finished successfully. Signals that the decoding has finished successfully.
If decoding fails, error signal is emitted instead. If decoding fails, error signal is emitted instead.
\sa start(), stop(), error \sa start(), stop(), error()
*/ */
/*! /*!
@@ -203,7 +212,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
Signals that the current \a position of the decoder has changed. Signals that the current \a position of the decoder has changed.
\sa durationChanged \sa durationChanged()
*/ */
/*! /*!
@@ -211,7 +220,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
Signals that the estimated \a duration of the decoded data has changed. Signals that the estimated \a duration of the decoded data has changed.
\sa positionChanged \sa positionChanged()
*/ */
/*! /*!
@@ -220,7 +229,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
Any buffers returned should have this format. Any buffers returned should have this format.
\sa setAudioFormat, audioFormatChanged \sa setAudioFormat(), formatChanged()
*/ */
/*! /*!

18
src/multimedia/controls/qcameraexposurecontrol.cpp
View File

@@ -53,22 +53,18 @@ QT_BEGIN_NAMESPACE
\ingroup multimedia \ingroup multimedia
\ingroup multimedia_control \ingroup multimedia_control
The QCameraExposure class is the usual method of adjusting exposure related parameters
when using camera functionality. This class provides a more complete but less easy
to use interface, and also forms the interface to implement when writing a new
implementation of QCamera functionality.
You can adjust a number of parameters that will affect images and video taken with You can adjust a number of parameters that will affect images and video taken with
the corresponding QCamera object. the corresponding QCamera object - see the \l {QCameraExposureControl::ExposureParameter}{ExposureParameter} enumeration.
There are a number of different parameters that can be adjusted, including:
\table
\row
\header
\
\endtable
The interface name of QCameraExposureControl is \c org.qt-project.qt.cameraexposurecontrol/5.0 as The interface name of QCameraExposureControl is \c org.qt-project.qt.cameraexposurecontrol/5.0 as
defined in QCameraExposureControl_iid. defined in QCameraExposureControl_iid.
\sa QCamera \sa QCameraExposure, QCamera
*/ */
/*! /*!

6
src/multimedia/controls/qcamerafocuscontrol.cpp
View File

@@ -172,7 +172,7 @@ QCameraFocusControl::~QCameraFocusControl()
Signal is emitted when the focus \a mode is changed, Signal is emitted when the focus \a mode is changed,
usually in result of QCameraFocusControl::setFocusMode call or capture mode changes. usually in result of QCameraFocusControl::setFocusMode call or capture mode changes.
\sa QCameraFocusControl::focusMode() QCameraFocusControl::setFocusMode() \sa QCameraFocusControl::focusMode(), QCameraFocusControl::setFocusMode()
*/ */
/*! /*!
@@ -181,7 +181,7 @@ QCameraFocusControl::~QCameraFocusControl()
Signal is emitted when the focus point \a mode is changed, Signal is emitted when the focus point \a mode is changed,
usually in result of QCameraFocusControl::setFocusPointMode call or capture mode changes. usually in result of QCameraFocusControl::setFocusPointMode call or capture mode changes.
\sa QCameraFocusControl::focusPointMode() QCameraFocusControl::setFocusPointMode() \sa QCameraFocusControl::focusPointMode(), QCameraFocusControl::setFocusPointMode()
*/ */
/*! /*!
@@ -189,7 +189,7 @@ QCameraFocusControl::~QCameraFocusControl()
Signal is emitted when the custom focus \a point is changed. Signal is emitted when the custom focus \a point is changed.
\sa QCameraFocusControl::customFocusPoint() QCameraFocusControl::setCustomFocusPoint() \sa QCameraFocusControl::customFocusPoint(), QCameraFocusControl::setCustomFocusPoint()
*/ */

5
src/multimedia/controls/qvideorenderercontrol.h
View File

@@ -51,11 +51,6 @@ QT_BEGIN_NAMESPACE
QT_MODULE(Multimedia) QT_MODULE(Multimedia)
class QAbstractVideoSurface; class QAbstractVideoSurface;
QT_END_NAMESPACE
QT_BEGIN_NAMESPACE
class Q_MULTIMEDIA_EXPORT QVideoRendererControl : public QMediaControl class Q_MULTIMEDIA_EXPORT QVideoRendererControl : public QMediaControl
{ {
Q_OBJECT Q_OBJECT

4
src/multimedia/multimedia.pro
View File

@@ -69,7 +69,3 @@ mac {
} }
HEADERS += $$PUBLIC_HEADERS $$PRIVATE_HEADERS HEADERS += $$PUBLIC_HEADERS $$PRIVATE_HEADERS
OTHER_FILES += \
qaudionamespace.qdoc \

71
src/multimedia/qaudionamespace.qdoc
View File

@@ -1,71 +0,0 @@
/****************************************************************************
**
** 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$
**
****************************************************************************/
/*!
\namespace QAudio
\brief The QAudio namespace contains enums used by the audio classes.
\inmodule QtMultimedia
\ingroup multimedia
\inheaderfile qaudio.h
*/
/*
\enum QAudio::Error
Error states
\value NoError No errors have occurred
\value OpenError An error opening the audio device
\value IOError An error occurred during read/write of audio device
\value UnderrunError Audio data is not being fed to the audio device at a fast enough rate
\value FatalError A non-recoverable error has occurred, the audio device is not usable at this time.
*/
/*
\enum QAudio::State
Audio processing states
\value ActiveState Audio data is being processed, this state is set after start() is called
and while audio data is available to be processed.
\value SuspendedState The audio device is in a suspended state, this state will only be entered
after suspend() is called.
\value StoppedState The audio device is closed, not processing any audio data
\value IdleState The QIODevice passed in has no data and audio system's buffer is empty, this state
is set after start() is called and while no audio data is available to be processed.
*/
/*
\enum QAudio::Mode
Audio I/O modes
\value AudioOutput audio output device
\value AudioInput audio input device
*/

275
src/multimedia/qtmedianamespace.cpp
View File

@@ -31,17 +31,14 @@ QT_BEGIN_NAMESPACE
/*! /*!
\namespace QtMultimedia \namespace QtMultimedia
\inheaderfile qtmedianamespace.h
\ingroup multimedia \ingroup multimedia
\inmodule QtMultimedia \inmodule QtMultimedia
\ingroup multimedia \ingroup multimedia
\ingroup multimedia_core \ingroup multimedia_core
\brief The QtMultimedia namespace contains miscellaneous identifiers used throughout the Qt Media services library. \brief The QtMultimedia namespace contains miscellaneous identifiers used throughout the Qt Multimedia library.
QtMultimedia is a module containing the low level, low latency,
Multimedia APIs which were introduced in Qt 4.6 and also includes the
high level QtMultimedia APIs which were introduced in QtMobility 1.0.
*/ */
@@ -196,162 +193,172 @@ Q_DEFINE_METADATA(ThumbnailImage);
\note Not all identifiers are supported on all platforms. Please consult vendor documentation for specific support \note Not all identifiers are supported on all platforms. Please consult vendor documentation for specific support
on different platforms. on different platforms.
\table 60%
\header \li {3,1}
Common attributes Common attributes
\value Title The title of the media. QString. \header \li Value \li Description \li Type
\value SubTitle The sub-title of the media. QString. \row \li Title \li The title of the media. \li QString
\value Author The authors of the media. QStringList. \row \li SubTitle \li The sub-title of the media. \li QString
\value Comment A user comment about the media. QString. \row \li Author \li The authors of the media. \li QStringList
\value Description A description of the media. QString \row \li Comment \li A user comment about the media. \li QString
\value Category The category of the media. QStringList. \row \li Description \li A description of the media. \li QString
\value Genre The genre of the media. QStringList. \row \li Category \li The category of the media. \li QStringList
\value Year The year of release of the media. int. \row \li Genre \li The genre of the media. \li QStringList
\value Date The date of the media. QDate. \row \li Year \li The year of release of the media. \li int
\value UserRating A user rating of the media. int [0..100]. \row \li Date \li The date of the media. \li QDate.
\value Keywords A list of keywords describing the media. QStringList. \row \li UserRating \li A user rating of the media. \li int [0..100]
\value Language The language of media, as an ISO 639-2 code. \row \li Keywords \li A list of keywords describing the media. \li QStringList
\row \li Language \li The language of media, as an ISO 639-2 code. \li QString
\value Publisher The publisher of the media. QString. \row \li Publisher \li The publisher of the media. \li QString
\value Copyright The media's copyright notice. QString. \row \li Copyright \li The media's copyright notice. \li QString
\value ParentalRating The parental rating of the media. QString. \row \li ParentalRating \li The parental rating of the media. \li QString
\value RatingOrganization The organization responsible for the parental rating of the media. \row \li RatingOrganization \li The organization responsible for the parental rating of the media.
QString. \li QString
\header \li {3,1}
Media attributes Media attributes
\value Size The size in bytes of the media. qint64 \row \li Size \li The size in bytes of the media. \li qint64
\value MediaType The type of the media (audio, video, etc). QString. \row \li MediaType \li The type of the media (audio, video, etc). \li QString
\value Duration The duration in millseconds of the media. qint64. \row \li Duration \li The duration in millseconds of the media. \li qint64
\header \li {3,1}
Audio attributes Audio attributes
\value AudioBitRate The bit rate of the media's audio stream in bits per second. int. \row \li AudioBitRate \li The bit rate of the media's audio stream in bits per second. \li int
\value AudioCodec The codec of the media's audio stream. QString. \row \li AudioCodec \li The codec of the media's audio stream. \li QString
\value AverageLevel The average volume level of the media. int. \row \li AverageLevel \li The average volume level of the media. \li int
\value ChannelCount The number of channels in the media's audio stream. int. \row \li ChannelCount \li The number of channels in the media's audio stream. \li int
\value PeakValue The peak volume of the media's audio stream. int \row \li PeakValue \li The peak volume of the media's audio stream. \li int
\value SampleRate The sample rate of the media's audio stream in hertz. int \row \li SampleRate \li The sample rate of the media's audio stream in hertz. \li int
\header \li {3,1}
Music attributes Music attributes
\value AlbumTitle The title of the album the media belongs to. QString. \row \li AlbumTitle \li The title of the album the media belongs to. \li QString
\value AlbumArtist The principal artist of the album the media belongs to. QString. \row \li AlbumArtist \li The principal artist of the album the media belongs to. \li QString
\value ContributingArtist The artists contributing to the media. QStringList. \row \li ContributingArtist \li The artists contributing to the media. \li QStringList
\value Composer The composer of the media. QStringList. \row \li Composer \li The composer of the media. \li QStringList
\value Conductor The conductor of the media. QString. \row \li Conductor \li The conductor of the media. \li QString
\value Lyrics The lyrics to the media. QString. \row \li Lyrics \li The lyrics to the media. \li QString
\value Mood The mood of the media. QString. \row \li Mood \li The mood of the media. \li QString
\value TrackNumber The track number of the media. int. \row \li TrackNumber \li The track number of the media. \li int
\value TrackCount The number of tracks on the album containing the media. int. \row \li TrackCount \li The number of tracks on the album containing the media. \li int
\value CoverArtUrlSmall The URL of a small cover art image. QUrl. \row \li CoverArtUrlSmall \li The URL of a small cover art image. \li QUrl
\value CoverArtUrlLarge The URL of a large cover art image. QUrl. \row \li CoverArtUrlLarge \li The URL of a large cover art image. \li QUrl
\value CoverArtImage An embedded cover art image. QImage. \row \li CoverArtImage \li An embedded cover art image. \li QImage
\header \li {3,1}
Image and video attributes Image and video attributes
\value Resolution The dimensions of an image or video. QSize. \row \li Resolution \li The dimensions of an image or video. \li QSize
\value PixelAspectRatio The pixel aspect ratio of an image or video. QSize. \row \li PixelAspectRatio \li The pixel aspect ratio of an image or video. \li QSize
\header \li {3,1}
Video attributes Video attributes
\value VideoFrameRate The frame rate of the media's video stream. qreal. \row \li VideoFrameRate \li The frame rate of the media's video stream. \li qreal
\value VideoBitRate The bit rate of the media's video stream in bits per second. int. \row \li VideoBitRate \li The bit rate of the media's video stream in bits per second. \li int
\value VideoCodec The codec of the media's video stream. QString. \row \li VideoCodec \li The codec of the media's video stream. \li QString
\value PosterUrl The URL of a poster image. QUrl. \row \li PosterUrl \li The URL of a poster image. \li QUrl
\value PosterImage An embedded poster image. QImage. \row \li PosterImage \li An embedded poster image. \li QImage
\header \li {3,1}
Movie attributes Movie attributes
\value ChapterNumber The chapter number of the media. int. \row \li ChapterNumber \li The chapter number of the media. \li int
\value Director The director of the media. QString. \row \li Director \li The director of the media. \li QString
\value LeadPerformer The lead performer in the media. QStringList. \row \li LeadPerformer \li The lead performer in the media. \li QStringList
\value Writer The writer of the media. QStringList. \row \li Writer \li The writer of the media. \li QStringList
\header \li {3,1}
Photo attributes. Photo attributes.
\value CameraManufacturer The manufacturer of the camera used to capture the media. QString. \row \li CameraManufacturer \li The manufacturer of the camera used to capture the media. \li QString
\value CameraModel The model of the camera used to capture the media. QString. \row \li CameraModel \li The model of the camera used to capture the media. \li QString
\value Event The event during which the media was captured. QString. \row \li Event \li The event during which the media was captured. \li QString
\value Subject The subject of the media. QString. \row \li Subject \li The subject of the media. \li QString
\value Orientation Orientation of image. \row \li Orientation \li Orientation of image. \li int (degrees)
\value ExposureTime Exposure time, given in seconds. \row \li ExposureTime \li Exposure time, given in seconds. \li qreal
\value FNumber The F Number. \row \li FNumber \li The F Number. \li int
\value ExposureProgram \row \li ExposureProgram
The class of the program used by the camera to set exposure when the picture is taken. \li The class of the program used by the camera to set exposure when the picture is taken. \li QString
\value ISOSpeedRatings \row \li ISOSpeedRatings
Indicates the ISO Speed and ISO Latitude of the camera or input device as specified in ISO 12232. \li Indicates the ISO Speed and ISO Latitude of the camera or input device as specified in ISO 12232. \li qreal
\value ExposureBiasValue \row \li ExposureBiasValue
The exposure bias. \li The exposure bias.
The unit is the APEX (Additive System of Photographic Exposure) setting. The unit is the APEX (Additive System of Photographic Exposure) setting. \li qreal
\value DateTimeOriginal The date and time when the original image data was generated. \row \li DateTimeOriginal \li The date and time when the original image data was generated. \li QDateTime
\value DateTimeDigitized The date and time when the image was stored as digital data. \row \li DateTimeDigitized \li The date and time when the image was stored as digital data. \li QDateTime
\value SubjectDistance The distance to the subject, given in meters. \row \li SubjectDistance \li The distance to the subject, given in meters. \li qreal
\value MeteringMode The metering mode. \row \li MeteringMode \li The metering mode. \li QCameraExposure::MeteringMode
\value LightSource \row \li LightSource
The kind of light source. \li The kind of light source. \li QString
\value Flash \row \li Flash
Status of flash when the image was shot. \li Status of flash when the image was shot. \li QCameraExposure::FlashMode
\value FocalLength \row \li FocalLength
The actual focal length of the lens, in mm. \li The actual focal length of the lens, in mm. \li qreal
\value ExposureMode \row \li ExposureMode
Indicates the exposure mode set when the image was shot. \li Indicates the exposure mode set when the image was shot. \li QCameraExposure::ExposureMode
\value WhiteBalance \row \li WhiteBalance
Indicates the white balance mode set when the image was shot. \li Indicates the white balance mode set when the image was shot. \li QCameraImageProcessing::WhiteBalanceMode
\value DigitalZoomRatio \row \li DigitalZoomRatio
Indicates the digital zoom ratio when the image was shot. \li Indicates the digital zoom ratio when the image was shot. \li qreal
\value FocalLengthIn35mmFilm \row \li FocalLengthIn35mmFilm
Indicates the equivalent focal length assuming a 35mm film camera, in mm. \li Indicates the equivalent focal length assuming a 35mm film camera, in mm. \li qreal
\value SceneCaptureType \row \li SceneCaptureType
Indicates the type of scene that was shot. \li Indicates the type of scene that was shot.
It can also be used to record the mode in which the image was shot. It can also be used to record the mode in which the image was shot. \li QString
\value GainControl \row \li GainControl
Indicates the degree of overall image gain adjustment. \li Indicates the degree of overall image gain adjustment. \li qreal
\value Contrast \row \li Contrast
Indicates the direction of contrast processing applied by the camera when the image was shot. \li Indicates the direction of contrast processing applied by the camera when the image was shot. \li qreal
\value Saturation \row \li Saturation
Indicates the direction of saturation processing applied by the camera when the image was shot. \li Indicates the direction of saturation processing applied by the camera when the image was shot. \li qreal
\value Sharpness \row \li Sharpness
Indicates the direction of sharpness processing applied by the camera when the image was shot. \li Indicates the direction of sharpness processing applied by the camera when the image was shot. \li qreal
\value DeviceSettingDescription \row \li DeviceSettingDescription
Exif tag, indicates information on the picture-taking conditions of a particular camera model. QString \li Exif tag, indicates information on the picture-taking conditions of a particular camera model. \li QString
\value GPSLatitude \row \li GPSLatitude
Latitude value of the geographical position (decimal degrees). \li Latitude value of the geographical position (decimal degrees).
A positive latitude indicates the Northern Hemisphere, A positive latitude indicates the Northern Hemisphere,
and a negative latitude indicates the Southern Hemisphere. double. and a negative latitude indicates the Southern Hemisphere. \li double
\value GPSLongitude \row \li GPSLongitude
Longitude value of the geographical position (decimal degrees). \li Longitude value of the geographical position (decimal degrees).
A positive longitude indicates the Eastern Hemisphere, A positive longitude indicates the Eastern Hemisphere,
and a negative longitude indicates the Western Hemisphere. double. and a negative longitude indicates the Western Hemisphere. \li double
\value GPSAltitude \row \li GPSAltitude
The value of altitude in meters above sea level. double. \li The value of altitude in meters above sea level. \li double
\value GPSTimeStamp \row \li GPSTimeStamp
Time stamp of GPS data. QDateTime. \li Time stamp of GPS data. \li QDateTime
\value GPSSatellites \row \li GPSSatellites
GPS satellites used for measurements. QString. \li GPS satellites used for measurements. \li QString
\value GPSStatus \row \li GPSStatus
Status of GPS receiver at image creation time. QString. \li Status of GPS receiver at image creation time. \li QString
\value GPSDOP \row \li GPSDOP
Degree of precision for GPS data. qreal. \li Degree of precision for GPS data. \li qreal
\value GPSSpeed \row \li GPSSpeed
Speed of GPS receiver movement in kilometers per hour. qreal. \li Speed of GPS receiver movement in kilometers per hour. \li qreal
\value GPSTrack \row \li GPSTrack
Direction of GPS receiver movement. qreal. \li Direction of GPS receiver movement.
The range of values is [0.0, 360), The range of values is [0.0, 360),
with 0 direction pointing on either true or magnetic north, with 0 direction pointing on either true or magnetic north,
depending on GPSTrackRef. depending on GPSTrackRef. \li qreal
\value GPSTrackRef \row \li GPSTrackRef
Reference for movement direction. QChar. \li Reference for movement direction. \li QChar.
'T' means true direction and 'M' is magnetic direction. 'T' means true direction and 'M' is magnetic direction.
\value GPSImgDirection \row \li GPSImgDirection
Direction of image when captured. qreal. \li Direction of image when captured. \li qreal
The range of values is [0.0, 360). The range of values is [0.0, 360).
\value GPSImgDirectionRef \row \li GPSImgDirectionRef
Reference for image direction. QChar. \li Reference for image direction. \li QChar.
'T' means true direction and 'M' is magnetic direction. 'T' means true direction and 'M' is magnetic direction.
\value GPSMapDatum \row \li GPSMapDatum
Geodetic survey data used by the GPS receiver. QString. \li Geodetic survey data used by the GPS receiver. \li QString
\value GPSProcessingMethod \row \li GPSProcessingMethod
The name of the method used for location finding. QString. \li The name of the method used for location finding. \li QString
\value GPSAreaInformation \row \li GPSAreaInformation
The name of the GPS area. QString \li The name of the GPS area. \li QString
\row \li ThumbnailImage \li An embedded thumbnail image. \li QImage
\value ThumbnailImage An embedded thumbnail image. QImage. \endtable
*/ */
/*! /*!

114
src/multimedia/qtmedianamespace.h
View File

@@ -59,6 +59,119 @@ QT_MODULE(Multimedia)
namespace QtMultimedia namespace QtMultimedia
{ {
namespace MetaData { namespace MetaData {
#ifdef Q_QDOC
// QDoc does not like macros, so try to keep this in sync :)
QString Title;
QString SubTitle;
QString Author;
QString Comment;
QString Description;
QString Category;
QString Genre;
QString Year;
QString Date;
QString UserRating;
QString Keywords;
QString Language;
QString Publisher;
QString Copyright;
QString ParentalRating;
QString RatingOrganization;
// Media
QString Size;
QString MediaType;
QString Duration;
// Audio
QString AudioBitRate;
QString AudioCodec;
QString AverageLevel;
QString ChannelCount;
QString PeakValue;
QString SampleRate;
// Music
QString AlbumTitle;
QString AlbumArtist;
QString ContributingArtist;
QString Composer;
QString Conductor;
QString Lyrics;
QString Mood;
QString TrackNumber;
QString TrackCount;
QString CoverArtUrlSmall;
QString CoverArtUrlLarge;
// Image/Video
QString Resolution;
QString PixelAspectRatio;
// Video
QString VideoFrameRate;
QString VideoBitRate;
QString VideoCodec;
QString PosterUrl;
// Movie
QString ChapterNumber;
QString Director;
QString LeadPerformer;
QString Writer;
// Photos
QString CameraManufacturer;
QString CameraModel;
QString Event;
QString Subject;
QString Orientation;
QString ExposureTime;
QString FNumber;
QString ExposureProgram;
QString ISOSpeedRatings;
QString ExposureBiasValue;
QString DateTimeOriginal;
QString DateTimeDigitized;
QString SubjectDistance;
QString MeteringMode;
QString LightSource;
QString Flash;
QString FocalLength;
QString ExposureMode;
QString WhiteBalance;
QString DigitalZoomRatio;
QString FocalLengthIn35mmFilm;
QString SceneCaptureType;
QString GainControl;
QString Contrast;
QString Saturation;
QString Sharpness;
QString DeviceSettingDescription;
// Location
QString GPSLatitude;
QString GPSLongitude;
QString GPSAltitude;
QString GPSTimeStamp;
QString GPSSatellites;
QString GPSStatus;
QString GPSDOP;
QString GPSSpeed;
QString GPSTrack;
QString GPSTrackRef;
QString GPSImgDirection;
QString GPSImgDirectionRef;
QString GPSMapDatum;
QString GPSProcessingMethod;
QString GPSAreaInformation;
QString PosterImage;
QString CoverArtImage;
QString ThumbnailImage;
#else
// Common // Common
Q_DECLARE_METADATA(Title); Q_DECLARE_METADATA(Title);
Q_DECLARE_METADATA(SubTitle); Q_DECLARE_METADATA(SubTitle);
@@ -170,6 +283,7 @@ namespace QtMultimedia
Q_DECLARE_METADATA(PosterImage); Q_DECLARE_METADATA(PosterImage);
Q_DECLARE_METADATA(CoverArtImage); Q_DECLARE_METADATA(CoverArtImage);
Q_DECLARE_METADATA(ThumbnailImage); Q_DECLARE_METADATA(ThumbnailImage);
#endif
} }
enum SupportEstimate enum SupportEstimate

6
src/multimedia/recording/qaudiorecorder.cpp
View File

@@ -203,6 +203,12 @@ QString QAudioRecorder::defaultAudioInput() const
return QString(); return QString();
} }
/*!
\property QAudioRecorder::audioInput
\brief the active audio input name.
*/
/*! /*!
Returns the active audio input name. Returns the active audio input name.
*/ */