/usr/share/qt5/doc/qtmultimedia/qaudioprobe.html is in qtmultimedia5-doc-html 5.9.5-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaudioprobe.cpp -->
<title>QAudioProbe 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 >QAudioProbe</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 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">QAudioProbe Class</h1>
<!-- $$$QAudioProbe-brief -->
<p>The <a href="qaudioprobe.html">QAudioProbe</a> class allows you to monitor audio being played or recorded. <a href="#details">More...</a></p>
<!-- @@@QAudioProbe -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAudioProbe></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="../qtcore/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qaudioprobe-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"> </td><td class="memItemRight bottomAlign"><b><a href="qaudioprobe.html#QAudioProbe">QAudioProbe</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudioprobe.html#dtor.QAudioProbe">~QAudioProbe</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudioprobe.html#isActive">isActive</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudioprobe.html#setSource">setSource</a></b>(QMediaObject *<i>source</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudioprobe.html#setSource-1">setSource</a></b>(QMediaRecorder *<i>mediaRecorder</i>)</td></tr>
</table></div>
<ul>
<li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</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="qaudioprobe.html#audioBufferProbed">audioBufferProbed</a></b>(const QAudioBuffer &<i>buffer</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioprobe.html#flush">flush</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAudioProbe-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qaudioprobe.html">QAudioProbe</a> class allows you to monitor audio being played or recorded.</p>
<pre class="cpp">
<span class="type"><a href="qaudiorecorder.html">QAudioRecorder</a></span> <span class="operator">*</span>recorder <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qaudiorecorder.html">QAudioRecorder</a></span>();
<span class="type"><a href="qaudioprobe.html#QAudioProbe">QAudioProbe</a></span> <span class="operator">*</span>probe <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qaudioprobe.html#QAudioProbe">QAudioProbe</a></span>;
<span class="comment">// ... configure the audio recorder (skipped)</span>
connect(probe<span class="operator">,</span> SIGNAL(audioBufferProbed(<span class="type"><a href="qaudiobuffer.html">QAudioBuffer</a></span>))<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> SLOT(processBuffer(<span class="type"><a href="qaudiobuffer.html">QAudioBuffer</a></span>)));
probe<span class="operator">-</span><span class="operator">></span>setSource(recorder); <span class="comment">// Returns true, hopefully.</span>
recorder<span class="operator">-</span><span class="operator">></span>record(); <span class="comment">// Now we can do things like calculating levels or performing an FFT</span>
</pre>
</div>
<p><b>See also </b><a href="qvideoprobe.html">QVideoProbe</a>, <a href="qmediaplayer.html">QMediaPlayer</a>, and <a href="qcamera.html">QCamera</a>.</p>
<!-- @@@QAudioProbe -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAudioProbe[overload1]$$$QAudioProbeQObject* -->
<h3 class="fn" id="QAudioProbe"><a name="QAudioProbe"></a>QAudioProbe::<span class="name">QAudioProbe</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Creates a new <a href="qaudioprobe.html">QAudioProbe</a> class with a <i>parent</i>. After setting the source to monitor with <a href="qaudioprobe.html#setSource">setSource</a>(), the <a href="qaudioprobe.html#audioBufferProbed">audioBufferProbed</a>() signal will be emitted when audio buffers are flowing in the source media object.</p>
<!-- @@@QAudioProbe -->
<!-- $$$~QAudioProbe[overload1]$$$~QAudioProbe -->
<h3 class="fn" id="dtor.QAudioProbe"><a name="dtor.QAudioProbe"></a>QAudioProbe::<span class="name">~QAudioProbe</span>()</h3>
<p>Destroys this probe and disconnects from any media object.</p>
<!-- @@@~QAudioProbe -->
<!-- $$$audioBufferProbed[overload1]$$$audioBufferProbedconstQAudioBuffer& -->
<h3 class="fn" id="audioBufferProbed"><a name="audioBufferProbed"></a><code>[signal] </code><span class="type">void</span> QAudioProbe::<span class="name">audioBufferProbed</span>(const <span class="type"><a href="qaudiobuffer.html">QAudioBuffer</a></span> &<i>buffer</i>)</h3>
<p>This signal should be emitted when an audio <i>buffer</i> is processed in the media service.</p>
<!-- @@@audioBufferProbed -->
<!-- $$$flush[overload1]$$$flush -->
<h3 class="fn" id="flush"><a name="flush"></a><code>[signal] </code><span class="type">void</span> QAudioProbe::<span class="name">flush</span>()</h3>
<p>This signal should be emitted when it is required to release all buffers. Application must release all outstanding references to audio buffers.</p>
<!-- @@@flush -->
<!-- $$$isActive[overload1]$$$isActive -->
<h3 class="fn" id="isActive"><a name="isActive"></a><span class="type">bool</span> QAudioProbe::<span class="name">isActive</span>() const</h3>
<p>Returns true if this probe is monitoring something, or false otherwise.</p>
<p>The source being monitored does not need to be active.</p>
<!-- @@@isActive -->
<!-- $$$setSource[overload1]$$$setSourceQMediaObject* -->
<h3 class="fn" id="setSource"><a name="setSource"></a><span class="type">bool</span> QAudioProbe::<span class="name">setSource</span>(<span class="type"><a href="qmediaobject.html">QMediaObject</a></span> *<i>source</i>)</h3>
<p>Sets the media object to monitor to <i>source</i>.</p>
<p>If <i>source</i> is zero, this probe will be deactivated and this function wil return true.</p>
<p>If the media object does not support monitoring audio, this function will return false.</p>
<p>The previous object will no longer be monitored. Passing in the same object will be ignored, but monitoring will continue.</p>
<!-- @@@setSource -->
<!-- $$$setSource$$$setSourceQMediaRecorder* -->
<h3 class="fn" id="setSource-1"><a name="setSource-1"></a><span class="type">bool</span> QAudioProbe::<span class="name">setSource</span>(<span class="type"><a href="qmediarecorder.html">QMediaRecorder</a></span> *<i>mediaRecorder</i>)</h3>
<p>Starts monitoring the given <i>mediaRecorder</i>.</p>
<p>Returns true on success.</p>
<p>If there is no mediaObject associated with <i>mediaRecorder</i>, or if it is zero, this probe will be deactivated and this function wil return true.</p>
<p>If the media recorder instance does not support monitoring audio, this function will return false.</p>
<p>Any previously monitored objects will no longer be monitored. Passing in the same (valid) object will be ignored, but monitoring will continue.</p>
<!-- @@@setSource -->
</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>
|