diff options
| author | Nicholas Bennett <nicholas.bennett@qt.io> | 2021-08-20 10:51:16 +0300 |
|---|---|---|
| committer | Nicholas Bennett <nicholas.bennett@qt.io> | 2021-08-20 13:52:09 +0300 |
| commit | 7ffdf8676d65efd29feec621d8526c9d1f205712 (patch) | |
| tree | 2717fb8d194d9298b0a134749fb285dc58f2bd8e /src/multimedia/audio/qaudioinput.cpp | |
| parent | 96cd25edcdbf40e67b3265fd9ab8eea611983803 (diff) | |
Doc: Fix small spelling mistakes, incorrect QAudioOutput references
QAudioInput referred to output in its class description, fixed this.
Reflowed lines to 80 characters were needed.
Fixed spelling, grammar, hyphenation noticed in other areas.
Added qdoc commands for notes and variable formatting.
Task-number: QTBUG-95115
Pick-to: 6.2
Change-Id: I0e12c6d964c3418427c42cc68112099ee59a91c3
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/multimedia/audio/qaudioinput.cpp')
| -rw-r--r-- | src/multimedia/audio/qaudioinput.cpp | 36 |
1 files changed, 20 insertions, 16 deletions
diff --git a/src/multimedia/audio/qaudioinput.cpp b/src/multimedia/audio/qaudioinput.cpp index e257e8f3f..431e2a871 100644 --- a/src/multimedia/audio/qaudioinput.cpp +++ b/src/multimedia/audio/qaudioinput.cpp @@ -45,45 +45,49 @@ /*! \class QAudioInput - \brief The QAudioOutput class represents an input channel for audio. + \brief Represents an input channel for audio. \inmodule QtMultimedia \ingroup multimedia \ingroup multimedia_audio - QAudioOutput represents an output channel that can be used together QMediaCaptureSession. - It allows selecting the physical input device to be used, muting the channel - or changing its volume. + This class represents an input channel that can be used together with + QMediaCaptureSession. It enables the selection of the physical input device + to be used, muting the channel, and changing the channel's volume. */ /*! \property QAudioInput::volume - \brief the current volume. + \brief The current volume. - The volume is scaled linearly, ranging from \c 0 (silence) to \c 1 (full volume). - Values outside this range will be clamped. + The volume is scaled linearly, ranging from \c 0 (silence) to \c 1 + (full volume). + \note values outside this range will be clamped. By default the volume is \c 1. - UI volume controls should usually be scaled nonlinearly. For example, using a logarithmic scale - will produce linear changes in perceived loudness, which is what a user would normally expect - from a volume control. See QAudio::convertVolume() for more details. + UI volume controls should usually be scaled non-linearly. For example, + using a logarithmic scale will produce linear changes in perceived loudness, + which is what a user would normally expect from a volume control. + \sa QAudio::convertVolume() */ /*! \property QAudioInput::muted - \brief the muted state of the current media. + \brief The muted state of the current media. - The value will be true if the input is muted; otherwise false. + The value will be \c true if the input is muted; otherwise \c false. */ /*! \property QAudioInput::device - \brief the audio device connected to this input. + \brief The audio device connected to this input. - The device property represents the audio device connected to this input. A default constructed - QAudioInput object will be connected to the systems default audio input at construction time. + The device property represents the audio device connected to this input. A + default constructed QAudioInput object will be connected to the system's + default audio input at construction time. - This property can be used to select any other output device listed by QMediaDevices::audioInputs(). + This property can be used to select any other input device listed by + QMediaDevices::audioInputs(). */ QAudioInput::QAudioInput(QObject *parent) |