qtmobility/src/multimedia/qmediaencodersettings.cpp
changeset 4 90517678cc4f
parent 1 2b40d63a9c3d
child 5 453da2cfceef
--- a/qtmobility/src/multimedia/qmediaencodersettings.cpp	Fri Apr 16 15:51:22 2010 +0300
+++ b/qtmobility/src/multimedia/qmediaencodersettings.cpp	Mon May 03 13:18:40 2010 +0300
@@ -39,7 +39,7 @@
 **
 ****************************************************************************/
 
-#include <qmediaencodersettings.h>
+#include "qmediaencodersettings.h"
 
 QTM_BEGIN_NAMESPACE
 
@@ -194,6 +194,13 @@
 /*!
     Sets the audio encoding \a mode setting.
 
+    If QtMedia::ConstantQualityEncoding is set,
+    the quality encoding parameter is used and bit rate is ignored,
+    otherwise the bitrate is used.
+
+    The audio codec, channels count and sample rate settings
+    are used in all the encoding modes.
+
     \sa encodingMode(), QtMedia::EncodingMode
 */
 void QAudioEncoderSettings::setEncodingMode(QtMedia::EncodingMode mode)
@@ -247,7 +254,7 @@
 }
 
 /*!
-    Sets the audio bit \a rate.
+    Sets the audio bit \a rate in bits per second.
 */
 void QAudioEncoderSettings::setBitRate(int rate)
 {
@@ -256,7 +263,7 @@
 }
 
 /*!
-    Returns the audio sample rate.
+    Returns the audio sample rate in Hz.
 */
 int QAudioEncoderSettings::sampleRate() const
 {
@@ -264,7 +271,7 @@
 }
 
 /*!
-    Sets the audio sample \a rate.
+    Sets the audio sample \a rate in Hz.
 
     A value of -1 indicates the encoder should make an optimal choice based on what is avaialbe
     from the audio source and the limitations of the codec.
@@ -286,6 +293,12 @@
 
 /*!
     Set the audio encoding \a quality.
+
+    Setting the audio quality parameter allows backend to choose the balanced
+    set of encoding parameters to achieve the desired quality level.
+
+    The \a quality settings parameter is only used in the
+    \l {QtMedia::ConstantQualityEncoding}{constant quality} \l{encodingMode()}{encoding mode}.
 */
 void QAudioEncoderSettings::setQuality(QtMedia::EncodingQuality quality)
 {
@@ -437,6 +450,12 @@
 /*!
     Sets the video encoding \a mode.
 
+    If QtMedia::ConstantQualityEncoding is set,
+    the quality encoding parameter is used and bit rate is ignored,
+    otherwise the bitrate is used.
+
+    The rest of encoding settings are respected regardless of encoding mode.
+
     \sa QtMedia::EncodingMode
 */
 void QVideoEncoderSettings::setEncodingMode(QtMedia::EncodingMode mode)
@@ -464,7 +483,7 @@
 }
 
 /*!
-    Returns bit rate of the encoded video stream.
+    Returns bit rate of the encoded video stream in bits per second.
 */
 int QVideoEncoderSettings::bitRate() const
 {
@@ -549,6 +568,12 @@
 
 /*!
     Sets the video encoding \a quality.
+
+    Setting the video quality parameter allows backend to choose the balanced
+    set of encoding parameters to achieve the desired quality level.
+
+    The \a quality settings parameter is only used in the
+    \l {QtMedia::ConstantQualityEncoding}{constant quality} \l{encodingMode()}{encoding mode}.
 */
 
 void QVideoEncoderSettings::setQuality(QtMedia::EncodingQuality quality)