diff options
| author | Yoann Lopes <yoann.lopes@qt.io> | 2016-07-08 15:22:16 +0200 |
|---|---|---|
| committer | Yoann Lopes <yoann.lopes@qt.io> | 2016-08-22 09:50:06 +0000 |
| commit | cc12446728d00161116d6e1823e161440415d2d5 (patch) | |
| tree | 81998ddb81bdb602be6faf76878e849fe675a75a /src/multimedia/controls | |
| parent | d47e412b7b196e37196fa7c7469ae3b54eecf6d4 (diff) | |
Improve audio volume documentation
Added information about volume scales.
Change-Id: Ica8367396147e3e1c814b3575faa5cf0503be031
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Christian Stromme <christian.stromme@qt.io>
Diffstat (limited to 'src/multimedia/controls')
| -rw-r--r-- | src/multimedia/controls/qmediaplayercontrol.cpp | 2 | ||||
| -rw-r--r-- | src/multimedia/controls/qmediarecordercontrol.cpp | 6 |
2 files changed, 6 insertions, 2 deletions
diff --git a/src/multimedia/controls/qmediaplayercontrol.cpp b/src/multimedia/controls/qmediaplayercontrol.cpp index cd56dffcb..46de05b51 100644 --- a/src/multimedia/controls/qmediaplayercontrol.cpp +++ b/src/multimedia/controls/qmediaplayercontrol.cpp @@ -175,6 +175,8 @@ QMediaPlayerControl::QMediaPlayerControl(QObject *parent): \fn QMediaPlayerControl::setVolume(int volume) Sets the audio \a volume of a player control. + + The volume is scaled linearly, ranging from \c 0 (silence) to \c 100 (full volume). */ /*! diff --git a/src/multimedia/controls/qmediarecordercontrol.cpp b/src/multimedia/controls/qmediarecordercontrol.cpp index 4654d16eb..611f1fdcc 100644 --- a/src/multimedia/controls/qmediarecordercontrol.cpp +++ b/src/multimedia/controls/qmediarecordercontrol.cpp @@ -160,13 +160,15 @@ QMediaRecorderControl::~QMediaRecorderControl() /*! \fn qreal QMediaRecorderControl::volume() const - Returns the linear audio gain of media recorder. + Returns the audio volume of a media recorder control. */ /*! \fn void QMediaRecorderControl::setVolume(qreal gain) - Sets the linear audio \a gain of a media recorder. + Sets the audio \a volume of a media recorder control. + + The volume is scaled linearly, ranging from \c 0 (silence) to \c 100 (full volume). */ /*! |