Class: QgsMediaWidget

A widget for playing back audio and video media files.

Added in version 3.30.

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

class qgis.gui.QgsMediaWidget

Bases: QWidget

__init__(parent: QWidget | None = None)

Constructor

Parameters:

parent (Optional[QWidget] = None)

Audio = 0

class Mode

Bases: int

Video = 1

mediaPath(self) → str

Returns the media path.

Return type:

str

mediaPlayer(self) → QMediaPlayer | None

Returns the QMediaPlayer object.

Return type:

Optional[QMediaPlayer]

mode(self) → QgsMediaWidget.Mode

Returns the media widget mode.

Return type:

QgsMediaWidget.Mode

setMediaPath(self, path: str | None)

Sets the media path.

Parameters:

path (Optional[str])

setMode(self, mode: QgsMediaWidget.Mode)

Sets the media widget mode.

Parameters:

mode (QgsMediaWidget.Mode)

setVideoHeight(self, height: int)

Sets the video frame height.

Note

setting the height to 0 is interpreted as a video frame that will expand to fill available height in the widget’s parent layout.

Parameters:

height (int)

videoHeight(self) → int

Returns the video frame height.

Return type:

int