qmediacapturesession.h

Go to the documentation of this file.

// Copyright (C) 2016 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 QMEDIACAPTURESESSION_H
#define QMEDIACAPTURESESSION_H
 
#include <QtCore/qobject.h>
#include <QtMultimedia/qtmultimediaglobal.h>
 
QT_BEGIN_NAMESPACE
 
class QCamera;
class QAudioInput;
class QAudioBufferInput;
class QAudioOutput;
class QCameraDevice;
class QImageCapture;
class QMediaRecorder;
class QPlatformMediaCaptureSession;
class QVideoSink;
class QScreenCapture;
class QWindowCapture;
class QVideoFrameInput;
 
class QMediaCaptureSessionPrivate;
class Q_MULTIMEDIA_EXPORT QMediaCaptureSession : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QAudioInput *audioInput READ audioInput WRITE setAudioInput NOTIFY audioInputChanged)
    Q_PROPERTY(QAudioBufferInput *audioBufferInput READ audioBufferInput WRITE setAudioBufferInput
                       NOTIFY audioBufferInputChanged REVISION(6, 8))
    Q_PROPERTY(QAudioOutput *audioOutput READ audioOutput WRITE setAudioOutput NOTIFY audioOutputChanged)
    Q_PROPERTY(QCamera *camera READ camera WRITE setCamera NOTIFY cameraChanged)
    Q_PROPERTY(QObject *nativeVideoSource READ nativeVideoSource WRITE setNativeVideoSource NOTIFY
                       nativeVideoSourceChanged REVISION(6, 12))
    Q_PROPERTY(
            QScreenCapture *screenCapture READ screenCapture WRITE setScreenCapture NOTIFY screenCaptureChanged)
    Q_PROPERTY(QWindowCapture *windowCapture READ windowCapture WRITE setWindowCapture NOTIFY
                       windowCaptureChanged)
    Q_PROPERTY(QVideoFrameInput *videoFrameInput READ videoFrameInput WRITE setVideoFrameInput
                       NOTIFY videoFrameInputChanged REVISION(6, 8))
    Q_PROPERTY(QImageCapture *imageCapture READ imageCapture WRITE setImageCapture NOTIFY imageCaptureChanged)
    Q_PROPERTY(QMediaRecorder *recorder READ recorder WRITE setRecorder NOTIFY recorderChanged)
    Q_PROPERTY(QObject *videoOutput READ videoOutput WRITE setVideoOutput NOTIFY videoOutputChanged)
public:
    explicit QMediaCaptureSession(QObject *parent = nullptr);
    ~QMediaCaptureSession() override;
 
    QAudioInput *audioInput() const;
    void setAudioInput(QAudioInput *input);
 
    QAudioBufferInput *audioBufferInput() const;
    void setAudioBufferInput(QAudioBufferInput *input);
 
    QCamera *camera() const;
    void setCamera(QCamera *camera);
 
    QObject *nativeVideoSource() const;
    void setNativeVideoSource(QObject *videoSource);
 
    QImageCapture *imageCapture();
    void setImageCapture(QImageCapture *imageCapture);
 
    QScreenCapture *screenCapture();
    void setScreenCapture(QScreenCapture *screenCapture);
 
    QWindowCapture *windowCapture();
    void setWindowCapture(QWindowCapture *windowCapture);
 
    QVideoFrameInput *videoFrameInput() const;
    void setVideoFrameInput(QVideoFrameInput *input);
 
    QMediaRecorder *recorder();
    void setRecorder(QMediaRecorder *recorder);
 
    void setVideoOutput(QObject *output);
    QObject *videoOutput() const;
 
    void setVideoSink(QVideoSink *sink);
    QVideoSink *videoSink() const;
 
    void setAudioOutput(QAudioOutput *output);
    QAudioOutput *audioOutput() const;
 
    QPlatformMediaCaptureSession *platformSession() const;
 
Q_SIGNALS:
    void audioInputChanged();
    Q_REVISION(6, 8) void audioBufferInputChanged();
    void cameraChanged();
    Q_REVISION(6, 12) void nativeVideoSourceChanged();
    void screenCaptureChanged();
    void windowCaptureChanged();
    Q_REVISION(6, 8) void videoFrameInputChanged();
    void imageCaptureChanged();
    void recorderChanged();
    void videoOutputChanged();
    void audioOutputChanged();
 
private:
    friend class QPlatformMediaCaptureSession;
 
    template <typename>
    struct ObjectTraits;
 
    template <typename Object>
    void setObject(Object *);
 
    // ### Qt7: remove unused member
    QT6_ONLY(Q_DECL_UNUSED_MEMBER void *unused = nullptr;) // for ABI compatibility
 
    Q_DISABLE_COPY(QMediaCaptureSession)
    Q_DECLARE_PRIVATE(QMediaCaptureSession)
};
 
QT_END_NAMESPACE
 
#endif  // QMEDIACAPTURESESSION_H