bba28afe55
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>
142 lines
4.6 KiB
C++
142 lines
4.6 KiB
C++
/****************************************************************************
|
|
**
|
|
** 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
|
|
|