sinks.py
rerun.sinks
def connect(addr=None, recording=None)
Connect to a remote Rerun Viewer on the given ip:port.
Requires that you first start a Rerun Viewer, e.g. with 'python -m rerun'
This function returns immediately.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
addr |
Optional[str]
|
The ip:port to connect to |
None
|
recording |
Optional[RecordingStream]
|
Specifies the |
None
|
def save(path, recording=None)
Stream all log-data to a file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path |
str
|
The path to save the data to. |
required |
recording |
Optional[RecordingStream]
|
Specifies the |
None
|
def disconnect(recording=None)
Closes all TCP connections, servers, and files.
Closes all TCP connections, servers, and files that have been opened with
[rerun.connect], [rerun.serve], [rerun.save] or [rerun.spawn].
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recording |
Optional[RecordingStream]
|
Specifies the |
None
|
def memory_recording(recording=None)
Streams all log-data to a memory buffer.
This can be used to display the RRD to alternative formats such as html. See: [rerun.MemoryRecording.as_html][].
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
recording |
Optional[RecordingStream]
|
Specifies the |
None
|
Returns:
| Type | Description |
|---|---|
MemoryRecording
|
A memory recording object that can be used to read the data. |
def serve(open_browser=True, web_port=None, ws_port=None, recording=None)
Serve log-data over WebSockets and serve a Rerun web viewer over HTTP.
You can connect to this server using python -m rerun.
WARNING: This is an experimental feature.
This function returns immediately.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
open_browser |
bool
|
Open the default browser to the viewer. |
True
|
web_port |
Optional[int]
|
The port to serve the web viewer on (defaults to 9090). |
None
|
ws_port |
Optional[int]
|
The port to serve the WebSocket server on (defaults to 9877) |
None
|
recording |
Optional[RecordingStream]
|
Specifies the |
None
|
def spawn(port=9876, connect=True, recording=None)
Spawn a Rerun Viewer, listening on the given port.
This is often the easiest and best way to use Rerun. Just call this once at the start of your program.
You can also call rerun.init with a spawn=True argument.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
port |
int
|
The port to listen on. |
9876
|
connect |
bool
|
also connect to the viewer and stream logging data to it. |
True
|
recording |
Optional[RecordingStream]
|
Specifies the |
None
|