You are reading documentation for the unreleased version of Matplotlib. Try searching for the released version of this page instead?
Applications are open for the 2018 John Hunter Matplotlib Summer Fellowship. Apply now!
Version 2.2.2.post1772+gd9240e24b
matplotlib
Fork me on GitHub

matplotlib.animation.FFMpegWriter

class matplotlib.animation.FFMpegWriter(fps=5, codec=None, bitrate=None, extra_args=None, metadata=None)[source]

Pipe-based ffmpeg writer.

Frames are streamed directly to ffmpeg via a pipe and written in a single pass.

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.

__init__(fps=5, codec=None, bitrate=None, extra_args=None, metadata=None)

MovieWriter

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.

Methods

__init__([fps, codec, bitrate, extra_args, ...]) MovieWriter
bin_path() Returns the binary path to the commandline tool used by a specific subclass.
cleanup() Clean-up and collect the process used to write the movie file.
finish() Finish any processing for writing the movie.
grab_frame(**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(fig, outfile, dpi, *args, **kwargs) Context manager to facilitate writing the movie file.
setup(fig, outfile[, dpi]) Perform setup for writing the movie file.

Attributes

args_key
exec_key
frame_size A tuple (width, height) in pixels of a movie frame.
output_args