/usr/share/qt5/doc/qtmultimedia/qaudioprobe.html is in qtmultimedia5-doc-html 5.2.1-0ubuntu5.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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" />
<!-- qaudioprobe.cpp -->
<title>QAudioProbe Class | QtMultimedia 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtmultimedia-index.html">Qt Multimedia</a></li>
<li><a href="qtmultimedia-module.html">C++ Classes</a></li>
<li>QAudioProbe</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<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="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QAudioProbe Class</h1>
<!-- $$$QAudioProbe-brief -->
<p>The QAudioProbe class allows you to monitor audio being played or recorded. <a href="#details">More...</a></p>
<!-- @@@QAudioProbe -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QAudioProbe></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimedia</tt></td></tr></table><ul>
<li><a href="qaudioprobe-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="qaudioprobe.html#QAudioProbe">QAudioProbe</a></b>(QObject *<i> parent</i> = 0)</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-2">setSource</a></b>(QMediaRecorder *<i> mediaRecorder</i>)</td></tr>
</table>
<a name="signals"></a>
<h2>Signals</h2>
<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>
<a name="details"></a>
<!-- $$$QAudioProbe-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAudioProbe 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">QAudioProbe</span> <span class="operator">*</span>probe <span class="operator">=</span> <span class="keyword">new</span> <span class="type">QAudioProbe</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><a href="qaudioprobe.html#setSource">setSource</a>(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"><a name="QAudioProbe"></a>QAudioProbe::<span class="name">QAudioProbe</span>(<span class="type">QObject</span> *<i> parent</i> = 0)</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"><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"><a name="audioBufferProbed"></a><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>)<tt> [signal]</tt></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"><a name="flush"></a><span class="type">void</span> QAudioProbe::<span class="name">flush</span>()<tt> [signal]</tt></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"><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"><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"><a name="setSource-2"></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> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|