Skip to content

Property functions

rerun

def send_property(name, values, recording=None)

Send a property of the recording.

PARAMETER DESCRIPTION
name

Name of the property.

TYPE: str

values

Anything that implements the rerun.AsComponents interface, usually an archetype, or an iterable of (described)component batches.

TYPE: AsComponents | Iterable[DescribedComponentBatch]

recording

Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.

TYPE: RecordingStream | None DEFAULT: None

def send_recording_name(name, recording=None)

Send the name of the recording.

This name is shown in the Rerun Viewer.

PARAMETER DESCRIPTION
name

The name of the recording.

TYPE: str

recording

Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.

TYPE: RecordingStream | None DEFAULT: None

def send_recording_start_time_nanos(nanos, recording=None)

Send the start time of the recording.

This timestamp is shown in the Rerun Viewer.

PARAMETER DESCRIPTION
nanos

The start time of the recording in nanoseconds since UNIX epoch.

TYPE: int

recording

Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.

TYPE: RecordingStream | None DEFAULT: None