Skip to content

Define how an in-place stream/start treats buffered visualizer data #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maximmaxim345 merged 1 commit into from
Oct 20, 2026
Merged

Define how an in-place stream/start treats buffered visualizer data #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1755,7 +1755,7 @@ The `visualizer@v1_support` object in [`client/hello`](#client--server-clienthel
- `visualizer@v1_support`: object
- `buffer_capacity`: integer - max total size in bytes of buffered visualizer binary messages, counting only each reassembled message's type byte, timestamp, and data

The server MUST NOT send a message if its size plus the total size of previously sent visualizer messages with future timestamps on the server's clock would exceed `buffer_capacity`. Sending a visualizer `stream/clear` or `stream/end` resets this count.
The server MUST NOT send a message if its size plus the total size of previously sent visualizer messages with future timestamps on the server's clock would exceed `buffer_capacity`. Sending a visualizer `stream/clear` or `stream/end` resets this count. An in-place `stream/start` does not.

The requested data types, frame-rate cap, and spectrum configuration are dynamic and reported in the [`client/state`](#client--server-clientstate-visualizer-object) visualizer object.

Expand Down Expand Up @@ -1790,6 +1790,8 @@ The `visualizer` object in [`stream/start`](#server--client-streamstart) has thi
- `f_min`: integer - lowest frequency in Hz
- `f_max`: integer - highest frequency in Hz

When the `visualizer` object updates an active stream, frames sent before this message use the previous configuration and frames sent after it use the new configuration. Clients MUST keep buffered frames and interpret each frame under the configuration in effect when it was received.

### Server → Client: `stream/clear` visualizer

When [`stream/clear`](#server--client-streamclear) includes the visualizer role, clients MUST clear all buffered visualization data and continue with data received after this message.
Expand Down
4 changes: 3 additions & 1 deletion roles/visualizer/v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The `visualizer@v1_support` object in [`client/hello`](../../messaging.md#client
- `visualizer@v1_support`: object
- `buffer_capacity`: integer - max total size in bytes of buffered visualizer binary messages, counting only each reassembled message's type byte, timestamp, and data

The server MUST NOT send a message if its size plus the total size of previously sent visualizer messages with future timestamps on the server's clock would exceed `buffer_capacity`. Sending a visualizer `stream/clear` or `stream/end` resets this count.
The server MUST NOT send a message if its size plus the total size of previously sent visualizer messages with future timestamps on the server's clock would exceed `buffer_capacity`. Sending a visualizer `stream/clear` or `stream/end` resets this count. An in-place `stream/start` does not.

The requested data types, frame-rate cap, and spectrum configuration are dynamic and reported in the [`client/state`](#client--server-clientstate-visualizer-object) visualizer object.

Expand Down Expand Up @@ -49,6 +49,8 @@ The `visualizer` object in [`stream/start`](../../messaging.md#server--client-st
- `f_min`: integer - lowest frequency in Hz
- `f_max`: integer - highest frequency in Hz

When the `visualizer` object updates an active stream, frames sent before this message use the previous configuration and frames sent after it use the new configuration. Clients MUST keep buffered frames and interpret each frame under the configuration in effect when it was received.

### Server → Client: `stream/clear` visualizer

When [`stream/clear`](../../messaging.md#server--client-streamclear) includes the visualizer role, clients MUST clear all buffered visualization data and continue with data received after this message.
Expand Down
Loading