<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaudiorecorder.cpp -->
<title>QAudioRecorder Class | Qt Multimedia 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-modules.html">C++ Classes</a></td><td >QAudioRecorder</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QAudioRecorder Class</h1>
<!-- $$$QAudioRecorder-brief -->
<p>The <a href="qaudiorecorder.html">QAudioRecorder</a> class is used for the recording of audio. <a href="#details">More...</a></p>
<!-- @@@QAudioRecorder -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAudioRecorder></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediarecorder.html">QMediaRecorder</a></td></tr></table></div><ul>
<li><a href="qaudiorecorder-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qaudiorecorder.html#audioInput-prop">audioInput</a></b> : QString</li>
</ul>
<ul>
<li class="fn">9 properties inherited from <a href="qmediarecorder.html#properties">QMediaRecorder</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudiorecorder.html#QAudioRecorder">QAudioRecorder</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudiorecorder.html#dtor.QAudioRecorder">~QAudioRecorder</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaudiorecorder.html#audioInput">audioInput</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaudiorecorder.html#audioInputDescription">audioInputDescription</a></b>(const QString &<i>name</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qaudiorecorder.html#audioInputs">audioInputs</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaudiorecorder.html#defaultAudioInput">defaultAudioInput</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">34 public functions inherited from <a href="qmediarecorder.html#public-functions">QMediaRecorder</a></li>
<li class="fn">1 public function inherited from <a href="qmediabindableinterface.html#public-functions">QMediaBindableInterface</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiorecorder.html#setAudioInput">setAudioInput</a></b>(const QString &<i>name</i>)</td></tr>
</table></div>
<ul>
<li class="fn">5 public slots inherited from <a href="qmediarecorder.html#public-slots">QMediaRecorder</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiorecorder.html#audioInputChanged">audioInputChanged</a></b>(const QString &<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudiorecorder.html#availableAudioInputsChanged">availableAudioInputsChanged</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">13 signals inherited from <a href="qmediarecorder.html#signals">QMediaRecorder</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 protected function inherited from <a href="qmediabindableinterface.html#protected-functions">QMediaBindableInterface</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAudioRecorder-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qaudiorecorder.html">QAudioRecorder</a> class is used for the recording of audio.</p>
<p>The <a href="qaudiorecorder.html">QAudioRecorder</a> class is a high level media recording class and contains the same functionality as <a href="qmediarecorder.html">QMediaRecorder</a>.</p>
<pre class="cpp">
audioRecorder <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qaudiorecorder.html#QAudioRecorder">QAudioRecorder</a></span>;
<span class="type"><a href="qaudioencodersettings.html">QAudioEncoderSettings</a></span> audioSettings;
audioSettings<span class="operator">.</span>setCodec(<span class="string">"audio/amr"</span>);
audioSettings<span class="operator">.</span>setQuality(<span class="type"><a href="qmultimedia.html">QMultimedia</a></span><span class="operator">::</span>HighQuality);
audioRecorder<span class="operator">-</span><span class="operator">></span>setEncodingSettings(audioSettings);
audioRecorder<span class="operator">-</span><span class="operator">></span>setOutputLocation(<span class="type">QUrl</span><span class="operator">::</span>fromLocalFile(<span class="string">"test.amr"</span>));
audioRecorder<span class="operator">-</span><span class="operator">></span>record();
</pre>
<p>In addition <a href="qaudiorecorder.html">QAudioRecorder</a> provides functionality for selecting the audio input.</p>
<pre class="cpp">
<span class="type">QStringList</span> inputs <span class="operator">=</span> audioRecorder<span class="operator">-</span><span class="operator">></span>audioInputs();
<span class="type">QString</span> selectedInput <span class="operator">=</span> audioRecorder<span class="operator">-</span><span class="operator">></span>defaultAudioInput();
foreach (<span class="type">QString</span> input<span class="operator">,</span> inputs) {
<span class="type">QString</span> description <span class="operator">=</span> audioRecorder<span class="operator">-</span><span class="operator">></span>audioInputDescription(input);
<span class="comment">// show descriptions to user and allow selection</span>
selectedInput <span class="operator">=</span> input;
}
audioRecorder<span class="operator">-</span><span class="operator">></span>setAudioInput(selectedInput);
</pre>
<p>The <a href="qtmultimedia-multimedia-audiorecorder-example.html">Audio Recorder Example</a> shows how to use this class in more detail.</p>
</div>
<p><b>See also </b><a href="qmediarecorder.html">QMediaRecorder</a> and <a href="qaudioinputselectorcontrol.html">QAudioInputSelectorControl</a>.</p>
<!-- @@@QAudioRecorder -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$audioInput-prop$$$audioInput$$$setAudioInputconstQString&$$$audioInputChangedconstQString& -->
<h3 class="fn" id="audioInput-prop"><a name="audioInput-prop"></a><span class="name">audioInput</span> : <span class="type">QString</span></h3>
<p>This property holds the active audio input name.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaudiorecorder.html#audioInput">audioInput</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaudiorecorder.html#setAudioInput">setAudioInput</a></b></span>(const QString &<i>name</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaudiorecorder.html#audioInputChanged">audioInputChanged</a></b></span>(const QString &<i>name</i>)</td></tr>
</table></div>
<!-- @@@audioInput -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAudioRecorder[overload1]$$$QAudioRecorderQObject* -->
<h3 class="fn" id="QAudioRecorder"><a name="QAudioRecorder"></a>QAudioRecorder::<span class="name">QAudioRecorder</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs an audio recorder. The <i>parent</i> is passed to <a href="qmediaobject.html">QMediaObject</a>.</p>
<!-- @@@QAudioRecorder -->
<!-- $$$~QAudioRecorder[overload1]$$$~QAudioRecorder -->
<h3 class="fn" id="dtor.QAudioRecorder"><a name="dtor.QAudioRecorder"></a>QAudioRecorder::<span class="name">~QAudioRecorder</span>()</h3>
<p>Destroys an audio recorder object.</p>
<!-- @@@~QAudioRecorder -->
<!-- $$$audioInput -->
<h3 class="fn" id="audioInput"><a name="audioInput"></a><span class="type">QString</span> QAudioRecorder::<span class="name">audioInput</span>() const</h3>
<p>Returns the active audio input name.</p>
<p><b>Note:</b> Getter function for property <a href="qaudiorecorder.html#audioInput-prop">audioInput</a>. </p><p><b>See also </b><a href="qaudiorecorder.html#setAudioInput">setAudioInput</a>().</p>
<!-- @@@audioInput -->
<!-- $$$audioInputChanged -->
<h3 class="fn" id="audioInputChanged"><a name="audioInputChanged"></a><code>[signal] </code><span class="type">void</span> QAudioRecorder::<span class="name">audioInputChanged</span>(const <span class="type">QString</span> &<i>name</i>)</h3>
<p>Signal emitted when active audio input changes to <i>name</i>.</p>
<p><b>Note:</b> Notifier signal for property <a href="qaudiorecorder.html#audioInput-prop">audioInput</a>. </p><!-- @@@audioInputChanged -->
<!-- $$$audioInputDescription[overload1]$$$audioInputDescriptionconstQString& -->
<h3 class="fn" id="audioInputDescription"><a name="audioInputDescription"></a><span class="type">QString</span> QAudioRecorder::<span class="name">audioInputDescription</span>(const <span class="type">QString</span> &<i>name</i>) const</h3>
<p>Returns the readable translated description of the audio input device with <i>name</i>.</p>
<!-- @@@audioInputDescription -->
<!-- $$$audioInputs[overload1]$$$audioInputs -->
<h3 class="fn" id="audioInputs"><a name="audioInputs"></a><span class="type">QStringList</span> QAudioRecorder::<span class="name">audioInputs</span>() const</h3>
<p>Returns a list of available audio inputs</p>
<!-- @@@audioInputs -->
<!-- $$$availableAudioInputsChanged[overload1]$$$availableAudioInputsChanged -->
<h3 class="fn" id="availableAudioInputsChanged"><a name="availableAudioInputsChanged"></a><code>[signal] </code><span class="type">void</span> QAudioRecorder::<span class="name">availableAudioInputsChanged</span>()</h3>
<p>Signal is emitted when the available audio inputs change.</p>
<!-- @@@availableAudioInputsChanged -->
<!-- $$$defaultAudioInput[overload1]$$$defaultAudioInput -->
<h3 class="fn" id="defaultAudioInput"><a name="defaultAudioInput"></a><span class="type">QString</span> QAudioRecorder::<span class="name">defaultAudioInput</span>() const</h3>
<p>Returns the default audio input name.</p>
<!-- @@@defaultAudioInput -->
<!-- $$$setAudioInput -->
<h3 class="fn" id="setAudioInput"><a name="setAudioInput"></a><code>[slot] </code><span class="type">void</span> QAudioRecorder::<span class="name">setAudioInput</span>(const <span class="type">QString</span> &<i>name</i>)</h3>
<p>Set the active audio input to <i>name</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qaudiorecorder.html#audioInput-prop">audioInput</a>. </p><p><b>See also </b><a href="qaudiorecorder.html#audioInput">audioInput</a>().</p>
<!-- @@@setAudioInput -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed 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.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
