Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 596

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmediaencodersettings.cpp -->
  <title>Qt Mobility 1.2: QAudioEncoderSettings Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtmultimediakit.html">QtMultimediaKit</a></li>
<li>QAudioEncoderSettings</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QAudioEncoderSettings Class Reference</h1>
<!-- $$$QAudioEncoderSettings-brief -->
<p>The QAudioEncoderSettings class provides a set of audio encoder settings. <a href="#details">More...</a></p>
<!-- @@@QAudioEncoderSettings -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QAudioEncoderSettings&gt;</span></pre><p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qaudioencodersettings-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#QAudioEncoderSettings">QAudioEncoderSettings</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#QAudioEncoderSettings-2">QAudioEncoderSettings</a></b> ( const QAudioEncoderSettings &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#dtor.QAudioEncoderSettings">~QAudioEncoderSettings</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#bitRate">bitRate</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#channelCount">channelCount</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#codec">codec</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QtMultimediaKit::EncodingMode </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#encodingMode">encodingMode</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#isNull">isNull</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QtMultimediaKit::EncodingQuality </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#quality">quality</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#sampleRate">sampleRate</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setBitRate">setBitRate</a></b> ( int <i>rate</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setChannelCount">setChannelCount</a></b> ( int <i>channels</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setCodec">setCodec</a></b> ( const QString &amp; <i>codec</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setEncodingMode">setEncodingMode</a></b> ( QtMultimediaKit::EncodingMode <i>mode</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setQuality">setQuality</a></b> ( QtMultimediaKit::EncodingQuality <i>quality</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setSampleRate">setSampleRate</a></b> ( int <i>rate</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#operator-not-eq">operator!=</a></b> ( const QAudioEncoderSettings &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAudioEncoderSettings &amp; </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#operator-eq">operator=</a></b> ( const QAudioEncoderSettings &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#operator-eq-eq">operator==</a></b> ( const QAudioEncoderSettings &amp; <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QAudioEncoderSettings-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAudioEncoderSettings class provides a set of audio encoder settings.</p>
<p>A audio encoder settings object is used to specify the audio encoder settings used by <a href="qmediarecorder.html">QMediaRecorder</a>. Audio encoder settings are selected by constructing a QAudioEncoderSettings object, setting the desired properties and then passing it to a <a href="qmediarecorder.html">QMediaRecorder</a> instance using the <a href="qmediarecorder.html#setEncodingSettings">QMediaRecorder::setEncodingSettings</a>() function.</p>
<pre class="cpp"> <span class="type">QAudioEncoderSettings</span> audioSettings;
 audioSettings<span class="operator">.</span>setCodec(<span class="string">&quot;audio/mpeg&quot;</span>);
 audioSettings<span class="operator">.</span>setChannelCount(<span class="number">2</span>);

 recorder<span class="operator">-</span><span class="operator">&gt;</span>setEncodingSettings(audioSettings);</pre>
