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 "qimageencodercontrol.h"
41#include <QtCore/qstringlist.h>
42
43QT_BEGIN_NAMESPACE
44
45/*!
46 \class QImageEncoderControl
47
48 \inmodule QtMultimedia
49
50
51 \ingroup multimedia_control
52
53 \brief The QImageEncoderControl class provides access to the settings of a media service that
54 performs image encoding.
55
56 If a QMediaService supports encoding image data it will implement QImageEncoderControl.
57 This control allows to \l {setImageSettings()}{set image encoding settings} and
58 provides functions for quering supported image \l {supportedImageCodecs()}{codecs} and
59 \l {supportedResolutions()}{resolutions}.
60
61 The interface name of QImageEncoderControl is \c org.qt-project.qt.imageencodercontrol/5.0 as
62 defined in QImageEncoderControl_iid.
63
64 \sa QImageEncoderSettings, QMediaService::requestControl()
65*/
66
67/*!
68 \macro QImageEncoderControl_iid
69
70 \c org.qt-project.qt.imageencodercontrol/5.0
71
72 Defines the interface name of the QImageEncoderControl class.
73
74 \relates QImageEncoderControl
75*/
76
77/*!
78 Constructs a new image encoder control object with the given \a parent
79*/
80QImageEncoderControl::QImageEncoderControl(QObject *parent)
81 :QMediaControl(parent)
82{
83}
84
85/*!
86 Destroys the image encoder control.
87*/
88QImageEncoderControl::~QImageEncoderControl()
89{
90}
91
92/*!
93 \fn QImageEncoderControl::supportedResolutions(const QImageEncoderSettings &settings = QImageEncoderSettings(),
94 bool *continuous = 0) const
95
96 Returns a list of supported resolutions.
97
98 If non null image \a settings parameter is passed,
99 the returned list is reduced to resolutions supported with partial settings applied.
100 It can be used to query the list of resolutions, supported by specific image codec.
101
102 If the encoder supports arbitrary resolutions within the supported resolutions range,
103 *\a continuous is set to true, otherwise *\a continuous is set to false.
104*/
105
106/*!
107 \fn QImageEncoderControl::supportedImageCodecs() const
108
109 Returns a list of supported image codecs.
110*/
111
112/*!
113 \fn QImageEncoderControl::imageCodecDescription(const QString &codec) const
114
115 Returns a description of an image \a codec.
116*/
117
118/*!
119 \fn QImageEncoderControl::imageSettings() const
120
121 Returns the currently used image encoder settings.
122
123 The returned value may be different tha passed to QImageEncoderControl::setImageSettings()
124 if the settings contains the default or undefined parameters.
125 In this case if the undefined parameters are already resolved, they should be returned.
126*/
127
128/*!
129 \fn QImageEncoderControl::setImageSettings(const QImageEncoderSettings &settings)
130
131 Sets the selected image encoder \a settings.
132*/
133
134#include "moc_qimageencodercontrol.cpp"
135QT_END_NAMESPACE
136
137