Updated a lot of minor fixes to the docs and removed warnings from qdoc
Change-Id: Ib7fd75fb93c038f9e8fa9d71b6ad01fb27b97622 Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
This commit is contained in:
@@ -235,6 +235,13 @@ QSoundBuffer* QDeclarativeAudioSample::soundBuffer() const
|
||||
return m_soundBuffer;
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty bool QtAudioEngine1::AudioSample::loaded
|
||||
|
||||
This property holds the load status of the audio sample.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\qmlsignal QtAudioEngine1::AudioSample::onLoadedChanged()
|
||||
|
||||
|
||||
@@ -459,7 +459,7 @@ void QDeclarativeSoundInstance::setGain(qreal gain)
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty vector3d QtAudioEngine1::SoundInstance::gain
|
||||
\qmlproperty vector3d QtAudioEngine1::SoundInstance::pitch
|
||||
|
||||
This property holds the pitch adjustment which will be used to modulate the audio pitch
|
||||
from this SoundInstance.
|
||||
|
||||
@@ -46,6 +46,7 @@ import QtMultimedia 5.0
|
||||
\qmlclass Video
|
||||
\inherits Item
|
||||
\ingroup multimedia_qml
|
||||
\ingroup multimedia_video_qml
|
||||
\brief A convenience element for showing a specified video
|
||||
|
||||
The \c Video element is a convenience element combining the functionality
|
||||
|
||||
@@ -62,6 +62,8 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\inqmlmodule QtMultimedia 5
|
||||
\ingroup multimedia_qml
|
||||
\ingroup multimedia_audio_qml
|
||||
\ingroup multimedia_video_qml
|
||||
|
||||
This element is part of the \b{QtMultimedia 5.0} module.
|
||||
|
||||
@@ -121,6 +123,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\inqmlmodule QtMultimedia 5
|
||||
\ingroup multimedia_qml
|
||||
\ingroup multimedia_audio_qml
|
||||
|
||||
This element is part of the \b{QtMultimedia 5.0} module.
|
||||
|
||||
@@ -782,7 +785,7 @@ void QDeclarativeAudio::_q_statusChanged()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\qmlsignal QtMultimedia5::Audio::onError(error, errorString)
|
||||
\qmlsignal QtMultimedia5::Audio::error(error, errorString)
|
||||
|
||||
This handler is called when an \l {QMediaPlayer::Error}{error} has
|
||||
occurred. The errorString parameter may contain more detailed
|
||||
|
||||
@@ -143,8 +143,8 @@ void QDeclarativeCamera::_q_availabilityChanged(QtMultimedia::AvailabilityError
|
||||
|
||||
Basic camera state management, error reporting, and simple zoom properties are
|
||||
available in the Camera element itself. For integration with C++ code, the
|
||||
\l mediaObject property allows you to access the standard QtMultimedia camera
|
||||
controls.
|
||||
\l mediaObject property allows you to
|
||||
access the standard QtMultimedia camera controls.
|
||||
|
||||
Many of the camera settings may take some time to apply, and might be limited
|
||||
to certain supported values depending on the hardware. Several camera settings
|
||||
@@ -500,6 +500,11 @@ void QDeclarativeCamera::setDigitalZoom(qreal value)
|
||||
m_camera->focus()->zoomTo(opticalZoom(), value);
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty variant QtMultimedia5::Camera::mediaObject
|
||||
|
||||
The media object for the Camera element.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\qmlsignal QtMultimedia5::Camera::onError(error, errorString)
|
||||
|
||||
@@ -60,9 +60,8 @@ QT_BEGIN_NAMESPACE
|
||||
are available or saved to disk. You can adjust the resolution of the captured
|
||||
image and where the saved image should go.
|
||||
|
||||
This element is a child of a Camera element (as the
|
||||
\l {Camera::imageCapture}{imageCapture} property) and cannot be created
|
||||
directly.
|
||||
This element is a child of a \l Camera element (as the \c imageCapture property)
|
||||
and cannot be created directly.
|
||||
|
||||
\qml
|
||||
import QtQuick 2.0
|
||||
|
||||
@@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
|
||||
like aperture and shutter speed, metering and ISO speed.
|
||||
|
||||
It should not be constructed separately but provided by the
|
||||
Camera element's \l {Camera::exposure} {exposure} property.
|
||||
\l Camera element's \c exposure property.
|
||||
|
||||
\qml
|
||||
import QtQuick 2.0
|
||||
|
||||
@@ -59,7 +59,7 @@ QT_BEGIN_NAMESPACE
|
||||
\l {Torch}{torch} hardware).
|
||||
|
||||
It should not be constructed separately but provided by the
|
||||
Camera element's \l {Camera::flash}{flash} property.
|
||||
\l Camera element's \c flash property.
|
||||
|
||||
\qml
|
||||
import QtQuick 2.0
|
||||
|
||||
@@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE
|
||||
camera frame that are selected for autofocusing.
|
||||
|
||||
It is not constructed separately but is provided by the
|
||||
Camera element's \l {Camera::focus}{focus} property.
|
||||
\l Camera element's \c focus property.
|
||||
|
||||
\qml
|
||||
import QtQuick 2.0
|
||||
@@ -122,8 +122,8 @@ QDeclarativeCamera::FocusMode QDeclarativeCameraFocus::focusMode() const
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusModeSupported(mode)
|
||||
\fn QDeclarativeCameraFocus::isFocusPointModeSupported(QDeclarativeCamera::FocusMode mode)
|
||||
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusModeSupported(mode) const
|
||||
\fn QDeclarativeCameraFocus::isFocusModeSupported(QDeclarativeCamera::FocusMode mode) const
|
||||
|
||||
Returns true if the supplied \a mode is a supported focus mode, and
|
||||
false otherwise.
|
||||
@@ -163,8 +163,8 @@ void QDeclarativeCameraFocus::setFocusPointMode(QDeclarativeCamera::FocusPointMo
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusPointModeSupported(mode)
|
||||
\fn QDeclarativeCameraFocus::isFocusPointModeSupported(QDeclarativeCamera::FocusPointMode mode)
|
||||
\qmlmethod bool QtMultimedia5::CameraFocus::isFocusPointModeSupported(mode) const
|
||||
\fn QDeclarativeCameraFocus::isFocusPointModeSupported(QDeclarativeCamera::FocusPointMode mode) const
|
||||
|
||||
Returns true if the supplied \a mode is a supported focus point mode, and
|
||||
false otherwise.
|
||||
|
||||
@@ -82,7 +82,7 @@ public:
|
||||
QAbstractListModel *focusZones() const;
|
||||
|
||||
Q_INVOKABLE bool isFocusModeSupported(QDeclarativeCamera::FocusMode mode) const;
|
||||
Q_INVOKABLE bool isFocusPointModeSupported(QDeclarativeCamera::FocusPointMode) const;
|
||||
Q_INVOKABLE bool isFocusPointModeSupported(QDeclarativeCamera::FocusPointMode mode) const;
|
||||
|
||||
public Q_SLOTS:
|
||||
void setFocusMode(QDeclarativeCamera::FocusMode);
|
||||
|
||||
@@ -55,8 +55,8 @@ QT_BEGIN_NAMESPACE
|
||||
done by the camera middleware, including white balance adjustments,
|
||||
contrast, saturation, sharpening, and denoising
|
||||
|
||||
It is not constructed separately but is provided by the Camera element's
|
||||
\l {Camera::imageProcessing}{imageProcessing} property.
|
||||
It is not constructed separately but is provided by the \a Camera element's
|
||||
\c imageProcessing property.
|
||||
|
||||
\qml
|
||||
import QtQuick 2.0
|
||||
|
||||
@@ -56,9 +56,8 @@ QT_BEGIN_NAMESPACE
|
||||
This element allows recording camera streams to files, and adjusting recording
|
||||
settings and metadata for videos.
|
||||
|
||||
This element is a child of a Camera element (as the
|
||||
\l {Camera::videoRecorder}{videoRecorder} property) and cannot be created
|
||||
directly.
|
||||
This element is a child of a \l Camera element (as the \c videoRecorder property)
|
||||
and cannot be created directly.
|
||||
|
||||
\qml
|
||||
Camera {
|
||||
@@ -113,7 +112,7 @@ QSize QDeclarativeCameraRecorder::captureResolution()
|
||||
The audio codec to use for recording video.
|
||||
Typically this is something like \c aac or \c amr-wb.
|
||||
|
||||
\sa whiteBalanceMode
|
||||
\sa {QtMultimedia5::CameraImageProcessing::whiteBalanceMode}{whileBalanceMode}
|
||||
*/
|
||||
QString QDeclarativeCameraRecorder::audioCodec() const
|
||||
{
|
||||
|
||||
@@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE
|
||||
\inqmlmodule QtMultimedia 5
|
||||
\brief The Radio element allows you to access radio functionality from a QML application.
|
||||
\ingroup multimedia_qml
|
||||
\ingroup multimedia_radio_qml
|
||||
\inherits Item
|
||||
|
||||
This element is part of the \b{QtMultimedia 5.0} module.
|
||||
|
||||
@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
|
||||
\inqmlmodule QtMultimedia 5
|
||||
\brief The RadioData element allows you to access RDS data from a QML application.
|
||||
\ingroup multimedia_qml
|
||||
\ingroup multimedia_radio_qml
|
||||
\inherits Item
|
||||
|
||||
This element is part of the \b{QtMultimedia 5.0} module.
|
||||
|
||||
@@ -122,6 +122,7 @@ private:
|
||||
\brief The VideoOutput element allows you to render video or camera viewfinder.
|
||||
|
||||
\ingroup multimedia_qml
|
||||
\ingroup multimedia_video_qml
|
||||
\inqmlmodule QtMultimedia 5
|
||||
|
||||
This element is part of the \b{QtMultimedia 5.0} module.
|
||||
|
||||
@@ -194,13 +194,10 @@ QAudioBufferPrivate *QAudioBufferPrivate::clone()
|
||||
|
||||
/*!
|
||||
\class QAudioBuffer
|
||||
\brief A class that represents a collection of audio samples.
|
||||
\inmodule QtMultimedia
|
||||
\ingroup multimedia
|
||||
\ingroup multimedia_audio
|
||||
|
||||
The QAudioBuffer class represents a collection of audio samples,
|
||||
with a specific format and sample rate.
|
||||
\brief The QAudioBuffer class represents a collection of audio samples with a specific format and sample rate.
|
||||
*/
|
||||
// ^ Mostly useful with probe or decoder
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ public:
|
||||
};
|
||||
|
||||
/*!
|
||||
Creates a new QAudioProbe class. After setting the
|
||||
Creates a new QAudioProbe class with a \a parent. After setting the
|
||||
source to monitor with \l setSource(), the \l audioBufferProbed()
|
||||
signal will be emitted when audio buffers are flowing in the
|
||||
source media object.
|
||||
@@ -157,8 +157,8 @@ bool QAudioProbe::setSource(QMediaObject *source)
|
||||
|
||||
Returns true on success.
|
||||
|
||||
If \a source is zero, this probe will be deactivated
|
||||
and this function will return true.
|
||||
If there is no mediaObject associated with \a mediaRecorder, or if it is
|
||||
zero, this probe will be deactivated and this function wil return true.
|
||||
|
||||
If the media recorder instance does not support monitoring
|
||||
audio, this function will return false.
|
||||
@@ -194,7 +194,7 @@ bool QAudioProbe::isActive() const
|
||||
/*!
|
||||
\fn QAudioProbe::audioBufferProbed(const QAudioBuffer &buffer)
|
||||
|
||||
This signal should be emitted when an audio buffer is processed in the
|
||||
This signal should be emitted when an audio \a buffer is processed in the
|
||||
media service.
|
||||
*/
|
||||
|
||||
|
||||
@@ -105,11 +105,6 @@ QAudioSystemPlugin::QAudioSystemPlugin(QObject* parent) :
|
||||
QAudioSystemPlugin::~QAudioSystemPlugin()
|
||||
{}
|
||||
|
||||
/*!
|
||||
\fn QStringList QAudioSystemPlugin::keys() const
|
||||
Returns the list of device identifiers this plugin supports.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QList<QByteArray> QAudioSystemPlugin::availableDevices(QAudio::Mode mode) const
|
||||
Returns a list of available audio devices for \a mode
|
||||
|
||||
@@ -80,6 +80,12 @@
|
||||
\sa QSoundEffect
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum QSound::Loop
|
||||
|
||||
\value Infinite Can be used as a parameter to \l setLoops() to loop infinitely.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
Plays the sound stored in the file specified by the given \a filename.
|
||||
|
||||
@@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\inmodule QtMultimedia
|
||||
\ingroup multimedia_qml
|
||||
\ingroup multimedia_audio_qml
|
||||
\inqmlmodule QtMultimedia 5
|
||||
|
||||
This element is part of the \b{QtMultimedia 5.0} module.
|
||||
@@ -74,6 +75,22 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum QSoundEffect::Loop
|
||||
|
||||
\value Infinite Used as a parameter to \l loops for infinite looping
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum QSoundEffect::Status
|
||||
|
||||
\value Null No source has been set or the source is null.
|
||||
\value Loading The soundeffect is trying to load the source.
|
||||
\value Ready The source is loaded and ready for play.
|
||||
\value Error An error occurred during operation, such as failure of loading the source.
|
||||
|
||||
*/
|
||||
|
||||
/*!
|
||||
\qmlproperty url QtMultimedia5::SoundEffect::source
|
||||
\property QSoundEffect::source
|
||||
@@ -113,20 +130,23 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
/*!
|
||||
\qmlproperty bool QtMultimedia5::SoundEffect::playing
|
||||
\property QSoundEffect::source
|
||||
\property QSoundEffect::playing
|
||||
|
||||
This property indicates if the soundeffect is playing or not.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\qmlproperty int QtMultimedia5::SoundEffect::status
|
||||
\qmlproperty enumeration QtMultimedia5::SoundEffect::status
|
||||
|
||||
This property indicates the following status of the soundeffect.
|
||||
|
||||
Null: no source has been set or is null.
|
||||
Loading: the soundeffect is trying to load the source.
|
||||
Ready: the source is loaded and ready for play.
|
||||
Error: some error happened during operation, such as failure of loading the source.
|
||||
\table
|
||||
\header \li Value \li Description
|
||||
\row \li SoundEffect.Null \li No source has been set or the source is null.
|
||||
\row \li SoundEffect.Loading \li The soundeffect is trying to load the source.
|
||||
\row \li SoundEffect.Ready \li The source is loaded and ready for play.
|
||||
\row \li SoundEffect.Error \li An error occurred during operation, such as failure of loading the source.
|
||||
\endtable
|
||||
*/
|
||||
|
||||
/*!
|
||||
@@ -208,6 +228,11 @@ QSoundEffect::~QSoundEffect()
|
||||
d->release();
|
||||
}
|
||||
|
||||
/*!
|
||||
\fn QSoundEffect::supportedMimeTypes()
|
||||
|
||||
Returns a list of the supported mime types for this sound effect.
|
||||
*/
|
||||
QStringList QSoundEffect::supportedMimeTypes()
|
||||
{
|
||||
return QSoundEffectPrivate::supportedMimeTypes();
|
||||
@@ -233,6 +258,18 @@ int QSoundEffect::loopCount() const
|
||||
return d->loopCount();
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlproperty int QtMultimedia5::SoundEffect::loopsRemaining
|
||||
|
||||
This property contains the number of loops remaining before the sound effect
|
||||
stops by itself, or SoundEffect.Infinite if that's what has been set in \l loops.
|
||||
*/
|
||||
/*!
|
||||
\property QSoundEffect::loopsRemaining
|
||||
|
||||
This property contains the number of loops remaining before the sound effect
|
||||
stops by itself, or QSoundEffect::Infinite if that's what has been set in \l loops.
|
||||
*/
|
||||
int QSoundEffect::loopsRemaining() const
|
||||
{
|
||||
return d->loopsRemaining();
|
||||
@@ -284,20 +321,32 @@ void QSoundEffect::setMuted(bool muted)
|
||||
d->setMuted(muted);
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod bool QtMultimedia5::SoundEffect::isLoaded()
|
||||
\fn QSoundEffect::isLoaded() const
|
||||
|
||||
Returns whether the sound effect has finished loading the \l source.
|
||||
*/
|
||||
bool QSoundEffect::isLoaded() const
|
||||
{
|
||||
return d->isLoaded();
|
||||
}
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::SoundEffect::play()
|
||||
\qmlmethod QtMultimedia5::SoundEffect::play()
|
||||
|
||||
Start playback of the sound effect, looping the effect for the number of
|
||||
times as specified in the loops property.
|
||||
Start playback of the sound effect, looping the effect for the number of
|
||||
times as specified in the loops property.
|
||||
|
||||
This is the default method for SoundEffect.
|
||||
This is the default method for SoundEffect.
|
||||
|
||||
\snippet doc/src/snippets/multimedia-snippets/soundeffect.qml play sound on click
|
||||
\snippet doc/src/snippets/multimedia-snippets/soundeffect.qml play sound on click
|
||||
*/
|
||||
/*!
|
||||
\fn QSoundEffect::play()
|
||||
|
||||
Start playback of the sound effect, looping the effect for the number of
|
||||
times as specified in the loops property.
|
||||
*/
|
||||
void QSoundEffect::play()
|
||||
{
|
||||
@@ -309,14 +358,6 @@ bool QSoundEffect::isPlaying() const
|
||||
return d->isPlaying();
|
||||
}
|
||||
|
||||
/*!
|
||||
\enum QSoundEffect::Status
|
||||
\value Null This sound effect does not have a source set.
|
||||
\value Loading The source is being loaded
|
||||
\value Ready The source has been loaded, and can be played.
|
||||
\value Error An error occurred while loading the source or during playback.
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns the current status of this sound effect.
|
||||
*/
|
||||
@@ -328,8 +369,10 @@ QSoundEffect::Status QSoundEffect::status() const
|
||||
|
||||
/*!
|
||||
\qmlmethod QtMultimedia5::SoundEffect::stop()
|
||||
\fn QSoundEffect::stop()
|
||||
|
||||
Stop current playback.
|
||||
|
||||
Note that if the backend is PulseAudio, due to the limitation of the underlying API,
|
||||
tis stop will only prevent next looping but will not be able to stop current playback immediately.
|
||||
|
||||
|
||||
@@ -336,7 +336,7 @@ void QCameraPrivate::_q_updateLockStatus(QCamera::LockType type, QCamera::LockSt
|
||||
|
||||
|
||||
/*!
|
||||
Construct a QCamera from service \a provider and \a parent.
|
||||
Construct a QCamera with a \a parent.
|
||||
*/
|
||||
|
||||
QCamera::QCamera(QObject *parent):
|
||||
|
||||
@@ -335,9 +335,9 @@ void QCameraExposure::setMeteringMode(QCameraExposure::MeteringMode mode)
|
||||
}
|
||||
|
||||
/*!
|
||||
\property QCameraExposure::spotMeteringPoint
|
||||
\fn QCameraExposure::spotMeteringPoint() const
|
||||
|
||||
When supported, this property is the (normalized) position of the point of the image
|
||||
When supported, the spot metering point is the (normalized) position of the point of the image
|
||||
where exposure metering will be performed. This is typically used to indicate an
|
||||
"interesting" area of the image that should be exposed properly.
|
||||
|
||||
@@ -346,13 +346,23 @@ void QCameraExposure::setMeteringMode(QCameraExposure::MeteringMode mode)
|
||||
which is typically the default spot metering point.
|
||||
|
||||
The spot metering point is only used with spot metering mode.
|
||||
*/
|
||||
|
||||
\sa setSpotMeteringPoint()
|
||||
*/
|
||||
|
||||
QPointF QCameraExposure::spotMeteringPoint() const
|
||||
{
|
||||
return d_func()->exposureControl ? d_func()->exposureControl->actualValue(QCameraExposureControl::SpotMeteringPoint).toPointF() : QPointF();
|
||||
}
|
||||
|
||||
/*!
|
||||
\fn QCameraExposure::setSpotMeteringPoint(const QPointF &point)
|
||||
|
||||
Allows setting the spot metering point to \a point.
|
||||
|
||||
\sa spotMeteringPoint()
|
||||
*/
|
||||
|
||||
void QCameraExposure::setSpotMeteringPoint(const QPointF &point)
|
||||
{
|
||||
if (d_func()->exposureControl)
|
||||
|
||||
@@ -76,6 +76,13 @@ QT_BEGIN_NAMESPACE
|
||||
\sa QCamera
|
||||
*/
|
||||
|
||||
/*!
|
||||
\enum QCameraImageCapture::CaptureDestination
|
||||
|
||||
\value CaptureToFile Capture the image to a file.
|
||||
\value CaptureToBuffer Capture the image to a buffer for further processing.
|
||||
*/
|
||||
|
||||
namespace
|
||||
{
|
||||
class MediaRecorderRegisterMetaTypes
|
||||
@@ -441,9 +448,9 @@ QVideoFrame::PixelFormat QCameraImageCapture::bufferFormat() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Sets the buffer image capture 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)
|
||||
{
|
||||
@@ -626,7 +633,8 @@ void QCameraImageCapture::cancelCapture()
|
||||
/*!
|
||||
\fn QCameraImageCapture::imageMetadataAvailable(int id, const QString &key, const QVariant &value)
|
||||
|
||||
Signals that a metadata for an image with request \a id is available.
|
||||
Signals that a metadata for an image with request \a id is available. Also
|
||||
includes the \a key and \a value of the metadata.
|
||||
|
||||
This signal is emitted between imageExposed and imageSaved signals.
|
||||
*/
|
||||
|
||||
@@ -117,7 +117,7 @@ public:
|
||||
|
||||
QList<QVideoFrame::PixelFormat> supportedBufferFormats() const;
|
||||
QVideoFrame::PixelFormat bufferFormat() const;
|
||||
void setBufferFormat(QVideoFrame::PixelFormat format);
|
||||
void setBufferFormat(const QVideoFrame::PixelFormat format);
|
||||
|
||||
bool isCaptureDestinationSupported(CaptureDestinations destination) const;
|
||||
CaptureDestinations captureDestination() const;
|
||||
|
||||
@@ -96,7 +96,7 @@ QT_BEGIN_NAMESPACE
|
||||
In some cases changing these settings may result in a longer delay
|
||||
before an image is ready.
|
||||
|
||||
For more information on image processing of camera frames, see \l {Camera Image Processing}.
|
||||
For more information on image processing of camera frames, see \l {camera_image_processing}{Camera Image Processing}.
|
||||
|
||||
\sa QCameraImageProcessingControl
|
||||
*/
|
||||
|
||||
@@ -215,7 +215,7 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAudioDecoderControl::audioFormat()
|
||||
\fn QAudioDecoderControl::audioFormat() const
|
||||
Returns the current audio format of the decoded stream.
|
||||
|
||||
Any buffers returned should have this format.
|
||||
@@ -244,13 +244,13 @@ QAudioDecoderControl::QAudioDecoderControl(QObject *parent):
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAudioDecoderControl::position()
|
||||
\fn QAudioDecoderControl::position() const
|
||||
Returns position (in milliseconds) of the last buffer read from
|
||||
the decoder or -1 if no buffers have been read.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAudioDecoderControl::duration()
|
||||
\fn QAudioDecoderControl::duration() const
|
||||
Returns total duration (in milliseconds) of the audio stream
|
||||
or -1 if not available.
|
||||
*/
|
||||
|
||||
@@ -96,7 +96,7 @@ QCameraCaptureDestinationControl::~QCameraCaptureDestinationControl()
|
||||
/*!
|
||||
\fn QCameraCaptureDestinationControl::captureDestination() const
|
||||
|
||||
Returns the current capture \a destination. The default destination is QCameraImageCapture::CaptureToFile.
|
||||
Returns the current capture destination. The default destination is QCameraImageCapture::CaptureToFile.
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
||||
@@ -139,7 +139,7 @@ QCameraFeedbackControl::~QCameraFeedbackControl()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QCameraFeedbackControl::setEventFeedbackEnabled(EventType event, bool enabled) const
|
||||
\fn bool QCameraFeedbackControl::setEventFeedbackEnabled(EventType event, bool enabled)
|
||||
|
||||
Turns on feedback for the specific \a event if \a enabled is true, otherwise disables the
|
||||
feedback. Returns true if the feedback could be modified, or false otherwise (e.g. this feedback
|
||||
@@ -150,7 +150,7 @@ QCameraFeedbackControl::~QCameraFeedbackControl()
|
||||
|
||||
|
||||
/*!
|
||||
\fn void QCameraFeedbackControl::resetEventFeedback(EventType event) const
|
||||
\fn void QCameraFeedbackControl::resetEventFeedback(EventType event)
|
||||
|
||||
Restores the feedback setting for this \a event to its default setting.
|
||||
|
||||
@@ -158,7 +158,7 @@ QCameraFeedbackControl::~QCameraFeedbackControl()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool setEventFeedbackSound(EventType event, const QString &filePath)
|
||||
\fn bool QCameraFeedbackControl::setEventFeedbackSound(EventType event, const QString &filePath)
|
||||
|
||||
When the given \a event occurs, the sound effect referenced by \a filePath
|
||||
will be played instead of the default sound.
|
||||
|
||||
@@ -169,27 +169,27 @@ QCameraFocusControl::~QCameraFocusControl()
|
||||
/*!
|
||||
\fn void QCameraFocusControl::focusModeChanged(QCameraFocus::FocusModes mode)
|
||||
|
||||
Signal is emitted when the focus mode is chaged,
|
||||
Signal is emitted when the focus \a mode is changed,
|
||||
usually in result of QCameraFocusControl::setFocusMode call or capture mode changes.
|
||||
|
||||
\sa QCameraFocusControl::focusMode QCameraFocusControl::setFocusMode
|
||||
\sa QCameraFocusControl::focusMode() QCameraFocusControl::setFocusMode()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QCameraFocusControl::focusPointModeChanged(QCameraFocus::FocusPointMode mode)
|
||||
|
||||
Signal is emitted when the focus point mode is chaged,
|
||||
Signal is emitted when the focus point \a mode is changed,
|
||||
usually in result of QCameraFocusControl::setFocusPointMode call or capture mode changes.
|
||||
|
||||
\sa QCameraFocusControl::focusPointMode QCameraFocusControl::setFocusPointMode
|
||||
\sa QCameraFocusControl::focusPointMode() QCameraFocusControl::setFocusPointMode()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QCameraFocusControl::customFocusPointChanged(const QPointF &point)
|
||||
|
||||
Signal is emitted when the custom focus point is changed.
|
||||
Signal is emitted when the custom focus \a point is changed.
|
||||
|
||||
\sa QCameraFocusControl::customFocusPoint QCameraFocusControl::setCustomFocusPoint
|
||||
\sa QCameraFocusControl::customFocusPoint() QCameraFocusControl::setCustomFocusPoint()
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@@ -150,7 +150,9 @@ QCameraImageCaptureControl::~QCameraImageCaptureControl()
|
||||
/*!
|
||||
\fn QCameraImageCaptureControl::imageMetadataAvailable(int id, const QString &key, const QVariant &value)
|
||||
|
||||
Signals that a metadata for an image with request \a id is available.
|
||||
Signals that a metadata for an image with request \a id is available. Signal
|
||||
also contains the \a key and \a value of the metadata.
|
||||
|
||||
This signal should be emitted between imageExposed and imageSaved signals.
|
||||
*/
|
||||
|
||||
|
||||
@@ -88,7 +88,7 @@ QMediaAudioProbeControl::~QMediaAudioProbeControl()
|
||||
/*!
|
||||
\fn QMediaAudioProbeControl::audioBufferProbed(const QAudioBuffer &buffer)
|
||||
|
||||
This signal should be emitted when an audio buffer is processed in the
|
||||
This signal should be emitted when an audio \a buffer is processed in the
|
||||
media service.
|
||||
*/
|
||||
|
||||
|
||||
@@ -99,13 +99,13 @@ QMediaGaplessPlaybackControl::QMediaGaplessPlaybackControl(QObject *parent):
|
||||
/*!
|
||||
\fn QMediaGaplessPlaybackControl::setNextMedia(const QMediaContent& media)
|
||||
|
||||
Sets the next media for smooth transition.
|
||||
Sets the next \a media for smooth transition.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QMediaGaplessPlaybackControl::nextMediaChanged(const QMediaContent& media)
|
||||
|
||||
Signals that the next media has changed (either explicitly via \l setNextMedia() or when the
|
||||
Signals that the next \a media has changed (either explicitly via \l setNextMedia() or when the
|
||||
player clears the next media while advancing to it).
|
||||
|
||||
\sa nextMedia()
|
||||
@@ -123,7 +123,7 @@ QMediaGaplessPlaybackControl::QMediaGaplessPlaybackControl(QObject *parent):
|
||||
\fn QMediaGaplessPlaybackControl::isCrossfadeSupported() const
|
||||
|
||||
Indicates whether crossfading is supported or not.
|
||||
If crossfading is not supported, \l setCrossfadTime() will be ignored and \l crossfadeTime() will
|
||||
If crossfading is not supported, \l setCrossfadeTime() will be ignored and \l crossfadeTime() will
|
||||
always return 0.
|
||||
|
||||
*/
|
||||
@@ -131,7 +131,7 @@ QMediaGaplessPlaybackControl::QMediaGaplessPlaybackControl(QObject *parent):
|
||||
/*!
|
||||
\fn QMediaGaplessPlaybackControl::setCrossfadeTime(qreal crossfadeTime)
|
||||
|
||||
Sets the crossfade time in seconds for smooth transition.
|
||||
Sets the \a crossfadeTime in seconds for smooth transition.
|
||||
|
||||
Positive value means how much time it will take for the next media to transit from silent to
|
||||
full volume and vice versa for current one. So both current and the next one will be playing
|
||||
@@ -151,7 +151,7 @@ QMediaGaplessPlaybackControl::QMediaGaplessPlaybackControl(QObject *parent):
|
||||
/*!
|
||||
\fn QMediaGaplessPlaybackControl::crossfadeTimeChanged(qreal crossfadeTime)
|
||||
|
||||
Signals that the crossfade time has changed.
|
||||
Signals that the \a crossfadeTime has changed.
|
||||
|
||||
\sa crossfadeTime()
|
||||
*/
|
||||
|
||||
@@ -59,6 +59,9 @@ QT_BEGIN_NAMESPACE
|
||||
usage by the supported QMediaObject.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\internal
|
||||
*/
|
||||
QMediaNetworkAccessControl::QMediaNetworkAccessControl(QObject *parent) :
|
||||
QMediaControl(parent)
|
||||
{
|
||||
@@ -81,7 +84,7 @@ QMediaNetworkAccessControl::~QMediaNetworkAccessControl()
|
||||
and replaced with the new list.
|
||||
*/
|
||||
|
||||
/*
|
||||
/*!
|
||||
\fn QNetworkConfiguration QMediaNetworkAccessControl::currentConfiguration() const
|
||||
|
||||
Returns the current active configuration in use.
|
||||
|
||||
@@ -88,7 +88,7 @@ QMediaVideoProbeControl::~QMediaVideoProbeControl()
|
||||
/*!
|
||||
\fn QMediaVideoProbeControl::videoFrameProbed(const QVideoFrame &frame)
|
||||
|
||||
This signal should be emitted when a video frame is processed in the
|
||||
This signal should be emitted when a video \a frame is processed in the
|
||||
media service.
|
||||
*/
|
||||
|
||||
|
||||
@@ -153,6 +153,12 @@ QRadioDataControl::~QRadioDataControl()
|
||||
Returns true if Alternative Frequency is currently enabled
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QRadioDataControl::alternativeFrequenciesEnabledChanged(bool enabled)
|
||||
|
||||
Signals that the alternative frequencies setting has changed to the value of \a enabled.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioDataControl::stationIdChanged(QString stationId)
|
||||
|
||||
|
||||
@@ -243,9 +243,10 @@ QRadioTunerControl::~QRadioTunerControl()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioTunerControl::searchAllStations()
|
||||
\fn void QRadioTunerControl::searchAllStations(QRadioTuner::SearchMode searchMode)
|
||||
|
||||
Starts a scan through the whole frequency band searching all stations
|
||||
Starts a scan through the whole frequency band searching all stations with a
|
||||
specific \a searchMode.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@@ -328,9 +329,9 @@ QRadioTunerControl::~QRadioTunerControl()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void QRadioTunerControl::stationFound(int frequency)
|
||||
\fn void QRadioTunerControl::stationFound(int frequency, QString stationId)
|
||||
|
||||
Signals that new station with \a frequency was found when scanning
|
||||
Signals that new station with \a frequency and \a stationId was found when scanning
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
||||
@@ -161,12 +161,6 @@ QMediaPlaylistIOPlugin::~QMediaPlaylistIOPlugin()
|
||||
Returns true if the data can be written; and false otherwise.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QMediaPlaylistIOPlugin::keys() const
|
||||
|
||||
Returns a list of format keys supported by a plug-in.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QMediaPlaylistIOPlugin::createReader(QIODevice *device, const QByteArray &format)
|
||||
|
||||
|
||||
@@ -93,6 +93,8 @@ namespace
|
||||
\typedef QMediaResourceList
|
||||
|
||||
Synonym for \c QList<QMediaResource>
|
||||
|
||||
\relates QMediaResource
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
||||
@@ -410,6 +410,12 @@ void QMediaObject::setupControls()
|
||||
Signal emitted when the availability state has changed to \a available
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QMediaObject::availabilityErrorChanged(QtMultimedia::AvailabilityError error)
|
||||
|
||||
Signal emitted when the availability error has changed to \a error
|
||||
*/
|
||||
|
||||
|
||||
#include "moc_qmediaobject.cpp"
|
||||
QT_END_NAMESPACE
|
||||
|
||||
@@ -650,12 +650,6 @@ QMediaServiceProvider *QMediaServiceProvider::defaultServiceProvider()
|
||||
to identify the features it supports.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QMediaServiceProviderPlugin::keys() const
|
||||
|
||||
Returns a list of keys for media services a plug-in can create.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QMediaServiceProviderPlugin::create(const QString &key)
|
||||
|
||||
|
||||
@@ -477,7 +477,7 @@ void QMediaTimeRange::addInterval(qint64 start, qint64 end)
|
||||
If the specified interval is adjacent to, or overlaps existing
|
||||
intervals within the time range, these intervals will be merged.
|
||||
|
||||
This operation takes \l{linear time}
|
||||
This operation takes linear time.
|
||||
|
||||
\sa removeInterval()
|
||||
*/
|
||||
@@ -526,7 +526,7 @@ void QMediaTimeRange::removeInterval(qint64 start, qint64 end)
|
||||
such that no intervals within the time range include any part of the
|
||||
target interval.
|
||||
|
||||
This operation takes \l{linear time}
|
||||
This operation takes linear time.
|
||||
|
||||
\sa addInterval()
|
||||
*/
|
||||
@@ -689,6 +689,7 @@ bool operator!=(const QMediaTimeRange &a, const QMediaTimeRange &b)
|
||||
|
||||
/*!
|
||||
\fn operator+(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
|
||||
\relates QMediaTimeRange
|
||||
|
||||
Returns a time range containing the union between \a r1 and \a r2.
|
||||
*/
|
||||
@@ -699,6 +700,7 @@ QMediaTimeRange operator+(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
|
||||
|
||||
/*!
|
||||
\fn operator-(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
|
||||
\relates QMediaTimeRange
|
||||
|
||||
Returns a time range containing \a r2 subtracted from \a r1.
|
||||
*/
|
||||
|
||||
@@ -113,7 +113,7 @@ void QRadioDataPrivate::_q_serviceDestroyed()
|
||||
}
|
||||
|
||||
/*!
|
||||
Constructs a radio data based on a media object.
|
||||
Constructs a radio data based on a \a mediaObject and \a parent.
|
||||
|
||||
The \a mediaObject should be an instance of \l QRadioTuner. It is preferable to use the
|
||||
\l{QRadioTuner::radioData()}{radioData} property on a QRadioTuner instance to get an instance
|
||||
|
||||
@@ -104,7 +104,8 @@ public:
|
||||
|
||||
|
||||
/*!
|
||||
Constructs a radio tuner based on a media service allocated by a media service \a provider.
|
||||
Constructs a radio tuner based on a media service allocated by the default
|
||||
media service provider.
|
||||
|
||||
The \a parent is passed to QMediaObject.
|
||||
*/
|
||||
|
||||
@@ -83,7 +83,7 @@ public:
|
||||
};
|
||||
|
||||
/*!
|
||||
Creates a new QVideoProbe class. After setting the
|
||||
Creates a new QVideoProbe class with \a parent. After setting the
|
||||
source to monitor with \l setSource(), the \l videoFrameProbed()
|
||||
signal will be emitted when video frames are flowing in the
|
||||
source media object.
|
||||
@@ -160,8 +160,8 @@ bool QVideoProbe::setSource(QMediaObject *source)
|
||||
/*!
|
||||
Starts monitoring the given \a mediaRecorder.
|
||||
|
||||
If \a source is zero, this probe will be deactivated
|
||||
and this function wil return true.
|
||||
If there is no mediaObject associated with \a mediaRecorder, or if it is
|
||||
zero, this probe will be deactivated and this function wil return true.
|
||||
|
||||
If the media recorder instance does not support monitoring
|
||||
video, this function will return false.
|
||||
@@ -197,7 +197,7 @@ bool QVideoProbe::isActive() const
|
||||
/*!
|
||||
\fn QVideoProbe::videoFrameProbed(const QVideoFrame &frame)
|
||||
|
||||
This signal should be emitted when a video frame is processed in the
|
||||
This signal should be emitted when a video \a frame is processed in the
|
||||
media service.
|
||||
*/
|
||||
|
||||
|
||||
@@ -200,6 +200,7 @@ void QGraphicsVideoItemPrivate::_q_serviceDestroyed()
|
||||
/*
|
||||
\class QGraphicsVideoItem
|
||||
|
||||
|
||||
\brief The QGraphicsVideoItem class provides a graphics item which display video produced by a QMediaObject.
|
||||
|
||||
\inmodule QtMultimedia
|
||||
@@ -247,7 +248,7 @@ QGraphicsVideoItem::QGraphicsVideoItem(QGraphicsItem *parent)
|
||||
this, SLOT(_q_updateNativeSize()), Qt::QueuedConnection);
|
||||
}
|
||||
|
||||
/*!
|
||||
/*
|
||||
Destroys a video graphics item.
|
||||
*/
|
||||
QGraphicsVideoItem::~QGraphicsVideoItem()
|
||||
|
||||
Reference in New Issue
Block a user