Changeset 846 for trunk/doc/src/classes/phonon-api.qdoc

Timestamp:

May 5, 2011, 5:36:53 AM (14 years ago)

Author:

Dmitry A. Kuminov

Message:

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

Location:

trunk

Files:

• . (modified) (1 prop)
• doc/src/classes/phonon-api.qdoc (modified) (6 diffs)

trunk/doc/src/classes/phonon-api.qdoc

@@ -2 +2 @@
     This file is part of the KDE project
     Copyright (C) 2005-2007 Matthias Kretz <kretz@kde.org>
-    Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+    Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
     Contact: Nokia Corporation (qt-info@nokia.com)
 
@@ -1578 +1578 @@
     \brief The MediaObject class provides an interface for media playback.
 
-
     The media object manages a \l{Phonon::}{MediaSource}, which
     supplies the media object with multimedia content, e.g., from a
@@ -1652 +1651 @@
     different one. A user readable error message is given by
     errorString().
-    \section1 Symbian Platform Security Requirements
-
-    On Symbian, processes which access media via the network must
-    have the \c NetworkServices platform security capability. If the client
-    process lacks this capability, operations will result in errors.
-    This failure is indicated by a state() of Phonon::ErrorState.
-
-    Platform security capabilities are added via the
-    \l{qmake-variable-reference.html#target-capability}{TARGET.CAPABILITY}
-    qmake variable.
-
+
+    \sa {Symbian Platform Security Requirements}
     \sa Phonon::MediaSource, Phonon::AudioOutput, VideoWidget,
     {Music Player Example}, {Phonon Overview}, Phonon::VideoPlayer,
@@ -4125 +4115 @@
 
 /*!
+    \fn Phonon::VideoWidget::snapshot() const
+    \since 4.7
+
+    Returns a snapshot of the current frame shown in the widget.
+*/
+
+/*!
     \enum Phonon::VideoWidget::ScaleMode
 
@@ -4316 +4313 @@
 
 /*!
+    \class Phonon::VideoWidgetInterface44
+    \inmodule Phonon
+    \since 4.7
+*/
+
+/*!
+    \fn Phonon::VideoWidgetInterface44::snapshot() const
+*/
+
+/*!
+    \typedef Phonon::VideoWidgetInterfaceLatest
+    \inmodule Phonon
+    \since 4.7
+*/
+
+/*!
     \class Phonon::PlatformPlugin
     \inmodule Phonon
@@ -5032 +5045 @@
 */
 
+/*!
+    \class Phonon::PulseSupport
+    \inmodule Phonon
+    \since 4.7
+    \internal
+*/
+
+/*!
+    \class Phonon::AudioDataOutput
+    \inmodule Phonon
+    \since 4.7
+
+    \brief The AudioDataOutput class provides access to audio data.
+
+    This class is used to obtain audio data, typically for the purpose of
+    visualizing it.
+
+    Although it is not designed for realtime performance, the latencies
+    associated with accessing the data should be low enough for applications
+    that provide visualizations of the data. This class can also be used to
+    save the audio data for further processing.
+*/
+
+/*!
+    \enum Phonon::AudioDataOutput::Channel
+
+    This enum describes the channel audio data belongs to.
+
+    \value LeftChannel
+    \value RightChannel
+    \value CenterChannel
+    \value LeftSurroundChannel
+    \value RightSurroundChannel
+    \value SubwooferChannel
+*/
+
+/*!
+    \property Phonon::AudioDataOutput::dataSize
+    \brief the number of samples passed via the dataReady() signal.
+*/
+
+/*!
+    \fn int Phonon::AudioDataOutput::sampleRate() const
+
+    Returns the sample rate measured in Hertz, as reported by the backend.
+    If the backend is unavailable -1 is returned.
+*/
+
+/*!
+    \fn void Phonon::AudioDataOutput::endOfMedia(int remainingSamples)
+
+    This signal is emitted before the final dataReady() signal is emitted for
+    a media. The \a remainingSamples value sent by the signal contains the
+    number of samples that will be sent in the final dataReady() signal for
+    the media.
+*/
+
+/*!
+    \fn Phonon::AudioDataOutput::dataReady(const QMap<Phonon::AudioDataOutput::Channel, QVector<qint16> > &data)
+
+    This signal is emitted whenever there is data available to read. The
+    \a data sent by the signal is supplied in the form of a map that holds the
+    data for different output channels.
+*/
+
+/*!
+    \fn Phonon::AudioDataOutputPrivate::AudioDataOutputPrivate()
+    \internal
+*/
+
+/*!
+    \fn Phonon::AudioDataOutputInterface::~AudioDataOutputInterface()
+
+    Destroys the data interface.
+*/
+
+/*!
+    \fn Phonon::AudioDataOutputInterface::frontendObject() const
+    \internal
+*/
+
+/*!
+    \fn Phonon::AudioDataOutputInterface::setFrontendObject(AudioDataOutput *)
+    \internal
+*/
+
+/*!
+    \fn Phonon::GlobalConfigPrivate::GlobalConfigPrivate()
+    \internal
+*/
+
+/*!
+    \fn Phonon::GlobalConfigPrivate::~GlobalConfigPrivate()
+    \internal
+*/
+
+/*!
+    \fn Phonon::SwiftSlider::~SwiftSlider()
+    \internal
+*/