PySide6.QtGui.QMovie

class QMovie

The QMovie class is a convenience class for playing movies with QImageReader . More…

Inheritance diagram of PySide6.QtGui.QMovie

Synopsis

Properties

Methods

Slots

Signals

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

This class is used to show simple animations without sound.

First, create a QMovie object by passing either the name of a file or a pointer to a QIODevice containing an animated image format to QMovie ‘s constructor. You can call isValid() to check if the image data is valid, before starting the movie. To start the movie, call start() . QMovie will enter Running state, and emit started() and stateChanged() . To get the current state of the movie, call state() .

To display the movie in your application, you can pass your QMovie object to QLabel::setMovie(). Example:

label = QLabel()
movie = QMovie("animations/fire.gif")
label.setMovie(movie)
movie.start()

Whenever a new frame is available in the movie, QMovie will emit updated() . If the size of the frame changes, resized() is emitted. You can call currentImage() or currentPixmap() to get a copy of the current frame. When the movie is done, QMovie emits finished() . If any error occurs during playback (i.e, the image file is corrupt), QMovie will emit error() .

You can control the speed of the movie playback by calling setSpeed() , which takes the percentage of the original speed as an argument. Pause the movie by calling setPaused (true). QMovie will then enter Paused state and emit stateChanged() . If you call setPaused (false), QMovie will reenter Running state and start the movie again. To stop the movie, call stop() .

Certain animation formats allow you to set the background color. You can call setBackgroundColor() to set the color, or backgroundColor() to retrieve the current background color.

currentFrameNumber() returns the sequence number of the current frame. The first frame in the animation has the sequence number 0. frameCount() returns the total number of frames in the animation, if the image format supports this. You can call loopCount() to get the number of times the movie should loop before finishing. nextFrameDelay() returns the number of milliseconds the current frame should be displayed.

QMovie can be instructed to cache frames of an animation by calling setCacheMode() .

Call supportedFormats() for a list of formats that QMovie supports.

See also

QImageReader

class MovieState

This enum describes the different states of QMovie .

Constant

Description

QMovie.MovieState.NotRunning

The movie is not running. This is QMovie ‘s initial state, and the state it enters after stop() has been called or the movie is finished.

QMovie.MovieState.Paused

The movie is paused, and QMovie stops emitting updated() or resized() . This state is entered after calling pause() or setPaused (true). The current frame number it kept, and the movie will continue with the next frame when unpause() or setPaused (false) is called.

QMovie.MovieState.Running

The movie is running.
class CacheMode

This enum describes the different cache modes of QMovie .

Constant

Description

QMovie.CacheMode.CacheNone

No frames are cached (the default).

QMovie.CacheMode.CacheAll

All frames are cached.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property cacheModeᅟ: QMovie.CacheMode

This property holds the movie’s cache mode.

Caching frames can be useful when the underlying animation format handler that QMovie relies on to decode the animation data does not support jumping to particular frames in the animation, or even “rewinding” the animation to the beginning (for looping). Furthermore, if the image data comes from a sequential device, it is not possible for the underlying animation handler to seek back to frames whose data has already been read (making looping altogether impossible).

To aid in such situations, a QMovie object can be instructed to cache the frames, at the added memory cost of keeping the frames in memory for the lifetime of the object.

By default, this property is set to CacheNone .

See also

CacheMode

Access functions:
property speedᅟ: int

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

This property holds the movie’s speed.

The speed is measured in percentage of the original movie speed. The default speed is 100%. Example:

movie = QMovie("racecar.gif")
movie.setSpeed(200) # 2x speed
Access functions:
__init__([parent=None])
Parameters:

parent – QObject

Constructs a QMovie object, passing the parent object to QObject’s constructor.

__init__(device[, format=QByteArray()[, parent=None]])
Parameters:

Constructs a QMovie object. QMovie will use read image data from device, which it assumes is open and readable. If format is not empty, QMovie will use the image format format for decoding the image data. Otherwise, QMovie will attempt to guess the format.

The parent object is passed to QObject’s constructor.

__init__(fileName[, format=QByteArray()[, parent=None]])
Parameters:

Constructs a QMovie object. QMovie will use read image data from fileName. If format is not empty, QMovie will use the image format format for decoding the image data. Otherwise, QMovie will attempt to guess the format.

The parent object is passed to QObject’s constructor.

backgroundColor()
Return type:

QColor

Returns the background color of the movie. If no background color has been assigned, an invalid QColor is returned.

cacheMode()
Return type:

CacheMode

See also

setCacheMode()

Getter of property cacheModeᅟ .

currentFrameNumber()
Return type:

int

Returns the sequence number of the current frame. The number of the first frame in the movie is 0.

currentImage()
Return type:

QImage

Returns the current frame as a QImage .

currentPixmap()
Return type:

QPixmap

Returns the current frame as a QPixmap .

