Contents

• Public Types
• Properties
• Public Functions
• Public Slots
• Reimplemented Protected Functions
• Detailed Description

Detailed Description

TheVideoWidget class provides a widget that is used to display video.

TheVideoWidget class renders the video of a media stream on aQWidget. It is connected to theMediaObject, of which video stream it should render. You connect the two objects using the Phonon::createPath() function.

The widget has some possibilities to manipulate the video stream. You can change thebrightness(),hue(),saturation(), andcontrast().

Resizing of the video is handled automatically, but you can affect the way the video is resized with theaspectRatio andscaleMode properties. By default, the widget will use the aspect ratio of the video stream itself.

The video widget takes the size of the video when it receives a new video stream (i.e., when a newMediaSource is set on theMediaObject to which it is connected). If you need to know the size of the video, you can callsizeHint() after the video has been loaded (i.e., after theMediaObject leaves theLoadingState).

It is also possible to go tofull screen mode.

A typical example of usage follows below:

MediaObject*media=new MediaObject(parent);VideoWidget*vwidget=new VideoWidget(parent);Phonon::createPath(media, vwidget);

Member Type Documentation

enum VideoWidget::AspectRatio

Defines the width:height to be used for the video.

enum VideoWidget::ScaleMode

The ScaleMode enum describes how to treat aspect ratio during resizing of video.

Property Documentation

aspectRatio :AspectRatio

Defaults toAspectRatioAuto.

Access functions:

See alsoAspectRatio.

brightness :qreal

This property holds brightness of the video.

Default is 0. Acceptable values are in range of -1, 1.

Access functions:

contrast :qreal

This property holds the contrast of the video.

Default is 0. Acceptable values are in range of -1, 1.

Access functions:

fullScreen :bool

This property holds whether the video is shown using the complete screen.

The property differs fromQWidget::fullScreen in that it is writeable.

By default the widget is not shown in fullScreen.

Warning: When switching to full screen mode using setFullScreen(), the widget onto which the video is rendered is shown as a top-level window. Key event forwarding is handled byVideoWidget, but if you need to handle other events, e.g., mouse events, you should handle fullscreen mode yourself.

Access functions:

hue :qreal

This property holds the hue of the video.

Default is 0. Acceptable values are in range of -1, 1.

Access functions:

saturation :qreal

This property holds saturation of the video.

Default is 0. Acceptable values are in range of -1, 1.

Access functions:

scaleMode :ScaleMode

If the size of the widget and the size of the video are not equal. The video will be zoomed to fit the widget. The smaller zoom (AddBarsScaleMode) adds black bars at the left/right or top/bottom to make all of the image visible (default). The bigger zoom (ExpandMode) fills the widget completely, keeping all information in one direction and leaving parts of the image outside of the widget in the other direction.

Access functions:

Member Function Documentation

VideoWidget::VideoWidget(QWidget * parent = 0)

Constructs a new video widget with the specifiedparent.

[slot]void VideoWidget::enterFullScreen()

Convenience slot, callingsetFullScreen(true)

[virtual protected]bool VideoWidget::event(QEvent *)

Reimplemented fromQObject::event().

[slot]void VideoWidget::exitFullScreen()

Convenience slot, callingsetFullScreen(false)

[virtual protected]void VideoWidget::mouseMoveEvent(QMouseEvent *)

Reimplemented fromQWidget::mouseMoveEvent().

QImage VideoWidget::snapshot() const

Returns a snapshot of the current frame shown in the widget.

This function was introduced in Qt 4.7.