1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qaudioencodersettingscontrol.h"
41#include <QtCore/qstringlist.h>
42
43QT_BEGIN_NAMESPACE
44
45
46/*!
47 \class QAudioEncoderSettingsControl
48 \inmodule QtMultimedia
49
50 \ingroup multimedia_control
51
52 \brief The QAudioEncoderSettingsControl class provides access to the settings of a
53 media service that performs audio encoding.
54
55 If a QMediaService supports encoding audio data it will implement
56 QAudioEncoderSettingsControl. This control provides information about the limits
57 of restricted audio encoder options and allows the selection of a set of
58 audio encoder settings as specified in a QAudioEncoderSettings object.
59
60 The functionality provided by this control is exposed to application code through the
61 QMediaRecorder class.
62
63 The interface name of QAudioEncoderSettingsControl is \c org.qt-project.qt.audioencodersettingscontrol/5.0 as
64 defined in QAudioEncoderSettingsControl_iid.
65
66 \sa QMediaService::requestControl(), QMediaRecorder
67*/
68
69/*!
70 \macro QAudioEncoderSettingsControl_iid
71
72 \c org.qt-project.qt.audioencodersettingscontrol/5.0
73
74 Defines the interface name of the QAudioEncoderSettingsControl class.
75
76 \relates QAudioEncoderSettingsControl
77*/
78
79/*!
80 Create a new audio encoder settings control object with the given \a parent.
81*/
82QAudioEncoderSettingsControl::QAudioEncoderSettingsControl(QObject *parent)
83 :QMediaControl(parent)
84{
85}
86
87/*!
88 Destroys the audio encoder settings control.
89*/
90QAudioEncoderSettingsControl::~QAudioEncoderSettingsControl()
91{
92}
93
94/*!
95 \fn QAudioEncoderSettingsControl::supportedAudioCodecs() const
96
97 Returns the list of supported audio codec names.
98*/
99
100/*!
101 \fn QAudioEncoderSettingsControl::codecDescription(const QString &codecName) const
102
103 Returns the description of audio codec \a codecName.
104*/
105
106/*!
107 \fn QAudioEncoderSettingsControl::supportedSampleRates(const QAudioEncoderSettings &settings = QAudioEncoderSettings(),
108 bool *continuous) const
109
110 Returns the list of supported audio sample rates, if known.
111
112 If non null audio \a settings parameter is passed,
113 the returned list is reduced to sample rates supported with partial settings applied.
114
115 It can be used for example to query the list of sample rates, supported by specific audio codec.
116
117 If the encoder supports arbitrary sample rates within the supported rates range,
118 *\a continuous is set to true, otherwise *\a continuous is set to false.
119*/
120
121/*!
122 \fn QAudioEncoderSettingsControl::audioSettings() const
123
124 Returns the audio encoder settings.
125
126 The returned value may be different tha passed to QAudioEncoderSettingsControl::setAudioSettings()
127 if the settings contains the default or undefined parameters.
128 In this case if the undefined parameters are already resolved, they should be returned.
129*/
130
131/*!
132 \fn QAudioEncoderSettingsControl::setAudioSettings(const QAudioEncoderSettings &settings)
133
134 Sets the selected audio \a settings.
135*/
136
137#include "moc_qaudioencodersettingscontrol.cpp"
138QT_END_NAMESPACE
139
140