1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QMediaRecorder_H
5#define QMediaRecorder_H
6
7#include <QtCore/qobject.h>
8#include <QtCore/qsize.h>
9#include <QtMultimedia/qtmultimediaglobal.h>
10#include <QtMultimedia/qmediametadata.h>
11
12#include <QtCore/qpair.h>
13
14QT_BEGIN_NAMESPACE
15
16class QUrl;
17class QMediaFormat;
18class QMediaCaptureSession;
19class QPlatformMediaRecorder;
20
21class QMediaRecorderPrivate;
22class Q_MULTIMEDIA_EXPORT QMediaRecorder : public QObject
23{
24 Q_OBJECT
25 Q_PROPERTY(QMediaRecorder::RecorderState recorderState READ recorderState NOTIFY recorderStateChanged)
26 Q_PROPERTY(qint64 duration READ duration NOTIFY durationChanged)
27 Q_PROPERTY(QUrl outputLocation READ outputLocation WRITE setOutputLocation)
28 Q_PROPERTY(QUrl actualLocation READ actualLocation NOTIFY actualLocationChanged)
29 Q_PROPERTY(QMediaMetaData metaData READ metaData WRITE setMetaData NOTIFY metaDataChanged)
30 Q_PROPERTY(QMediaRecorder::Error error READ error NOTIFY errorChanged)
31 Q_PROPERTY(QString errorString READ errorString NOTIFY errorChanged)
32 Q_PROPERTY(QMediaFormat mediaFormat READ mediaFormat WRITE setMediaFormat NOTIFY mediaFormatChanged)
33 Q_PROPERTY(Quality quality READ quality WRITE setQuality NOTIFY qualityChanged)
34 Q_PROPERTY(QMediaRecorder::EncodingMode encodingMode READ encodingMode WRITE setEncodingMode NOTIFY encodingModeChanged)
35 Q_PROPERTY(QSize videoResolution READ videoResolution WRITE setVideoResolution NOTIFY videoResolutionChanged)
36 Q_PROPERTY(qreal videoFrameRate READ videoFrameRate WRITE setVideoFrameRate NOTIFY videoFrameRateChanged)
37 Q_PROPERTY(int videoBitRate READ videoBitRate WRITE setVideoBitRate NOTIFY videoBitRateChanged)
38 Q_PROPERTY(int audioBitRate READ audioBitRate WRITE setAudioBitRate NOTIFY audioBitRateChanged)
39 Q_PROPERTY(int audioChannelCount READ audioChannelCount WRITE setAudioChannelCount NOTIFY audioChannelCountChanged)
40 Q_PROPERTY(int audioSampleRate READ audioSampleRate WRITE setAudioSampleRate NOTIFY audioSampleRateChanged)
41 Q_PROPERTY(bool autoStop READ autoStop WRITE setAutoStop NOTIFY autoStopChanged REVISION(6, 8))
42public:
43 enum Quality
44 {
45 VeryLowQuality,
46 LowQuality,
47 NormalQuality,
48 HighQuality,
49 VeryHighQuality
50 };
51 Q_ENUM(Quality)
52
53 enum EncodingMode
54 {
55 ConstantQualityEncoding,
56 ConstantBitRateEncoding,
57 AverageBitRateEncoding,
58 TwoPassEncoding
59 };
60 Q_ENUM(EncodingMode)
61
62 enum RecorderState
63 {
64 StoppedState,
65 RecordingState,
66 PausedState
67 };
68 Q_ENUM(RecorderState)
69
70 enum Error
71 {
72 NoError,
73 ResourceError,
74 FormatError,
75 OutOfSpaceError,
76 LocationNotWritable
77 };
78 Q_ENUM(Error)
79
80 QMediaRecorder(QObject *parent = nullptr);
81 ~QMediaRecorder() override;
82
83 bool isAvailable() const;
84
85 QUrl outputLocation() const;
86 void setOutputLocation(const QUrl &location);
87
88 void setOutputDevice(QIODevice *device);
89 QIODevice *outputDevice() const;
90
91 QUrl actualLocation() const;
92
93 RecorderState recorderState() const;
94
95 Error error() const;
96 QString errorString() const;
97
98 qint64 duration() const;
99
100 QMediaFormat mediaFormat() const;
101 void setMediaFormat(const QMediaFormat &format);
102
103 EncodingMode encodingMode() const;
104 void setEncodingMode(EncodingMode);
105
106 Quality quality() const;
107 void setQuality(Quality quality);
108
109 QSize videoResolution() const;
110 void setVideoResolution(const QSize &);
111 void setVideoResolution(int width, int height) { setVideoResolution(QSize(width, height)); }
112
113 qreal videoFrameRate() const;
114 void setVideoFrameRate(qreal frameRate);
115
116 int videoBitRate() const;
117 void setVideoBitRate(int bitRate);
118
119 int audioBitRate() const;
120 void setAudioBitRate(int bitRate);
121
122 int audioChannelCount() const;
123 void setAudioChannelCount(int channels);
124
125 int audioSampleRate() const;
126 void setAudioSampleRate(int sampleRate);
127
128 QMediaMetaData metaData() const;
129 void setMetaData(const QMediaMetaData &metaData);
130 void addMetaData(const QMediaMetaData &metaData);
131
132 bool autoStop() const;
133 void setAutoStop(bool autoStop);
134
135 QMediaCaptureSession *captureSession() const;
136 QPlatformMediaRecorder *platformRecoder() const;
137
138public Q_SLOTS:
139 void record();
140 void pause();
141 void stop();
142
143Q_SIGNALS:
144 void recorderStateChanged(RecorderState state);
145 void durationChanged(qint64 duration);
146 void actualLocationChanged(const QUrl &location);
147
148#if QT_DEPRECATED_SINCE(6, 9)
149 QT_DEPRECATED_VERSION_X_6_9("Use specific signals instead")
150 void encoderSettingsChanged();
151#endif
152
153 void errorOccurred(Error error, const QString &errorString);
154 void errorChanged();
155
156 void metaDataChanged();
157
158 void mediaFormatChanged();
159 void encodingModeChanged();
160 void qualityChanged();
161 void videoResolutionChanged();
162 void videoFrameRateChanged();
163 void videoBitRateChanged();
164 void audioBitRateChanged();
165 void audioChannelCountChanged();
166 void audioSampleRateChanged();
167 Q_REVISION(6, 8) void autoStopChanged();
168
169private:
170 QMediaRecorderPrivate *d_ptr;
171 friend class QMediaCaptureSession;
172 void setCaptureSession(QMediaCaptureSession *session);
173 Q_DISABLE_COPY(QMediaRecorder)
174 Q_DECLARE_PRIVATE(QMediaRecorder)
175};
176
177QT_END_NAMESPACE
178
179#endif // QMediaRecorder_H
180

source code of qtmultimedia/src/multimedia/recording/qmediarecorder.h