diff options
| author | Bartlomiej Moskal <bartlomiej.moskal@qt.io> | 2023-06-01 13:51:48 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-06-02 13:59:57 +0000 |
| commit | f3cf84ad5a954ccd0f280f7f1eb8f62564412655 (patch) | |
| tree | 7a586c893df833190de59cbee5334c7c240a927f | |
| parent | 1b7d016850d582960f24c307b3f9c221cd93e2b3 (diff) | |
Docs: Update CameraSession's AudioOutput description
Accoring to the QTBUG-109659, documentation should clearly point that
setting AudioOutput is used for audio routing.
It is already mentioned in:
- qml-qtmultimedia-capturesession[0]
"Route audio to an output device by assigning an AudioOutput object to
the audioOutput property."
- qmediacapturesession[1]
"A preview of the captured media can be (...) heard by routing the
audio to an output device using setAudioOutput()."
But there was no mention about it for audioOutput setter.
This commit add information about audio routing in audioOutput setter
description.
[0]https://doc.qt.io/qt-6/qml-qtmultimedia-capturesession.html#details
[1]https://doc.qt.io/qt-6/qmediacapturesession.html#details
Task-number: QTBUG-109659
Change-Id: I07cd697200d533b649be04a91dd03dca3ac8adc5
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
(cherry picked from commit 3245781b12e90d87ae009d679e801b5388300c5d)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/multimedia/recording/qmediacapturesession.cpp | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/multimedia/recording/qmediacapturesession.cpp b/src/multimedia/recording/qmediacapturesession.cpp index 605d9d9d7..60d99192b 100644 --- a/src/multimedia/recording/qmediacapturesession.cpp +++ b/src/multimedia/recording/qmediacapturesession.cpp @@ -437,6 +437,8 @@ QVideoSink *QMediaCaptureSession::videoSink() const } /*! Sets the audio output device to \a{output}. + + Setting an audio output device enables audio routing from an audio input device. */ void QMediaCaptureSession::setAudioOutput(QAudioOutput *output) { @@ -458,6 +460,9 @@ void QMediaCaptureSession::setAudioOutput(QAudioOutput *output) /*! \qmlproperty AudioOutput QtMultimedia::CaptureSession::audioOutput \brief The audio output device for the capture session. + + Add an AudioOutput device to the capture session to enable + audio routing from an AudioInput device. */ /*! \property QMediaCaptureSession::audioOutput |