matplotlib.animation.FileMovieWriter

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

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

This must be sub-classed to be useful.

__init__(self, *args, **kwargs) [source]

MovieWriter

Parameters:

Parameters:	`fps : int` Framerate for movie. `codec : string or None, optional` The codec to use. If `None` (the default) the `animation.codec` rcParam is used. `bitrate : int or None, optional` The bitrate for the saved movie file, which is one way to control the output file size and quality. The default value is `None`, which uses the `animation.bitrate` rcParam. A value of -1 implies that the bitrate should be determined automatically by the underlying utility. `extra_args : list of strings or None, optional` A list of extra string arguments to be passed to the underlying movie utility. The default is `None`, which passes the additional arguments in the `animation.extra_args` rcParam. `metadata : Dict[str, str] or None` A dictionary of keys and values for metadata to include in the output file. Some keys that may be of use include: title, artist, genre, subject, copyright, srcform, comment.

fps : int: Framerate for movie.
codec : string or None, optional: The codec to use. If None (the default) the animation.codec rcParam is used.
bitrate : int or None, optional: The bitrate for the saved movie file, which is one way to control the output file size and quality. The default value is None, which uses the animation.bitrate rcParam. A value of -1 implies that the bitrate should be determined automatically by the underlying utility.
extra_args : list of strings or None, optional: A list of extra string arguments to be passed to the underlying movie utility. The default is None, which passes the additional arguments in the animation.extra_args rcParam.
metadata : Dict[str, str] or None: A dictionary of keys and values for metadata to include in the output file. Some keys that may be of use include: title, artist, genre, subject, copyright, srcform, comment.

`__init__`(self, \args, \\*kwargs)	MovieWriter
`bin_path`()	Return the binary path to the commandline tool used by a specific subclass.
`cleanup`(self)	Clean-up and collect the process used to write the movie file.
`finish`(self)	Finish any processing for writing the movie.
`grab_frame`(self, \\savefig_kwargs)	Grab the image information from the figure and save as a movie frame.
`isAvailable`()	Check to see if a MovieWriter subclass is actually available.
`saving`(self, fig, outfile, dpi, \*args, ...)	Context manager to facilitate writing the movie file.
`setup`(self, fig, outfile[, dpi, ...])	Perform setup for writing the movie file.

`frame_format`	Format (png, jpeg, etc.) to use for saving the frames, which can be decided by the individual subclasses.
`frame_size`	A tuple `(width, height)` in pixels of a movie frame.

cleanup(self) [source]: Clean-up and collect the process used to write the movie file.

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

grab_frame(self, **savefig_kwargs) [source]: 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.

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

Perform setup for writing the movie file.

Parameters:

Parameters:	`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`.

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.