summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-06-06 12:28:34 +1000
committerQt by Nokia <qt-info@nokia.com>2012-06-07 07:05:57 +0200
commitf53788ae42175bd3b7cda1a18366086b285f6f1d (patch)
treeff0581a23c7ee28e4ada783867ab5e8685d6fa4e /doc
parenta8ec84e3ca3abec75f99801db9128bf9ea490e31 (diff)
A number of documentation fixes.
* Remove references to private QMediaServiceProvider class and point new backend writers to irc/mailing lists * Wrong or missing parameter names * Fix a few links * Correct a few property data types * Various other things to keep qdoc happier Change-Id: I5c8800d65c00f0783541afef35990bd3918acab7 Reviewed-by: Angus Cummings <angus.cummings@nokia.com> Reviewed-by: Ling Hu <ling.hu@nokia.com> Reviewed-by: Daniel Kovacic <daniel.kovacic@nokia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/multimediabackend.qdoc14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/src/multimediabackend.qdoc b/doc/src/multimediabackend.qdoc
index fffa12176..2c359d02e 100644
--- a/doc/src/multimediabackend.qdoc
+++ b/doc/src/multimediabackend.qdoc
@@ -53,13 +53,14 @@ this by implementing certain control and service classes, as detailed below.
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
@@ -89,6 +90,11 @@ for the interface.
\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
@@ -123,6 +129,8 @@ Other methods that may be overloaded
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