.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_gallery/misc/record_video.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download__gallery_misc_record_video.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr__gallery_misc_record_video.py:


Record Video
============

Example showing how to record a Figure to a video file. The recording includes everything
drawn in the canvas, including the toolbar and any other UI.

Recording can also be started and stopped with the record button in the subplot toolbar.
Videos are saved as ``fastplotlib_<date>_<time>.mp4`` in the current working directory
unless a ``path`` is given. Recording requires ``av``: ``pip install av``

.. GENERATED FROM PYTHON SOURCE LINES 12-52

.. code-block:: Python


    # test_example = false

    import fastplotlib as fpl
    import numpy as np

    # number of frames to record
    n_frames = 300

    xs = np.linspace(0, 4 * np.pi, 200)
    ys = np.sin(xs)

    figure = fpl.Figure(size=(700, 560))

    sine = figure[0, 0].add_line(np.column_stack([xs, ys]), thickness=5, cmap="viridis")

    i = 0
    def update_line(subplot):
        global i

        # shift the sine wave
        sine.data[:, 1] = np.sin(xs + i * 0.05)

        # stop recording after n_frames, the video file is saved when recording stops
        i += 1
        if i == n_frames:
            figure.stop_recording()

    figure[0, 0].add_animations(update_line)

    figure.show()

    # start recording, every rendered frame is written to the video until stop_recording() is called
    figure.start_recording("sine_wave.mp4")


    # NOTE: fpl.loop.run() should not be used for interactive sessions
    # See the "JupyterLab and IPython" section in the user guide
    if __name__ == "__main__":
        print(__doc__)
        fpl.loop.run()

.. _sphx_glr_download__gallery_misc_record_video.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: record_video.py <record_video.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: record_video.zip <record_video.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_