diff options
author | David Boddie <david.boddie@nokia.com> | 2010-09-20 11:40:16 (GMT) |
---|---|---|
committer | David Boddie <david.boddie@nokia.com> | 2010-09-20 11:40:16 (GMT) |
commit | d5f87b551f2d22f8179ce7072308f69c4eee4067 (patch) | |
tree | bb4ed7778af968efde28c7d2c70331ae8a034ad8 /doc | |
parent | 9236526841d04886307eadc036b92936b47d058d (diff) | |
download | Qt-d5f87b551f2d22f8179ce7072308f69c4eee4067.zip Qt-d5f87b551f2d22f8179ce7072308f69c4eee4067.tar.gz Qt-d5f87b551f2d22f8179ce7072308f69c4eee4067.tar.bz2 |
Doc: Fixed qdoc warnings for Phonon documentation.
This more or less contains the same documentation as upstream Phonon
but can't be merged because we need to maintain our documentation in
different files to make qdoc read it. :-(
Reviewed-by: Trust Me
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/classes/phonon-api.qdoc | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/src/classes/phonon-api.qdoc b/doc/src/classes/phonon-api.qdoc index 6fe0223..a429e5a 100644 --- a/doc/src/classes/phonon-api.qdoc +++ b/doc/src/classes/phonon-api.qdoc @@ -4114,6 +4114,13 @@ */ /*! + \fn Phonon::VideoWidget::snapshot() + \since 4.7 + + Returns a snapshot of the current frame shown in the widget. +*/ + +/*! \enum Phonon::VideoWidget::ScaleMode The ScaleMode enum describes how to treat aspect ratio during @@ -4305,6 +4312,12 @@ */ /*! + \typedef Phonon::VideoWidgetInterfaceLatest + \inmodule Phonon + \since 4.7 +*/ + +/*! \class Phonon::PlatformPlugin \inmodule Phonon \since 4.4 @@ -5021,3 +5034,67 @@ \internal */ +/*! + \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 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::AudioDataOutputInterface::~AudioDataOutputInterface() + + Destroys the data interface. +*/ + +/*! + \fn Phonon::AudioDataOutputInterface::frontendObject() + \internal +*/ + +/*! + \fn Phonon::GlobalConfigPrivate::~GlobalConfigPrivate() + \internal +*/ |