diff options
Diffstat (limited to 'src/multimediakit/qaudioencodercontrol.cpp')
| -rw-r--r-- | src/multimediakit/qaudioencodercontrol.cpp | 167 |
1 files changed, 167 insertions, 0 deletions
diff --git a/src/multimediakit/qaudioencodercontrol.cpp b/src/multimediakit/qaudioencodercontrol.cpp new file mode 100644 index 000000000..d836da94a --- /dev/null +++ b/src/multimediakit/qaudioencodercontrol.cpp @@ -0,0 +1,167 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** This file may be used under the terms of the GNU Lesser General Public +** License version 2.1 as published by the Free Software Foundation and +** appearing in the file LICENSE.LGPL included in the packaging of this +** file. Please review the following information to ensure the GNU Lesser +** General Public License version 2.1 requirements will be met: +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qaudioencodercontrol.h" +#include <QtCore/qstringlist.h> + +QT_BEGIN_NAMESPACE + + +/*! + \class QAudioEncoderControl + \inmodule QtMultimediaKit + \ingroup multimedia + \since 1.0 + + \brief The QAudioEncoderControl class provides access to the settings of a + media service that performs audio encoding. + + If a QMediaService supports encoding audio data it will implement + QAudioEncoderControl. This control provides information about the limits + of restricted audio encoder options and allows the selection of a set of + audio encoder settings as specified in a QAudioEncoderSettings object. + + The functionality provided by this control is exposed to application code through the + QMediaRecorder class. + + The interface name of QAudioEncoderControl is \c com.nokia.Qt.QAudioEncoderControl/1.0 as + defined in QAudioEncoderControl_iid. + + \sa QMediaService::requestControl(), QMediaRecorder +*/ + +/*! + \macro QAudioEncoderControl_iid + + \c com.nokia.Qt.AudioEncoderControl/1.0 + + Defines the interface name of the QAudioEncoderControl class. + + \relates QAudioEncoderControl +*/ + +/*! + Create a new audio encode control object with the given \a parent. +*/ +QAudioEncoderControl::QAudioEncoderControl(QObject *parent) + :QMediaControl(parent) +{ +} + +/*! + Destroys the audio encode control. +*/ +QAudioEncoderControl::~QAudioEncoderControl() +{ +} + +/*! + \fn QAudioEncoderControl::supportedAudioCodecs() const + + Returns the list of supported audio codec names. + \since 1.0 +*/ + +/*! + \fn QAudioEncoderControl::codecDescription(const QString &codec) const + + Returns description of audio \a codec. + \since 1.0 +*/ + +/*! + \fn QAudioEncoderControl::supportedSampleRates(const QAudioEncoderSettings &settings = QAudioEncoderSettings(), + bool *continuous) const + + Returns the list of supported audio sample rates, if known. + + If non null audio \a settings parameter is passed, + the returned list is reduced to sample rates supported with partial settings applied. + + It can be used for example to query the list of sample rates, supported by specific audio codec. + + If the encoder supports arbitrary sample rates within the supported rates range, + *\a continuous is set to true, otherwise *\a continuous is set to false. + \since 1.0 +*/ + +/*! + \fn QAudioEncoderControl::supportedEncodingOptions(const QString &codec) const + + Returns the list of \a codec specific audio encoding options. + \since 1.0 +*/ + +/*! + \fn QAudioEncoderControl::encodingOption(const QString &codec, const QString &option) const + + Returns the value of audio encoding \a option for \a codec. + \since 1.0 +*/ + +/*! + \fn QAudioEncoderControl::setEncodingOption(const QString &codec, const QString &option, const QVariant &value) + + Set the \a codec specific \a option to \a value. + \since 1.0 +*/ + +/*! + \fn QAudioEncoderControl::audioSettings() const + + Returns the audio encoder settings. + + The returned value may be different tha passed to QAudioEncoderControl::setAudioSettings() + if the settings contains the default or undefined parameters. + In this case if the undefined parameters are already resolved, they should be returned. + \since 1.0 +*/ + +/*! + \fn QAudioEncoderControl::setAudioSettings(const QAudioEncoderSettings &settings) + + Sets the selected audio \a settings. + \since 1.0 +*/ + +#include "moc_qaudioencodercontrol.cpp" +QT_END_NAMESPACE + |