Plotter.open_movie

Plotter.open_movie(

filename: str | Path,

framerate: int = 24,

quality: int = 5,

**kwargs,

) → None

Establish a connection to the ffmpeg writer.

Requires imageio to be installed.

Parameters:

filenamestr | Path

Filename of the movie to open. Filename should end in mp4, but other filetypes may be supported. See imageio.get_writer().

framerateint, default: 24

Frames per second.

qualityint, default: 5

Quality 10 is the top possible quality for any codec. The range is 0 - 10. Higher quality leads to a larger file.

**kwargsdict, optional

See the documentation for imageio.get_writer() for additional kwargs.

Notes

See the documentation for imageio.get_writer().

Examples

Download Python source code | Download Jupyter notebook

Open a MP4 movie and set the quality to maximum.

>>> import pyvista as pv
>>> pl = pv.Plotter()
>>> pl.open_movie('movie.mp4', quality=10)