From e567e098d9d45bd812f42707ad4c864628e7e993 Mon Sep 17 00:00:00 2001 From: Thomas McGuire Date: Tue, 30 Oct 2012 16:48:15 +0100 Subject: Blackberry: Add a page with platform-specific documentation Change-Id: Ic03c59523648ee25c419ec5d80122da9a717aa2d Reviewed-by: Bernd Weimer Reviewed-by: Mitch Curtis Reviewed-by: Sean Harmer --- src/multimedia/doc/src/blackberry.qdoc | 78 ++++++++++++++++++++++++++ src/multimedia/doc/src/qtmultimedia-index.qdoc | 5 ++ 2 files changed, 83 insertions(+) create mode 100644 src/multimedia/doc/src/blackberry.qdoc diff --git a/src/multimedia/doc/src/blackberry.qdoc b/src/multimedia/doc/src/blackberry.qdoc new file mode 100644 index 000000000..2599bb560 --- /dev/null +++ b/src/multimedia/doc/src/blackberry.qdoc @@ -0,0 +1,78 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Research In Motion +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** 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. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page blackberry.html +\title BlackBerry +\brief Platform notes for the BlackBerry Platform + +QtMultimedia supports BlackBerry devices that run the BB10 operating system. +This page covers the availibility of different features on BB10. + +\section1 Implementation + +BB10 ships with a few different multimedia libraries. The main library for audio +and video playback is \e mmrenderer. For low-latency output of raw audio samples, +\e libasound, a variant of the Linux ALSA library, is available. Finally, for +three-dimensional positional audio playback, \e OpenAL is supported and present +on BB10. + +The QtMultimedia BlackBerry backend uses mmrenderer for media playback. + +For the positional audio classes in the \l {Positional Audio} {QtAudioEngine} QML +module, OpenAL is used as on all other platforms. + +\section1 Supported Features + +Playback of audio and video with QMediaPlayer and related classes is supported. +This includes the corresponding QML elements like MediaPlayer and VideoOutput. +Since the playback is delegated to mmrenderer, the supported formats are the same as in +mmrenderer. As mmrenderer supports streaming from HTTP and other URLs, this is +supported in QMediaPlayer as well. Playlists as sources are also supported. + +mmrenderer does not allow access to the pixel data of video frames, hence QtMultimedia +classes like QVideoFrame and QAbstractVideoSurface will not work since they require access +to the image data. QVideoWidget and the VideoOutput QML element are implemented with an overlay window; +mmrenderer creates a seperate window displaying a video and puts that on top of the Qt application. +As a consequence, no other widget or QML element can be put on top of the video, and QML shaders have +no effect. + +The \l {Positional Audio} {QtAudioEngine} QML module is fully supported, as it is based on OpenAL which is available +in BB10. + +\section1 Unsupported Features + +Low-latency output and input of raw audio samples with QAudioOutput, QAudioInput and related classes is +not yet supported. The SoundEffect QML element and QSoundEffect are based on these classes. In your +QML file, use the MediaPlayer element instead of the SoundEffect element, as the APIs are nearly identical. + +QMediaPlayer does not support QIODevice-based streaming sources. However, streaming by specifying, for example, +an HTTP URL as the source does work. In addition, QMediaPlayer does not yet provide metadata like +the artist and album of the current track. + +Camera, radio and audio and video recording are not yet supported. +*/ diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc index 09ba06b08..dcf438d51 100644 --- a/src/multimedia/doc/src/qtmultimedia-index.qdoc +++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc @@ -115,6 +115,11 @@ \li \l{Radio Overview} \endlist + \section2 Platform Notes + \list + \li \l{BlackBerry} + \endlist + \section2 Reference \list \li \l{Qt Multimedia QML Types}{QML Types} -- cgit v1.2.3