summaryrefslogtreecommitdiff
path: root/src/multimedia/controls/qaudioencodersettingscontrol.cpp
diff options
context:
space:
mode:
authorMichael Goddard <michael.goddard@nokia.com>2012-06-20 16:04:57 +1000
committerQt by Nokia <qt-info@nokia.com>2012-06-29 02:47:29 +0200
commitbba28afe559837321a2083b3ce046ab774a7ef6b (patch)
tree8908febff01fa8cfbe889dcde87e425b00fbf0d8 /src/multimedia/controls/qaudioencodersettingscontrol.cpp
parentb834fe032f6504ec07f80332d1e22de0b4fc64e0 (diff)
downloadqtmultimedia-bba28afe559837321a2083b3ce046ab774a7ef6b.tar.gz
Rename a few controls.
The encoder controls could be confused with actual encoding, so make clear they are just settings. Also, the end point selector controls were not named very well. Change-Id: I27f8bf9c865c5f295abad97c01ef98752af42613 Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com> Reviewed-by: Ling Hu <ling.hu@nokia.com>
Diffstat (limited to 'src/multimedia/controls/qaudioencodersettingscontrol.cpp')
-rw-r--r--src/multimedia/controls/qaudioencodersettingscontrol.cpp141
1 files changed, 141 insertions, 0 deletions
diff --git a/src/multimedia/controls/qaudioencodersettingscontrol.cpp b/src/multimedia/controls/qaudioencodersettingscontrol.cpp
new file mode 100644
index 000000000..73f2379fa
--- /dev/null
+++ b/src/multimedia/controls/qaudioencodersettingscontrol.cpp
@@ -0,0 +1,141 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the Qt Toolkit.
+**
+** $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 "qaudioencodersettingscontrol.h"
+#include <QtCore/qstringlist.h>
+
+QT_BEGIN_NAMESPACE
+
+
+/*!
+ \class QAudioEncoderSettingsControl
+ \inmodule QtMultimedia
+
+ \ingroup multimedia_control
+
+ \brief The QAudioEncoderSettingsControl class provides access to the settings of a
+ media service that performs audio encoding.
+
+ If a QMediaService supports encoding audio data it will implement
+ QAudioEncoderSettingsControl. 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 QAudioEncoderSettingsControl is \c org.qt-project.qt.audioencodersettingscontrol/5.0 as
+ defined in QAudioEncoderSettingsControl_iid.
+
+ \sa QMediaService::requestControl(), QMediaRecorder
+*/
+
+/*!
+ \macro QAudioEncoderSettingsControl_iid
+
+ \c org.qt-project.qt.audioencodersettingscontrol/5.0
+
+ Defines the interface name of the QAudioEncoderSettingsControl class.
+
+ \relates QAudioEncoderSettingsControl
+*/
+
+/*!
+ Create a new audio encoder settings control object with the given \a parent.
+*/
+QAudioEncoderSettingsControl::QAudioEncoderSettingsControl(QObject *parent)
+ :QMediaControl(parent)
+{
+}
+
+/*!
+ Destroys the audio encoder settings control.
+*/
+QAudioEncoderSettingsControl::~QAudioEncoderSettingsControl()
+{
+}
+
+/*!
+ \fn QAudioEncoderSettingsControl::supportedAudioCodecs() const
+
+ Returns the list of supported audio codec names.
+*/
+
+/*!
+ \fn QAudioEncoderSettingsControl::codecDescription(const QString &codec) const
+
+ Returns description of audio \a codec.
+*/
+
+/*!
+ \fn QAudioEncoderSettingsControl::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.
+*/
+
+/*!
+ \fn QAudioEncoderSettingsControl::audioSettings() const
+
+ Returns the audio encoder settings.
+
+ The returned value may be different tha passed to QAudioEncoderSettingsControl::setAudioSettings()
+ if the settings contains the default or undefined parameters.
+ In this case if the undefined parameters are already resolved, they should be returned.
+*/
+
+/*!
+ \fn QAudioEncoderSettingsControl::setAudioSettings(const QAudioEncoderSettings &settings)
+
+ Sets the selected audio \a settings.
+*/
+
+#include "moc_qaudioencodersettingscontrol.cpp"
+QT_END_NAMESPACE
+