matplotlib.animation.HTMLWriter
- classmatplotlib.animation.HTMLWriter(fps=30, codec=None, bitrate=None, extra_args=None, metadata=None, embed_frames=False, default_mode='loop', embed_limit=None)[исходный код]
-
Записывает HTML-видео на основе JavaScript.
- Параметры:
-
- fpsint, default: 5
-
Частота кадров видео (в секунду).
-
codecstr or None, default:
rcParams["animation.codec"](default:'h264') -
Используемый кодек.
-
bitrateint, default:
rcParams["animation.bitrate"](default:-1) -
Битрейт видео в килобитах в секунду. Более высокие значения обеспечивают лучшее качество видео, но увеличивают размер файла. Значение -1 позволяет используемому кодировщику видео выбрать битрейт.
- extra_argslist of str or None, optional
-
Дополнительные аргументы командной строки, передаваемые используемому кодировщику видео. Эти аргументы передаются кодировщику последними, непосредственно перед именем файла. Значение по умолчанию None означает, что для встроенных средств записи используется
rcParams["animation.[name-of-encoder]_args"]. - metadatadict[str, str], default: {}
-
Словарь ключей и значений метаданных, добавляемых в выходной файл. Могут быть полезны следующие ключи: title, artist, genre, subject, copyright, srcform, comment.
- __init__(fps=30, codec=None, bitrate=None, extra_args=None, metadata=None, embed_frames=False, default_mode='loop', embed_limit=None)[исходный код]
-
- Параметры:
-
- fpsint, default: 5
-
Частота кадров видео (в секунду).
-
codecstr or None, default:
rcParams["animation.codec"](default:'h264') -
Используемый кодек.
-
bitrateint, default:
rcParams["animation.bitrate"](default:-1) -
Битрейт видео в килобитах в секунду. Более высокие значения обеспечивают лучшее качество видео, но увеличивают размер файла. Значение -1 позволяет используемому кодировщику видео выбрать битрейт.
- extra_argslist of str or None, optional
-
Дополнительные аргументы командной строки, передаваемые используемому кодировщику видео. Эти аргументы передаются кодировщику последними, непосредственно перед именем файла. Значение по умолчанию None означает, что для встроенных средств записи используется
rcParams["animation.[name-of-encoder]_args"]. - metadatadict[str, str], default: {}
-
Словарь ключей и значений метаданных, добавляемых в выходной файл. Могут быть полезны следующие ключи: title, artist, genre, subject, copyright, srcform, comment.
Методы
__init__([fps, codec, bitrate, extra_args, ...])bin_path()Возвращает путь к исполняемому файлу инструмента командной строки, используемого конкретным подклассом.
finish()Завершает обработку при записи видео.
grab_frame(**savefig_kwargs)Получает данные изображения из рисунка и сохраняет их как кадр видео.
Возвращает, доступен ли подкласс MovieWriter.
saving(fig, outfile, dpi, *args, **kwargs)Менеджер контекста для упрощения записи файла видео.
setup(fig, outfile[, dpi, frame_dir])Настраивает запись файла видео.
Атрибуты
frame_formatФормат (png, jpeg и т. д.), используемый для сохранения кадров; его можно выбрать в отдельных подклассах.
frame_sizeКортеж
(width, height)в пикселях, задающий размер кадра видео.- finish()[исходный код]
-
Завершает обработку при записи видео.
- grab_frame(**savefig_kwargs)[исходный код]
-
Получает данные изображения из рисунка и сохраняет их как кадр видео.
Все именованные аргументы из savefig_kwargs передаются вызову
savefig, который сохраняет рисунок. Однако некоторые именованные аргументы, поддерживаемыеsavefig, передавать нельзя, поскольку ими управляет MovieWriter:-
- dpi, bbox_inches: эти аргументы нельзя передавать, поскольку каждый кадр
-
анимации должен иметь абсолютно одинаковый размер в пикселях.
- format: этим параметром управляет MovieWriter.
-
- classmethodisAvailable()[исходный код]
-
Возвращает, доступен ли подкласс MovieWriter.
- setup(fig, outfile, dpi=None, frame_dir=None)[исходный код]
-
Настраивает запись файла видео.
- Параметры:
-
-
fig
Figure -
Рисунок, из которого будут извлекаться отрисованные кадры.
- outfilestr
-
Имя файла создаваемого видео.
-
dpifloat, default:
fig.dpi -
Разрешение выходного файла в точках на дюйм. Вместе с размером рисунка оно определяет размер создаваемого видео в пикселях.
- frame_prefixstr, optional
-
Префикс имени временных файлов. Если указано None (значение по умолчанию), файлы записываются во временный каталог, который удаляется методом
finish; если указано не None, временные файлы не удаляются.
-
fig
- supported_formats=['png', 'jpeg', 'tiff', 'svg']
© 2012–2026 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.HTMLWriter.html