<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaudiosystem.cpp -->
<title>QAbstractAudioInput 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 >QAbstractAudioInput</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="#public-functions">Public Functions</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">QAbstractAudioInput Class</h1>
<!-- $$$QAbstractAudioInput-brief -->
<p>The <a href="qabstractaudioinput.html">QAbstractAudioInput</a> class provides access for <a href="qaudioinput.html">QAudioInput</a> to access the audio device provided by the plugin. <a href="#details">More...</a></p>
<!-- @@@QAbstractAudioInput -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAbstractAudioInput></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr></table></div><ul>
<li><a href="qabstractaudioinput-members.html">List of all members, including inherited members</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"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#bufferSize">bufferSize</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#bytesReady">bytesReady</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual qint64 </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#elapsedUSecs">elapsedUSecs</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QAudio::Error </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#error">error</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QAudioFormat </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#format">format</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#notifyInterval">notifyInterval</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#periodSize">periodSize</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual qint64 </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#processedUSecs">processedUSecs</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#reset">reset</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#resume">resume</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#setBufferSize">setBufferSize</a></b>(int <i>value</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#setFormat">setFormat</a></b>(const QAudioFormat &<i>fmt</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#setNotifyInterval">setNotifyInterval</a></b>(int <i>ms</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#setVolume">setVolume</a></b>(<i>qreal</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#start">start</a></b>(QIODevice *<i>device</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QIODevice *</td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#start-1">start</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QAudio::State </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#state">state</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#stop">stop</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#suspend">suspend</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual qreal </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#volume">volume</a></b>() const = 0</td></tr>
</table></div>
<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="qabstractaudioinput.html#errorChanged">errorChanged</a></b>(QAudio::Error <i>error</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#notify">notify</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractaudioinput.html#stateChanged">stateChanged</a></b>(QAudio::State <i>state</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QAbstractAudioInput-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qabstractaudioinput.html">QAbstractAudioInput</a> class provides access for <a href="qaudioinput.html">QAudioInput</a> to access the audio device provided by the plugin.</p>
<p>QAudioDeviceInput keeps an instance of <a href="qabstractaudioinput.html">QAbstractAudioInput</a> and routes calls to functions of the same name to <a href="qabstractaudioinput.html">QAbstractAudioInput</a>. This means that it is <a href="qabstractaudioinput.html">QAbstractAudioInput</a> that implements the audio functionality. For a description of the functionality, see the <a href="qaudioinput.html">QAudioInput</a> class description.</p>
</div>
<p><b>See also </b><a href="qaudioinput.html">QAudioInput</a>.</p>
<!-- @@@QAbstractAudioInput -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$bufferSize[overload1]$$$bufferSize -->
<h3 class="fn" id="bufferSize"><a name="bufferSize"></a><code>[pure virtual] </code><span class="type">int</span> QAbstractAudioInput::<span class="name">bufferSize</span>() const</h3>
<p>Returns the audio buffer size in milliseconds.</p>
<p><b>See also </b><a href="qabstractaudioinput.html#setBufferSize">setBufferSize</a>().</p>
<!-- @@@bufferSize -->
<!-- $$$bytesReady[overload1]$$$bytesReady -->
<h3 class="fn" id="bytesReady"><a name="bytesReady"></a><code>[pure virtual] </code><span class="type">int</span> QAbstractAudioInput::<span class="name">bytesReady</span>() const</h3>
<p>Returns the amount of audio data available to read in bytes.</p>
<!-- @@@bytesReady -->
<!-- $$$elapsedUSecs[overload1]$$$elapsedUSecs -->
<h3 class="fn" id="elapsedUSecs"><a name="elapsedUSecs"></a><code>[pure virtual] </code><span class="type">qint64</span> QAbstractAudioInput::<span class="name">elapsedUSecs</span>() const</h3>
<p>Returns the milliseconds since <a href="qabstractaudioinput.html#start-1">start</a>() was called, including time in Idle and suspend states.</p>
<!-- @@@elapsedUSecs -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn" id="error"><a name="error"></a><code>[pure virtual] </code><span class="type"><a href="qaudio.html#Error-enum">QAudio::Error</a></span> QAbstractAudioInput::<span class="name">error</span>() const</h3>
<p>Returns the error state.</p>
<!-- @@@error -->
<!-- $$$errorChanged[overload1]$$$errorChangedQAudio::Error -->
<h3 class="fn" id="errorChanged"><a name="errorChanged"></a><code>[signal] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">errorChanged</span>(<span class="type"><a href="qaudio.html#Error-enum">QAudio::Error</a></span> <i>error</i>)</h3>
<p>This signal is emitted when the <i>error</i> state has changed.</p>
<!-- @@@errorChanged -->
<!-- $$$format[overload1]$$$format -->
<h3 class="fn" id="format"><a name="format"></a><code>[pure virtual] </code><span class="type"><a href="qaudioformat.html">QAudioFormat</a></span> QAbstractAudioInput::<span class="name">format</span>() const</h3>
<p>Returns the <a href="qaudioformat.html">QAudioFormat</a> being used</p>
<p><b>See also </b><a href="qabstractaudioinput.html#setFormat">setFormat</a>().</p>
<!-- @@@format -->
<!-- $$$notify[overload1]$$$notify -->
<h3 class="fn" id="notify"><a name="notify"></a><code>[signal] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">notify</span>()</h3>
<p>This signal is emitted when x ms of audio data has been processed the interval set by <a href="qabstractaudioinput.html#setNotifyInterval">setNotifyInterval</a>(x).</p>
<!-- @@@notify -->
<!-- $$$notifyInterval[overload1]$$$notifyInterval -->
<h3 class="fn" id="notifyInterval"><a name="notifyInterval"></a><code>[pure virtual] </code><span class="type">int</span> QAbstractAudioInput::<span class="name">notifyInterval</span>() const</h3>
<p>Returns the notify interval in milliseconds.</p>
<p><b>See also </b><a href="qabstractaudioinput.html#setNotifyInterval">setNotifyInterval</a>().</p>
<!-- @@@notifyInterval -->
<!-- $$$periodSize[overload1]$$$periodSize -->
<h3 class="fn" id="periodSize"><a name="periodSize"></a><code>[pure virtual] </code><span class="type">int</span> QAbstractAudioInput::<span class="name">periodSize</span>() const</h3>
<p>Returns the period size in bytes.</p>
<!-- @@@periodSize -->
<!-- $$$processedUSecs[overload1]$$$processedUSecs -->
<h3 class="fn" id="processedUSecs"><a name="processedUSecs"></a><code>[pure virtual] </code><span class="type">qint64</span> QAbstractAudioInput::<span class="name">processedUSecs</span>() const</h3>
<p>Returns the amount of audio data processed since <a href="qabstractaudioinput.html#start-1">start</a>() was called in milliseconds.</p>
<!-- @@@processedUSecs -->
<!-- $$$reset[overload1]$$$reset -->
<h3 class="fn" id="reset"><a name="reset"></a><code>[pure virtual] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">reset</span>()</h3>
<p>Drops all audio data in the buffers, resets buffers to zero.</p>
<!-- @@@reset -->
<!-- $$$resume[overload1]$$$resume -->
<h3 class="fn" id="resume"><a name="resume"></a><code>[pure virtual] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">resume</span>()</h3>
<p>Resumes processing audio data after a <a href="qabstractaudioinput.html#suspend">suspend</a>().</p>
<!-- @@@resume -->
<!-- $$$setBufferSize[overload1]$$$setBufferSizeint -->
<h3 class="fn" id="setBufferSize"><a name="setBufferSize"></a><code>[pure virtual] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">setBufferSize</span>(<span class="type">int</span> <i>value</i>)</h3>
<p>Sets the audio buffer size to <i>value</i> in milliseconds.</p>
<p><b>See also </b><a href="qabstractaudioinput.html#bufferSize">bufferSize</a>().</p>
<!-- @@@setBufferSize -->
<!-- $$$setFormat[overload1]$$$setFormatconstQAudioFormat& -->
<h3 class="fn" id="setFormat"><a name="setFormat"></a><code>[pure virtual] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">setFormat</span>(const <span class="type"><a href="qaudioformat.html">QAudioFormat</a></span> &<i>fmt</i>)</h3>
<p>Set the <a href="qaudioformat.html">QAudioFormat</a> to use to <i>fmt</i>. Setting the format is only allowable while in <a href="qaudio.html#State-enum">QAudio::StoppedState</a>.</p>
<p><b>See also </b><a href="qabstractaudioinput.html#format">format</a>().</p>
<!-- @@@setFormat -->
<!-- $$$setNotifyInterval[overload1]$$$setNotifyIntervalint -->
<h3 class="fn" id="setNotifyInterval"><a name="setNotifyInterval"></a><code>[pure virtual] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">setNotifyInterval</span>(<span class="type">int</span> <i>ms</i>)</h3>
<p>Sets the interval for <a href="qabstractaudioinput.html#notify">notify</a>() signal to be emitted. This is based on the <i>ms</i> of audio data processed not on actual real-time. The resolution of the timer is platform specific.</p>
<p><b>See also </b><a href="qabstractaudioinput.html#notifyInterval">notifyInterval</a>().</p>
<!-- @@@setNotifyInterval -->
<!-- $$$setVolume[overload1]$$$setVolumeqreal -->
<h3 class="fn" id="setVolume"><a name="setVolume"></a><code>[pure virtual] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">setVolume</span>(<i>qreal</i>)</h3>
<p><b>See also </b><a href="qabstractaudioinput.html#volume">volume</a>().</p>
<!-- @@@setVolume -->
<!-- $$$start[overload1]$$$startQIODevice* -->
<h3 class="fn" id="start"><a name="start"></a><code>[pure virtual] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">start</span>(<span class="type">QIODevice</span> *<i>device</i>)</h3>
<p>Uses the <i>device</i> as the QIODevice to transfer data.</p>
<!-- @@@start -->
<!-- $$$start$$$start -->
<h3 class="fn" id="start-1"><a name="start-1"></a><code>[pure virtual] </code><span class="type">QIODevice</span> *QAbstractAudioInput::<span class="name">start</span>()</h3>
<p>Returns a pointer to the QIODevice being used to handle the data transfer. This QIODevice can be used to read() audio data directly.</p>
<!-- @@@start -->
<!-- $$$state[overload1]$$$state -->
<h3 class="fn" id="state"><a name="state"></a><code>[pure virtual] </code><span class="type"><a href="qaudio.html#State-enum">QAudio::State</a></span> QAbstractAudioInput::<span class="name">state</span>() const</h3>
<p>Returns the state of audio processing.</p>
<!-- @@@state -->
<!-- $$$stateChanged[overload1]$$$stateChangedQAudio::State -->
<h3 class="fn" id="stateChanged"><a name="stateChanged"></a><code>[signal] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">stateChanged</span>(<span class="type"><a href="qaudio.html#State-enum">QAudio::State</a></span> <i>state</i>)</h3>
<p>This signal is emitted when the device <i>state</i> has changed.</p>
<!-- @@@stateChanged -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn" id="stop"><a name="stop"></a><code>[pure virtual] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">stop</span>()</h3>
<p>Stops the audio input.</p>
<!-- @@@stop -->
<!-- $$$suspend[overload1]$$$suspend -->
<h3 class="fn" id="suspend"><a name="suspend"></a><code>[pure virtual] </code><span class="type">void</span> QAbstractAudioInput::<span class="name">suspend</span>()</h3>
<p>Stops processing audio data, preserving buffered audio data.</p>
<!-- @@@suspend -->
<!-- $$$volume[overload1]$$$volume -->
<h3 class="fn" id="volume"><a name="volume"></a><code>[pure virtual] </code><span class="type">qreal</span> QAbstractAudioInput::<span class="name">volume</span>() const</h3>
<p><b>See also </b><a href="qabstractaudioinput.html#setVolume">setVolume</a>().</p>
<!-- @@@volume -->
</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>
