- Qt 5.3
- Qt Multimedia
- C++ Classes
- QVideoWindowControl
- Qt 5.3.2 Reference Documentation

# QVideoWindowControl Class

The QVideoWindowControl class provides a media control for rendering video to a window. More...

Header: | `#include <QVideoWindowControl>`
qmake: | `QT += multimedia`
Inherits: | QMediaControl.

- List of all members, including inherited members

## Public Functions

| ~QVideoWindowControl()
virtual Qt::AspectRatioMode | aspectRatioMode() const = 0
virtual int | brightness() const = 0
virtual int | contrast() const = 0
virtual QRect | displayRect() const = 0
virtual int | hue() const = 0
virtual bool | isFullScreen() const = 0
virtual QSize | nativeSize() const = 0
virtual void | repaint() = 0
virtual int | saturation() const = 0
virtual void | setAspectRatioMode(Qt::AspectRatioMode mode) = 0
virtual void | setBrightness(int brightness) = 0
virtual void | setContrast(int contrast) = 0
virtual void | setDisplayRect(const QRect & rect) = 0
virtual void | setFullScreen(bool fullScreen) = 0
virtual void | setHue(int hue) = 0
virtual void | setSaturation(int saturation) = 0
virtual void | setWinId(WId id) = 0
virtual WId | winId() const = 0

## Signals

void | brightnessChanged(int brightness)
void | contrastChanged(int contrast)
void | fullScreenChanged(bool fullScreen)
void | hueChanged(int hue)
void | nativeSizeChanged()
void | saturationChanged(int saturation)

## Protected Functions

| QVideoWindowControl(QObject * parent = 0)

## Macros

| QVideoWindowControl_iid

## Detailed Description

The QVideoWindowControl class provides a media control for rendering video to a window.

The winId() property QVideoWindowControl allows a platform specific window ID to be set as the video render target of a QMediaService. The displayRect() property is used to set the region of the window the video should be rendered to, and the aspectRatioMode() property indicates how the video should be scaled to fit the displayRect().

    QVideoWindowControl *windowControl = mediaService->requestControl<QVideoWindowControl *>();
    windowControl->setWinId(widget->winId());
    windowControl->setDisplayRect(widget->rect());
    windowControl->setAspectRatioMode(Qt::KeepAspectRatio);

QVideoWindowControl is one of a number of possible video output controls.

The interface name of QVideoWindowControl is `org.qt-project.qt.videowindowcontrol/5.0` as defined in QVideoWindowControl_iid.

See also QMediaService::requestControl() and QVideoWidget.

## Member Function Documentation

### QVideoWindowControl::QVideoWindowControl(QObject * parent = 0)`[protected]`

Constructs a new video window control with the given parent.

### QVideoWindowControl::~QVideoWindowControl()

Destroys a video window control.

### Qt::AspectRatioMode QVideoWindowControl::aspectRatioMode() const`[pure virtual]`

Returns how video is scaled to fit the display region with respect to its aspect ratio.

See also setAspectRatioMode().

### int QVideoWindowControl::brightness() const`[pure virtual]`

Returns the brightness adjustment applied to a video overlay.

Valid brightness values range between -100 and 100, the default is 0.

See also setBrightness().

### void QVideoWindowControl::brightnessChanged(int brightness)`[signal]`

Signals that a video overlay's brightness adjustment has changed.

### int QVideoWindowControl::contrast() const`[pure virtual]`

Returns the contrast adjustment applied to a video overlay.

Valid contrast values range between -100 and 100, the default is 0.

See also setContrast().

### void QVideoWindowControl::contrastChanged(int contrast)`[signal]`

Signals that a video overlay's contrast adjustment has changed.

### QRect QVideoWindowControl::displayRect() const`[pure virtual]`

Returns the sub-rect of a window where video is displayed.

See also setDisplayRect().

### void QVideoWindowControl::fullScreenChanged(bool fullScreen)`[signal]`

Signals that the fullScreen state of a video overlay has changed.

### int QVideoWindowControl::hue() const`[pure virtual]`

Returns the hue adjustment applied to a video overlay.

Value hue values range between -100 and 100, the default is 0.

See also setHue().

### void QVideoWindowControl::hueChanged(int hue)`[signal]`

Signals that a video overlay's hue adjustment has changed.

### bool QVideoWindowControl::isFullScreen() const`[pure virtual]`

Identifies if a video overlay is a fullScreen overlay.

Returns true if the video overlay is fullScreen, and false otherwise.

### QSize QVideoWindowControl::nativeSize() const`[pure virtual]`

Returns a suggested size for the video display based on the resolution and aspect ratio of the video.

### void QVideoWindowControl::nativeSizeChanged()`[signal]`

Signals that the native dimensions of the video have changed.

### void QVideoWindowControl::repaint()`[pure virtual]`

Repaints the last frame.

### int QVideoWindowControl::saturation() const`[pure virtual]`

Returns the saturation adjustment applied to a video overlay.

Value saturation values range between -100 and 100, the default is 0.

See also setSaturation().

### void QVideoWindowControl::saturationChanged(int saturation)`[signal]`

Signals that a video overlay's saturation adjustment has changed.

### void QVideoWindowControl::setAspectRatioMode(Qt::AspectRatioMode mode)`[pure virtual]`

Sets the aspect ratio mode which determines how video is scaled to the fit the display region with respect to its aspect ratio.

See also aspectRatioMode().

### void QVideoWindowControl::setBrightness(int brightness)`[pure virtual]`

Sets a brightness adjustment for a video overlay.

Valid brightness values range between -100 and 100, the default is 0.

See also brightness().

### void QVideoWindowControl::setContrast(int contrast)`[pure virtual]`

Sets the contrast adjustment for a video overlay.

Valid contrast values range between -100 and 100, the default is 0.

See also contrast().

### void QVideoWindowControl::setDisplayRect(const QRect & rect)`[pure virtual]`

Sets the sub-rect of a window where video is displayed.

See also displayRect().

### void QVideoWindowControl::setFullScreen(bool fullScreen)`[pure virtual]`

Sets whether a video overlay is a fullScreen overlay.

See also isFullScreen().

### void QVideoWindowControl::setHue(int hue)`[pure virtual]`

Sets a hue adjustment for a video overlay.

Valid hue values range between -100 and 100, the default is 0.

See also hue().

### void QVideoWindowControl::setSaturation(int saturation)`[pure virtual]`

Sets a saturation adjustment for a video overlay.

Valid saturation values range between -100 and 100, the default is 0.

See also saturation().

### void QVideoWindowControl::setWinId(WId id)`[pure virtual]`

Sets the id of the window a video overlay end point renders to.

See also winId().

### WId QVideoWindowControl::winId() const`[pure virtual]`

Returns the ID of the window a video overlay end point renders to.

See also setWinId().

## Macro Documentation

### QVideoWindowControl_iid

`org.qt-project.qt.videowindowcontrol/5.0`

Defines the interface name of the QVideoWindowControl class.