API reference - Class QVideoWidget

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

actionEvent

Signature: void actionEvent (QActionEvent ptr event)

Description: Virtual method void QVideoWidget::actionEvent(QActionEvent *event)

This method can be reimplemented in a derived class.

asConstQMediaBindableInterface

Signature: [const] const QMediaBindableInterface ptr asConstQMediaBindableInterface

Description: Delivers the base class interface QMediaBindableInterface of QVideoWidget

Class QVideoWidget is derived from multiple base classes. This method delivers the QMediaBindableInterface base class aspect.

Use this version if you have a const reference.

asConstQWidget

Signature: [const] const QWidget ptr asConstQWidget

Description: Delivers the base class interface QWidget of QVideoWidget

Class QVideoWidget is derived from multiple base classes. This method delivers the QWidget base class aspect.

Use this version if you have a const reference.

asQMediaBindableInterface

Signature: QMediaBindableInterface ptr asQMediaBindableInterface

Description: Delivers the base class interface QMediaBindableInterface of QVideoWidget

Class QVideoWidget is derived from multiple base classes. This method delivers the QMediaBindableInterface base class aspect.

asQWidget

Signature: QWidget ptr asQWidget

Description: Delivers the base class interface QWidget of QVideoWidget

Class QVideoWidget is derived from multiple base classes. This method delivers the QWidget base class aspect.

aspectRatioMode

Signature: [const] Qt_AspectRatioMode aspectRatioMode

Description: Method Qt::AspectRatioMode QVideoWidget::aspectRatioMode()

Python specific notes:
The object exposes a readable attribute 'aspectRatioMode'. This is the getter.

aspectRatioMode=

Signature: void aspectRatioMode= (const Qt_AspectRatioMode mode)

Description: Method void QVideoWidget::setAspectRatioMode(Qt::AspectRatioMode mode)

Python specific notes:
The object exposes a writable attribute 'aspectRatioMode'. This is the setter.

brightness

Signature: [const] int brightness

Description: Method int QVideoWidget::brightness()

Python specific notes:
The object exposes a readable attribute 'brightness'. This is the getter.

brightness=

Signature: void brightness= (int brightness)

Description: Method void QVideoWidget::setBrightness(int brightness)

Python specific notes:
The object exposes a writable attribute 'brightness'. This is the setter.

brightnessChanged

Signature: [signal] void brightnessChanged (int brightness)

Description: Signal declaration for QVideoWidget::brightnessChanged(int brightness)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'brightnessChanged'. This is the getter.
The object exposes a writable attribute 'brightnessChanged'. This is the setter.

changeEvent

Signature: void changeEvent (QEvent ptr arg1)

Description: Virtual method void QVideoWidget::changeEvent(QEvent *)

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QVideoWidget::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

closeEvent

Signature: void closeEvent (QCloseEvent ptr event)

Description: Virtual method void QVideoWidget::closeEvent(QCloseEvent *event)

This method can be reimplemented in a derived class.

contextMenuEvent

Signature: void contextMenuEvent (QContextMenuEvent ptr event)

Description: Virtual method void QVideoWidget::contextMenuEvent(QContextMenuEvent *event)

This method can be reimplemented in a derived class.

contrast

Signature: [const] int contrast

Description: Method int QVideoWidget::contrast()

Python specific notes:
The object exposes a readable attribute 'contrast'. This is the getter.

contrast=

Signature: void contrast= (int contrast)

Description: Method void QVideoWidget::setContrast(int contrast)

Python specific notes:
The object exposes a writable attribute 'contrast'. This is the setter.

contrastChanged

Signature: [signal] void contrastChanged (int contrast)

Description: Signal declaration for QVideoWidget::contrastChanged(int contrast)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'contrastChanged'. This is the getter.
The object exposes a writable attribute 'contrastChanged'. This is the setter.

create

Signature: void create (unsigned long long arg1 = 0, bool initializeWindow = true, bool destroyOldWindow = true)

Description: Method void QVideoWidget::create(WId, bool initializeWindow, bool destroyOldWindow)

This method is protected and can only be called from inside a derived class.

customContextMenuRequested

Signature: [signal] void customContextMenuRequested (const QPoint pos)

Description: Signal declaration for QVideoWidget::customContextMenuRequested(const QPoint &pos)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'customContextMenuRequested'. This is the getter.
The object exposes a writable attribute 'customContextMenuRequested'. This is the setter.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QVideoWidget::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroy

Signature: void destroy (bool destroyWindow = true, bool destroySubWindows = true)

Description: Method void QVideoWidget::destroy(bool destroyWindow, bool destroySubWindows)

This method is protected and can only be called from inside a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QVideoWidget::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QVideoWidget::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

dragEnterEvent

Signature: void dragEnterEvent (QDragEnterEvent ptr event)