device()
Return type:

QIODevice

Returns the device QMovie reads image data from. If no device has currently been assigned, None is returned.

error(error)
Parameters:

error – ImageReaderError

This signal is emitted by QMovie when the error error occurred during playback. QMovie will stop the movie, and enter NotRunning state.

fileName()
Return type:

str

Returns the name of the file that QMovie reads image data from. If no file name has been assigned, or if the assigned device is not a file, an empty QString is returned.

finished()

This signal is emitted when the movie has finished.

See also

stop()

format()
Return type:

QByteArray

Returns the format that QMovie uses when decoding image data. If no format has been assigned, an empty QByteArray() is returned.

See also

setFormat()

frameChanged(frameNumber)
Parameters:

frameNumber – int

This signal is emitted when the frame number has changed to frameNumber. You can call currentImage() or currentPixmap() to get a copy of the frame.

frameCount()
Return type:

int

Returns the number of frames in the movie.

Certain animation formats do not support this feature, in which case 0 is returned.

frameRect()
Return type:

QRect

Returns the rect of the last frame. If no frame has yet been updated, an invalid QRect is returned.

isValid()
Return type:

bool

Returns true if the movie is valid (e.g., the image data is readable and the image format is supported); otherwise returns false.

For information about why the movie is not valid, see lastError() .

jumpToFrame(frameNumber)
Parameters:

frameNumber – int

Return type:

bool

Jumps to frame number frameNumber. Returns true on success; otherwise returns false.

jumpToNextFrame()
Return type:

bool

Jumps to the next frame. Returns true on success; otherwise returns false.

lastError()
Return type:

ImageReaderError

Returns the most recent error that occurred while attempting to read image data.

lastErrorString()
Return type:

str

Returns a human-readable representation of the most recent error that occurred while attempting to read image data.

See also

lastError()

loopCount()
Return type:

int

Returns the number of times the movie will loop before it finishes. If the movie will only play once (no looping), loopCount returns 0. If the movie loops forever, loopCount returns -1.

Note that, if the image data comes from a sequential device (e.g. a socket), QMovie can only loop the movie if the cacheMode is set to CacheAll .

nextFrameDelay()
Return type:

int

Returns the number of milliseconds QMovie will wait before updating the next frame in the animation.

resized(size)
Parameters:

size – QSize

This signal is emitted when the current frame has been resized to size. This effect is sometimes used in animations as an alternative to replacing the frame. You can call currentImage() or currentPixmap() to get a copy of the updated frame.

scaledSize()
Return type:

QSize

Returns the scaled size of frames.

setBackgroundColor(color)
Parameters:

color – QColor

For image formats that support it, this function sets the background color to color.

setCacheMode(mode)
Parameters:

mode – CacheMode

See also

cacheMode()

Setter of property cacheModeᅟ .

setDevice(device)
Parameters:

device – QIODevice

Sets the current device to device. QMovie will read image data from this device when the movie is running.

setFileName(fileName)
Parameters:

fileName – str

Sets the name of the file that QMovie reads image data from, to fileName.

setFormat(format)
Parameters:

format – QByteArray

Sets the format that QMovie will use when decoding image data, to format. By default, QMovie will attempt to guess the format of the image data.

You can call supportedFormats() for the full list of formats QMovie supports.

setPaused(paused)
Parameters:

paused – bool

If paused is true, QMovie will enter Paused state and emit stateChanged (Paused); otherwise it will enter Running state and emit stateChanged (Running).

See also

state()

setScaledSize(size)
Parameters:

size – QSize

Sets the scaled frame size to size.

setSpeed(percentSpeed)
Parameters:

percentSpeed – int

See also

speed()

Setter of property speedᅟ .

speed()
Return type:

int

See also

setSpeed()

Getter of property speedᅟ .

start()

Starts the movie. QMovie will enter Running state, and start emitting updated() and resized() as the movie progresses.

If QMovie is in the Paused state, this function is equivalent to calling setPaused (false). If QMovie is already in the Running state, this function does nothing.

See also

stop() setPaused()

started()

This signal is emitted after start() has been called, and QMovie has entered Running state.

state()
Return type:

MovieState

Returns the current state of QMovie .

stateChanged(state)
Parameters:

state – MovieState

This signal is emitted every time the state of the movie changes. The new state is specified by state.

See also

state()

stop()

Stops the movie. QMovie enters NotRunning state, and stops emitting updated() and resized() . If start() is called again, the movie will restart from the beginning.

If QMovie is already in the NotRunning state, this function does nothing.

See also

start() setPaused()

static supportedFormats()
Return type:

.list of QByteArray

Returns the list of image formats supported by QMovie .

updated(rect)
Parameters:

rect – QRect

This signal is emitted when the rect rect in the current frame has been updated. You can call currentImage() or currentPixmap() to get a copy of the updated frame.