package rerun.sdk_comms.v1alpha1
Get desktop application:
View/edit binary Protocol Buffers messages
Simple buffer for messages between SDKs and viewers. - SDKs produce messages by calling `WriteMessages` - Viewers consume messages by calling `ReadMessages` The buffer is bounded by a memory limit, and will drop the oldest messages when the limit is reached. Whenever `ReadMessages` is called, all buffered messages are sent in the order they were received. The stream will then also yield any new messages passed to `WriteMessages` from any client.
rpc ReadMessages (, stream )
sdk_comms.proto:21message
sdk_comms.proto:37(message has no fields)
message
sdk_comms.proto:39optional log_msg = 1
rpc ReadTables (, stream )
sdk_comms.proto:24message
sdk_comms.proto:54(message has no fields)
message
sdk_comms.proto:56optional id = 1
optional data = 2
rpc WriteMessages (stream , )
sdk_comms.proto:20TODO(jan): Would it be more efficient to send a "message batch" instead of individual messages? It may allow us to amortize the overhead of the gRPC protocol.
message
sdk_comms.proto:29optional log_msg = 1
message
sdk_comms.proto:33(message has no fields)
rpc WriteTable (, )
sdk_comms.proto:23message
sdk_comms.proto:45optional id = 1
optional data = 2
message
sdk_comms.proto:50(message has no fields)
rpc GetViewerState (, )
viewer.proto:21Returns info about what the viewer is currently showing, so the agent can orient itself via `re_viewer_mcp`
message
viewer.proto:92(message has no fields)
message
viewer.proto:94string url = 1
The current viewer page/route (e.g. which recording or hub page is shown).
optional active_store_id = 2
The active recording, if any.
repeated recordings = 3
Every open recording.
rpc Inspect (, )
viewer.proto:18One `egui_inspection` request/response exchange, used by `re_viewer_mcp` to control the viewer ui.
message
viewer.proto:80bytes request = 1
`egui_inspection` request.
message
viewer.proto:85bytes response = 1
`egui_inspection` response.
rpc OpenUrl (, )
viewer.proto:15Open a URL in the viewer (a recording/blueprint file, a `rerun://` dataset URI, a redap server/catalog URL, or an intra-recording link).
message
viewer.proto:70string url = 1
The URL to open in the viewer. This can be a recording/blueprint file URL, a `rerun://` dataset URI, a redap server/catalog URL, or an intra-recording link.
message
viewer.proto:76(message has no fields)
rpc SaveScreenshot (, )
viewer.proto:8message
viewer.proto:26optional string view_id = 1
Optional view ID to screenshot. If omitted, screenshots the entire viewer.
string file_path = 2
Path at which the screenshot will be saved. This path is relative to the current working directory of the viewer process.
message
viewer.proto:35(message has no fields)
rpc SetTimeCursor (, )
viewer.proto:11Move the time cursor (timeline position) of a recording in the viewer.
message
viewer.proto:39optional store_id = 1
Recording to seek. If omitted, the active recording is used.
optional timeline = 2
Timeline to seek on. If omitted, the active timeline is used.
optional time = 3
Time value to seek to: a sequence index for sequence timelines, or nanoseconds for temporal timelines (see `GetViewerState` for each timeline's type and range).
bool play = 4
If true, start playing the recording from the new position. If false, pause the recording.
message
viewer.proto:54optional store_id = 1
The recording the cursor was moved in (resolved from the request, or the active recording).
optional timeline = 2
The timeline the cursor was moved on (resolved from the request, or the active/first timeline).
common.v1alpha1.TimeType time_type = 3
Timeline type, e.g. `"timestamp"`, `"duration"`, or `"sequence"`.
optional time = 4
The time the cursor was moved to.
message
viewer.proto:129A position on a timeline.
Used in:
optional timeline = 1
optional common.v1alpha1.TimeType time_type = 2
Timeline type. May be absent if the recording is still loading.
optional time = 3
Current time on the timeline. Absent if the cursor is not set.
message
viewer.proto:106One open recording in the viewer.
Used in:
optional store_id = 1
Store id of the recording.
repeated timelines = 2
The recording's timelines with their time ranges.
optional current_time = 3
The recording's current time cursor.
message
viewer.proto:118A timeline of a recording, with its time range.
Used in:
optional timeline = 1
common.v1alpha1.TimeType time_type = 2
Timeline type, e.g. `"timestamp"`, `"duration"`, or `"sequence"`.
optional time_range = 3
The inclusive range of time values present on this timeline. Absent if the timeline has no data yet.