Description: Virtual method void QVideoWidget::dragEnterEvent(QDragEnterEvent *event)

This method can be reimplemented in a derived class.

dragLeaveEvent

Signature: void dragLeaveEvent (QDragLeaveEvent ptr event)

Description: Virtual method void QVideoWidget::dragLeaveEvent(QDragLeaveEvent *event)

This method can be reimplemented in a derived class.

dragMoveEvent

Signature: void dragMoveEvent (QDragMoveEvent ptr event)

Description: Virtual method void QVideoWidget::dragMoveEvent(QDragMoveEvent *event)

This method can be reimplemented in a derived class.

dropEvent

Signature: void dropEvent (QDropEvent ptr event)

Description: Virtual method void QVideoWidget::dropEvent(QDropEvent *event)

This method can be reimplemented in a derived class.

emit_brightnessChanged

Signature: void emit_brightnessChanged (int brightness)

Description: Emitter for signal void QVideoWidget::brightnessChanged(int brightness)

Call this method to emit this signal.

emit_contrastChanged

Signature: void emit_contrastChanged (int contrast)

Description: Emitter for signal void QVideoWidget::contrastChanged(int contrast)

Call this method to emit this signal.

emit_customContextMenuRequested

Signature: void emit_customContextMenuRequested (const QPoint pos)

Description: Emitter for signal void QVideoWidget::customContextMenuRequested(const QPoint &pos)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QVideoWidget::destroyed(QObject *)

Call this method to emit this signal.

emit_fullScreenChanged

Signature: void emit_fullScreenChanged (bool fullScreen)

Description: Emitter for signal void QVideoWidget::fullScreenChanged(bool fullScreen)

Call this method to emit this signal.

emit_hueChanged

Signature: void emit_hueChanged (int hue)

Description: Emitter for signal void QVideoWidget::hueChanged(int hue)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QVideoWidget::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_saturationChanged

Signature: void emit_saturationChanged (int saturation)

Description: Emitter for signal void QVideoWidget::saturationChanged(int saturation)

Call this method to emit this signal.

emit_windowIconChanged

Signature: void emit_windowIconChanged (const QIcon icon)

Description: Emitter for signal void QVideoWidget::windowIconChanged(const QIcon &icon)

Call this method to emit this signal.

emit_windowIconTextChanged

Signature: void emit_windowIconTextChanged (string iconText)

Description: Emitter for signal void QVideoWidget::windowIconTextChanged(const QString &iconText)

Call this method to emit this signal.

emit_windowTitleChanged

Signature: void emit_windowTitleChanged (string title)

Description: Emitter for signal void QVideoWidget::windowTitleChanged(const QString &title)

Call this method to emit this signal.

enterEvent

Signature: void enterEvent (QEvent ptr event)

Description: Virtual method void QVideoWidget::enterEvent(QEvent *event)

This method can be reimplemented in a derived class.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QVideoWidget::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QVideoWidget::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

focusInEvent

Signature: void focusInEvent (QFocusEvent ptr event)

Description: Virtual method void QVideoWidget::focusInEvent(QFocusEvent *event)

This method can be reimplemented in a derived class.

focusNextChild

Signature: bool focusNextChild

Description: Method bool QVideoWidget::focusNextChild()

This method is protected and can only be called from inside a derived class.

focusNextPrevChild

Signature: bool focusNextPrevChild (bool next)

Description: Virtual method bool QVideoWidget::focusNextPrevChild(bool next)

This method can be reimplemented in a derived class.

focusOutEvent

Signature: void focusOutEvent (QFocusEvent ptr event)

Description: Virtual method void QVideoWidget::focusOutEvent(QFocusEvent *event)

This method can be reimplemented in a derived class.

focusPreviousChild

Signature: bool focusPreviousChild

Description: Method bool QVideoWidget::focusPreviousChild()

This method is protected and can only be called from inside a derived class.

fullScreen=

Signature: void fullScreen= (bool fullScreen)

Description: Method void QVideoWidget::setFullScreen(bool fullScreen)

Python specific notes:
The object exposes a writable attribute 'fullScreen'. This is the setter.

fullScreenChanged

Signature: [signal] void fullScreenChanged (bool fullScreen)

Description: Signal declaration for QVideoWidget::fullScreenChanged(bool fullScreen)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'fullScreenChanged'. This is the getter.
The object exposes a writable attribute 'fullScreenChanged'. This is the setter.

hasHeightForWidth

Signature: [const] bool hasHeightForWidth

Description: Virtual method bool QVideoWidget::hasHeightForWidth()

This method can be reimplemented in a derived class.

heightForWidth

Signature: [const] int heightForWidth (int arg1)

Description: Virtual method int QVideoWidget::heightForWidth(int)

This method can be reimplemented in a derived class.

hideEvent

Signature: void hideEvent (QHideEvent ptr event)

