Qt Documentation

Contents

QVideoWindowControl Class

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

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

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
  • 31 public functions inherited from QObject

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)
  • 9 protected functions inherited from QObject

Macros

QVideoWindowControl_iid

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 11 static public members inherited from QObject

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

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

Constructs a new video window control with the given parent.

QVideoWindowControl::​~QVideoWindowControl()

Destroys a video window control.

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

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

See also setAspectRatioMode().

[pure virtual] int QVideoWindowControl::​brightness() const

Returns the brightness adjustment applied to a video overlay.

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

See also setBrightness().

[signal] void QVideoWindowControl::​brightnessChanged(int brightness)

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

[pure virtual] int QVideoWindowControl::​contrast() const

Returns the contrast adjustment applied to a video overlay.

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

See also setContrast().

[signal] void QVideoWindowControl::​contrastChanged(int contrast)

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

[pure virtual] QRect QVideoWindowControl::​displayRect() const

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

See also setDisplayRect().

[signal] void QVideoWindowControl::​fullScreenChanged(bool fullScreen)

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

[pure virtual] int QVideoWindowControl::​hue() const

Returns the hue adjustment applied to a video overlay.

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

See also setHue().

[signal] void QVideoWindowControl::​hueChanged(int hue)

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

[pure virtual] bool QVideoWindowControl::​isFullScreen() const

Identifies if a video overlay is a fullScreen overlay.

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

[pure virtual] QSize QVideoWindowControl::​nativeSize() const

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

[signal] void QVideoWindowControl::​nativeSizeChanged()

Signals that the native dimensions of the video have changed.

[pure virtual] void QVideoWindowControl::​repaint()

Repaints the last frame.

[pure virtual] int QVideoWindowControl::​saturation() const

Returns the saturation adjustment applied to a video overlay.

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

See also setSaturation().

[signal] void QVideoWindowControl::​saturationChanged(int saturation)

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

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

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().

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

Sets a brightness adjustment for a video overlay.

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

See also brightness().

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

Sets the contrast adjustment for a video overlay.

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

See also contrast().

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

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

See also displayRect().

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

Sets whether a video overlay is a fullScreen overlay.

See also isFullScreen().

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

Sets a hue adjustment for a video overlay.

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

See also hue().

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

Sets a saturation adjustment for a video overlay.

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

See also saturation().

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

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

See also winId().

[pure virtual] WId QVideoWindowControl::​winId() const

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.

© 2015 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. 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.