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

.. only:: html

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

        Click :ref:`here <sphx_glr_download_auto_examples_online_3_record.py>`
        to download the full example code

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

.. _sphx_glr_auto_examples_online_3_record.py:


.. _recording_example:

Record from connected devices
=============================

This example shows how to record video streams from a connected Pupil Core
headset.

.. note::

    This example requires the dependencies for
    :ref:`streaming<streaming_dependencies>` and
    :ref:`recording<recording_dependencies>`.


.. GENERATED FROM PYTHON SOURCE LINES 17-24

.. code-block:: default

    import sys
    import logging
    import datetime

    import pupil_recording_interface as pri



.. GENERATED FROM PYTHON SOURCE LINES 25-29

Set Pupil Core generation
-------------------------

Set the generation of your Pupil Core device (1, 2 or 3)

.. GENERATED FROM PYTHON SOURCE LINES 29-31

.. code-block:: default

    pupil_gen = 2


.. GENERATED FROM PYTHON SOURCE LINES 32-34

Set recording folder
--------------------

.. GENERATED FROM PYTHON SOURCE LINES 34-36

.. code-block:: default

    folder = f"~/recordings/{datetime.datetime.today():%Y_%m_%d}"


.. GENERATED FROM PYTHON SOURCE LINES 37-39

Set up stream configurations
----------------------------

.. GENERATED FROM PYTHON SOURCE LINES 39-71

.. code-block:: default

    configs = [
        pri.VideoStream.Config(
            device_type="uvc",
            device_uid=f"Pupil Cam{pupil_gen} ID2",
            name="world",
            resolution=(1280, 720),
            fps=30,
            pipeline=[pri.VideoRecorder.Config(), pri.VideoDisplay.Config()],
        ),
        pri.VideoStream.Config(
            device_type="uvc",
            device_uid=f"Pupil Cam{pupil_gen} ID0",
            name="eye0",
            resolution=(320, 240) if pupil_gen == 1 else (192, 192),
            fps=120,
            color_format="gray",
            pipeline=[
                pri.VideoRecorder.Config(),
                pri.VideoDisplay.Config(flip=True),
            ],
        ),
        pri.VideoStream.Config(
            device_type="uvc",
            device_uid=f"Pupil Cam{pupil_gen} ID1",
            name="eye1",
            resolution=(320, 240) if pupil_gen == 1 else (192, 192),
            fps=120,
            color_format="gray",
            pipeline=[pri.VideoRecorder.Config(), pri.VideoDisplay.Config()],
        ),
    ]


.. GENERATED FROM PYTHON SOURCE LINES 72-74

Set up logger
-------------

.. GENERATED FROM PYTHON SOURCE LINES 74-78

.. code-block:: default

    logging.basicConfig(
        stream=sys.stdout, level=logging.INFO, format="%(message)s"
    )


.. GENERATED FROM PYTHON SOURCE LINES 79-87

Run manager
-----------

.. note::

    When running the script from the command line, press 'Ctrl+C' to stop the
    manager. When running from a Jupyter notebook, interrupt the kernel
    (*Kernel > Interrupt Kernel* or press 'Esc' and then twice 'i').

.. GENERATED FROM PYTHON SOURCE LINES 87-96

.. code-block:: default

    with pri.StreamManager(configs, folder) as manager:
        while not manager.stopped:
            if manager.all_streams_running:
                status = manager.format_status(
                    "fps", format="{:.2f} Hz", max_cols=72, sleep=0.1
                )
                print("\r" + status, end="")

    print("\nStopped")


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  0.000 seconds)


.. _sphx_glr_download_auto_examples_online_3_record.py:


.. only :: html

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



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

     :download:`Download Python source code: 3_record.py <3_record.py>`



  .. container:: sphx-glr-download sphx-glr-download-jupyter

     :download:`Download Jupyter notebook: 3_record.ipynb <3_record.ipynb>`


.. only:: html

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

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