<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qgraphicsvideoitem.cpp -->
<title>QGraphicsVideoItem 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 >QGraphicsVideoItem</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#reimplemented-public-functions">Reimplemented 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">QGraphicsVideoItem Class</h1>
<!-- $$$QGraphicsVideoItem-brief -->
<p>The <a href="qgraphicsvideoitem.html">QGraphicsVideoItem</a> class provides a graphics item which display video produced by a <a href="qmediaobject.html">QMediaObject</a>. <a href="#details">More...</a></p>
<!-- @@@QGraphicsVideoItem -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QGraphicsVideoItem></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimediawidgets</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediabindableinterface.html">QMediaBindableInterface</a> and </td></tr></table></div><ul>
<li><a href="qgraphicsvideoitem-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qgraphicsvideoitem.html#aspectRatioMode-prop">aspectRatioMode</a></b> : Qt::AspectRatioMode</li>
<li class="fn"><b><a href="qgraphicsvideoitem.html#mediaObject-prop">mediaObject</a></b> : QMediaObject * const</li>
<li class="fn"><b><a href="qgraphicsvideoitem.html#nativeSize-prop">nativeSize</a></b> : const QSizeF</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qgraphicsvideoitem.html#offset-prop">offset</a></b> : QPointF</li>
<li class="fn"><b><a href="qgraphicsvideoitem.html#size-prop">size</a></b> : QSizeF</li>
</ul>
</td></tr>
</table></div>
<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="qgraphicsvideoitem.html#QGraphicsVideoItem">QGraphicsVideoItem</a></b>(QGraphicsItem *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#dtor.QGraphicsVideoItem">~QGraphicsVideoItem</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::AspectRatioMode </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#aspectRatioMode-prop">aspectRatioMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#boundingRect">boundingRect</a></b>() const override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSizeF </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#nativeSize-prop">nativeSize</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPointF </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#offset-prop">offset</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#paint">paint</a></b>(QPainter *<i>painter</i>, const QStyleOptionGraphicsItem *<i>option</i>, QWidget *<i>widget</i> = Q_NULLPTR) override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#aspectRatioMode-prop">setAspectRatioMode</a></b>(Qt::AspectRatioMode <i>mode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#offset-prop">setOffset</a></b>(const QPointF &<i>offset</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#size-prop">setSize</a></b>(const QSizeF &<i>size</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSizeF </td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#size-prop">size</a></b>() const</td></tr>
</table></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QMediaObject *</td><td class="memItemRight bottomAlign"><b><a href="qgraphicsvideoitem.html#mediaObject-prop">mediaObject</a></b>() const override</td></tr>
</table></div>
<ul>
<li class="fn">1 public function inherited from <a href="qmediabindableinterface.html#public-functions">QMediaBindableInterface</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="qgraphicsvideoitem.html#nativeSizeChanged">nativeSizeChanged</a></b>(const QSizeF &<i>size</i>)</td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 protected function inherited from <a href="qmediabindableinterface.html#protected-functions">QMediaBindableInterface</a></li>
</ul>
<a name="details"></a>
<!-- $$$QGraphicsVideoItem-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qgraphicsvideoitem.html">QGraphicsVideoItem</a> class provides a graphics item which display video produced by a <a href="qmediaobject.html">QMediaObject</a>.</p>
<p>Attaching a <a href="qgraphicsvideoitem.html">QGraphicsVideoItem</a> to a <a href="qmediaobject.html">QMediaObject</a> allows it to display the video or image output of that media object. A <a href="qgraphicsvideoitem.html">QGraphicsVideoItem</a> is attached to a media object by passing a pointer to the <a href="qmediaobject.html">QMediaObject</a> to the <a href="qmediabindableinterface.html#setMediaObject">setMediaObject</a>() function.</p>
<pre class="cpp">
player <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qmediaplayer.html">QMediaPlayer</a></span>(<span class="keyword">this</span>);
<span class="type"><a href="qgraphicsvideoitem.html#QGraphicsVideoItem">QGraphicsVideoItem</a></span> <span class="operator">*</span>item <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qgraphicsvideoitem.html#QGraphicsVideoItem">QGraphicsVideoItem</a></span>;
player<span class="operator">-</span><span class="operator">></span>setVideoOutput(item);
graphicsView<span class="operator">-</span><span class="operator">></span>scene()<span class="operator">-</span><span class="operator">></span>addItem(item);
graphicsView<span class="operator">-</span><span class="operator">></span>show();
player<span class="operator">-</span><span class="operator">></span>setMedia(<span class="type">QUrl</span>(<span class="string">"http://example.com/myclip4.ogv"</span>));
player<span class="operator">-</span><span class="operator">></span>play();
</pre>
<p><b>Note</b>: Only a single display output can be attached to a media object at one time.</p>
</div>
<p><b>See also </b><a href="qmediaobject.html">QMediaObject</a>, <a href="qmediaplayer.html">QMediaPlayer</a>, and <a href="qvideowidget.html">QVideoWidget</a>.</p>
<!-- @@@QGraphicsVideoItem -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$aspectRatioMode-prop$$$aspectRatioMode$$$setAspectRatioModeQt::AspectRatioMode -->
<h3 class="fn" id="aspectRatioMode-prop"><a name="aspectRatioMode-prop"></a><span class="name">aspectRatioMode</span> : <span class="type">Qt::AspectRatioMode</span></h3>
<p>how a video is scaled to fit the graphics item's size.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt::AspectRatioMode </td><td class="memItemRight bottomAlign"><span class="name"><b>aspectRatioMode</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAspectRatioMode</b></span>(Qt::AspectRatioMode <i>mode</i>)</td></tr>
</table></div>
<!-- @@@aspectRatioMode -->
<!-- $$$mediaObject-prop$$$mediaObject -->
<h3 class="fn" id="mediaObject-prop"><a name="mediaObject-prop"></a><span class="name">mediaObject</span> : <span class="type"><a href="qmediaobject.html">QMediaObject</a></span> * const</h3>
<p>This property holds the media object which provides the video displayed by a graphics item.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> virtual QMediaObject *</td><td class="memItemRight bottomAlign"><span class="name"><b>mediaObject</b></span>() const override</td></tr>
</table></div>
<!-- @@@mediaObject -->
<!-- $$$nativeSize-prop$$$nativeSize$$$nativeSizeChangedconstQSizeF& -->
<h3 class="fn" id="nativeSize-prop"><a name="nativeSize-prop"></a><span class="name">nativeSize</span> : const <span class="type">QSizeF</span></h3>
<p>This property holds the native size of the video.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QSizeF </td><td class="memItemRight bottomAlign"><span class="name"><b>nativeSize</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="qgraphicsvideoitem.html#nativeSizeChanged">nativeSizeChanged</a></b></span>(const QSizeF &<i>size</i>)</td></tr>
</table></div>
<!-- @@@nativeSize -->
<!-- $$$offset-prop$$$offset$$$setOffsetconstQPointF& -->
<h3 class="fn" id="offset-prop"><a name="offset-prop"></a><span class="name">offset</span> : <span class="type">QPointF</span></h3>
<p>This property holds the video item's offset.</p>
<p><a href="qgraphicsvideoitem.html">QGraphicsVideoItem</a> will draw video using the offset for its top left corner.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QPointF </td><td class="memItemRight bottomAlign"><span class="name"><b>offset</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setOffset</b></span>(const QPointF &<i>offset</i>)</td></tr>
</table></div>
<!-- @@@offset -->
<!-- $$$size-prop$$$size$$$setSizeconstQSizeF& -->
<h3 class="fn" id="size-prop"><a name="size-prop"></a><span class="name">size</span> : <span class="type">QSizeF</span></h3>
<p>This property holds the video item's size.</p>
<p><a href="qgraphicsvideoitem.html">QGraphicsVideoItem</a> will draw video scaled to fit size according to its fillMode.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QSizeF </td><td class="memItemRight bottomAlign"><span class="name"><b>size</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSize</b></span>(const QSizeF &<i>size</i>)</td></tr>
</table></div>
<!-- @@@size -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGraphicsVideoItem[overload1]$$$QGraphicsVideoItemQGraphicsItem* -->
<h3 class="fn" id="QGraphicsVideoItem"><a name="QGraphicsVideoItem"></a>QGraphicsVideoItem::<span class="name">QGraphicsVideoItem</span>(<span class="type">QGraphicsItem</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a graphics item that displays video.</p>
<p>The <i>parent</i> is passed to QGraphicsItem.</p>
<!-- @@@QGraphicsVideoItem -->
<!-- $$$~QGraphicsVideoItem[overload1]$$$~QGraphicsVideoItem -->
<h3 class="fn" id="dtor.QGraphicsVideoItem"><a name="dtor.QGraphicsVideoItem"></a>QGraphicsVideoItem::<span class="name">~QGraphicsVideoItem</span>()</h3>
<p>Destroys a video graphics item.</p>
<!-- @@@~QGraphicsVideoItem -->
<!-- $$$boundingRect[overload1]$$$boundingRect -->
<h3 class="fn" id="boundingRect"><a name="boundingRect"></a><span class="type">QRectF</span> QGraphicsVideoItem::<span class="name">boundingRect</span>() const</h3>
<!-- @@@boundingRect -->
<!-- $$$nativeSizeChanged -->
<h3 class="fn" id="nativeSizeChanged"><a name="nativeSizeChanged"></a><code>[signal] </code><span class="type">void</span> QGraphicsVideoItem::<span class="name">nativeSizeChanged</span>(const <span class="type">QSizeF</span> &<i>size</i>)</h3>
<p>Signals that the native <i>size</i> of the video has changed.</p>
<p><b>Note:</b> Notifier signal for property <a href="qgraphicsvideoitem.html#nativeSize-prop">nativeSize</a>. </p><!-- @@@nativeSizeChanged -->
<!-- $$$paint[overload1]$$$paintQPainter*constQStyleOptionGraphicsItem*QWidget* -->
<h3 class="fn" id="paint"><a name="paint"></a><span class="type">void</span> QGraphicsVideoItem::<span class="name">paint</span>(<span class="type">QPainter</span> *<i>painter</i>, const <span class="type">QStyleOptionGraphicsItem</span> *<i>option</i>, <span class="type">QWidget</span> *<i>widget</i> = Q_NULLPTR)</h3>
<!-- @@@paint -->
</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>
