summaryrefslogtreecommitdiffstats
path: root/src/multimedia/doc/src
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@qt.io>2021-06-11 11:55:29 +0200
committerLars Knoll <lars.knoll@qt.io>2021-06-16 08:56:52 +0200
commitfde5d6f7cce6118cac4ce7b92cd056225737917f (patch)
tree6eafa4110806eb354f899cbd4fea2b826c9fdf2c /src/multimedia/doc/src
parent994bcb23af8399485ddfdd16d2ba34c20326b432 (diff)
Rename QMediaEncoder to QMediaRecorder
As per API review, this is the better name. Since we removed the old QMediaRecorder class, the name is free as well. Change-Id: I1ec9af3876af8b6957e20c13f9e225bf1e5032d5 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Diffstat (limited to 'src/multimedia/doc/src')
-rw-r--r--src/multimedia/doc/src/audiooverview.qdoc2
-rw-r--r--src/multimedia/doc/src/cameraoverview.qdoc12
-rw-r--r--src/multimedia/doc/src/changes.qdoc6
-rw-r--r--src/multimedia/doc/src/multimedia.qdoc2
-rw-r--r--src/multimedia/doc/src/qtmultimedia-index.qdoc2
-rw-r--r--src/multimedia/doc/src/videooverview.qdoc2
6 files changed, 13 insertions, 13 deletions
diff --git a/src/multimedia/doc/src/audiooverview.qdoc b/src/multimedia/doc/src/audiooverview.qdoc
index 8adbf8beb..ce49e1e98 100644
--- a/src/multimedia/doc/src/audiooverview.qdoc
+++ b/src/multimedia/doc/src/audiooverview.qdoc
@@ -53,7 +53,7 @@ You can also put files (even remote URLs) into a playlist:
\snippet multimedia-snippets/media.cpp Audio playlist
\section2 Recording Audio to a File
-For recording audio to a file, the \l {QMediaEncoder} class allows you
+For recording audio to a file, the \l {QMediaRecorder} class allows you
to compress audio data from an input device and record it.
\snippet multimedia-snippets/media.cpp Audio recorder
diff --git a/src/multimedia/doc/src/cameraoverview.qdoc b/src/multimedia/doc/src/cameraoverview.qdoc
index c15916fb7..f1f33d79a 100644
--- a/src/multimedia/doc/src/cameraoverview.qdoc
+++ b/src/multimedia/doc/src/cameraoverview.qdoc
@@ -204,7 +204,7 @@ object. All that is then needed is to start the camera and capture the image.
\section2 Movies
Previously we saw code that allowed the capture of a still image. Recording
-video requires the use of a \l QMediaEncoder object.
+video requires the use of a \l QMediaRecorder object.
To record video we need to create a camera object as before but this time as
well as creating a viewfinder, we will also initialize a media recorder object.
@@ -213,13 +213,13 @@ well as creating a viewfinder, we will also initialize a media recorder object.
Signals from the \e mediaEncoder can be connected to slots to react to
changes in the state of the encoding process or error events. Recording itself
-starts with the \l {QMediaEncoder::record()}{record()} function of
+starts with the \l {QMediaRecorder::record()}{record()} function of
mediaEncoder being called, this causes the signal \l
-{QMediaEncoder::recorderStateChanged()}{recorderStateChanged()} to be emitted. The
-recording process can be changed with the \l {QMediaEncoder::record()}{record()},
-\l {QMediaEncoder::stop()}{stop()} slots in \l QMediaEncoder.
+{QMediaRecorder::recorderStateChanged()}{recorderStateChanged()} to be emitted. The
+recording process can be changed with the \l {QMediaRecorder::record()}{record()},
+\l {QMediaRecorder::stop()}{stop()} slots in \l QMediaRecorder.
-On top of the above, QMediaEncoder provides a simple to use, but more limited all-in-one class
+On top of the above, QMediaRecorder provides a simple to use, but more limited all-in-one class
for recording audio and video content.
\section2 Controlling the Imaging Pipeline
diff --git a/src/multimedia/doc/src/changes.qdoc b/src/multimedia/doc/src/changes.qdoc
index 62e4c72b4..4855620a4 100644
--- a/src/multimedia/doc/src/changes.qdoc
+++ b/src/multimedia/doc/src/changes.qdoc
@@ -41,8 +41,8 @@ Existing code that uses Qt Multimedia from Qt 5 can be ported with limited effor
There are a number of new features in Qt Multimedia:
\list
\li QMediaCaptureSession class as the central object for media capture
-\li Changed QMediaEncoder class to be a high level class for audio/video recording
-\li new QMediaEncoder class to handle encoding of data produced in a capture session
+\li Changed QMediaRecorder class to be a high level class for audio/video recording
+\li new QMediaRecorder class to handle encoding of data produced in a capture session
\li Setting up the desired encodings when recording has changed significantly, see
QMediaEncoderSettings for details
\li Support for selection of audio, video and subtitle tracks when playing back media files
@@ -67,7 +67,7 @@ QMediaEncoderSettings for details
and video outputs may be added in a future release.
\row
\li QAudioRecorder and the Audio QML type
- \li QMediaEncoder and the MediaRecorder QML type provide the same functionality
+ \li QMediaRecorder and the MediaRecorder QML type provide the same functionality
\row
\li QMediaObject and QMediaBindableInterface
\li These classes have been removed in favor of a more direct API for setting up connections
diff --git a/src/multimedia/doc/src/multimedia.qdoc b/src/multimedia/doc/src/multimedia.qdoc
index 4dbf2f2d8..c554d5898 100644
--- a/src/multimedia/doc/src/multimedia.qdoc
+++ b/src/multimedia/doc/src/multimedia.qdoc
@@ -138,7 +138,7 @@ For some quick recipes, look at the overviews above and consult this table:
\li \l {Camera Example}{camera},
\l {QML Camera Example}{declarative-camera}
\li \l Camera
- \li QCamera, QMediaEncoder
+ \li QCamera, QMediaRecorder
\row
\li 3D sound sources
\li
diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc
index 86c1dc8c3..5e2f4d98f 100644
--- a/src/multimedia/doc/src/qtmultimedia-index.qdoc
+++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc
@@ -120,7 +120,7 @@
\li QCameraImageCapture
\li Capture still images with a camera.
\row
- \li QMediaEncoder
+ \li QMediaRecorder
\li Record media content from a camera source.
\row
\li QMediaPlayer
diff --git a/src/multimedia/doc/src/videooverview.qdoc b/src/multimedia/doc/src/videooverview.qdoc
index ced829a1e..e3fe0175e 100644
--- a/src/multimedia/doc/src/videooverview.qdoc
+++ b/src/multimedia/doc/src/videooverview.qdoc
@@ -75,7 +75,7 @@ allows you to receive these frames from \l QMediaPlayer and
\l QCamera.
\section2 Recording Video
-You can use the \l QMediaEncoder class as a simple way to record video to disk.
+You can use the \l QMediaRecorder class as a simple way to record video to disk.
For more advances use cases \l QMediaCaptureSession provides a more flexible API.
\section1 Examples