Expand description
Messages generated from proto/dspk_stream.proto (package dspk_stream.v1).
Modules§
- envelope_
frame - Nested message and enum types in
EnvelopeFrame. - request
- Nested message and enum types in
Request. - response
- Nested message and enum types in
Response.
Structs§
- Channel
- One channel: value = stored · gain + offset, in unit.
- Client
Hello - client → server, first message on the control stream.
- Columns
- [min, max] per column, row per requested channel: min_max[2 · (row · width + column)] is the min and the next value the max. NaN where nothing is known yet or every sample is NaN.
- Configure
- A job for the server to run (a sort), checked when configured: the sorter is one the server has, the recording is under the data root, the output is a new .sorting.zarr under it. Configure, Start and Stop need the control permission; one job runs at a time.
- Envelope
Frame - A view’s contents (in Response.envelope).
- Fetch
- Fetch a file under the data root. The answer is a Response with its FileHeader, then the file’s bytes as FileChunk messages on the same stream until it ends. A directory (a .sorting.zarr) is fetched file by file after listing it.
- File
Chunk - File
Entry - File
Header - File
List - GetLogs
- GetStatus
- Header
- What a recording is: the answer to Open, and part of ServerInfo.
- List
Files - List a directory under the data root (“” is the root itself).
- LogLines
- Open
- Open a recording under the data root for this client (its views and signal).
- Ratio
- An exact fraction (sample rates in Hz, times in seconds).
- Request
- client → server, the only message on a request stream.
- Response
- server → client, the answer on a request stream.
- Samples
- The samples themselves (fewer samples than columns), row per requested channel.
- Server
Info - server → client, the answer to ClientHello.
- Signal
Frame - server → client on the signal stream: samples first_sample .. first_sample + samples of every channel, channel-major, stored as Header.format.
- Start
- Status
- The device’s state and its job.
- Stop
- Subscribe
- client → server on the control stream: start the signal stream at sample first_sample.
- View
Request - A view of the open recording: [min, max] columns or samples of some channels.
Enums§
- Device
State - What the server is doing.
- File
Kind - Permission
- What a client may do (from its enrollment).
- Sample
Format - Numeric type of stored samples (little-endian).
- Unit