summaryrefslogtreecommitdiffstats
path: root/src/multimedia/recording/qwindowcapture.h
blob: 4c8b2eac3f758f49579d24033a6bbcf58ce354bd (plain)
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
// Copyright (C) 2023 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

#ifndef QWINDOWCAPTURE_H
#define QWINDOWCAPTURE_H

#include <QtMultimedia/qtmultimediaexports.h>
#include <QtMultimedia/qcapturablewindow.h>
#include <QtCore/qobject.h>
#include <QtCore/qlist.h>

QT_BEGIN_NAMESPACE

class QPlatformSurfaceCapture;

class Q_MULTIMEDIA_EXPORT QWindowCapture : public QObject
{
    Q_OBJECT
    Q_PROPERTY(bool active READ isActive WRITE setActive NOTIFY activeChanged)
    Q_PROPERTY(QCapturableWindow window READ window WRITE setWindow NOTIFY windowChanged)
    Q_PROPERTY(Error error READ error NOTIFY errorChanged)
    Q_PROPERTY(QString errorString READ errorString NOTIFY errorChanged)
public:
    enum Error {
        NoError = 0,
        InternalError = 1,
        CapturingNotSupported = 2,
        CaptureFailed = 4,
        NotFound = 5,
    };
    Q_ENUM(Error)

    explicit QWindowCapture(QObject *parent = nullptr);
    ~QWindowCapture() override;

    Q_INVOKABLE static QList<QCapturableWindow> capturableWindows();

    QMediaCaptureSession *captureSession() const;

    void setWindow(QCapturableWindow window);

    QCapturableWindow window() const;

    bool isActive() const;

    Error error() const;
    QString errorString() const;

public Q_SLOTS:
    void setActive(bool active);
    void start() { setActive(true); }
    void stop() { setActive(false); }

Q_SIGNALS:
    void activeChanged(bool);
    void windowChanged(QCapturableWindow window);
    void errorChanged();
    void errorOccurred(QWindowCapture::Error error, const QString &errorString);

private:
    void setCaptureSession(QMediaCaptureSession *captureSession);
    QPlatformSurfaceCapture *platformWindowCapture() const;

    friend class QMediaCaptureSession;
    Q_DISABLE_COPY(QWindowCapture)
    Q_DECLARE_PRIVATE(QWindowCapture)
};

QT_END_NAMESPACE

#endif // QWINDOWCAPTURE_H