mini_arcade_core.runtime.capture.replay
=======================================

.. py:module:: mini_arcade_core.runtime.capture.replay

.. autoapi-nested-parse::

   Replay recording and playback functionality.



Classes
-------

.. autoapisummary::

   mini_arcade_core.runtime.capture.replay.ReplayRecorderConfig
   mini_arcade_core.runtime.capture.replay.ReplayRecorder
   mini_arcade_core.runtime.capture.replay.ReplayPlayer


Module Contents
---------------

.. py:class:: ReplayRecorderConfig

   Configuration for replay recording.

   :ivar path (Path): Path to save the replay file.
   :ivar header (ReplayHeader): Header information for the replay.


   .. py:attribute:: path
      :type:  pathlib.Path


   .. py:attribute:: header
      :type:  mini_arcade_core.runtime.capture.replay_format.ReplayHeader


.. py:class:: ReplayRecorder

   Recorder for game replays.


   .. py:property:: active
      :type: bool


      Check if the recorder is currently active.

      :return: True if recording is active, False otherwise.
      :rtype: bool


   .. py:method:: start(cfg: ReplayRecorderConfig) -> None

      Start recording a replay.

      :param cfg: Configuration for the replay recorder.
      :type cfg: ReplayRecorderConfig



   .. py:method:: record(frame: mini_arcade_core.runtime.input_frame.InputFrame) -> None

      Record an input frame to the replay.

      :param frame: The input frame to record.
      :type frame: InputFrame



   .. py:method:: stop() -> None

      Stop recording the current replay.



.. py:class:: ReplayPlayer

   Player for game replays.


   .. py:attribute:: header
      :type:  Optional[mini_arcade_core.runtime.capture.replay_format.ReplayHeader]
      :value: None



   .. py:property:: active
      :type: bool


      Check if the player is currently active.

      :return: True if a replay is being played, False otherwise.
      :rtype: bool


   .. py:method:: start(path: pathlib.Path) -> mini_arcade_core.runtime.capture.replay_format.ReplayHeader

      Start playing back a replay.

      :param path: Path to the replay file.
      :type path: Path
      :return: The header information of the replay.
      :rtype: ReplayHeader



   .. py:method:: next() -> mini_arcade_core.runtime.input_frame.InputFrame

      Get the next input frame from the replay.

      :return: The next input frame.
      :rtype: InputFrame



   .. py:method:: stop() -> None

      Stop playing back the current replay.