<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qvideowidgetcontrol.cpp -->
<title>QVideoWidgetControl 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 >QVideoWidgetControl</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="#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="#macros">Macros</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">QVideoWidgetControl Class</h1>
<!-- $$$QVideoWidgetControl-brief -->
<p>The <a href="qvideowidgetcontrol.html">QVideoWidgetControl</a> class provides a media control which implements a video widget. <a href="#details">More...</a></p>
<!-- @@@QVideoWidgetControl -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QVideoWidgetControl></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="qmediacontrol.html">QMediaControl</a></td></tr></table></div><ul>
<li><a href="qvideowidgetcontrol-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"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#dtor.QVideoWidgetControl">~QVideoWidgetControl</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual Qt::AspectRatioMode </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#aspectRatioMode">aspectRatioMode</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#brightness">brightness</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#contrast">contrast</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#hue">hue</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#isFullScreen">isFullScreen</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#saturation">saturation</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#setAspectRatioMode">setAspectRatioMode</a></b>(Qt::AspectRatioMode <i>mode</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#setBrightness">setBrightness</a></b>(int <i>brightness</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#setContrast">setContrast</a></b>(int <i>contrast</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#setFullScreen">setFullScreen</a></b>(bool <i>fullScreen</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#setHue">setHue</a></b>(int <i>hue</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#setSaturation">setSaturation</a></b>(int <i>saturation</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QWidget *</td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#videoWidget">videoWidget</a></b>() = 0</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="qvideowidgetcontrol.html#brightnessChanged">brightnessChanged</a></b>(int <i>brightness</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#contrastChanged">contrastChanged</a></b>(int <i>contrast</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#fullScreenChanged">fullScreenChanged</a></b>(bool <i>fullScreen</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#hueChanged">hueChanged</a></b>(int <i>hue</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#saturationChanged">saturationChanged</a></b>(int <i>saturation</i>)</td></tr>
</table></div>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#QVideoWidgetControl">QVideoWidgetControl</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
</table></div>
<a name="macros"></a>
<h2 id="macros">Macros</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qvideowidgetcontrol.html#QVideoWidgetControl_iid">QVideoWidgetControl_iid</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QVideoWidgetControl-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qvideowidgetcontrol.html">QVideoWidgetControl</a> class provides a media control which implements a video widget.</p>
<p>The <a href="qvideowidgetcontrol.html#videoWidget">videoWidget</a>() property of <a href="qvideowidgetcontrol.html">QVideoWidgetControl</a> provides a pointer to a video widget implemented by the control's media service. This widget is owned by the media service and so care should be taken not to delete it.</p>
<pre class="cpp">
<span class="type"><a href="qvideowidgetcontrol.html#QVideoWidgetControl">QVideoWidgetControl</a></span> <span class="operator">*</span>widgetControl <span class="operator">=</span> mediaService<span class="operator">-</span><span class="operator">></span>requestControl<span class="operator"><</span><span class="type"><a href="qvideowidgetcontrol.html#QVideoWidgetControl">QVideoWidgetControl</a></span> <span class="operator">*</span><span class="operator">></span>();
layout<span class="operator">-</span><span class="operator">></span>addWidget(widgetControl<span class="operator">-</span><span class="operator">></span>videoWidget());
</pre>
<p><a href="qvideowidgetcontrol.html">QVideoWidgetControl</a> is one of number of possible video output controls.</p>
<p>The interface name of <a href="qvideowidgetcontrol.html">QVideoWidgetControl</a> is <code>org.qt-project.qt.videowidgetcontrol/5.0</code> as defined in <a href="qvideowidgetcontrol.html#QVideoWidgetControl_iid">QVideoWidgetControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>() and <a href="qvideowidget.html">QVideoWidget</a>.</p>
<!-- @@@QVideoWidgetControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QVideoWidgetControl[overload1]$$$QVideoWidgetControlQObject* -->
<h3 class="fn" id="QVideoWidgetControl"><a name="QVideoWidgetControl"></a><code>[protected] </code>QVideoWidgetControl::<span class="name">QVideoWidgetControl</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a new video widget control with the given <i>parent</i>.</p>
<!-- @@@QVideoWidgetControl -->
<!-- $$$~QVideoWidgetControl[overload1]$$$~QVideoWidgetControl -->
<h3 class="fn" id="dtor.QVideoWidgetControl"><a name="dtor.QVideoWidgetControl"></a><code>[virtual] </code>QVideoWidgetControl::<span class="name">~QVideoWidgetControl</span>()</h3>
<p>Destroys a video widget control.</p>
<!-- @@@~QVideoWidgetControl -->
<!-- $$$aspectRatioMode[overload1]$$$aspectRatioMode -->
<h3 class="fn" id="aspectRatioMode"><a name="aspectRatioMode"></a><code>[pure virtual] </code><span class="type">Qt::AspectRatioMode</span> QVideoWidgetControl::<span class="name">aspectRatioMode</span>() const</h3>
<p>Returns how video is scaled to fit the widget with respect to its aspect ratio.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#setAspectRatioMode">setAspectRatioMode</a>().</p>
<!-- @@@aspectRatioMode -->
<!-- $$$brightness[overload1]$$$brightness -->
<h3 class="fn" id="brightness"><a name="brightness"></a><code>[pure virtual] </code><span class="type">int</span> QVideoWidgetControl::<span class="name">brightness</span>() const</h3>
<p>Returns the brightness adjustment applied to a video.</p>
<p>Valid brightness values range between -100 and 100, the default is 0.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#setBrightness">setBrightness</a>().</p>
<!-- @@@brightness -->
<!-- $$$brightnessChanged[overload1]$$$brightnessChangedint -->
<h3 class="fn" id="brightnessChanged"><a name="brightnessChanged"></a><code>[signal] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">brightnessChanged</span>(<span class="type">int</span> <i>brightness</i>)</h3>
<p>Signals that a video widget's <i>brightness</i> adjustment has changed.</p>
<!-- @@@brightnessChanged -->
<!-- $$$contrast[overload1]$$$contrast -->
<h3 class="fn" id="contrast"><a name="contrast"></a><code>[pure virtual] </code><span class="type">int</span> QVideoWidgetControl::<span class="name">contrast</span>() const</h3>
<p>Returns the contrast adjustment applied to a video.</p>
<p>Valid contrast values range between -100 and 100, the default is 0.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#setContrast">setContrast</a>().</p>
<!-- @@@contrast -->
<!-- $$$contrastChanged[overload1]$$$contrastChangedint -->
<h3 class="fn" id="contrastChanged"><a name="contrastChanged"></a><code>[signal] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">contrastChanged</span>(<span class="type">int</span> <i>contrast</i>)</h3>
<p>Signals that a video widget's <i>contrast</i> adjustment has changed.</p>
<!-- @@@contrastChanged -->
<!-- $$$fullScreenChanged[overload1]$$$fullScreenChangedbool -->
<h3 class="fn" id="fullScreenChanged"><a name="fullScreenChanged"></a><code>[signal] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">fullScreenChanged</span>(<span class="type">bool</span> <i>fullScreen</i>)</h3>
<p>Signals that the <i>fullScreen</i> state of a video widget has changed.</p>
<!-- @@@fullScreenChanged -->
<!-- $$$hue[overload1]$$$hue -->
<h3 class="fn" id="hue"><a name="hue"></a><code>[pure virtual] </code><span class="type">int</span> QVideoWidgetControl::<span class="name">hue</span>() const</h3>
<p>Returns the hue adjustment applied to a video widget.</p>
<p>Value hue values range between -100 and 100, the default is 0.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#setHue">setHue</a>().</p>
<!-- @@@hue -->
<!-- $$$hueChanged[overload1]$$$hueChangedint -->
<h3 class="fn" id="hueChanged"><a name="hueChanged"></a><code>[signal] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">hueChanged</span>(<span class="type">int</span> <i>hue</i>)</h3>
<p>Signals that a video widget's <i>hue</i> adjustment has changed.</p>
<!-- @@@hueChanged -->
<!-- $$$isFullScreen[overload1]$$$isFullScreen -->
<h3 class="fn" id="isFullScreen"><a name="isFullScreen"></a><code>[pure virtual] </code><span class="type">bool</span> QVideoWidgetControl::<span class="name">isFullScreen</span>() const</h3>
<p>Returns true if the video is shown using the complete screen.</p>
<!-- @@@isFullScreen -->
<!-- $$$saturation[overload1]$$$saturation -->
<h3 class="fn" id="saturation"><a name="saturation"></a><code>[pure virtual] </code><span class="type">int</span> QVideoWidgetControl::<span class="name">saturation</span>() const</h3>
<p>Returns the saturation adjustment applied to a video widget.</p>
<p>Value saturation values range between -100 and 100, the default is 0.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#setSaturation">setSaturation</a>().</p>
<!-- @@@saturation -->
<!-- $$$saturationChanged[overload1]$$$saturationChangedint -->
<h3 class="fn" id="saturationChanged"><a name="saturationChanged"></a><code>[signal] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">saturationChanged</span>(<span class="type">int</span> <i>saturation</i>)</h3>
<p>Signals that a video widget's <i>saturation</i> adjustment has changed.</p>
<!-- @@@saturationChanged -->
<!-- $$$setAspectRatioMode[overload1]$$$setAspectRatioModeQt::AspectRatioMode -->
<h3 class="fn" id="setAspectRatioMode"><a name="setAspectRatioMode"></a><code>[pure virtual] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">setAspectRatioMode</span>(<span class="type">Qt::AspectRatioMode</span> <i>mode</i>)</h3>
<p>Sets the aspect ratio <i>mode</i> which determines how video is scaled to the fit the widget with respect to its aspect ratio.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#aspectRatioMode">aspectRatioMode</a>().</p>
<!-- @@@setAspectRatioMode -->
<!-- $$$setBrightness[overload1]$$$setBrightnessint -->
<h3 class="fn" id="setBrightness"><a name="setBrightness"></a><code>[pure virtual] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">setBrightness</span>(<span class="type">int</span> <i>brightness</i>)</h3>
<p>Sets a <i>brightness</i> adjustment for a video.</p>
<p>Valid brightness values range between -100 and 100, the default is 0.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#brightness">brightness</a>().</p>
<!-- @@@setBrightness -->
<!-- $$$setContrast[overload1]$$$setContrastint -->
<h3 class="fn" id="setContrast"><a name="setContrast"></a><code>[pure virtual] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">setContrast</span>(<span class="type">int</span> <i>contrast</i>)</h3>
<p>Sets the contrast adjustment for a video widget to <i>contrast</i>.</p>
<p>Valid contrast values range between -100 and 100, the default is 0.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#contrast">contrast</a>().</p>
<!-- @@@setContrast -->
<!-- $$$setFullScreen[overload1]$$$setFullScreenbool -->
<h3 class="fn" id="setFullScreen"><a name="setFullScreen"></a><code>[pure virtual] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">setFullScreen</span>(<span class="type">bool</span> <i>fullScreen</i>)</h3>
<p>Sets whether a video widget is in <i>fullScreen</i> mode.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#isFullScreen">isFullScreen</a>().</p>
<!-- @@@setFullScreen -->
<!-- $$$setHue[overload1]$$$setHueint -->
<h3 class="fn" id="setHue"><a name="setHue"></a><code>[pure virtual] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">setHue</span>(<span class="type">int</span> <i>hue</i>)</h3>
<p>Sets a <i>hue</i> adjustment for a video widget.</p>
<p>Valid hue values range between -100 and 100, the default is 0.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#hue">hue</a>().</p>
<!-- @@@setHue -->
<!-- $$$setSaturation[overload1]$$$setSaturationint -->
<h3 class="fn" id="setSaturation"><a name="setSaturation"></a><code>[pure virtual] </code><span class="type">void</span> QVideoWidgetControl::<span class="name">setSaturation</span>(<span class="type">int</span> <i>saturation</i>)</h3>
<p>Sets a <i>saturation</i> adjustment for a video widget.</p>
<p>Valid saturation values range between -100 and 100, the default is 0.</p>
<p><b>See also </b><a href="qvideowidgetcontrol.html#saturation">saturation</a>().</p>
<!-- @@@setSaturation -->
<!-- $$$videoWidget[overload1]$$$videoWidget -->
<h3 class="fn" id="videoWidget"><a name="videoWidget"></a><code>[pure virtual] </code><span class="type">QWidget</span> *QVideoWidgetControl::<span class="name">videoWidget</span>()</h3>
<p>Returns the QWidget.</p>
<!-- @@@videoWidget -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QVideoWidgetControl_iid[overload1]$$$QVideoWidgetControl_iid -->
<h3 class="fn" id="QVideoWidgetControl_iid"><a name="QVideoWidgetControl_iid"></a><span class="name">QVideoWidgetControl_iid</span></h3>
<p><code>org.qt-project.qt.videowidgetcontrol/5.0</code></p>
<p>Defines the interface name of the <a href="qvideowidgetcontrol.html">QVideoWidgetControl</a> class.</p>
<!-- @@@QVideoWidgetControl_iid -->
</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>
