You are reading an old version of the documentation (v3.0.0). For the latest version see
Version 3.0.0
Fork me on GitHub


class matplotlib.animation.FileMovieWriter(*args, **kwargs)[source]

Bases: matplotlib.animation.MovieWriter

MovieWriter for writing to individual files and stitching at the end.

This must be sub-classed to be useful.

classmethod bin_path()

Returns the binary path to the commandline tool used by a specific subclass. This is a class method so that the tool can be looked for before making a particular MovieWriter subclass available.


Clean-up and collect the process used to write the movie file.


Finish any processing for writing the movie.


Format (png, jpeg, etc.) to use for saving the frames, which can be decided by the individual subclasses.


A tuple (width, height) in pixels of a movie frame.


Grab the image information from the figure and save as a movie frame. All keyword arguments in savefig_kwargs are passed on to the savefig command that saves the figure.

classmethod isAvailable()

Check to see if a MovieWriter subclass is actually available.

saving(fig, outfile, dpi, *args, **kwargs)

Context manager to facilitate writing the movie file.

*args, **kw are any parameters that should be passed to setup.

setup(fig, outfile, dpi=None, frame_prefix='_tmp', clear_temp=True)[source]

Perform setup for writing the movie file.

fig : matplotlib.figure.Figure

The figure to grab the rendered frames from.

outfile : str

The filename of the resulting movie file.

dpi : number, optional

The dpi of the output file. This, with the figure size, controls the size in pixels of the resulting movie file. Default is fig.dpi.

frame_prefix : str, optional

The filename prefix to use for temporary files. Defaults to '_tmp'.

clear_temp : bool, optional

If the temporary files should be deleted after stitching the final result. Setting this to False can be useful for debugging. Defaults to True.