</div>
<p><b>See also </b><a href="qmediarecorder.html">QMediaRecorder</a> and <a href="qaudioencodercontrol.html">QAudioEncoderControl</a>.</p>
<!-- @@@QAudioEncoderSettings -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAudioEncoderSettings[overload1]$$$QAudioEncoderSettings -->
<h3 class="fn"><a name="QAudioEncoderSettings"></a>QAudioEncoderSettings::<span class="name">QAudioEncoderSettings</span> ()</h3>
<p>Construct a null audio encoder settings object.</p>
<!-- @@@QAudioEncoderSettings -->
<!-- $$$QAudioEncoderSettings$$$QAudioEncoderSettingsconstQAudioEncoderSettings& -->
<h3 class="fn"><a name="QAudioEncoderSettings-2"></a>QAudioEncoderSettings::<span class="name">QAudioEncoderSettings</span> ( const <span class="type">QAudioEncoderSettings</span> &amp; <i>other</i> )</h3>
<p>Constructs a copy of the audio encoder settings object <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QAudioEncoderSettings -->
<!-- $$$~QAudioEncoderSettings[overload1]$$$~QAudioEncoderSettings -->
<h3 class="fn"><a name="dtor.QAudioEncoderSettings"></a>QAudioEncoderSettings::<span class="name">~QAudioEncoderSettings</span> ()</h3>
<p>Destroys an audio encoder settings object.</p>
<!-- @@@~QAudioEncoderSettings -->
<!-- $$$bitRate[overload1]$$$bitRate -->
<h3 class="fn"><a name="bitRate"></a><span class="type">int</span> QAudioEncoderSettings::<span class="name">bitRate</span> () const</h3>
<p>Returns the bit rate of the compressed audio stream in bits per second.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setBitRate">setBitRate</a>().</p>
<!-- @@@bitRate -->
<!-- $$$channelCount[overload1]$$$channelCount -->
<h3 class="fn"><a name="channelCount"></a><span class="type">int</span> QAudioEncoderSettings::<span class="name">channelCount</span> () const</h3>
<p>Returns the number of audio channels.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setChannelCount">setChannelCount</a>().</p>
<!-- @@@channelCount -->
<!-- $$$codec[overload1]$$$codec -->
<h3 class="fn"><a name="codec"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QAudioEncoderSettings::<span class="name">codec</span> () const</h3>
<p>Returns the audio codec.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setCodec">setCodec</a>().</p>
<!-- @@@codec -->
<!-- $$$encodingMode[overload1]$$$encodingMode -->
<h3 class="fn"><a name="encodingMode"></a><span class="type"><a href="qtmultimediakit.html#EncodingMode-enum">QtMultimediaKit::EncodingMode</a></span> QAudioEncoderSettings::<span class="name">encodingMode</span> () const</h3>
<p>Returns the audio encoding mode.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setEncodingMode">setEncodingMode</a>() and <a href="qtmultimediakit.html#EncodingMode-enum">QtMultimediaKit::EncodingMode</a>.</p>
<!-- @@@encodingMode -->
<!-- $$$isNull[overload1]$$$isNull -->
<h3 class="fn"><a name="isNull"></a><span class="type">bool</span> QAudioEncoderSettings::<span class="name">isNull</span> () const</h3>
<p>Identifies if an audio settings object is initialized.</p>
<p>Returns true if the settings object is null, and false if it is not.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@isNull -->
<!-- $$$quality[overload1]$$$quality -->
<h3 class="fn"><a name="quality"></a><span class="type"><a href="qtmultimediakit.html#EncodingQuality-enum">QtMultimediaKit::EncodingQuality</a></span> QAudioEncoderSettings::<span class="name">quality</span> () const</h3>
<p>Returns the audio encoding quality.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setQuality">setQuality</a>().</p>
<!-- @@@quality -->
<!-- $$$sampleRate[overload1]$$$sampleRate -->
<h3 class="fn"><a name="sampleRate"></a><span class="type">int</span> QAudioEncoderSettings::<span class="name">sampleRate</span> () const</h3>
<p>Returns the audio sample rate in Hz.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setSampleRate">setSampleRate</a>().</p>
<!-- @@@sampleRate -->
<!-- $$$setBitRate[overload1]$$$setBitRateint -->
<h3 class="fn"><a name="setBitRate"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setBitRate</span> ( <span class="type">int</span> <i>rate</i> )</h3>
<p>Sets the audio bit <i>rate</i> in bits per second.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#bitRate">bitRate</a>().</p>
<!-- @@@setBitRate -->
<!-- $$$setChannelCount[overload1]$$$setChannelCountint -->
<h3 class="fn"><a name="setChannelCount"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setChannelCount</span> ( <span class="type">int</span> <i>channels</i> )</h3>
<p>Sets the number of audio <i>channels</i>.</p>
<p>A value of -1 indicates the encoder should make an optimal choice based on what is available from the audio source and the limitations of the codec.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#channelCount">channelCount</a>().</p>
<!-- @@@setChannelCount -->
<!-- $$$setCodec[overload1]$$$setCodecconstQString& -->
<h3 class="fn"><a name="setCodec"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setCodec</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>codec</i> )</h3>
<p>Sets the audio <i>codec</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#codec">codec</a>().</p>
<!-- @@@setCodec -->
<!-- $$$setEncodingMode[overload1]$$$setEncodingModeQtMultimediaKit::EncodingMode -->
<h3 class="fn"><a name="setEncodingMode"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setEncodingMode</span> ( <span class="type"><a href="qtmultimediakit.html#EncodingMode-enum">QtMultimediaKit::EncodingMode</a></span> <i>mode</i> )</h3>
<p>Sets the audio encoding <i>mode</i> setting.</p>
<p>If <a href="qtmultimediakit.html#EncodingMode-enum">QtMultimediaKit::ConstantQualityEncoding</a> is set, the quality encoding parameter is used and bit rate is ignored, otherwise the bitrate is used.</p>
<p>The audio codec, channels count and sample rate settings are used in all the encoding modes.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#encodingMode">encodingMode</a>() and <a href="qtmultimediakit.html#EncodingMode-enum">QtMultimediaKit::EncodingMode</a>.</p>
<!-- @@@setEncodingMode -->
<!-- $$$setQuality[overload1]$$$setQualityQtMultimediaKit::EncodingQuality -->
<h3 class="fn"><a name="setQuality"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setQuality</span> ( <span class="type"><a href="qtmultimediakit.html#EncodingQuality-enum">QtMultimediaKit::EncodingQuality</a></span> <i>quality</i> )</h3>
<p>Set the audio encoding <i>quality</i>.</p>
<p>Setting the audio quality parameter allows backend to choose the balanced set of encoding parameters to achieve the desired quality level.</p>
<p>The <i>quality</i> settings parameter is only used in the <a href="qtmultimediakit.html#EncodingMode-enum">constant quality</a> <a href="qaudioencodersettings.html#encodingMode">encoding mode</a>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#quality">quality</a>().</p>
<!-- @@@setQuality -->
<!-- $$$setSampleRate[overload1]$$$setSampleRateint -->
<h3 class="fn"><a name="setSampleRate"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setSampleRate</span> ( <span class="type">int</span> <i>rate</i> )</h3>
<p>Sets the audio sample <i>rate</i> in Hz.</p>
<p>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.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#sampleRate">sampleRate</a>().</p>
<!-- @@@setSampleRate -->
<!-- $$$operator!=[overload1]$$$operator!=constQAudioEncoderSettings& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QAudioEncoderSettings::<span class="name">operator!=</span> ( const <span class="type">QAudioEncoderSettings</span> &amp; <i>other</i> ) const</h3>
<p>Determines if <i>other</i> is of equal value to an audio encoder settings object.</p>
<p>Returns true if the settings objects are not of equal value, and true if they are of equal value.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQAudioEncoderSettings& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QAudioEncoderSettings</span> &amp; QAudioEncoderSettings::<span class="name">operator=</span> ( const <span class="type">QAudioEncoderSettings</span> &amp; <i>other</i> )</h3>
<p>Assigns the value of <i>other</i> to an audio encoder settings object.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQAudioEncoderSettings& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QAudioEncoderSettings::<span class="name">operator==</span> ( const <span class="type">QAudioEncoderSettings</span> &amp; <i>other</i> ) const</h3>
<p>Determines if <i>other</i> is of equal value to an audio encoder settings object.</p>
<p>Returns true if the settings objects are of equal value, and false if they are not of equal value.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator== -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
    Free Documentation License version 1.3</a>
    as published by the Free Software Foundation.</p>
</div>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional