For the developer who wishes to extend the functionality of the Qt Multimedia
classes there are several classes of particular importance. The classes
providing default functionality are QMediaService, QMediaServiceProvider and
-QMediaControl.
+QMediaControl. Some of these classes are not in the public API since they
+are very seldom useful to application developers.
-to extend the Multimedia API you would use the following three classes or
+To extend the Multimedia API you would use the following three classes or
classes derived from them.
\list
- \li \l QMediaServiceProvider is used by the top level client class to
+ \li QMediaServiceProvider is used by the top level client class to
request a service. The top level class knowing what kind of service it needs.
\li \l QMediaService provides a service and when asked by the top level
\section2 Adding a Media Service Provider
+In general, adding a new media service provider is outside the scope of this documentation.
+For best results, consult the existing provider source code, and seek assistance on the relevant
+mailing lists and IRC channels.
+
+\omit
The base class for creating new service providers is \l{QMediaServiceProvider}.
The user must implement the \l{QMediaServiceProvider::requestService()}{requestService()}
function
The choice of what needs to be done depends on what the developer wishes to do with the service.
+\endomit
+
\section2 Classes for service implementers.
\annotatedlist multimedia_control
///////////// MediaPlayer Docs /////////////
/*!
- \qmlclass MediaPlayer
+ \qmlclass MediaPlayer QDeclarativeAudio
\brief The MediaPlayer type allows you to add media playback to a scene.
\inqmlmodule QtMultimedia 5
Indicates camera is ready to capture photo.
It's permissible to call capture() while the camera is active
- regardless of isReadyForCapture property value.
+ regardless of the \e ready property value.
If camera is not ready to capture image immediately,
the capture request is queued with all the related camera settings
to be executed as soon as possible.
}
/*!
- \qmlproperty int QtMultimedia5::CameraImageProcessing::contrast
+ \qmlproperty qreal QtMultimedia5::CameraImageProcessing::contrast
Image contrast adjustment.
Valid contrast adjustment values range between -1.0 and 1.0, with a default of 0.
}
/*!
- \qmlproperty int QtMultimedia5::CameraImageProcessing::saturation
+ \qmlproperty qreal QtMultimedia5::CameraImageProcessing::saturation
Image saturation adjustment.
Valid saturation adjustment values range between -1.0 and 1.0, the default is 0.
}
/*!
- \qmlproperty int QtMultimedia5::CameraImageProcessing::sharpeningLevel
+ \qmlproperty qreal QtMultimedia5::CameraImageProcessing::sharpeningLevel
Adjustment of sharpening level applied to image.
}
/*!
- \qmlproperty int QtMultimedia5::CameraImageProcessing::denoisingLevel
+ \qmlproperty qreal QtMultimedia5::CameraImageProcessing::denoisingLevel
Adjustment of denoising applied to image.
}
/*!
- Sets the audio category of this audio stream.
+ Sets the audio category of this audio stream to \a category.
Some platforms can group audio streams into categories
and manage their volumes independently, or display them
\brief The QMediaRecorderControl class provides access to the recording
functionality of a QMediaService.
+ Generally you will use the QMediaRecorder class in application code - this
+ class is mostly used when implementing a new QMediaService or if there is
+ access to specific low level functionality not otherwise present in QMediaRecorder.
+
If a QMediaService can record media it will implement QMediaRecorderControl.
This control provides a means to set the \l {outputLocation()}{output location},
- and \l {record()}{start}, \l {pause()}{pause} and \l {stop()}{stop}
- recording. It also provides feedback on the \l {duration()}{duration}
- of the recording.
-
- The functionality provided by this control is exposed to application
- code through the QMediaRecorder class.
+ and record, pause and stop recording via the \l setState() method. It also
+ provides feedback on the \l {duration()}{duration} of the recording.
The interface name of QMediaRecorderControl is \c org.qt-project.qt.mediarecordercontrol/5.0 as
defined in QMediaRecorderControl_iid.
functions for things like:
\list
- \li Accessing the currently playing media's metadata (\l {QMediaObject::metaData()} and \l predefined \l {QtMultimedia::MetaData}{meta-data keys})
+ \li Accessing the currently playing media's metadata (\l {QMediaObject::metaData()} and \l {QtMultimedia::MetaData}{predefined meta-data keys})
\li Checking to see if the media playback service is currently available (\l {QMediaObject::availabilityError()})
\endlist
Media objects can use services loaded dynamically from plug-ins or
implemented statically within an applications. Plug-in based services
should also implement the QMediaServiceProviderPlugin interface. Static
- services should implement the QMediaServiceProvider interface.
+ services should implement the QMediaServiceProvider interface. In general,
+ implementing a QMediaService is outside of the scope of this documentation
+ and support on the relevant mailing lists or IRC channels should be sought.
- \sa QMediaObject, QMediaControl, QMediaServiceProvider, QMediaServiceProviderPlugin
+ \sa QMediaObject, QMediaControl
*/
/*!
}
/*!
- Set the encoding \a option \a value.
+ Set the encoding \a option to \a value.
The supported set and meaning of encoding options are
system and selected codec specific.
}
/*!
- Replace all the \a encoding options.
+ Replace all the encoding options with \a options.
The supported set and meaning of encoding options are
system and selected codec specific.
- \sa encodingOption(), setEncodingOptions()
+ \sa encodingOption(), setEncodingOption()
*/
void QAudioEncoderSettings::setEncodingOptions(const QVariantMap &options)
{
}
/*!
- Replace all the \a encoding options.
+ Replace all the encoding options with \a options.
The supported set and meaning of encoding options are
system and selected codec specific.
- \sa encodingOption(), setEncodingOptions()
+ \sa encodingOption(), setEncodingOption()
*/
void QVideoEncoderSettings::setEncodingOptions(const QVariantMap &options)
{
}
/*!
- Replace all the \a encoding options.
+ Replace all the encoding options with \a options.
The supported set and meaning of encoding options are
system and selected codec specific.
- \sa encodingOption(), setEncodingOptions()
+ \sa encodingOption(), setEncodingOption()
*/
void QImageEncoderSettings::setEncodingOptions(const QVariantMap &options)
{
Signals that the \a fullScreen mode of a video widget has changed.
- \sa fullScreen
+ \sa fullScreen()
*/
/*!
Signals that a video widgets's \a brightness adjustment has changed.
- \sa brightness
+ \sa brightness()
*/
/*!
Signals that a video widgets's \a contrast adjustment has changed.
- \sa contrast
+ \sa contrast()
*/
/*!
Signals that a video widgets's \a hue has changed.
- \sa hue
+ \sa hue()
*/
/*!
Signals that a video widgets's \a saturation has changed.
- \sa saturation
+ \sa saturation()
*/
/*!
}
/*!
+ \reimp
Current event \a event.
Returns the value of the baseclass QWidget::event(QEvent *event) function.
*/
}
/*!
+ \reimp
Handles the show \a event.
*/
void QVideoWidget::showEvent(QShowEvent *event)
}
/*!
-
+ \reimp
Handles the hide \a event.
*/
void QVideoWidget::hideEvent(QHideEvent *event)
}
/*!
+ \reimp
Handles the resize \a event.
*/
void QVideoWidget::resizeEvent(QResizeEvent *event)
}
/*!
+ \reimp
Handles the move \a event.
*/
void QVideoWidget::moveEvent(QMoveEvent *event)
}
/*!
+ \reimp
Handles the paint \a event.
*/
void QVideoWidget::paintEvent(QPaintEvent *event)
projects / platform / upstream / qtmultimedia.git / commitdiff