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 "qvideoencodersettingscontrol.h"
41#include <QtCore/qstringlist.h>
42#include <QtCore/qvariant.h>
43
44QT_BEGIN_NAMESPACE
45
46/*!
47 \class QVideoEncoderSettingsControl
48
49 \inmodule QtMultimedia
50
51
52 \ingroup multimedia_control
53
54 \brief The QVideoEncoderSettingsControl class provides access to the settings
55 of a media service that performs video encoding.
56
57 If a QMediaService supports encoding video data it will implement
58 QVideoEncoderSettingsControl. This control provides information about the limits
59 of restricted video encoder options and allows the selection of a set of
60 video encoder settings as specified in a QVideoEncoderSettings object.
61
62 The functionality provided by this control is exposed to application code
63 through the QMediaRecorder class.
64
65 The interface name of QVideoEncoderSettingsControl is \c org.qt-project.qt.videoencodersettingscontrol/5.0 as
66 defined in QVideoEncoderSettingsControl_iid.
67
68 \sa QMediaRecorder, QVideoEncoderSettings, QMediaService::requestControl()
69*/
70
71/*!
72 \macro QVideoEncoderSettingsControl_iid
73
74 \c org.qt-project.qt.videoencodersettingscontrol/5.0
75
76 Defines the interface name of the QVideoEncoderSettingsControl class.
77
78 \relates QVideoEncoderSettingsControl
79*/
80
81/*!
82 Create a new video encoder settings control object with the given \a parent.
83*/
84QVideoEncoderSettingsControl::QVideoEncoderSettingsControl(QObject *parent)
85 :QMediaControl(parent)
86{
87}
88
89/*!
90 Destroys a video encoder settings control.
91*/
92QVideoEncoderSettingsControl::~QVideoEncoderSettingsControl()
93{
94}
95
96/*!
97 \fn QVideoEncoderSettingsControl::supportedVideoCodecs() const
98
99 Returns the list of supported video codecs.
100*/
101
102/*!
103 \fn QVideoEncoderSettingsControl::videoCodecDescription(const QString &codec) const
104
105 Returns a description of a video \a codec.
106*/
107
108/*!
109 \fn QVideoEncoderSettingsControl::supportedResolutions(const QVideoEncoderSettings &settings = QVideoEncoderSettings(),
110 bool *continuous = 0) const
111
112 Returns a list of supported resolutions.
113
114 If non null video \a settings parameter is passed,
115 the returned list is reduced to resolution supported with partial settings like
116 \l {QVideoEncoderSettings::setCodec()}{video codec} or
117 \l {QVideoEncoderSettings::setFrameRate()}{frame rate} applied.
118
119 If the encoder supports arbitrary resolutions within the supported resolutions range,
120 *\a continuous is set to true, otherwise *\a continuous is set to false.
121
122 \sa QVideoEncoderSettings::resolution()
123*/
124
125/*!
126 \fn QVideoEncoderSettingsControl::supportedFrameRates(const QVideoEncoderSettings &settings = QVideoEncoderSettings(),
127 bool *continuous = 0) const
128
129 Returns a list of supported frame rates.
130
131 If non null video \a settings parameter is passed,
132 the returned list is reduced to frame rates supported with partial settings like
133 \l {QVideoEncoderSettings::setCodec()}{video codec} or
134 \l {QVideoEncoderSettings::setResolution()}{video resolution} applied.
135
136 If the encoder supports arbitrary frame rates within the supported range,
137 *\a continuous is set to true, otherwise *\a continuous is set to false.
138
139 \sa QVideoEncoderSettings::frameRate()
140*/
141
142/*!
143 \fn QVideoEncoderSettingsControl::videoSettings() const
144
145 Returns the video encoder settings.
146
147 The returned value may be different tha passed to QVideoEncoderSettingsControl::setVideoSettings()
148 if the settings contains the default or undefined parameters.
149 In this case if the undefined parameters are already resolved, they should be returned.
150*/
151
152/*!
153 \fn QVideoEncoderSettingsControl::setVideoSettings(const QVideoEncoderSettings &settings)
154
155 Sets the selected video encoder \a settings.
156*/
157
158#include "moc_qvideoencodersettingscontrol.cpp"
159QT_END_NAMESPACE
160
161