Skip to content

Recording

rerun.recording

class Recording

A single Rerun recording.

This can be loaded from an RRD file using load_recording().

A recording is a collection of data that was logged to Rerun. This data is organized as a column for each index (timeline) and each entity/component pair that was logged.

You can examine the .schema() of the recording to see what data is available.

def application_id()

The application ID of the recording.

def recording_id()

The recording ID of the recording.

def save(path)

Save this recording to an RRD file.

def schema()

The schema describing all the columns available in the recording.

class RRDArchive

An archive loaded from an RRD.

RRD archives may include 1 or more recordings or blueprints.

def all_recordings()

All the recordings in the archive.

def num_recordings()

The number of recordings in the archive.

def load_archive(path_to_rrd)

Load a rerun archive from an RRD file.

PARAMETER DESCRIPTION
path_to_rrd

The path to the file to load.

TYPE: str | Path

RETURNS DESCRIPTION
RRDArchive

The loaded archive.

def load_recording(path_to_rrd)

Load a single recording from an RRD file.

Will raise a ValueError if the file does not contain exactly one recording.

PARAMETER DESCRIPTION
path_to_rrd

The path to the file to load.

TYPE: str | Path

RETURNS DESCRIPTION
Recording

The loaded recording.