QMovie

PyQt5.QtGui.QMovie

Inherits from QObject.

Description

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

This class is used to show simple animations without sound. If you want to display video and media content, use the Qt Multimedia multimedia framework instead.

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:

# QLabel label;
# QMovie *movie = new 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, Movie Example, QLabel.

Enums

CacheMode

TODO

Member	Value	Description
CacheAll	TODO	TODO
CacheNone	TODO	TODO

---

MovieState

This enum describes the different states of QMovie.

Member	Value	Description
NotRunning	0	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.
Paused	1	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.
Running	2	The movie is running.

Methods

__init__(parent: QObject = None)

TODO

---

__init__(QIODevice, format: Union[QByteArray, bytes, bytearray] = QByteArray(), parent: QObject = None)

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__(str, format: Union[QByteArray, bytes, bytearray] = QByteArray(), parent: QObject = None)

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() → QColor

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

See also

setBackgroundColor().

---

cacheMode() → CacheMode

See also

setCacheMode().

---

currentFrameNumber() → int

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

---

currentImage() → QImage

Returns the current frame as a QImage.

See also

currentPixmap(), updated.

---

currentPixmap() → QPixmap

Returns the current frame as a QPixmap.

See also

currentImage(), updated.

---

device() → QIODevice

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

See also

setDevice(), fileName().

---

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

See also

setFileName(), device().

---

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

---

frameCount() → int

Returns the number of frames in the movie.

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

---

frameRect() → QRect

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

See also

currentImage(), currentPixmap().

---

isValid() → 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(int) → bool

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

---

jumpToNextFrame() → bool

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

---

lastError() → ImageReaderError

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

See also

lastErrorString().

---

lastErrorString() → str

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

See also

lastError().

---

loopCount() → int

Returns the number of times the movie will loop before it finishes. If the movie will only play once (no looping), returns 0. If the movie loops forever, 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 QMovie::CacheAll.

---

nextFrameDelay() → int

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

---

scaledSize() → QSize

Returns the scaled size of frames.

See also

setScaledSize(), scaledSize().

---

setBackgroundColor(Union[QColor, GlobalColor, QGradient])

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

See also

backgroundColor().

---

setCacheMode(CacheMode)

TODO

---

setDevice(QIODevice)

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

See also

device(), setFormat().

---

setFileName(str)

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

See also

fileName(), setDevice(), setFormat().

---

setFormat(Union[QByteArray, bytes, bytearray])

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.

See also

format(), supportedImageFormats().

---

setPaused(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(QSize)

Sets the scaled frame size to size.

See also

scaledSize(), setScaledSize().

---

setSpeed(int)

See also

speed().

---

speed() → int

See also

setSpeed().

---

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

---

state() → MovieState

Returns the current state of QMovie.

See also

MovieState, stateChanged.

---

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

---

@staticmethod
supportedFormats() → List[QByteArray]

Returns the list of image formats supported by QMovie.

See also

supportedImageFormats().

Signals

error(ImageReaderError)

TODO

---

finished()

TODO

---

frameChanged(int)

TODO

---

resized(QSize)

TODO

---

started()

TODO

---

stateChanged(MovieState)

TODO

---

updated(QRect)

TODO