recording.py
rerun.recording
Helper functions for directly working with recordings.
class MemoryRecording(storage)
def reset_data()
Reset the data in the MemoryRecording.
def reset_blueprint(add_to_app_default_blueprint=False)
Reset the blueprint in the MemoryRecording.
def as_html(width=DEFAULT_WIDTH, height=DEFAULT_HEIGHT, app_url=None, timeout_ms=DEFAULT_TIMEOUT, other=None)
Generate an HTML snippet that displays the recording in an IFrame.
For use in contexts such as Jupyter notebooks.
⚠️ This will do a blocking flush of the current sink before returning!
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
width |
int
|
The width of the viewer in pixels. |
DEFAULT_WIDTH
|
height |
int
|
The height of the viewer in pixels. |
DEFAULT_HEIGHT
|
app_url |
str
|
Alternative HTTP url to find the Rerun web viewer. This will default to using https://app.rerun.io or localhost if rerun.start_web_viewer_server has been called. |
None
|
timeout_ms |
int
|
The number of milliseconds to wait for the Rerun web viewer to load. |
DEFAULT_TIMEOUT
|
other |
MemoryRecording | None
|
An optional MemoryRecording to merge with this one. |
None
|
def show(other=None, width=DEFAULT_WIDTH, height=DEFAULT_HEIGHT, app_url=None, timeout_ms=DEFAULT_TIMEOUT)
Output the Rerun viewer using IPython IPython.core.display.HTML.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
width |
int
|
The width of the viewer in pixels. |
DEFAULT_WIDTH
|
height |
int
|
The height of the viewer in pixels. |
DEFAULT_HEIGHT
|
app_url |
str
|
Alternative HTTP url to find the Rerun web viewer. This will default to using https://app.rerun.io or localhost if rerun.start_web_viewer_server has been called. |
None
|
timeout_ms |
int
|
The number of milliseconds to wait for the Rerun web viewer to load. |
DEFAULT_TIMEOUT
|
other |
MemoryRecording | None
|
An optional MemoryRecording to merge with this one. |
None
|