<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qvideoprobe.cpp -->
<title>QVideoProbe Class | Qt Multimedia 5.12.6</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.12</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-modules.html">C++ Classes</a></td><td >QVideoProbe</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtmultimedia-index.html">Qt 5.12.6 Reference Documentation</a></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="#static-public-members">Static Public Members</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">QVideoProbe Class</h1>
<!-- $$$QVideoProbe-brief -->
<p>The <a href="qvideoprobe.html">QVideoProbe</a> class allows you to monitor video frames being played or recorded. <a href="#details">More...</a></p>
<!-- @@@QVideoProbe -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QVideoProbe></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="qvideoprobe-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="qvideoprobe.html#QVideoProbe">QVideoProbe</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qvideoprobe.html#dtor.QVideoProbe">~QVideoProbe</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qvideoprobe.html#isActive">isActive</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qvideoprobe.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="qvideoprobe.html#setSource-1">setSource</a></b>(QMediaRecorder *<i>mediaRecorder</i>)</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="qvideoprobe.html#flush">flush</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideoprobe.html#videoFrameProbed">videoFrameProbed</a></b>(const QVideoFrame &<i>frame</i>)</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qvideoprobe.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QVideoProbe-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qvideoprobe.html">QVideoProbe</a> class allows you to monitor video frames being played or recorded.</p>
<pre class="cpp">
<span class="type"><a href="qmediaplayer.html">QMediaPlayer</a></span> <span class="operator">*</span>player <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qmediaplayer.html">QMediaPlayer</a></span>();
<span class="type"><a href="qvideoprobe.html#QVideoProbe">QVideoProbe</a></span> <span class="operator">*</span>probe <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qvideoprobe.html#QVideoProbe">QVideoProbe</a></span>;
connect(probe<span class="operator">,</span> SIGNAL(videoFrameProbed(<span class="type"><a href="qvideoframe.html">QVideoFrame</a></span>))<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> SLOT(processFrame(<span class="type"><a href="qvideoframe.html">QVideoFrame</a></span>)));
probe<span class="operator">-</span><span class="operator">></span>setSource(player); <span class="comment">// Returns true, hopefully.</span>
player<span class="operator">-</span><span class="operator">></span>setVideoOutput(myVideoSurface);
player<span class="operator">-</span><span class="operator">></span>setMedia(<span class="type">QUrl</span><span class="operator">::</span>fromLocalFile(<span class="string">"observation.mp4"</span>));
player<span class="operator">-</span><span class="operator">></span>play(); <span class="comment">// Start receiving frames as they get presented to myVideoSurface</span>
</pre>
<p>This same approach works with the <a href="qcamera.html">QCamera</a> object as well, to receive viewfinder or video frames as they are captured.</p>
</div>
<p><b>See also </b><a href="qaudioprobe.html">QAudioProbe</a>, <a href="qmediaplayer.html">QMediaPlayer</a>, and <a href="qcamera.html">QCamera</a>.</p>
<!-- @@@QVideoProbe -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QVideoProbe[overload1]$$$QVideoProbeQObject* -->
<h3 class="fn" id="QVideoProbe"><a name="QVideoProbe"></a>QVideoProbe::<span class="name">QVideoProbe</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Creates a new <a href="qvideoprobe.html">QVideoProbe</a> class with <i>parent</i>. After setting the source to monitor with <a href="qvideoprobe.html#setSource">setSource</a>(), the <a href="qvideoprobe.html#videoFrameProbed">videoFrameProbed</a>() signal will be emitted when video frames are flowing in the source media object.</p>
<!-- @@@QVideoProbe -->
<!-- $$$~QVideoProbe[overload1]$$$~QVideoProbe -->
<h3 class="fn" id="dtor.QVideoProbe"><a name="dtor.QVideoProbe"></a><code>[virtual] </code>QVideoProbe::<span class="name">~QVideoProbe</span>()</h3>
<p>Destroys this probe and disconnects from any media object.</p>
<!-- @@@~QVideoProbe -->
<!-- $$$flush[overload1]$$$flush -->
<h3 class="fn" id="flush"><a name="flush"></a><code>[signal] </code><span class="type">void</span> QVideoProbe::<span class="name">flush</span>()</h3>
<p>This signal should be emitted when it is required to release all frames. Application must release all outstanding references to video frames.</p>
<!-- @@@flush -->
<!-- $$$isActive[overload1]$$$isActive -->
<h3 class="fn" id="isActive"><a name="isActive"></a><span class="type">bool</span> QVideoProbe::<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> QVideoProbe::<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 video, this function will return false.</p>
<p>Any previously monitored objects 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> QVideoProbe::<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>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 video, this function will return false.</p>
<p>Any previously monitored objects will no longer be monitored. Passing in the same object will be ignored, but monitoring will continue.</p>
<!-- @@@setSource -->
<!-- $$$videoFrameProbed[overload1]$$$videoFrameProbedconstQVideoFrame& -->
<h3 class="fn" id="videoFrameProbed"><a name="videoFrameProbed"></a><code>[signal] </code><span class="type">void</span> QVideoProbe::<span class="name">videoFrameProbed</span>(const <span class="type"><a href="qvideoframe.html">QVideoFrame</a></span> &<i>frame</i>)</h3>
<p>This signal should be emitted when a video <i>frame</i> is processed in the media service.</p>
<!-- @@@videoFrameProbed -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 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>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-updates
>
by-pkgid
>
1680fb88efc4e76ac8cb0ebf3578014f
>
files
>
582
