mini_arcade_core.runtime.capture.replay

Replay recording and playback functionality.

Classes

ReplayRecorderConfig	Configuration for replay recording.
ReplayRecorder	Recorder for game replays.
ReplayPlayer	Player for game replays.

Module Contents

class mini_arcade_core.runtime.capture.replay.ReplayRecorderConfig

Configuration for replay recording.

Variables:

• (Path) (path) – Path to save the replay file.

• (ReplayHeader) (header) – Header information for the replay.

path: pathlib.Path

header: mini_arcade_core.runtime.capture.replay_format.ReplayHeader

class mini_arcade_core.runtime.capture.replay.ReplayRecorder

Recorder for game replays.

property active: bool

Check if the recorder is currently active.

Returns:

True if recording is active, False otherwise.

Return type:

bool

start(cfg: ReplayRecorderConfig) → None

Start recording a replay.

Parameters:

cfg (ReplayRecorderConfig) – Configuration for the replay recorder.

record(frame: mini_arcade_core.runtime.input_frame.InputFrame) → None

Record an input frame to the replay.

Parameters:

frame (InputFrame) – The input frame to record.

stop() → None

Stop recording the current replay.

class mini_arcade_core.runtime.capture.replay.ReplayPlayer

Player for game replays.

header: mini_arcade_core.runtime.capture.replay_format.ReplayHeader | None = None

property active: bool

Check if the player is currently active.

Returns:

True if a replay is being played, False otherwise.

Return type:

bool

start(path: pathlib.Path) → mini_arcade_core.runtime.capture.replay_format.ReplayHeader

Start playing back a replay.

Parameters:

path (Path) – Path to the replay file.

Returns:

The header information of the replay.

Return type:

ReplayHeader

next() → mini_arcade_core.runtime.input_frame.InputFrame

Get the next input frame from the replay.

Returns:

The next input frame.

Return type:

InputFrame

stop() → None

Stop playing back the current replay.