/usr/share/qt5/doc/qtmultimedia/qabstractvideosurface.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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qabstractvideosurface.cpp -->
<title>QAbstractVideoSurface 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 >QAbstractVideoSurface</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-types">Public Types</a></li>
<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="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#implementing-a-subclass-of-qabstractvideosurface">Implementing a subclass of QAbstractVideoSurface</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QAbstractVideoSurface Class</h1>
<!-- $$$QAbstractVideoSurface-brief -->
<p>The <a href="qabstractvideosurface.html">QAbstractVideoSurface</a> class is a base class for video presentation surfaces. <a href="#details">More...</a></p>
<!-- @@@QAbstractVideoSurface -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAbstractVideoSurface></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="qabstractvideosurface-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#Error-enum">Error</a></b> { NoError, UnsupportedFormatError, IncorrectFormatError, StoppedError, ResourceError }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qabstractvideosurface.html#nativeResolution-prop">nativeResolution</a></b> : const QSize</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</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="qabstractvideosurface.html#QAbstractVideoSurface">QAbstractVideoSurface</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#dtor.QAbstractVideoSurface">~QAbstractVideoSurface</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Error </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#error">error</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#isActive">isActive</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#isFormatSupported">isFormatSupported</a></b>(const QVideoSurfaceFormat &<i>format</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#nativeResolution-prop">nativeResolution</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVideoSurfaceFormat </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#nearestFormat">nearestFormat</a></b>(const QVideoSurfaceFormat &<i>format</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#present">present</a></b>(const QVideoFrame &<i>frame</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#start">start</a></b>(const QVideoSurfaceFormat &<i>format</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#stop">stop</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList<QVideoFrame::PixelFormat> </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#supportedPixelFormats">supportedPixelFormats</a></b>(QAbstractVideoBuffer::HandleType <i>type</i> = QAbstractVideoBuffer::NoHandle) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVideoSurfaceFormat </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#surfaceFormat">surfaceFormat</a></b>() const</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="qabstractvideosurface.html#activeChanged">activeChanged</a></b>(bool <i>active</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#nativeResolutionChanged">nativeResolutionChanged</a></b>(const QSize &<i>resolution</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#supportedFormatsChanged">supportedFormatsChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#surfaceFormatChanged">surfaceFormatChanged</a></b>(const QVideoSurfaceFormat &<i>format</i>)</td></tr>
</table></div>
<ul>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#setError">setError</a></b>(Error <i>error</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractvideosurface.html#setNativeResolution">setNativeResolution</a></b>(const QSize &<i>resolution</i>)</td></tr>
</table></div>
<ul>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<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">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAbstractVideoSurface-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qabstractvideosurface.html">QAbstractVideoSurface</a> class is a base class for video presentation surfaces.</p>
<p>The <a href="qabstractvideosurface.html">QAbstractVideoSurface</a> class defines the standard interface that video producers use to inter-operate with video presentation surfaces. You can subclass this interface to receive video frames from sources like <a href="qmediaplayer.html">decoded media</a> or <a href="qcamera.html">cameras</a> to perform your own processing.</p>
<p>A video surface presents a continuous stream of identically formatted <a href="qvideoframe.html">QVideoFrame</a> instances, where the format of each frame is compatible with a stream format supplied when starting a presentation. Each frame may have timestamp information that can be used by the surface to decide when to display that frame.</p>
<p>A list of pixel formats a surface can present is given by the <a href="qabstractvideosurface.html#supportedPixelFormats">supportedPixelFormats</a>() function, and the <a href="qabstractvideosurface.html#isFormatSupported">isFormatSupported</a>() function will test if a video surface format is supported. If a format is not supported the <a href="qabstractvideosurface.html#nearestFormat">nearestFormat</a>() function may be able to suggest a similar format. For example, if a surface supports fixed set of resolutions it may suggest the smallest supported resolution that contains the proposed resolution.</p>
<p>The <a href="qabstractvideosurface.html#start">start</a>() function takes a supported format and enables a video surface. Once started a surface will begin displaying the frames it receives in the <a href="qabstractvideosurface.html#present">present</a>() function. Surfaces may hold a reference to the buffer of a presented video frame until a new frame is presented or streaming is stopped. In addition, a video surface may hold a reference to a video frame until the <a href="qvideoframe.html#endTime">end timestamp</a> has passed. The <a href="qabstractvideosurface.html#stop">stop</a>() function will disable a surface and release any video buffers it holds references to.</p>
<a name="implementing-a-subclass-of-qabstractvideosurface"></a>
<h4 >Implementing a subclass of QAbstractVideoSurface</h4>
<p>When implementing a subclass of this interface, there are only a handful of functions to implement, broken down into two classes:</p>
<ul>
<li>Format related</li>
<li>Presentation related</li>
</ul>
<p>For format related functionality, you just have to describe the pixel formats that you support (and the <a href="qabstractvideosurface.html#nearestFormat">nearestFormat</a>() function). For presentation related functionality, you have to implement the <a href="qabstractvideosurface.html#present">present</a>() function, and the <a href="qabstractvideosurface.html#start">start</a>() and <a href="qabstractvideosurface.html#stop">stop</a>() functions.</p>
<p><b>Note: </b>You must call the base class implementation of <a href="qabstractvideosurface.html#start">start</a>() and <a href="qabstractvideosurface.html#stop">stop</a>() in your implementation.</p></div>
<!-- @@@QAbstractVideoSurface -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Error$$$NoError$$$UnsupportedFormatError$$$IncorrectFormatError$$$StoppedError$$$ResourceError -->
<h3 class="fn" id="Error-enum"><a name="Error-enum"></a>enum QAbstractVideoSurface::<span class="name">Error</span></h3>
<p>This enum describes the errors that may be returned by the <a href="qabstractvideosurface.html#error">error</a>() function.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QAbstractVideoSurface::NoError</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">No error occurred.</td></tr>
<tr><td class="topAlign"><code>QAbstractVideoSurface::UnsupportedFormatError</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">A video format was not supported.</td></tr>
<tr><td class="topAlign"><code>QAbstractVideoSurface::IncorrectFormatError</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">A video frame was not compatible with the format of the surface.</td></tr>
<tr><td class="topAlign"><code>QAbstractVideoSurface::StoppedError</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The surface has not been started.</td></tr>
<tr><td class="topAlign"><code>QAbstractVideoSurface::ResourceError</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">The surface could not allocate some resource.</td></tr>
</table></div>
<!-- @@@Error -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$nativeResolution-prop$$$nativeResolution$$$nativeResolutionChangedconstQSize& -->
<h3 class="fn" id="nativeResolution-prop"><a name="nativeResolution-prop"></a><span class="name">nativeResolution</span> : const <span class="type"><a href="../qtcore/qsize.html">QSize</a></span></h3>
<p>The native resolution of video surface. This is the resolution of video frames the surface can render with optimal quality and/or performance.</p>
<p>The native resolution is not always known and can be changed during playback.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QSize </td><td class="memItemRight bottomAlign"><span class="name"><b>nativeResolution</b></span>() const</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="qabstractvideosurface.html#nativeResolutionChanged">nativeResolutionChanged</a></b></span>(const QSize &<i>resolution</i>)</td></tr>
</table></div>
<!-- @@@nativeResolution -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAbstractVideoSurface[overload1]$$$QAbstractVideoSurfaceQObject* -->
<h3 class="fn" id="QAbstractVideoSurface"><a name="QAbstractVideoSurface"></a>QAbstractVideoSurface::<span class="name">QAbstractVideoSurface</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a video surface with the given <i>parent</i>.</p>
<!-- @@@QAbstractVideoSurface -->
<!-- $$$~QAbstractVideoSurface[overload1]$$$~QAbstractVideoSurface -->
<h3 class="fn" id="dtor.QAbstractVideoSurface"><a name="dtor.QAbstractVideoSurface"></a>QAbstractVideoSurface::<span class="name">~QAbstractVideoSurface</span>()</h3>
<p>Destroys a video surface.</p>
<!-- @@@~QAbstractVideoSurface -->
<!-- $$$activeChanged[overload1]$$$activeChangedbool -->
<h3 class="fn" id="activeChanged"><a name="activeChanged"></a><code>[signal] </code><span class="type">void</span> QAbstractVideoSurface::<span class="name">activeChanged</span>(<span class="type">bool</span> <i>active</i>)</h3>
<p>Signals that the <i>active</i> state of a video surface has changed.</p>
<p><b>See also </b><a href="qabstractvideosurface.html#isActive">isActive</a>(), <a href="qabstractvideosurface.html#start">start</a>(), and <a href="qabstractvideosurface.html#stop">stop</a>().</p>
<!-- @@@activeChanged -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn" id="error"><a name="error"></a><span class="type"><a href="qabstractvideosurface.html#Error-enum">Error</a></span> QAbstractVideoSurface::<span class="name">error</span>() const</h3>
<p>Returns the last error that occurred.</p>
<p>If a surface fails to <a href="qabstractvideosurface.html#start">start</a>(), or stops unexpectedly this function can be called to discover what error occurred.</p>
<p><b>See also </b><a href="qabstractvideosurface.html#setError">setError</a>().</p>
<!-- @@@error -->
<!-- $$$isActive[overload1]$$$isActive -->
<h3 class="fn" id="isActive"><a name="isActive"></a><span class="type">bool</span> QAbstractVideoSurface::<span class="name">isActive</span>() const</h3>
<p>Indicates whether a video surface has been started.</p>
<p>Returns true if the surface has been started, and false otherwise.</p>
<!-- @@@isActive -->
<!-- $$$isFormatSupported[overload1]$$$isFormatSupportedconstQVideoSurfaceFormat& -->
<h3 class="fn" id="isFormatSupported"><a name="isFormatSupported"></a><code>[virtual] </code><span class="type">bool</span> QAbstractVideoSurface::<span class="name">isFormatSupported</span>(const <span class="type"><a href="qvideosurfaceformat.html">QVideoSurfaceFormat</a></span> &<i>format</i>) const</h3>
<p>Tests a video surface <i>format</i> to determine if a surface can accept it.</p>
<p>Returns true if the format is supported by the surface, and false otherwise.</p>
<!-- @@@isFormatSupported -->
<!-- $$$nativeResolutionChanged -->
<h3 class="fn" id="nativeResolutionChanged"><a name="nativeResolutionChanged"></a><code>[signal] </code><span class="type">void</span> QAbstractVideoSurface::<span class="name">nativeResolutionChanged</span>(const <span class="type"><a href="../qtcore/qsize.html">QSize</a></span> &<i>resolution</i>)</h3>
<p>Signals the native <i>resolution</i> of video surface has changed.</p>
<p><b>Note:</b> Notifier signal for property <a href="qabstractvideosurface.html#nativeResolution-prop">nativeResolution</a>. </p><!-- @@@nativeResolutionChanged -->
<!-- $$$nearestFormat[overload1]$$$nearestFormatconstQVideoSurfaceFormat& -->
<h3 class="fn" id="nearestFormat"><a name="nearestFormat"></a><code>[virtual] </code><span class="type"><a href="qvideosurfaceformat.html">QVideoSurfaceFormat</a></span> QAbstractVideoSurface::<span class="name">nearestFormat</span>(const <span class="type"><a href="qvideosurfaceformat.html">QVideoSurfaceFormat</a></span> &<i>format</i>) const</h3>
<p>Returns a supported video surface format that is similar to <i>format</i>.</p>
<p>A similar surface format is one that has the same <a href="qvideosurfaceformat.html#pixelFormat">pixel format</a> and <a href="qvideosurfaceformat.html#handleType">handle type</a> but may differ in some of the other properties. For example, if there are restrictions on the <a href="qvideosurfaceformat.html#frameSize">frame sizes</a> a video surface can accept it may suggest a format with a larger frame size and a <a href="qvideosurfaceformat.html#viewport">viewport</a> the size of the original frame size.</p>
<p>If the format is already supported it will be returned unchanged, or if there is no similar supported format an invalid format will be returned.</p>
<!-- @@@nearestFormat -->
<!-- $$$present[overload1]$$$presentconstQVideoFrame& -->
<h3 class="fn" id="present"><a name="present"></a><code>[pure virtual] </code><span class="type">bool</span> QAbstractVideoSurface::<span class="name">present</span>(const <span class="type"><a href="qvideoframe.html">QVideoFrame</a></span> &<i>frame</i>)</h3>
<p>Presents a video <i>frame</i>.</p>
<p>Returns true if the frame was presented, and false if an error occurred.</p>
<p>Not all surfaces will block until the presentation of a frame has completed. Calling present() on a non-blocking surface may fail if called before the presentation of a previous frame has completed. In such cases the surface may not return to a ready state until it has had an opportunity to process events.</p>
<p>If present() fails for any other reason the surface should immediately enter the stopped state and an <a href="qabstractvideosurface.html#error">error</a>() value will be set.</p>
<p>A video surface must be in the started state for present() to succeed, and the format of the video frame must be compatible with the current video surface format.</p>
<p><b>See also </b><a href="qabstractvideosurface.html#error">error</a>().</p>
<!-- @@@present -->
<!-- $$$setError[overload1]$$$setErrorError -->
<h3 class="fn" id="setError"><a name="setError"></a><code>[protected] </code><span class="type">void</span> QAbstractVideoSurface::<span class="name">setError</span>(<span class="type"><a href="qabstractvideosurface.html#Error-enum">Error</a></span> <i>error</i>)</h3>
<p>Sets the value of <a href="qabstractvideosurface.html#error">error</a>() to <i>error</i>.</p>
<p>This can be called by implementors of this interface to communicate what the most recent error was.</p>
<p><b>See also </b><a href="qabstractvideosurface.html#error">error</a>().</p>
<!-- @@@setError -->
<!-- $$$setNativeResolution[overload1]$$$setNativeResolutionconstQSize& -->
<h3 class="fn" id="setNativeResolution"><a name="setNativeResolution"></a><code>[protected] </code><span class="type">void</span> QAbstractVideoSurface::<span class="name">setNativeResolution</span>(const <span class="type"><a href="../qtcore/qsize.html">QSize</a></span> &<i>resolution</i>)</h3>
<p>Set the video surface native <i>resolution</i>.</p>
<p>This function can be called by implementors of this interface to specify to frame producers what the native resolution of this surface is.</p>
<p><b>See also </b><a href="qabstractvideosurface.html#nativeResolution-prop">nativeResolution</a>().</p>
<!-- @@@setNativeResolution -->
<!-- $$$start[overload1]$$$startconstQVideoSurfaceFormat& -->
<h3 class="fn" id="start"><a name="start"></a><code>[virtual] </code><span class="type">bool</span> QAbstractVideoSurface::<span class="name">start</span>(const <span class="type"><a href="qvideosurfaceformat.html">QVideoSurfaceFormat</a></span> &<i>format</i>)</h3>
<p>Starts a video surface presenting <i>format</i> frames.</p>
<p>Returns true if the surface was started, and false if an error occurred.</p>
<p><b>Note: </b>You must call the base class implementation of start() at the end of your implementation.</p><p><b>See also </b><a href="qabstractvideosurface.html#isActive">isActive</a>() and <a href="qabstractvideosurface.html#stop">stop</a>().</p>
<!-- @@@start -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn" id="stop"><a name="stop"></a><code>[virtual] </code><span class="type">void</span> QAbstractVideoSurface::<span class="name">stop</span>()</h3>
<p>Stops a video surface presenting frames and releases any resources acquired in <a href="qabstractvideosurface.html#start">start</a>().</p>
<p><b>Note: </b>You must call the base class implementation of stop() at the start of your implementation.</p><p><b>See also </b><a href="qabstractvideosurface.html#isActive">isActive</a>() and <a href="qabstractvideosurface.html#start">start</a>().</p>
<!-- @@@stop -->
<!-- $$$supportedFormatsChanged[overload1]$$$supportedFormatsChanged -->
<h3 class="fn" id="supportedFormatsChanged"><a name="supportedFormatsChanged"></a><code>[signal] </code><span class="type">void</span> QAbstractVideoSurface::<span class="name">supportedFormatsChanged</span>()</h3>
<p>Signals that the set of formats supported by a video surface has changed.</p>
<p><b>See also </b><a href="qabstractvideosurface.html#supportedPixelFormats">supportedPixelFormats</a>() and <a href="qabstractvideosurface.html#isFormatSupported">isFormatSupported</a>().</p>
<!-- @@@supportedFormatsChanged -->
<!-- $$$supportedPixelFormats[overload1]$$$supportedPixelFormatsQAbstractVideoBuffer::HandleType -->
<h3 class="fn" id="supportedPixelFormats"><a name="supportedPixelFormats"></a><code>[pure virtual] </code><span class="type"><a href="../qtcore/qlist.html">QList</a></span><<span class="type"><a href="qvideoframe.html#PixelFormat-enum">QVideoFrame::PixelFormat</a></span>> QAbstractVideoSurface::<span class="name">supportedPixelFormats</span>(<span class="type"><a href="qabstractvideobuffer.html#HandleType-enum">QAbstractVideoBuffer::HandleType</a></span> <i>type</i> = QAbstractVideoBuffer::NoHandle) const</h3>
<p>Returns a list of pixel formats a video surface can present for a given handle <i>type</i>.</p>
<p>The pixel formats returned for the <a href="qabstractvideobuffer.html#HandleType-enum">QAbstractVideoBuffer::NoHandle</a> type are valid for any buffer that can be mapped in read-only mode.</p>
<p>Types that are first in the list can be assumed to be faster to render.</p>
<!-- @@@supportedPixelFormats -->
<!-- $$$surfaceFormat[overload1]$$$surfaceFormat -->
<h3 class="fn" id="surfaceFormat"><a name="surfaceFormat"></a><span class="type"><a href="qvideosurfaceformat.html">QVideoSurfaceFormat</a></span> QAbstractVideoSurface::<span class="name">surfaceFormat</span>() const</h3>
<p>Returns the format of a video surface.</p>
<!-- @@@surfaceFormat -->
<!-- $$$surfaceFormatChanged[overload1]$$$surfaceFormatChangedconstQVideoSurfaceFormat& -->
<h3 class="fn" id="surfaceFormatChanged"><a name="surfaceFormatChanged"></a><code>[signal] </code><span class="type">void</span> QAbstractVideoSurface::<span class="name">surfaceFormatChanged</span>(const <span class="type"><a href="qvideosurfaceformat.html">QVideoSurfaceFormat</a></span> &<i>format</i>)</h3>
<p>Signals that the configured <i>format</i> of a video surface has changed.</p>
<p><b>See also </b><a href="qabstractvideosurface.html#surfaceFormat">surfaceFormat</a>() and <a href="qabstractvideosurface.html#start">start</a>().</p>
<!-- @@@surfaceFormatChanged -->
</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>
|