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 "qvideowindowcontrol.h"
41
42QT_BEGIN_NAMESPACE
43
44/*!
45 \class QVideoWindowControl
46 \obsolete
47
48 \inmodule QtMultimedia
49
50 \ingroup multimedia_control
51 \brief The QVideoWindowControl class provides a media control for rendering video to a window.
52
53
54 The winId() property QVideoWindowControl allows a platform specific window
55 ID to be set as the video render target of a QMediaService. The
56 displayRect() property is used to set the region of the window the video
57 should be rendered to, and the aspectRatioMode() property indicates how the
58 video should be scaled to fit the displayRect().
59
60 \snippet multimedia-snippets/video.cpp Video window control
61
62 QVideoWindowControl is one of a number of possible video output controls.
63
64 The interface name of QVideoWindowControl is \c org.qt-project.qt.videowindowcontrol/5.0 as
65 defined in QVideoWindowControl_iid.
66
67 \sa QMediaService::requestControl(), QVideoWidget
68*/
69
70/*!
71 \macro QVideoWindowControl_iid
72
73 \c org.qt-project.qt.videowindowcontrol/5.0
74
75 Defines the interface name of the QVideoWindowControl class.
76
77 \relates QVideoWindowControl
78*/
79
80/*!
81 Constructs a new video window control with the given \a parent.
82*/
83QVideoWindowControl::QVideoWindowControl(QObject *parent)
84 : QMediaControl(parent)
85{
86}
87
88/*!
89 Destroys a video window control.
90*/
91QVideoWindowControl::~QVideoWindowControl()
92{
93}
94
95/*!
96 \fn QVideoWindowControl::winId() const
97
98 Returns the ID of the window a video overlay end point renders to.
99*/
100
101/*!
102 \fn QVideoWindowControl::setWinId(WId id)
103
104 Sets the \a id of the window a video overlay end point renders to.
105*/
106
107/*!
108 \fn QVideoWindowControl::displayRect() const
109 Returns the sub-rect of a window where video is displayed.
110*/
111
112/*!
113 \fn QVideoWindowControl::setDisplayRect(const QRect &rect)
114 Sets the sub-\a rect of a window where video is displayed.
115*/
116
117/*!
118 \fn QVideoWindowControl::isFullScreen() const
119
120 Identifies if a video overlay is a fullScreen overlay.
121
122 Returns true if the video overlay is fullScreen, and false otherwise.
123*/
124
125/*!
126 \fn QVideoWindowControl::setFullScreen(bool fullScreen)
127
128 Sets whether a video overlay is a \a fullScreen overlay.
129*/
130
131/*!
132 \fn QVideoWindowControl::fullScreenChanged(bool fullScreen)
133
134 Signals that the \a fullScreen state of a video overlay has changed.
135*/
136
137/*!
138 \fn QVideoWindowControl::repaint()
139
140 Repaints the last frame.
141*/
142
143/*!
144 \fn QVideoWindowControl::nativeSize() const
145
146 Returns a suggested size for the video display based on the resolution and aspect ratio of the
147 video.
148*/
149
150/*!
151 \fn QVideoWindowControl::nativeSizeChanged()
152
153 Signals that the native dimensions of the video have changed.
154*/
155
156
157/*!
158 \fn QVideoWindowControl::aspectRatioMode() const
159
160 Returns how video is scaled to fit the display region with respect to its aspect ratio.
161*/
162
163/*!
164 \fn QVideoWindowControl::setAspectRatioMode(Qt::AspectRatioMode mode)
165
166 Sets the aspect ratio \a mode which determines how video is scaled to the fit the display region
167 with respect to its aspect ratio.
168*/
169
170/*!
171 \fn QVideoWindowControl::brightness() const
172
173 Returns the brightness adjustment applied to a video overlay.
174
175 Valid brightness values range between -100 and 100, the default is 0.
176*/
177
178/*!
179 \fn QVideoWindowControl::setBrightness(int brightness)
180
181 Sets a \a brightness adjustment for a video overlay.
182
183 Valid brightness values range between -100 and 100, the default is 0.
184*/
185
186/*!
187 \fn QVideoWindowControl::brightnessChanged(int brightness)
188
189 Signals that a video overlay's \a brightness adjustment has changed.
190*/
191
192/*!
193 \fn QVideoWindowControl::contrast() const
194
195 Returns the contrast adjustment applied to a video overlay.
196
197 Valid contrast values range between -100 and 100, the default is 0.
198*/
199
200/*!
201 \fn QVideoWindowControl::setContrast(int contrast)
202
203 Sets the \a contrast adjustment for a video overlay.
204
205 Valid contrast values range between -100 and 100, the default is 0.
206*/
207
208/*!
209 \fn QVideoWindowControl::contrastChanged(int contrast)
210
211 Signals that a video overlay's \a contrast adjustment has changed.
212*/
213
214/*!
215 \fn QVideoWindowControl::hue() const
216
217 Returns the hue adjustment applied to a video overlay.
218
219 Value hue values range between -100 and 100, the default is 0.
220*/
221
222/*!
223 \fn QVideoWindowControl::setHue(int hue)
224
225 Sets a \a hue adjustment for a video overlay.
226
227 Valid hue values range between -100 and 100, the default is 0.
228*/
229
230/*!
231 \fn QVideoWindowControl::hueChanged(int hue)
232
233 Signals that a video overlay's \a hue adjustment has changed.
234*/
235
236/*!
237 \fn QVideoWindowControl::saturation() const
238
239 Returns the saturation adjustment applied to a video overlay.
240
241 Value saturation values range between -100 and 100, the default is 0.
242*/
243
244/*!
245 \fn QVideoWindowControl::setSaturation(int saturation)
246 Sets a \a saturation adjustment for a video overlay.
247
248 Valid saturation values range between -100 and 100, the default is 0.
249*/
250
251/*!
252 \fn QVideoWindowControl::saturationChanged(int saturation)
253
254 Signals that a video overlay's \a saturation adjustment has changed.
255*/
256
257QT_END_NAMESPACE
258
259#include "moc_qvideowindowcontrol.cpp"
260

source code of qtmultimedia/src/multimedia/controls/qvideowindowcontrol.cpp