Description: Virtual method void QVideoWidget::hideEvent(QHideEvent *event)

This method can be reimplemented in a derived class.

hue

Signature: [const] int hue

Description: Method int QVideoWidget::hue()

Python specific notes:
The object exposes a readable attribute 'hue'. This is the getter.

hue=

Signature: void hue= (int hue)

Description: Method void QVideoWidget::setHue(int hue)

Python specific notes:
The object exposes a writable attribute 'hue'. This is the setter.

hueChanged

Signature: [signal] void hueChanged (int hue)

Description: Signal declaration for QVideoWidget::hueChanged(int hue)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'hueChanged'. This is the getter.
The object exposes a writable attribute 'hueChanged'. This is the setter.

initPainter

Signature: [const] void initPainter (QPainter ptr painter)

Description: Virtual method void QVideoWidget::initPainter(QPainter *painter)

This method can be reimplemented in a derived class.

inputMethodEvent

Signature: void inputMethodEvent (QInputMethodEvent ptr arg1)

Description: Virtual method void QVideoWidget::inputMethodEvent(QInputMethodEvent *)

This method can be reimplemented in a derived class.

inputMethodQuery

Signature: [const] variant inputMethodQuery (const Qt_InputMethodQuery arg1)

Description: Virtual method QVariant QVideoWidget::inputMethodQuery(Qt::InputMethodQuery)

This method can be reimplemented in a derived class.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QVideoWidget::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

keyPressEvent

Signature: void keyPressEvent (QKeyEvent ptr event)

Description: Virtual method void QVideoWidget::keyPressEvent(QKeyEvent *event)

This method can be reimplemented in a derived class.

keyReleaseEvent

Signature: void keyReleaseEvent (QKeyEvent ptr event)

Description: Virtual method void QVideoWidget::keyReleaseEvent(QKeyEvent *event)

This method can be reimplemented in a derived class.

leaveEvent

Signature: void leaveEvent (QEvent ptr event)

Description: Virtual method void QVideoWidget::leaveEvent(QEvent *event)

This method can be reimplemented in a derived class.

mediaObject

Signature: [const] QMediaObject ptr mediaObject

Description: Virtual method QMediaObject *QVideoWidget::mediaObject()

This method can be reimplemented in a derived class.

metric

Signature: [const] int metric (const QPaintDevice_PaintDeviceMetric arg1)

Description: Virtual method int QVideoWidget::metric(QPaintDevice::PaintDeviceMetric)

This method can be reimplemented in a derived class.

minimumSizeHint

Signature: [const] QSize minimumSizeHint

Description: Virtual method QSize QVideoWidget::minimumSizeHint()

This method can be reimplemented in a derived class.

mouseDoubleClickEvent

Signature: void mouseDoubleClickEvent (QMouseEvent ptr event)

Description: Virtual method void QVideoWidget::mouseDoubleClickEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mouseMoveEvent

Signature: void mouseMoveEvent (QMouseEvent ptr event)

Description: Virtual method void QVideoWidget::mouseMoveEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mousePressEvent

Signature: void mousePressEvent (QMouseEvent ptr event)

Description: Virtual method void QVideoWidget::mousePressEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mouseReleaseEvent

Signature: void mouseReleaseEvent (QMouseEvent ptr event)

Description: Virtual method void QVideoWidget::mouseReleaseEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

moveEvent

Signature: void moveEvent (QMoveEvent ptr event)

Description: Virtual method void QVideoWidget::moveEvent(QMoveEvent *event)

This method can be reimplemented in a derived class.

nativeEvent

Signature: bool nativeEvent (bytes eventType, void * message, long ptr result)

Description: Virtual method bool QVideoWidget::nativeEvent(const QByteArray &eventType, void *message, long int *result)

This method can be reimplemented in a derived class.

new

Signature: [static] new QVideoWidget new (QWidget ptr parent = nullptr)

Description: Constructor QVideoWidget::QVideoWidget(QWidget *parent)

This method creates an object of class QVideoWidget.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QVideoWidget::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QVideoWidget::paintEngine()

This method can be reimplemented in a derived class.

paintEvent

Signature: void paintEvent (QPaintEvent ptr event)

Description: Virtual method void QVideoWidget::paintEvent(QPaintEvent *event)

This method can be reimplemented in a derived class.

qt_create

Signature: void qt_create (unsigned long long arg1 = 0, bool initializeWindow = true, bool destroyOldWindow = true)

Description: Method void QVideoWidget::create(WId, bool initializeWindow, bool destroyOldWindow)

This method is protected and can only be called from inside a derived class.

qt_destroy

Signature: void qt_destroy (bool destroyWindow = true, bool destroySubWindows = true)

Description: Method void QVideoWidget::destroy(bool destroyWindow, bool destroySubWindows)

This method is protected and can only be called from inside a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QVideoWidget::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

