/usr/share/qt5/doc/qtmultimedia/qml-qtmultimedia-videooutput.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 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 | <?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" />
<!-- qdeclarativevideooutput.cpp -->
<title>VideoOutput | 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-qmlmodule.html">QML Types</a></li>
<li>VideoOutput</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="#properties">Properties</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#screen-saver">Screen Saver</a></li>
</ul>
</div>
<h1 class="title">VideoOutput</h1>
<span class="subtitle"></span>
<!-- $$$VideoOutput-brief -->
<p>Render video or camera viewfinder. <a href="#details">More...</a></p>
<!-- @@@VideoOutput -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> </b><tt>import QtMultimedia 5.0</tt></td></tr></table><ul>
<li><a href="qml-qtmultimedia-videooutput-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtmultimedia-videooutput.html#autoOrientation-prop">autoOrientation</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-videooutput.html#contentRect-prop">contentRect</a></b></b> : rectangle</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-videooutput.html#fillMode-prop">fillMode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-videooutput.html#orientation-prop">orientation</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-videooutput.html#source-prop">source</a></b></b> : variant</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-videooutput.html#sourceRect-prop">sourceRect</a></b></b> : rectangle</li>
</ul>
<a name="methods"></a>
<h2>Methods</h2>
<ul>
<li class="fn">QPointF <b><b><a href="qml-qtmultimedia-videooutput.html#mapNormalizedPointToItem-method">mapNormalizedPointToItem</a></b></b>(const QPointF & <i>point</i>)</li>
<li class="fn">QRectF <b><b><a href="qml-qtmultimedia-videooutput.html#mapNormalizedRectToItem-method">mapNormalizedRectToItem</a></b></b>(const QRectF & <i>rectangle</i>)</li>
<li class="fn">QPointF <b><b><a href="qml-qtmultimedia-videooutput.html#mapPointToItem-method">mapPointToItem</a></b></b>(const QPointF & <i>point</i>)</li>
<li class="fn">QPointF <b><b><a href="qml-qtmultimedia-videooutput.html#mapPointToSource-method">mapPointToSource</a></b></b>(const QPointF & <i>point</i>)</li>
<li class="fn">QPointF <b><b><a href="qml-qtmultimedia-videooutput.html#mapPointToSourceNormalized-method">mapPointToSourceNormalized</a></b></b>(const QPointF & <i>point</i>)</li>
<li class="fn">QRectF <b><b><a href="qml-qtmultimedia-videooutput.html#mapRectToItem-method">mapRectToItem</a></b></b>(const QRectF & <i>rectangle</i>)</li>
<li class="fn">QRectF <b><b><a href="qml-qtmultimedia-videooutput.html#mapRectToSource-method">mapRectToSource</a></b></b>(const QRectF & <i>rectangle</i>)</li>
<li class="fn">QRectF <b><b><a href="qml-qtmultimedia-videooutput.html#mapRectToSourceNormalized-method">mapRectToSourceNormalized</a></b></b>(const QRectF & <i>rectangle</i>)</li>
</ul>
<!-- $$$VideoOutput-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p><tt>VideoOutput</tt> is part of the <b><a href="qtmultimedia-module.html">QtMultimedia</a> 5.0</b> module.</p>
<pre class="qml">import QtQuick 2.0
import QtMultimedia 5.0
<span class="type">Rectangle</span> {
<span class="name">width</span>: <span class="number">800</span>
<span class="name">height</span>: <span class="number">600</span>
<span class="name">color</span>: <span class="string">"black"</span>
<span class="type"><a href="qml-qtmultimedia-mediaplayer.html">MediaPlayer</a></span> {
<span class="name">id</span>: <span class="name">player</span>
<span class="name">source</span>: <span class="string">"file://video.webm"</span>
<span class="name">autoPlay</span>: <span class="number">true</span>
}
<span class="type">VideoOutput</span> {
<span class="name">id</span>: <span class="name">videoOutput</span>
<span class="name">source</span>: <span class="name">player</span>
<span class="name">anchors</span>.fill: <span class="name">parent</span>
}
}</pre>
<p>The VideoOutput item supports untransformed, stretched, and uniformly scaled video presentation. For a description of stretched uniformly scaled presentation, see the <a href="qml-qtmultimedia-videooutput.html#fillMode-prop">fillMode</a> property description.</p>
<p>The VideoOutput item works with backends that support either <a href="qvideorenderercontrol.html">QVideoRendererControl</a> or <a href="qvideowindowcontrol.html">QVideoWindowControl</a>. If the backend only supports <a href="qvideowindowcontrol.html">QVideoWindowControl</a>, the video is rendered onto an overlay window that is layered on top of the QtQuick window. Due to the nature of the video overlays, certain features are not available for these kind of backends:</p>
<ul>
<li>Some transformations like rotations</li>
<li>Having other QtQuick items on top of the VideoOutput item</li>
</ul>
<p>Most backends however do support <a href="qvideorenderercontrol.html">QVideoRendererControl</a> and therefore don't have the limitations listed above.</p>
<a name="screen-saver"></a>
<h2>Screen Saver</h2>
<p>If it is likely that an application will be playing video for an extended period of time without user interaction it may be necessary to disable the platform's screen saver. The ScreenSaver (from QtSystemInfo) may be used to disable the screensaver in this fashion:</p>
<pre class="qml">import QtSystemInfo 5.0
<span class="type">ScreenSaver</span> { <span class="name">screenSaverEnabled</span>: <span class="number">false</span> }</pre>
<p><b>See also </b><a href="qml-qtmultimedia-mediaplayer.html">MediaPlayer</a> and <a href="qml-qtmultimedia-camera.html">Camera</a>.</p>
<!-- @@@VideoOutput -->
<h2>Property Documentation</h2>
<!-- $$$autoOrientation -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="autoOrientation-prop"></a><span class="name">autoOrientation</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>This property allows you to enable and disable auto orientation of the video stream, so that its orientation always matches the orientation of the screen. If <tt>autoOrientation</tt> is enabled, the <tt>orientation</tt> property is overwritten.</p>
<p>By default <tt>autoOrientation</tt> is disabled.</p>
<p>This QML property was introduced in QtMultimedia 5.2.</p>
</div></div><!-- @@@autoOrientation -->
<br/>
<!-- $$$contentRect -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="contentRect-prop"></a><span class="name">contentRect</span> : <span class="type">rectangle</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the item coordinates of the area that would contain video to render. With certain fill modes, this rectangle will be larger than the visible area of the <tt>VideoOutput</tt>.</p>
<p>This property is useful when other coordinates are specified in terms of the source dimensions - this applied for relative (normalized) frame coordinates in the range of 0 to 1.0.</p>
<p>Areas outside this will be transparent.</p>
<p><b>See also </b><a href="qml-qtmultimedia-videooutput.html#mapRectToItem-method">mapRectToItem()</a> and <a href="qml-qtmultimedia-videooutput.html#mapPointToItem-method">mapPointToItem()</a>.</p>
</div></div><!-- @@@contentRect -->
<br/>
<!-- $$$fillMode -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="fillMode-prop"></a><span class="name">fillMode</span> : <span class="type">enumeration</span></p></td></tr></table></div><div class="qmldoc"><p>Set this property to define how the video is scaled to fit the target area.</p>
<ul>
<li>Stretch - the video is scaled to fit.</li>
<li>PreserveAspectFit - the video is scaled uniformly to fit without cropping</li>
<li>PreserveAspectCrop - the video is scaled uniformly to fill, cropping if necessary</li>
</ul>
<p>The default fill mode is PreserveAspectFit.</p>
</div></div><!-- @@@fillMode -->
<br/>
<!-- $$$orientation -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="orientation-prop"></a><span class="name">orientation</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>In some cases the source video stream requires a certain orientation to be correct. This includes sources like a camera viewfinder, where the displayed viewfinder should match reality, no matter what rotation the rest of the user interface has.</p>
<p>This property allows you to apply a rotation (in steps of 90 degrees) to compensate for any user interface rotation, with positive values in the anti-clockwise direction.</p>
<p>The orientation change will also affect the mapping of coordinates from source to viewport.</p>
</div></div><!-- @@@orientation -->
<br/>
<!-- $$$source -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="source-prop"></a><span class="name">source</span> : <span class="type">variant</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the source item providing the video frames like <a href="qml-qtmultimedia-mediaplayer.html">MediaPlayer</a> or Camera.</p>
<p>If you are extending your own C++ classes to interoperate with <a href="qml-qtmultimedia-videooutput.html">VideoOutput</a>, you can either provide a QObject based class with a <tt>mediaObject</tt> property that exposes a <a href="qmediaobject.html">QMediaObject</a> derived class that has a <a href="qvideorenderercontrol.html">QVideoRendererControl</a> available, or you can provide a QObject based class with a writable <tt>videoSurface</tt> property that can accept a <a href="qabstractvideosurface.html">QAbstractVideoSurface</a> based class and can follow the correct protocol to deliver QVideoFrames to it.</p>
</div></div><!-- @@@source -->
<br/>
<!-- $$$sourceRect -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="sourceRect-prop"></a><span class="name">sourceRect</span> : <span class="type">rectangle</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the area of the source video content that is considered for rendering. The values are in source pixel coordinates, adjusted for the source's pixel aspect ratio.</p>
<p>Note that typically the top left corner of this rectangle will be <tt>0,0</tt> while the width and height will be the width and height of the input content. Only when the video source has a viewport set, these values will differ.</p>
<p>The orientation setting does not affect this rectangle.</p>
<p><b>See also </b><a href="qvideosurfaceformat.html#pixelAspectRatio">QVideoSurfaceFormat::pixelAspectRatio()</a> and <a href="qvideosurfaceformat.html#viewport">QVideoSurfaceFormat::viewport()</a>.</p>
</div></div><!-- @@@sourceRect -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$mapNormalizedPointToItem -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="mapNormalizedPointToItem-method"></a><span class="type">QPointF</span> <span class="name">mapNormalizedPointToItem</span>(const <span class="type">QPointF</span> &<i> point</i>) const</p></td></tr></table></div><div class="qmldoc"><p>Given normalized coordinates <i>point</i> (that is, each component in the range of 0 to 1.0), return the mapped point that it corresponds to (in item coordinates). This mapping is affected by the orientation.</p>
<p>Depending on the fill mode, this point may lie outside the rendered rectangle.</p>
</div></div><!-- @@@mapNormalizedPointToItem -->
<br/>
<!-- $$$mapNormalizedRectToItem -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="mapNormalizedRectToItem-method"></a><span class="type">QRectF</span> <span class="name">mapNormalizedRectToItem</span>(const <span class="type">QRectF</span> &<i> rectangle</i>) const</p></td></tr></table></div><div class="qmldoc"><p>Given a rectangle <i>rectangle</i> in normalized coordinates (that is, each component in the range of 0 to 1.0), return the mapped rectangle that it corresponds to (in item coordinates). This mapping is affected by the orientation.</p>
<p>Depending on the fill mode, this rectangle may extend outside the rendered rectangle.</p>
</div></div><!-- @@@mapNormalizedRectToItem -->
<br/>
<!-- $$$mapPointToItem -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="mapPointToItem-method"></a><span class="type">QPointF</span> <span class="name">mapPointToItem</span>(const <span class="type">QPointF</span> &<i> point</i>) const</p></td></tr></table></div><div class="qmldoc"><p>Given a point <i>point</i> in source coordinates, return the corresponding point in item coordinates. This mapping is affected by the orientation.</p>
<p>Depending on the fill mode, this point may lie outside the rendered rectangle.</p>
</div></div><!-- @@@mapPointToItem -->
<br/>
<!-- $$$mapPointToSource -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="mapPointToSource-method"></a><span class="type">QPointF</span> <span class="name">mapPointToSource</span>(const <span class="type">QPointF</span> &<i> point</i>) const</p></td></tr></table></div><div class="qmldoc"><p>Given a point <i>point</i> in item coordinates, return the corresponding point in source coordinates. This mapping is affected by the orientation.</p>
<p>If the supplied point lies outside the rendered area, the returned point will be outside the source rectangle.</p>
</div></div><!-- @@@mapPointToSource -->
<br/>
<!-- $$$mapPointToSourceNormalized -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="mapPointToSourceNormalized-method"></a><span class="type">QPointF</span> <span class="name">mapPointToSourceNormalized</span>(const <span class="type">QPointF</span> &<i> point</i>) const</p></td></tr></table></div><div class="qmldoc"><p>Given a point <i>point</i> in item coordinates, return the corresponding point in normalized source coordinates. This mapping is affected by the orientation.</p>
<p>If the supplied point lies outside the rendered area, the returned point will be outside the source rectangle. No clamping is performed.</p>
</div></div><!-- @@@mapPointToSourceNormalized -->
<br/>
<!-- $$$mapRectToItem -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="mapRectToItem-method"></a><span class="type">QRectF</span> <span class="name">mapRectToItem</span>(const <span class="type">QRectF</span> &<i> rectangle</i>) const</p></td></tr></table></div><div class="qmldoc"><p>Given a rectangle <i>rectangle</i> in source coordinates, return the corresponding rectangle in item coordinates. This mapping is affected by the orientation.</p>
<p>Depending on the fill mode, this rectangle may extend outside the rendered rectangle.</p>
</div></div><!-- @@@mapRectToItem -->
<br/>
<!-- $$$mapRectToSource -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="mapRectToSource-method"></a><span class="type">QRectF</span> <span class="name">mapRectToSource</span>(const <span class="type">QRectF</span> &<i> rectangle</i>) const</p></td></tr></table></div><div class="qmldoc"><p>Given a rectangle <i>rectangle</i> in item coordinates, return the corresponding rectangle in source coordinates. This mapping is affected by the orientation.</p>
<p>This mapping is affected by the orientation.</p>
<p>If the supplied point lies outside the rendered area, the returned point will be outside the source rectangle.</p>
</div></div><!-- @@@mapRectToSource -->
<br/>
<!-- $$$mapRectToSourceNormalized -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="mapRectToSourceNormalized-method"></a><span class="type">QRectF</span> <span class="name">mapRectToSourceNormalized</span>(const <span class="type">QRectF</span> &<i> rectangle</i>) const</p></td></tr></table></div><div class="qmldoc"><p>Given a rectangle <i>rectangle</i> in item coordinates, return the corresponding rectangle in normalized source coordinates. This mapping is affected by the orientation.</p>
<p>This mapping is affected by the orientation.</p>
<p>If the supplied point lies outside the rendered area, the returned point will be outside the source rectangle. No clamping is performed.</p>
</div></div><!-- @@@mapRectToSourceNormalized -->
<br/>
</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>
|