1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qscreencapture.h"
#include "qmediacapturesession.h"
#include <private/qplatformmediaintegration_p.h>
#include <private/qplatformsurfacecapture_p.h>
#include <private/qobject_p.h>
QT_BEGIN_NAMESPACE
static QScreenCapture::Error toScreenCaptureError(QPlatformSurfaceCapture::Error error)
{
return static_cast<QScreenCapture::Error>(error);
}
class QScreenCapturePrivate : public QObjectPrivate
{
public:
QMediaCaptureSession *captureSession = nullptr;
std::unique_ptr<QPlatformSurfaceCapture> platformScreenCapture;
};
/*!
\class QScreenCapture
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_video
\since 6.5
\brief This class is used for capturing a screen.
The class captures a screen. It is managed by
the QMediaCaptureSession class where the captured screen can be displayed
in a video preview object or recorded to a file.
\snippet multimedia-snippets/media.cpp Media recorder
\include qscreencapture-limitations.qdocinc {content} {Q}
\sa QWindowCapture, QMediaCaptureSession
*/
/*!
\qmltype ScreenCapture
\instantiates QScreenCapture
\brief This type is used for capturing a screen.
\inqmlmodule QtMultimedia
\ingroup multimedia_qml
\ingroup multimedia_video_qml
ScreenCapture captures a screen. It is managed by
MediaCaptureSession where the captured screen can be displayed
in a video preview object or recorded to a file.
\since 6.5
The code below shows a simple capture session with ScreenCapture playing
back the captured primary screen view in VideoOutput.
\qml
CaptureSession {
id: captureSession
screenCapture: ScreenCapture {
id: screenCapture
active: true
}
videoOutput: VideoOutput {
id: videoOutput
}
}
\endqml
\include qscreencapture-limitations.qdocinc {content} {}
\sa WindowCapture, CaptureSession
*/
QScreenCapture::QScreenCapture(QObject *parent)
: QObject(*new QScreenCapturePrivate, parent)
{
Q_D(QScreenCapture);
auto platformCapture = QPlatformMediaIntegration::instance()->createScreenCapture(this);
if (platformCapture) {
connect(platformCapture, &QPlatformSurfaceCapture::activeChanged, this,
&QScreenCapture::activeChanged);
connect(platformCapture, &QPlatformSurfaceCapture::errorChanged, this,
&QScreenCapture::errorChanged);
connect(platformCapture, &QPlatformSurfaceCapture::errorOccurred, this,
[this](QPlatformSurfaceCapture::Error error, QString errorString) {
emit errorOccurred(toScreenCaptureError(error), errorString);
});
connect(platformCapture,
qOverload<QPlatformSurfaceCapture::ScreenSource>(
&QPlatformSurfaceCapture::sourceChanged),
this, &QScreenCapture::screenChanged);
d->platformScreenCapture.reset(platformCapture);
}
}
QScreenCapture::~QScreenCapture()
{
Q_D(QScreenCapture);
// Reset platformScreenCapture in the destructor to avoid having broken ref in the object.
d->platformScreenCapture.reset();
if (d->captureSession)
d->captureSession->setScreenCapture(nullptr);
}
/*!
\enum QScreenCapture::Error
Enumerates error codes that can be signaled by the QScreenCapture class.
errorString() provides detailed information about the error cause.
\value NoError No error
\value InternalError Internal screen capturing driver error
\value CapturingNotSupported Capturing is not supported
\value CaptureFailed Capturing screen failed
\value NotFound Selected screen not found
*/
/*!
Returns the capture session this QScreenCapture is connected to.
Use QMediaCaptureSession::setScreenCapture() to connect the camera to
a session.
*/
QMediaCaptureSession *QScreenCapture::captureSession() const
{
Q_D(const QScreenCapture);
return d->captureSession;
}
/*!
\qmlproperty bool QtMultimedia::ScreenCapture::active
Describes whether the capturing is currently active.
*/
/*!
\property QScreenCapture::active
\brief whether the capturing is currently active.
*/
void QScreenCapture::setActive(bool active)
{
Q_D(QScreenCapture);
if (d->platformScreenCapture)
d->platformScreenCapture->setActive(active);
}
bool QScreenCapture::isActive() const
{
Q_D(const QScreenCapture);
return d->platformScreenCapture && d->platformScreenCapture->isActive();
}
/*!
\qmlproperty Screen QtMultimedia::ScreenCapture::screen
Describes the screen for capturing.
*/
/*!
\property QScreenCapture::screen
\brief the screen for capturing.
*/
void QScreenCapture::setScreen(QScreen *screen)
{
Q_D(QScreenCapture);
if (d->platformScreenCapture)
d->platformScreenCapture->setSource(QPlatformSurfaceCapture::ScreenSource(screen));
}
QScreen *QScreenCapture::screen() const
{
Q_D(const QScreenCapture);
return d->platformScreenCapture
? d->platformScreenCapture->source<QPlatformSurfaceCapture::ScreenSource>()
: nullptr;
}
/*!
\qmlproperty enumeration QtMultimedia::ScreenCapture::error
Returns a code of the last error.
*/
/*!
\property QScreenCapture::error
\brief the code of the last error.
*/
QScreenCapture::Error QScreenCapture::error() const
{
Q_D(const QScreenCapture);
return d->platformScreenCapture ? toScreenCaptureError(d->platformScreenCapture->error())
: CapturingNotSupported;
}
/*!
\fn void QScreenCapture::errorOccurred(QScreenCapture::Error error, const QString &errorString)
Signals when an \a error occurs, along with the \a errorString.
*/
/*!
\qmlproperty string QtMultimedia::ScreenCapture::errorString
Returns a human readable string describing the cause of error.
*/
/*!
\property QScreenCapture::errorString
\brief a human readable string describing the cause of error.
*/
QString QScreenCapture::errorString() const
{
Q_D(const QScreenCapture);
return d->platformScreenCapture ? d->platformScreenCapture->errorString()
: QLatin1StringView("Capturing is not support on this platform");
}
/*!
\fn void QScreenCapture::start()
Starts screen capture.
*/
/*!
\fn void QScreenCapture::stop()
Stops screen capture.
*/
/*!
\internal
*/
void QScreenCapture::setCaptureSession(QMediaCaptureSession *captureSession)
{
Q_D(QScreenCapture);
d->captureSession = captureSession;
}
/*!
\internal
*/
class QPlatformSurfaceCapture *QScreenCapture::platformScreenCapture() const
{
Q_D(const QScreenCapture);
return d->platformScreenCapture.get();
}
QT_END_NAMESPACE
#include "moc_qscreencapture.cpp"
|