redirected

Signature: [const] QPaintDevice ptr redirected (QPoint ptr offset)

Description: Virtual method QPaintDevice *QVideoWidget::redirected(QPoint *offset)

This method can be reimplemented in a derived class.

resizeEvent

Signature: void resizeEvent (QResizeEvent ptr event)

Description: Virtual method void QVideoWidget::resizeEvent(QResizeEvent *event)

This method can be reimplemented in a derived class.

saturation

Signature: [const] int saturation

Description: Method int QVideoWidget::saturation()

Python specific notes:
The object exposes a readable attribute 'saturation'. This is the getter.

saturation=

Signature: void saturation= (int saturation)

Description: Method void QVideoWidget::setSaturation(int saturation)

Python specific notes:
The object exposes a writable attribute 'saturation'. This is the setter.

saturationChanged

Signature: [signal] void saturationChanged (int saturation)

Description: Signal declaration for QVideoWidget::saturationChanged(int saturation)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'saturationChanged'. This is the getter.
The object exposes a writable attribute 'saturationChanged'. This is the setter.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QVideoWidget::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QVideoWidget::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setAspectRatioMode

Signature: void setAspectRatioMode (const Qt_AspectRatioMode mode)

Description: Method void QVideoWidget::setAspectRatioMode(Qt::AspectRatioMode mode)

Python specific notes:
The object exposes a writable attribute 'aspectRatioMode'. This is the setter.

setBrightness

Signature: void setBrightness (int brightness)

Description: Method void QVideoWidget::setBrightness(int brightness)

Python specific notes:
The object exposes a writable attribute 'brightness'. This is the setter.

setContrast

Signature: void setContrast (int contrast)

Description: Method void QVideoWidget::setContrast(int contrast)

Python specific notes:
The object exposes a writable attribute 'contrast'. This is the setter.

setFullScreen

Signature: void setFullScreen (bool fullScreen)

Description: Method void QVideoWidget::setFullScreen(bool fullScreen)

Python specific notes:
The object exposes a writable attribute 'fullScreen'. This is the setter.

setHue

Signature: void setHue (int hue)

Description: Method void QVideoWidget::setHue(int hue)

Python specific notes:
The object exposes a writable attribute 'hue'. This is the setter.

setMediaObject

Signature: bool setMediaObject (QMediaObject ptr object)

Description: Virtual method bool QVideoWidget::setMediaObject(QMediaObject *object)

This method can be reimplemented in a derived class.

setSaturation

Signature: void setSaturation (int saturation)

Description: Method void QVideoWidget::setSaturation(int saturation)

Python specific notes:
The object exposes a writable attribute 'saturation'. This is the setter.

setVisible

Signature: void setVisible (bool visible)

Description: Virtual method void QVideoWidget::setVisible(bool visible)

This method can be reimplemented in a derived class.

sharedPainter

Signature: [const] QPainter ptr sharedPainter

Description: Virtual method QPainter *QVideoWidget::sharedPainter()

This method can be reimplemented in a derived class.

showEvent

Signature: void showEvent (QShowEvent ptr event)

Description: Virtual method void QVideoWidget::showEvent(QShowEvent *event)

This method can be reimplemented in a derived class.

sizeHint

Signature: [const] QSize sizeHint

Description: Virtual method QSize QVideoWidget::sizeHint()

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tabletEvent

Signature: void tabletEvent (QTabletEvent ptr event)

Description: Virtual method void QVideoWidget::tabletEvent(QTabletEvent *event)

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QVideoWidget::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QVideoWidget::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QVideoWidget::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

updateMicroFocus

Signature: void updateMicroFocus

Description: Method void QVideoWidget::updateMicroFocus()

This method is protected and can only be called from inside a derived class.

wheelEvent

Signature: void wheelEvent (QWheelEvent ptr event)

Description: Virtual method void QVideoWidget::wheelEvent(QWheelEvent *event)

This method can be reimplemented in a derived class.

windowIconChanged

Signature: [signal] void windowIconChanged (const QIcon icon)

Description: Signal declaration for QVideoWidget::windowIconChanged(const QIcon &icon)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'windowIconChanged'. This is the getter.
The object exposes a writable attribute 'windowIconChanged'. This is the setter.

windowIconTextChanged

Signature: [signal] void windowIconTextChanged (string iconText)

Description: Signal declaration for QVideoWidget::windowIconTextChanged(const QString &iconText)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'windowIconTextChanged'. This is the getter.
The object exposes a writable attribute 'windowIconTextChanged'. This is the setter.

windowTitleChanged

Signature: [signal] void windowTitleChanged (string title)

Description: Signal declaration for QVideoWidget::windowTitleChanged(const QString &title)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'windowTitleChanged'. This is the getter.
The object exposes a writable attribute 'windowTitleChanged'. This is the setter.