matplotlib.animation.FFMpegFileWriter

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

File-based ffmpeg writer.

Frames are written to temporary files on disk and then stitched together at the end.

Parameters:

Parameters:	`fpsint, default: 5` Movie frame rate (per second). `codecstr or None, default: rcParams["animation.codec"] (default: 'h264')` The codec to use. `bitrateint, default: rcParams["animation.bitrate"] (default: -1)` The bitrate of the movie, in kilobits per second. Higher values means higher quality movies, but increase the file size. A value of -1 lets the underlying movie encoder select the bitrate. `extra_argslist of str or None, optional` Extra command-line arguments passed to the underlying movie encoder. The default, None, means to use `rcParams["animation.[name-of-encoder]_args"]` for the builtin writers. `metadataDict[str, str], default: {}` 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.

fpsint, default: 5: Movie frame rate (per second).
codecstr or None, default: rcParams["animation.codec"] (default: 'h264'): The codec to use.
bitrateint, default: rcParams["animation.bitrate"] (default: -1): The bitrate of the movie, in kilobits per second. Higher values means higher quality movies, but increase the file size. A value of -1 lets the underlying movie encoder select the bitrate.
extra_argslist of str or None, optional: Extra command-line arguments passed to the underlying movie encoder. The default, None, means to use rcParams["animation.[name-of-encoder]_args"] for the builtin writers.
metadataDict[str, str], default: {}: 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)

Parameters:

Parameters:	`fpsint, default: 5` Movie frame rate (per second). `codecstr or None, default: rcParams["animation.codec"] (default: 'h264')` The codec to use. `bitrateint, default: rcParams["animation.bitrate"] (default: -1)` The bitrate of the movie, in kilobits per second. Higher values means higher quality movies, but increase the file size. A value of -1 lets the underlying movie encoder select the bitrate. `extra_argslist of str or None, optional` Extra command-line arguments passed to the underlying movie encoder. The default, None, means to use `rcParams["animation.[name-of-encoder]_args"]` for the builtin writers. `metadataDict[str, str], default: {}` 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.

fpsint, default: 5: Movie frame rate (per second).
codecstr or None, default: rcParams["animation.codec"] (default: 'h264'): The codec to use.
bitrateint, default: rcParams["animation.bitrate"] (default: -1): The bitrate of the movie, in kilobits per second. Higher values means higher quality movies, but increase the file size. A value of -1 lets the underlying movie encoder select the bitrate.
extra_argslist of str or None, optional: Extra command-line arguments passed to the underlying movie encoder. The default, None, means to use rcParams["animation.[name-of-encoder]_args"] for the builtin writers.
metadataDict[str, str], default: {}: 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)

Parameters:

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() Return whether a MovieWriter subclass is actually available.

saving(self, fig, outfile, dpi, *args, **kwargs) Context manager to facilitate writing the movie file.

setup(self, fig, outfile[, dpi, ...]) Setup for writing the movie file.

`args_key`
`clear_temp`
`exec_key`
`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.
`output_args`
`supported_formats`

supported_formats = ['png', 'jpeg', 'ppm', 'tiff', 'sgi', 'bmp', 'pbm', 'raw', 'rgba']