slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Remove antiquated \since lines in docs.

Browse Source 
They aren't useful in the case of QtMultimedia{Kit}

Change-Id: If1b0b6625763c85907fb05beb9c440046472ddef
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
Michael Goddard
2012-01-16 15:19:20 +10:00
committed by Qt by Nokia
parent b228ff95d7
commit a6268601c9
81 changed files with 0 additions and 1319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/multimedia/audio/qaudiodeviceinfo.cpp
View File

@@ -162,7 +162,6 @@ QAudioDeviceInfo::QAudioDeviceInfo():
/*!
Constructs a copy of \a other.
\since 1.0
*/
QAudioDeviceInfo::QAudioDeviceInfo(const QAudioDeviceInfo& other):
d(other.d)
@@ -178,7 +177,6 @@ QAudioDeviceInfo::~QAudioDeviceInfo()
/*!
Sets the QAudioDeviceInfo object to be equal to \a other.
\since 1.0
*/
QAudioDeviceInfo& QAudioDeviceInfo::operator=(const QAudioDeviceInfo &other)
{
@@ -188,7 +186,6 @@ QAudioDeviceInfo& QAudioDeviceInfo::operator=(const QAudioDeviceInfo &other)
/*!
Returns whether this QAudioDeviceInfo object holds a device definition.
\since 1.0
*/
bool QAudioDeviceInfo::isNull() const
{
@@ -203,7 +200,6 @@ bool QAudioDeviceInfo::isNull() const
They are a unique string identifier for the audio device.
eg. default, Intel, U0x46d0x9a4
\since 1.0
*/
QString QAudioDeviceInfo::deviceName() const
{
@@ -213,7 +209,6 @@ QString QAudioDeviceInfo::deviceName() const
/*!
Returns true if the supplied \a settings are supported by the audio
device described by this QAudioDeviceInfo.
\since 1.0
*/
bool QAudioDeviceInfo::isFormatSupported(const QAudioFormat &settings) const
{
@@ -232,7 +227,6 @@ bool QAudioDeviceInfo::isFormatSupported(const QAudioFormat &settings) const
\o Input settings: 8000Hz mono 8 bit.
\o Output settings: 44100Hz stereo 16 bit little endian.
\endlist
\since 1.0
*/
QAudioFormat QAudioDeviceInfo::preferredFormat() const
{
@@ -245,7 +239,6 @@ QAudioFormat QAudioDeviceInfo::preferredFormat() const
These settings are provided by the platform/audio plugin being used.
They are also dependent on the \l {QAudio}::Mode being used.
\since 1.0
*/
QAudioFormat QAudioDeviceInfo::nearestFormat(const QAudioFormat &settings) const
{
@@ -343,7 +336,6 @@ QAudioFormat QAudioDeviceInfo::nearestFormat(const QAudioFormat &settings) const
For writing plugins to support additional codecs refer to:
http://www.iana.org/assignments/media-types/audio/
\since 1.0
*/
QStringList QAudioDeviceInfo::supportedCodecs() const
{
@@ -353,7 +345,6 @@ QStringList QAudioDeviceInfo::supportedCodecs() const
/*!
Returns a list of supported sample rates (in Hertz).
\since 1.0
*/
QList<int> QAudioDeviceInfo::supportedSampleRates() const
{
@@ -364,7 +355,6 @@ QList<int> QAudioDeviceInfo::supportedSampleRates() const
\obsolete
Use supportedSampleRates() instead.
\since 1.0
*/
QList<int> QAudioDeviceInfo::supportedFrequencies() const
{
@@ -376,7 +366,6 @@ QList<int> QAudioDeviceInfo::supportedFrequencies() const
This is typically 1 for mono sound, or 2 for stereo sound.
\since 1.0
*/
QList<int> QAudioDeviceInfo::supportedChannelCounts() const
{
@@ -387,7 +376,6 @@ QList<int> QAudioDeviceInfo::supportedChannelCounts() const
\obsolete
Use supportedChannelCount() instead.
\since 1.0
*/
QList<int> QAudioDeviceInfo::supportedChannels() const
{
@@ -399,7 +387,6 @@ QList<int> QAudioDeviceInfo::supportedChannels() const
Typically this will include 8 and 16 bit sample sizes.
\since 1.0
*/
QList<int> QAudioDeviceInfo::supportedSampleSizes() const
{
@@ -408,7 +395,6 @@ QList<int> QAudioDeviceInfo::supportedSampleSizes() const
/*!
Returns a list of supported byte orders.
\since 1.0
*/
QList<QAudioFormat::Endian> QAudioDeviceInfo::supportedByteOrders() const
{
@@ -417,7 +403,6 @@ QList<QAudioFormat::Endian> QAudioDeviceInfo::supportedByteOrders() const
/*!
Returns a list of supported sample types.
\since 1.0
*/
QList<QAudioFormat::SampleType> QAudioDeviceInfo::supportedSampleTypes() const
{
@@ -427,7 +412,6 @@ QList<QAudioFormat::SampleType> QAudioDeviceInfo::supportedSampleTypes() const
/*!
Returns the information for the default input audio device.
All platform and audio plugin implementations provide a default audio device to use.
\since 1.0
*/
QAudioDeviceInfo QAudioDeviceInfo::defaultInputDevice()
{
@@ -437,7 +421,6 @@ QAudioDeviceInfo QAudioDeviceInfo::defaultInputDevice()
/*!
Returns the information for the default output audio device.
All platform and audio plugin implementations provide a default audio device to use.
\since 1.0
*/
QAudioDeviceInfo QAudioDeviceInfo::defaultOutputDevice()
{
@@ -446,7 +429,6 @@ QAudioDeviceInfo QAudioDeviceInfo::defaultOutputDevice()
/*!
Returns a list of audio devices that support \a mode.
\since 1.0
*/
QList<QAudioDeviceInfo> QAudioDeviceInfo::availableDevices(QAudio::Mode mode)
{
@@ -456,7 +438,6 @@ QList<QAudioDeviceInfo> QAudioDeviceInfo::availableDevices(QAudio::Mode mode)
/*!
\internal
\since 1.0
*/
QAudioDeviceInfo::QAudioDeviceInfo(const QString &realm, const QByteArray &handle, QAudio::Mode mode):
d(new QAudioDeviceInfoPrivate(realm, handle, mode))
@@ -465,7 +446,6 @@ QAudioDeviceInfo::QAudioDeviceInfo(const QString &realm, const QByteArray &handl
/*!
\internal
\since 1.0
*/
QString QAudioDeviceInfo::realm() const
{
@@ -474,7 +454,6 @@ QString QAudioDeviceInfo::realm() const
/*!
\internal
\since 1.0
*/
QByteArray QAudioDeviceInfo::handle() const
{
@@ -484,7 +463,6 @@ QByteArray QAudioDeviceInfo::handle() const
/*!
\internal
\since 1.0
*/
QAudio::Mode QAudioDeviceInfo::mode() const
{

18
src/multimedia/audio/qaudioformat.cpp
View File

@@ -108,7 +108,6 @@ public:
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
An audio format specifies how data in an audio stream is arranged,
i.e, how the stream is to be interpreted. The encoding itself is
@@ -176,7 +175,6 @@ QAudioFormat::QAudioFormat():
/*!
Construct a new audio format using \a other.
\since 1.0
*/
QAudioFormat::QAudioFormat(const QAudioFormat &other):
d(other.d)
@@ -192,7 +190,6 @@ QAudioFormat::~QAudioFormat()
/*!
Assigns \a other to this QAudioFormat implementation.
\since 1.0
*/
QAudioFormat& QAudioFormat::operator=(const QAudioFormat &other)
{
@@ -205,7 +202,6 @@ QAudioFormat& QAudioFormat::operator=(const QAudioFormat &other)
QAudioFormat; otherwise returns false.
All elements of QAudioFormat are used for the comparison.
\since 1.0
*/
bool QAudioFormat::operator==(const QAudioFormat &other) const
{
@@ -222,7 +218,6 @@ bool QAudioFormat::operator==(const QAudioFormat &other) const
QAudioFormat; otherwise returns false.
All elements of QAudioFormat are used for the comparison.
\since 1.0
*/
bool QAudioFormat::operator!=(const QAudioFormat& other) const
{
@@ -231,7 +226,6 @@ bool QAudioFormat::operator!=(const QAudioFormat& other) const
/*!
Returns true if all of the parameters are valid.
\since 1.0
*/
bool QAudioFormat::isValid() const
{
@@ -242,7 +236,6 @@ bool QAudioFormat::isValid() const
/*!
Sets the sample rate to \a samplerate Hertz.
\since 1.0
*/
void QAudioFormat::setSampleRate(int samplerate)
{
@@ -262,7 +255,6 @@ void QAudioFormat::setFrequency(int frequency)
/*!
Returns the current sample rate in Hertz.
\since 1.0
*/
int QAudioFormat::sampleRate() const
{
@@ -282,7 +274,6 @@ int QAudioFormat::frequency() const
/*!
Sets the channel count to \a channels.
\since 1.0
*/
void QAudioFormat::setChannelCount(int channels)
{
@@ -302,7 +293,6 @@ void QAudioFormat::setChannels(int channels)
/*!
Returns the current channel count value.
\since 1.0
*/
int QAudioFormat::channelCount() const
{
@@ -323,7 +313,6 @@ int QAudioFormat::channels() const
Sets the sample size to the \a sampleSize specified, in bits.
This is typically 8 or 16, but some systems may support higher sample sizes.
\since 1.0
*/
void QAudioFormat::setSampleSize(int sampleSize)
{
@@ -332,7 +321,6 @@ void QAudioFormat::setSampleSize(int sampleSize)
/*!
Returns the current sample size value, in bits.
\since 1.0
*/
int QAudioFormat::sampleSize() const
{
@@ -346,7 +334,6 @@ int QAudioFormat::sampleSize() const
reported by the QAudioDeviceInfo::supportedCodecs() function
for the audio device you are working with.
\since 1.0
\sa QAudioDeviceInfo::supportedCodecs()
*/
void QAudioFormat::setCodec(const QString &codec)
@@ -357,7 +344,6 @@ void QAudioFormat::setCodec(const QString &codec)
/*!
Returns the current codec identifier.
\since 1.0
\sa QAudioDeviceInfo::supportedCodecs()
*/
QString QAudioFormat::codec() const
@@ -367,7 +353,6 @@ QString QAudioFormat::codec() const
/*!
Sets the byteOrder to \a byteOrder.
\since 1.0
*/
void QAudioFormat::setByteOrder(QAudioFormat::Endian byteOrder)
{
@@ -376,7 +361,6 @@ void QAudioFormat::setByteOrder(QAudioFormat::Endian byteOrder)
/*!
Returns the current byteOrder value.
\since 1.0
*/
QAudioFormat::Endian QAudioFormat::byteOrder() const
{
@@ -385,7 +369,6 @@ QAudioFormat::Endian QAudioFormat::byteOrder() const
/*!
Sets the sampleType to \a sampleType.
\since 1.0
*/
void QAudioFormat::setSampleType(QAudioFormat::SampleType sampleType)
{
@@ -394,7 +377,6 @@ void QAudioFormat::setSampleType(QAudioFormat::SampleType sampleType)
/*!
Returns the current SampleType value.
\since 1.0
*/
QAudioFormat::SampleType QAudioFormat::sampleType() const
{

22
src/multimedia/audio/qaudioinput.cpp
View File

@@ -55,7 +55,6 @@ QT_BEGIN_NAMESPACE
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
You can construct an audio input with the system's
\l{QAudioDeviceInfo::defaultInputDevice()}{default audio input
@@ -117,7 +116,6 @@ QT_BEGIN_NAMESPACE
Construct a new audio input and attach it to \a parent.
The default audio input device is used with the output
\a format parameters.
\since 1.0
*/
QAudioInput::QAudioInput(const QAudioFormat &format, QObject *parent):
@@ -132,7 +130,6 @@ QAudioInput::QAudioInput(const QAudioFormat &format, QObject *parent):
Construct a new audio input and attach it to \a parent.
The device referenced by \a audioDevice is used with the input
\a format parameters.
\since 1.0
*/
QAudioInput::QAudioInput(const QAudioDeviceInfo &audioDevice, const QAudioFormat &format, QObject *parent):
@@ -164,7 +161,6 @@ QAudioInput::~QAudioInput()
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
\since 1.0
\sa QIODevice
*/
@@ -185,7 +181,6 @@ void QAudioInput::start(QIODevice* device)
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
\since 1.0
\sa QIODevice
*/
@@ -196,7 +191,6 @@ QIODevice* QAudioInput::start()
/*!
Returns the QAudioFormat being used.
\since 1.0
*/
QAudioFormat QAudioInput::format() const
@@ -209,7 +203,6 @@ QAudioFormat QAudioInput::format() const
Sets error() to QAudio::NoError, state() to QAudio::StoppedState and
emit stateChanged() signal.
\since 1.0
*/
void QAudioInput::stop()
@@ -219,7 +212,6 @@ void QAudioInput::stop()
/*!
Drops all audio data in the buffers, resets buffers to zero.
\since 1.0
*/
void QAudioInput::reset()
@@ -232,7 +224,6 @@ void QAudioInput::reset()
Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and
emit stateChanged() signal.
\since 1.0
*/
void QAudioInput::suspend()
@@ -247,7 +238,6 @@ void QAudioInput::suspend()
Sets state() to QAudio::ActiveState if you previously called start(QIODevice*).
Sets state() to QAudio::IdleState if you previously called start().
emits stateChanged() signal.
\since 1.0
*/
void QAudioInput::resume()
@@ -263,7 +253,6 @@ void QAudioInput::resume()
set is the actual buffer size used, calling bufferSize() anytime after start()
will return the actual buffer size being used.
\since 1.0
*/
void QAudioInput::setBufferSize(int value)
@@ -279,7 +268,6 @@ void QAudioInput::setBufferSize(int value)
If called after start(), returns the actual buffer size being used. This may not be what was set previously
by setBufferSize().
\since 1.0
*/
int QAudioInput::bufferSize() const
@@ -292,7 +280,6 @@ int QAudioInput::bufferSize() const
NOTE: returned value is only valid while in QAudio::ActiveState or QAudio::IdleState
state, otherwise returns zero.
\since 1.0
*/
int QAudioInput::bytesReady() const
@@ -308,7 +295,6 @@ int QAudioInput::bytesReady() const
Returns the period size in bytes.
Note: This is the recommended read size in bytes.
\since 1.0
*/
int QAudioInput::periodSize() const
@@ -323,7 +309,6 @@ int QAudioInput::periodSize() const
The minimum resolution of the timer is platform specific and values
should be checked with notifyInterval() to confirm actual value
being used.
\since 1.0
*/
void QAudioInput::setNotifyInterval(int ms)
@@ -333,7 +318,6 @@ void QAudioInput::setNotifyInterval(int ms)
/*!
Returns the notify interval in milliseconds.
\since 1.0
*/
int QAudioInput::notifyInterval() const
@@ -344,7 +328,6 @@ int QAudioInput::notifyInterval() const
/*!
Returns the amount of audio data processed since start()
was called in microseconds.
\since 1.0
*/
qint64 QAudioInput::processedUSecs() const
@@ -355,7 +338,6 @@ qint64 QAudioInput::processedUSecs() const
/*!
Returns the microseconds since start() was called, including time in Idle and
Suspend states.
\since 1.0
*/
qint64 QAudioInput::elapsedUSecs() const
@@ -365,7 +347,6 @@ qint64 QAudioInput::elapsedUSecs() const
/*!
Returns the error state.
\since 1.0
*/
QAudio::Error QAudioInput::error() const
@@ -375,7 +356,6 @@ QAudio::Error QAudioInput::error() const
/*!
Returns the state of audio processing.
\since 1.0
*/
QAudio::State QAudioInput::state() const
@@ -386,14 +366,12 @@ QAudio::State QAudioInput::state() const
/*!
\fn QAudioInput::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
\since 1.0
*/
/*!
\fn QAudioInput::notify()
This signal is emitted when x ms of audio data has been processed
the interval set by setNotifyInterval(x).
\since 1.0
*/
QT_END_NAMESPACE

24
src/multimedia/audio/qaudiooutput.cpp
View File

@@ -56,7 +56,6 @@ QT_BEGIN_NAMESPACE
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
You can construct an audio output with the system's
\l{QAudioDeviceInfo::defaultOutputDevice()}{default audio output
@@ -119,7 +118,6 @@ QT_BEGIN_NAMESPACE
Construct a new audio output and attach it to \a parent.
The default audio output device is used with the output
\a format parameters.
\since 1.0
*/
QAudioOutput::QAudioOutput(const QAudioFormat &format, QObject *parent):
QObject(parent)
@@ -133,7 +131,6 @@ QAudioOutput::QAudioOutput(const QAudioFormat &format, QObject *parent):
Construct a new audio output and attach it to \a parent.
The device referenced by \a audioDevice is used with the output
\a format parameters.
\since 1.0
*/
QAudioOutput::QAudioOutput(const QAudioDeviceInfo &audioDevice, const QAudioFormat &format, QObject *parent):
QObject(parent)
@@ -156,7 +153,6 @@ QAudioOutput::~QAudioOutput()
/*!
Returns the QAudioFormat being used.
\since 1.0
*/
QAudioFormat QAudioOutput::format() const
{
@@ -175,7 +171,6 @@ QAudioFormat QAudioOutput::format() const
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
\since 1.0
\sa QIODevice
*/
void QAudioOutput::start(QIODevice* device)
@@ -194,7 +189,6 @@ void QAudioOutput::start(QIODevice* device)
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
\since 1.0
\sa QIODevice
*/
QIODevice* QAudioOutput::start()
@@ -207,7 +201,6 @@ QIODevice* QAudioOutput::start()
Sets error() to QAudio::NoError, state() to QAudio::StoppedState and
emit stateChanged() signal.
\since 1.0
*/
void QAudioOutput::stop()
{
@@ -217,7 +210,6 @@ void QAudioOutput::stop()
/*!
Drops all audio data in the buffers, resets buffers to zero.
\since 1.0
*/
void QAudioOutput::reset()
{
@@ -229,7 +221,6 @@ void QAudioOutput::reset()
Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and
emits stateChanged() signal.
\since 1.0
*/
void QAudioOutput::suspend()
{
@@ -243,7 +234,6 @@ void QAudioOutput::suspend()
Sets state() to QAudio::ActiveState if you previously called start(QIODevice*).
Sets state() to QAudio::IdleState if you previously called start().
emits stateChanged() signal.
\since 1.0
*/
void QAudioOutput::resume()
{
@@ -255,7 +245,6 @@ void QAudioOutput::resume()
\note The returned value is only valid while in QAudio::ActiveState or QAudio::IdleState
state, otherwise returns zero.
\since 1.0
*/
int QAudioOutput::bytesFree() const
{
@@ -268,7 +257,6 @@ int QAudioOutput::bytesFree() const
\note It is recommended to provide at least enough data for a full period with each
write operation.
\since 1.0
*/
int QAudioOutput::periodSize() const
{
@@ -282,7 +270,6 @@ int QAudioOutput::periodSize() const
are ignored after start(). It should not be assumed that the buffer size
set is the actual buffer size used - call bufferSize() anytime after start()
to return the actual buffer size being used.
\since 1.0
*/
void QAudioOutput::setBufferSize(int value)
{
@@ -297,7 +284,6 @@ void QAudioOutput::setBufferSize(int value)
If called after start(), returns the actual buffer size being used. This may not be what was set previously
by setBufferSize().
\since 1.0
*/
int QAudioOutput::bufferSize() const
{
@@ -311,7 +297,6 @@ int QAudioOutput::bufferSize() const
The minimum resolution of the timer is platform specific and values
should be checked with notifyInterval() to confirm the actual value
being used.
\since 1.0
*/
void QAudioOutput::setNotifyInterval(int ms)
{
@@ -320,7 +305,6 @@ void QAudioOutput::setNotifyInterval(int ms)
/*!
Returns the notify interval in milliseconds.
\since 1.0
*/
int QAudioOutput::notifyInterval() const
{
@@ -330,7 +314,6 @@ int QAudioOutput::notifyInterval() const
/*!
Returns the amount of audio data processed since start()
was called (in microseconds).
\since 1.0
*/
qint64 QAudioOutput::processedUSecs() const
{
@@ -340,7 +323,6 @@ qint64 QAudioOutput::processedUSecs() const
/*!
Returns the microseconds since start() was called, including time in Idle and
Suspend states.
\since 1.0
*/
qint64 QAudioOutput::elapsedUSecs() const
{
@@ -349,7 +331,6 @@ qint64 QAudioOutput::elapsedUSecs() const
/*!
Returns the error state.
\since 1.0
*/
QAudio::Error QAudioOutput::error() const
{
@@ -358,7 +339,6 @@ QAudio::Error QAudioOutput::error() const
/*!
Returns the state of audio processing.
\since 1.0
*/
QAudio::State QAudioOutput::state() const
{
@@ -368,7 +348,6 @@ QAudio::State QAudioOutput::state() const
/*!
Sets the volume.
Where \a volume is between 0.0 and 1.0 inclusive.
\since 5.0
*/
void QAudioOutput::setVolume(qreal volume)
{
@@ -377,7 +356,6 @@ void QAudioOutput::setVolume(qreal volume)
/*!
Returns the volume between 0.0 and 1.0 inclusive.
\since 5.0
*/
qreal QAudioOutput::volume() const
{
@@ -388,7 +366,6 @@ qreal QAudioOutput::volume() const
\fn QAudioOutput::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
This is the current state of the audio output.
\since 1.0
*/
/*!
@@ -396,7 +373,6 @@ qreal QAudioOutput::volume() const
This signal is emitted when a certain interval of milliseconds
of audio data has been processed. The interval is set by
setNotifyInterval().
\since 1.0
*/
QT_END_NAMESPACE

56
src/multimedia/audio/qaudiosystem.cpp
View File

@@ -50,7 +50,6 @@ QT_BEGIN_NAMESPACE
\ingroup multimedia
\inmodule QtMultimedia
\internal
\since 1.0
This class implements the audio functionality for
QAudioDeviceInfo, i.e., QAudioDeviceInfo keeps a
@@ -66,61 +65,51 @@ QT_BEGIN_NAMESPACE
/*!
\fn virtual QAudioFormat QAbstractAudioDeviceInfo::preferredFormat() const
Returns the recommended settings to use.
\since 1.0
*/
/*!
\fn virtual bool QAbstractAudioDeviceInfo::isFormatSupported(const QAudioFormat& format) const
Returns true if \a format is available from audio device.
\since 1.0
*/
/*!
\fn virtual QString QAbstractAudioDeviceInfo::deviceName() const
Returns the audio device name.
\since 1.0
*/
/*!
\fn virtual QStringList QAbstractAudioDeviceInfo::supportedCodecs()
Returns the list of currently available codecs.
\since 1.0
*/
/*!
\fn virtual QList<int> QAbstractAudioDeviceInfo::supportedSampleRates()
Returns the list of currently available sample rates.
\since 1.0
*/
/*!
\fn virtual QList<int> QAbstractAudioDeviceInfo::supportedChannelCounts()
Returns the list of currently available channels.
\since 1.0
*/
/*!
\fn virtual QList<int> QAbstractAudioDeviceInfo::supportedSampleSizes()
Returns the list of currently available sample sizes.
\since 1.0
*/
/*!
\fn virtual QList<QAudioFormat::Endian> QAbstractAudioDeviceInfo::supportedByteOrders()
Returns the list of currently available byte orders.
\since 1.0
*/
/*!
\fn virtual QList<QAudioFormat::SampleType> QAbstractAudioDeviceInfo::supportedSampleTypes()
Returns the list of currently available sample types.
\since 1.0
*/
/*!
\class QAbstractAudioOutput
\brief The QAbstractAudioOutput class is a base class for audio backends.
\since 1.0
\ingroup multimedia
\inmodule QtMultimedia
@@ -138,62 +127,52 @@ QT_BEGIN_NAMESPACE
/*!
\fn virtual void QAbstractAudioOutput::start(QIODevice* device)
Uses the \a device as the QIODevice to transfer data.
\since 1.0
*/
/*!
\fn virtual QIODevice* QAbstractAudioOutput::start()
Returns a pointer to the QIODevice being used to handle
the data transfer. This QIODevice can be used to write() audio data directly.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::stop()
Stops the audio output.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::reset()
Drops all audio data in the buffers, resets buffers to zero.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::suspend()
Stops processing audio data, preserving buffered audio data.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::resume()
Resumes processing audio data after a suspend()
\since 1.0
*/
/*!
\fn virtual int QAbstractAudioOutput::bytesFree() const
Returns the free space available in bytes in the audio buffer.
\since 1.0
*/
/*!
\fn virtual int QAbstractAudioOutput::periodSize() const
Returns the period size in bytes.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::setBufferSize(int value)
Sets the audio buffer size to \a value in bytes.
\since 1.0
*/
/*!
\fn virtual int QAbstractAudioOutput::bufferSize() const
Returns the audio buffer size in bytes.
\since 1.0
*/
/*!
@@ -201,82 +180,69 @@ QT_BEGIN_NAMESPACE
Sets the interval for notify() signal to be emitted. This is based on the \a ms
of audio data processed not on actual real-time. The resolution of the timer
is platform specific.
\since 1.0
*/
/*!
\fn virtual int QAbstractAudioOutput::notifyInterval() const
Returns the notify interval in milliseconds.
\since 1.0
*/
/*!
\fn virtual qint64 QAbstractAudioOutput::processedUSecs() const
Returns the amount of audio data processed since start() was called in milliseconds.
\since 1.0
*/
/*!
\fn virtual qint64 QAbstractAudioOutput::elapsedUSecs() const
Returns the milliseconds since start() was called, including time in Idle and suspend states.
\since 1.0
*/
/*!
\fn virtual QAudio::Error QAbstractAudioOutput::error() const
Returns the error state.
\since 1.0
*/
/*!
\fn virtual QAudio::State QAbstractAudioOutput::state() const
Returns the state of audio processing.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::setFormat(const QAudioFormat& fmt)
Set the QAudioFormat to use to \a fmt.
Setting the format is only allowable while in QAudio::StoppedState.
\since 1.0
*/
/*!
\fn virtual QAudioFormat QAbstractAudioOutput::format() const
Returns the QAudioFormat being used.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::setVolume(qreal volume)
Sets the volume.
Where \a volume is between 0.0 and 1.0.
\since 5.0
*/
/*!
\fn virtual qreal QAbstractAudioOutput::volume() const
Returns the volume in the range 0.0 and 1.0.
\since 5.0
*/
/*!
\fn QAbstractAudioOutput::errorChanged(QAudio::Error error)
This signal is emitted when the \a error state has changed.
\since 1.0
*/
/*!
\fn QAbstractAudioOutput::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
\since 1.0
*/
/*!
\fn QAbstractAudioOutput::notify()
This signal is emitted when x ms of audio data has been processed
the interval set by setNotifyInterval(x).
\since 1.0
*/
@@ -284,7 +250,6 @@ QT_BEGIN_NAMESPACE
\class QAbstractAudioInput
\brief The QAbstractAudioInput class provides access for QAudioInput to access the audio
device provided by the plugin.
\since 1.0
\ingroup multimedia
\inmodule QtMultimedia
@@ -302,62 +267,52 @@ QT_BEGIN_NAMESPACE
/*!
\fn virtual void QAbstractAudioInput::start(QIODevice* device)
Uses the \a device as the QIODevice to transfer data.
\since 1.0
*/
/*!
\fn virtual QIODevice* QAbstractAudioInput::start()
Returns a pointer to the QIODevice being used to handle
the data transfer. This QIODevice can be used to read() audio data directly.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::stop()
Stops the audio input.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::reset()
Drops all audio data in the buffers, resets buffers to zero.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::suspend()
Stops processing audio data, preserving buffered audio data.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::resume()
Resumes processing audio data after a suspend().
\since 1.0
*/
/*!
\fn virtual int QAbstractAudioInput::bytesReady() const
Returns the amount of audio data available to read in bytes.
\since 1.0
*/
/*!
\fn virtual int QAbstractAudioInput::periodSize() const
Returns the period size in bytes.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::setBufferSize(int value)
Sets the audio buffer size to \a value in milliseconds.
\since 1.0
*/
/*!
\fn virtual int QAbstractAudioInput::bufferSize() const
Returns the audio buffer size in milliseconds.
\since 1.0
*/
/*!
@@ -365,69 +320,58 @@ QT_BEGIN_NAMESPACE
Sets the interval for notify() signal to be emitted. This is based
on the \a ms of audio data processed not on actual real-time.
The resolution of the timer is platform specific.
\since 1.0
*/
/*!
\fn virtual int QAbstractAudioInput::notifyInterval() const
Returns the notify interval in milliseconds.
\since 1.0
*/
/*!
\fn virtual qint64 QAbstractAudioInput::processedUSecs() const
Returns the amount of audio data processed since start() was called in milliseconds.
\since 1.0
*/
/*!
\fn virtual qint64 QAbstractAudioInput::elapsedUSecs() const
Returns the milliseconds since start() was called, including time in Idle and suspend states.
\since 1.0
*/
/*!
\fn virtual QAudio::Error QAbstractAudioInput::error() const
Returns the error state.
\since 1.0
*/
/*!
\fn virtual QAudio::State QAbstractAudioInput::state() const
Returns the state of audio processing.
\since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::setFormat(const QAudioFormat& fmt)
Set the QAudioFormat to use to \a fmt.
Setting the format is only allowable while in QAudio::StoppedState.
\since 1.0
*/
/*!
\fn virtual QAudioFormat QAbstractAudioInput::format() const
Returns the QAudioFormat being used
\since 1.0
*/
/*!
\fn QAbstractAudioInput::errorChanged(QAudio::Error error)
This signal is emitted when the \a error state has changed.
\since 1.0
*/
/*!
\fn QAbstractAudioInput::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
\since 1.0
*/
/*!
\fn QAbstractAudioInput::notify()
This signal is emitted when x ms of audio data has been processed
the interval set by setNotifyInterval(x).
\since 1.0
*/

6
src/multimedia/audio/qaudiosystemplugin.cpp
View File

@@ -47,7 +47,6 @@ QT_BEGIN_NAMESPACE
/*!
\class QAudioSystemPlugin
\brief The QAudioSystemPlugin class provides an abstract base for audio plugins.
\since 1.0
\ingroup multimedia
\inmodule QtMultimedia
@@ -108,33 +107,28 @@ QAudioSystemPlugin::~QAudioSystemPlugin()
/*!
\fn QStringList QAudioSystemPlugin::keys() const
Returns the list of device identifiers this plugin supports.
\since 1.0
*/
/*!
\fn QList<QByteArray> QAudioSystemPlugin::availableDevices(QAudio::Mode mode) const
Returns a list of available audio devices for \a mode
\since 1.0
*/
/*!
\fn QAbstractAudioInput* QAudioSystemPlugin::createInput(const QByteArray& device)
Returns a pointer to a QAbstractAudioInput created using \a device identifier
\since 1.0
*/
/*!
\fn QAbstractAudioOutput* QAudioSystemPlugin::createOutput(const QByteArray& device)
Returns a pointer to a QAbstractAudioOutput created using \a device identifier
\since 1.0
*/
/*!
\fn QAbstractAudioDeviceInfo* QAudioSystemPlugin::createDeviceInfo(const QByteArray& device, QAudio::Mode mode)
Returns a pointer to a QAbstractAudioDeviceInfo created using \a device and \a mode
\since 1.0
*/

1
src/multimedia/audio/qsamplecache_p.cpp
View File

@@ -54,7 +54,6 @@ QT_BEGIN_NAMESPACE
When you want to get a sound sample data, you need to request the QSample reference from QSampleCache.
\since 1.1
\code
QSample *m_sample; // class member.

10
src/multimedia/audio/qsound.cpp
View File

@@ -80,7 +80,6 @@
/*!
Plays the sound stored in the file specified by the given \a filename.
\since 5.0
\sa stop(), loopsRemaining(), isFinished()
*/
void QSound::play(const QString& filename)
@@ -96,7 +95,6 @@ void QSound::play(const QString& filename)
Constructs a QSound object from the file specified by the given \a
filename and with the given \a parent.
\since 5.0
\sa play()
*/
QSound::QSound(const QString& filename, QObject* parent)
@@ -111,7 +109,6 @@ QSound::QSound(const QString& filename, QObject* parent)
the stop() function is called before the sound object is
destroyed.
\since 5.0
\sa stop(), isFinished()
*/
QSound::~QSound()
@@ -138,7 +135,6 @@ bool QSound::isFinished() const
sound. The sound can be played again at any time, possibly mixing
or replacing previous plays of the sound.
\since 5.0
\sa fileName()
*/
void QSound::play()
@@ -150,7 +146,6 @@ void QSound::play()
Returns the number of times the sound will play.
Return value of \c QSound::Infinite indicates infinite number of loops
\since 5.0
\sa loopsRemaining(), setLoops()
*/
int QSound::loops() const
@@ -168,7 +163,6 @@ int QSound::loops() const
positive values this value decreases each time the sound is played).
Return value of \c QSound::Infinite indicates infinite number of loops
\since 5.0
\sa loops(), isFinished()
*/
int QSound::loopsRemaining() const
@@ -190,7 +184,6 @@ int QSound::loopsRemaining() const
Note that passing the value \c QSound::Infinite will cause the sound to loop
indefinitely.
\since 5.0
\sa loops()
*/
void QSound::setLoops(int n)
@@ -204,7 +197,6 @@ void QSound::setLoops(int n)
/*!
Returns the filename associated with this QSound object.
\since 5.0
\sa QSound()
*/
QString QSound::fileName() const
@@ -215,7 +207,6 @@ QString QSound::fileName() const
/*!
Stops the sound playing.
\since 5.0
\sa play()
*/
void QSound::stop()
@@ -225,7 +216,6 @@ void QSound::stop()
/*!
\internal
\since 5.0
*/
void QSound::deleteOnComplete()
{

17
src/multimedia/audio/qsoundeffect.cpp
View File

@@ -52,7 +52,6 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass SoundEffect QSoundEffect
\brief The SoundEffect element provides a way to play sound effects in QML.
\since 1.0
\inmodule QtMultimedia
@@ -65,14 +64,12 @@ QT_BEGIN_NAMESPACE
/*!
\qmlproperty url SoundEffect::source
\since 1.0
This property provides a way to control the sound to play.
*/
/*!
\qmlproperty int SoundEffect::loops
\since 1.0
This property provides a way to control the number of times to repeat the sound on each play().
@@ -81,7 +78,6 @@ QT_BEGIN_NAMESPACE
/*!
\qmlproperty qreal SoundEffect::volume
\since 1.0
This property holds the volume of the playback, from 0.0 (silent) to 1.0 (maximum volume).
Note: Currently this has no effect on Mac OS X.
@@ -89,21 +85,18 @@ QT_BEGIN_NAMESPACE
/*!
\qmlproperty bool SoundEffect::muted
\since 1.0
This property provides a way to control muting.
*/
/*!
\qmlproperty bool SoundEffect::playing
\since 1.1
This property indicates if the soundeffect is playing or not.
*/
/*!
\qmlproperty int SoundEffect::status
\since 1.0
This property indicates the following status of the soundeffect.
@@ -115,42 +108,36 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal SoundEffect::sourceChanged()
\since 1.0
This handler is called when the source has changed.
*/
/*!
\qmlsignal SoundEffect::loopCountChanged()
\since 1.0
This handler is called when the initial number of loops has changed.
*/
/*!
\qmlsignal SoundEffect::loopsRemainingChanged()
\since 1.0
This handler is called when the remaining number of loops has changed.
*/
/*!
\qmlsignal SoundEffect::volumeChanged()
\since 1.0
This handler is called when the volume has changed.
*/
/*!
\qmlsignal SoundEffect::mutedChanged()
\since 1.0
This handler is called when the mute state has changed.
*/
/*!
\qmlsignal SoundEffect::playingChanged()
\since 1.0
This handler is called when the playing property has changed.
*/
@@ -159,12 +146,10 @@ QT_BEGIN_NAMESPACE
\qmlsignal SoundEffect::statusChanged()
This handler is called when the status property has changed.
\since 1.0
*/
/*!
\since 1.0
*/
QSoundEffect::QSoundEffect(QObject *parent) :
@@ -274,7 +259,6 @@ bool QSoundEffect::isLoaded() const
This is the default method for SoundEffect.
\snippet doc/src/snippets/multimedia-snippets/soundeffect.qml play sound on click
\since 1.0
*/
void QSoundEffect::play()
{
@@ -299,7 +283,6 @@ QSoundEffect::Status QSoundEffect::status() const
Note that if the backend is PulseAudio, due to the limitation of the underlying API,
tis stop will only prevent next looping but will not be able to stop current playback immediately.
\since 1.0
*/
void QSoundEffect::stop()
{