zen_api/acquisition/v1beta/experiment_streaming_service.proto#
Version: 2026.5.1
Package: zen_api.acquisition.v1beta
Service ExperimentStreamingService#
The IExperimentStreamingService interface.
MonitorAllExperiments#
Starts monitoring all experiments.
rpc MonitorAllExperiments (zen_api.acquisition.v1beta.ExperimentStreamingServiceMonitorAllExperimentsRequest) returns (stream zen_api.acquisition.v1beta.ExperimentStreamingServiceMonitorAllExperimentsResponse);
Request: zen_api.acquisition.v1beta.ExperimentStreamingServiceMonitorAllExperimentsRequest
Response: zen_api.acquisition.v1beta.ExperimentStreamingServiceMonitorAllExperimentsResponse
MonitorExperiment#
Starts monitoring the specified experiment.
rpc MonitorExperiment (zen_api.acquisition.v1beta.ExperimentStreamingServiceMonitorExperimentRequest) returns (stream zen_api.acquisition.v1beta.ExperimentStreamingServiceMonitorExperimentResponse);
Request: zen_api.acquisition.v1beta.ExperimentStreamingServiceMonitorExperimentRequest
Response: zen_api.acquisition.v1beta.ExperimentStreamingServiceMonitorExperimentResponse
Message ExperimentStreamingServiceMonitorAllExperimentsRequest#
The ExperimentStreamingServiceMonitorAllExperimentsRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
channel_index |
1 | google.protobuf.Int32Value |
singular | Optional parameter for filtering by specific channel. If the channel index is provided, then only that channel will be monitored, but if the channel index is not provided, then all channels will be monitored. |
enable_raw_data |
2 | bool |
singular | Value indicating whether the streamed frame data contains raw frames as received from the acquisition (when set), which can be either full or partial frames (e.g., in general LM cameras produce full frames and LSM and EM detectors produce partial frames/lines). Otherwise (when not set) the streamed frame data contains only full frames, which means that in the case of partial frames/lines, they would be assembled into full frames. |
Message ExperimentStreamingServiceMonitorAllExperimentsResponse#
Response object of the method for monitoring all experiments.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
frame_data |
1 | zen_api.acquisition.v1beta.FrameData | singular | The experiment's frame data. |
Message ExperimentStreamingServiceMonitorExperimentRequest#
The ExperimentStreamingServiceMonitorExperimentRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | ID of the experiment to monitor. |
channel_index |
2 | google.protobuf.Int32Value |
singular | Optional parameter for filtering by specific channel. If the channel index is provided, then only that channel will be monitored, but if the channel index is not provided, then all channels will be monitored. |
enable_raw_data |
3 | bool |
singular | Value indicating whether the streamed frame data contains raw frames as received from the acquisition (when set), which can be either full or partial frames (e.g., in general LM cameras produce full frames and LSM and EM detectors produce partial frames/lines). Otherwise (when not set) the streamed frame data contains only full frames, which means that in the case of partial frames/lines, they would be assembled into full frames. |
Message ExperimentStreamingServiceMonitorExperimentResponse#
Response object of the method for monitoring an experiment.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
frame_data |
1 | zen_api.acquisition.v1beta.FrameData | singular | The experiment's frame data. |