zen_api/em/hardware/v1/camera_service.proto

Version: 2026.5.1

Package: zen_api.em.hardware.v1

Download proto source

Service CameraService

The ICameraService interface.

GetAcquisitionStatus

Gets the acquisition status for the specified camera.

rpc GetAcquisitionStatus (zen_api.em.hardware.v1.CameraServiceGetAcquisitionStatusRequest) returns (zen_api.em.hardware.v1.CameraServiceGetAcquisitionStatusResponse);

Request: zen_api.em.hardware.v1.CameraServiceGetAcquisitionStatusRequest

Response: zen_api.em.hardware.v1.CameraServiceGetAcquisitionStatusResponse

GetAvailableCameras

Gets the available cameras/

rpc GetAvailableCameras (zen_api.em.hardware.v1.CameraServiceGetAvailableCamerasRequest) returns (zen_api.em.hardware.v1.CameraServiceGetAvailableCamerasResponse);

Request: zen_api.em.hardware.v1.CameraServiceGetAvailableCamerasRequest

Response: zen_api.em.hardware.v1.CameraServiceGetAvailableCamerasResponse

GetBrightness

Gets the brightness for the specified camera.

rpc GetBrightness (zen_api.em.hardware.v1.CameraServiceGetBrightnessRequest) returns (zen_api.em.hardware.v1.CameraServiceGetBrightnessResponse);

Request: zen_api.em.hardware.v1.CameraServiceGetBrightnessRequest

Response: zen_api.em.hardware.v1.CameraServiceGetBrightnessResponse

GetCcdMode

Gets the CCD mode for the specified camera.

rpc GetCcdMode (zen_api.em.hardware.v1.CameraServiceGetCcdModeRequest) returns (zen_api.em.hardware.v1.CameraServiceGetCcdModeResponse);

Request: zen_api.em.hardware.v1.CameraServiceGetCcdModeRequest

Response: zen_api.em.hardware.v1.CameraServiceGetCcdModeResponse

GetContrast

Gets the contrast for the specified camera.

rpc GetContrast (zen_api.em.hardware.v1.CameraServiceGetContrastRequest) returns (zen_api.em.hardware.v1.CameraServiceGetContrastResponse);

Request: zen_api.em.hardware.v1.CameraServiceGetContrastRequest

Response: zen_api.em.hardware.v1.CameraServiceGetContrastResponse

RegisterOnAcquisitionStatusChanged

Registers a subscriber on acquisition status changes for the specified camera.

rpc RegisterOnAcquisitionStatusChanged (zen_api.em.hardware.v1.CameraServiceRegisterOnAcquisitionStatusChangedRequest) returns (stream zen_api.em.hardware.v1.CameraServiceRegisterOnAcquisitionStatusChangedResponse);

Request: zen_api.em.hardware.v1.CameraServiceRegisterOnAcquisitionStatusChangedRequest

Response: zen_api.em.hardware.v1.CameraServiceRegisterOnAcquisitionStatusChangedResponse

RegisterOnBrightnessChanged

Registers a subscriber on brightness changes for the specified camera.

rpc RegisterOnBrightnessChanged (zen_api.em.hardware.v1.CameraServiceRegisterOnBrightnessChangedRequest) returns (stream zen_api.em.hardware.v1.CameraServiceRegisterOnBrightnessChangedResponse);

Request: zen_api.em.hardware.v1.CameraServiceRegisterOnBrightnessChangedRequest

Response: zen_api.em.hardware.v1.CameraServiceRegisterOnBrightnessChangedResponse

RegisterOnCcdModeChanged

Registers a subscriber on CCD mode changes for the specified camera.

rpc RegisterOnCcdModeChanged (zen_api.em.hardware.v1.CameraServiceRegisterOnCcdModeChangedRequest) returns (stream zen_api.em.hardware.v1.CameraServiceRegisterOnCcdModeChangedResponse);

Request: zen_api.em.hardware.v1.CameraServiceRegisterOnCcdModeChangedRequest

Response: zen_api.em.hardware.v1.CameraServiceRegisterOnCcdModeChangedResponse

RegisterOnContrastChanged

Registers a subscriber on contrast changes for the specified camera.

rpc RegisterOnContrastChanged (zen_api.em.hardware.v1.CameraServiceRegisterOnContrastChangedRequest) returns (stream zen_api.em.hardware.v1.CameraServiceRegisterOnContrastChangedResponse);

Request: zen_api.em.hardware.v1.CameraServiceRegisterOnContrastChangedRequest

Response: zen_api.em.hardware.v1.CameraServiceRegisterOnContrastChangedResponse

SetBrightness

Sets the brightness for the specified camera.

rpc SetBrightness (zen_api.em.hardware.v1.CameraServiceSetBrightnessRequest) returns (zen_api.em.hardware.v1.CameraServiceSetBrightnessResponse);

Request: zen_api.em.hardware.v1.CameraServiceSetBrightnessRequest

Response: zen_api.em.hardware.v1.CameraServiceSetBrightnessResponse

SetCcdMode

Sets the CCD mode for the specified camera.

rpc SetCcdMode (zen_api.em.hardware.v1.CameraServiceSetCcdModeRequest) returns (zen_api.em.hardware.v1.CameraServiceSetCcdModeResponse);

Request: zen_api.em.hardware.v1.CameraServiceSetCcdModeRequest

Response: zen_api.em.hardware.v1.CameraServiceSetCcdModeResponse

SetContrast

Sets the contrast for the specified camera.

rpc SetContrast (zen_api.em.hardware.v1.CameraServiceSetContrastRequest) returns (zen_api.em.hardware.v1.CameraServiceSetContrastResponse);

Request: zen_api.em.hardware.v1.CameraServiceSetContrastRequest

Response: zen_api.em.hardware.v1.CameraServiceSetContrastResponse

StartLiveAcquisition

Starts a live acquisition with the given settings.

rpc StartLiveAcquisition (zen_api.em.hardware.v1.CameraServiceStartLiveAcquisitionRequest) returns (stream zen_api.em.hardware.v1.CameraServiceStartLiveAcquisitionResponse);

Request: zen_api.em.hardware.v1.CameraServiceStartLiveAcquisitionRequest

Response: zen_api.em.hardware.v1.CameraServiceStartLiveAcquisitionResponse

StartSingleAcquisition

Starts a single frame acquisition for the specified camera. The image is streamed to the same destination as live acquisition.

rpc StartSingleAcquisition (zen_api.em.hardware.v1.CameraServiceStartSingleAcquisitionRequest) returns (stream zen_api.em.hardware.v1.CameraServiceStartSingleAcquisitionResponse);

Request: zen_api.em.hardware.v1.CameraServiceStartSingleAcquisitionRequest

Response: zen_api.em.hardware.v1.CameraServiceStartSingleAcquisitionResponse

StopLiveAcquisition

Stops any ongoing live acquisition. Only has an effect if ZenApi.EM.Hardware.V1.ICameraApi.GetAcquisitionStatus(System.String) returns ZenApi.EM.Hardware.V1.AcquisitionStatus.LiveRunning.

rpc StopLiveAcquisition (zen_api.em.hardware.v1.CameraServiceStopLiveAcquisitionRequest) returns (zen_api.em.hardware.v1.CameraServiceStopLiveAcquisitionResponse);

Request: zen_api.em.hardware.v1.CameraServiceStopLiveAcquisitionRequest

Response: zen_api.em.hardware.v1.CameraServiceStopLiveAcquisitionResponse

Message CameraServiceGetAcquisitionStatusRequest

The CameraServiceGetAcquisitionStatusRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.

Message CameraServiceGetAcquisitionStatusResponse

Response object for the get acquisition state.

Field	Number	Type	Presence	Description
status	1	zen_api.em.hardware.v1.CameraAcquisitionStatus	singular	The acquisition status.
message	2	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceGetAvailableCamerasRequest

The CameraServiceGetAvailableCamerasRequest class.

Message CameraServiceGetAvailableCamerasResponse

Response object representing a list of available cameras.

Field	Number	Type	Presence	Description
camera_names	1	string	repeated	The available cameras on the system.

Message CameraServiceGetBrightnessRequest

The CameraServiceGetBrightnessRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.

Message CameraServiceGetBrightnessResponse

Response object for the get brightness.

Field	Number	Type	Presence	Description
brightness	1	double	singular	The brightness.
message	2	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceGetCcdModeRequest

The CameraServiceGetCcdModeRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.

Message CameraServiceGetCcdModeResponse

Response object for the get CCD mode.

Field	Number	Type	Presence	Description
mode	1	zen_api.em.hardware.v1.CcdMode	singular	The CCD mode.
message	2	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceGetContrastRequest

The CameraServiceGetContrastRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.

Message CameraServiceGetContrastResponse

Response object for the get contrast.

Field	Number	Type	Presence	Description
contrast	1	double	singular	The contrast.
message	2	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceRegisterOnAcquisitionStatusChangedRequest

The CameraServiceRegisterOnAcquisitionStatusChangedRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.

Message CameraServiceRegisterOnAcquisitionStatusChangedResponse

Response object for the get acquisition state.

Field	Number	Type	Presence	Description
status	1	zen_api.em.hardware.v1.CameraAcquisitionStatus	singular	The acquisition status.
message	2	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceRegisterOnBrightnessChangedRequest

The CameraServiceRegisterOnBrightnessChangedRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.

Message CameraServiceRegisterOnBrightnessChangedResponse

Response object for the get brightness.

Field	Number	Type	Presence	Description
brightness	1	double	singular	The brightness.
message	2	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceRegisterOnCcdModeChangedRequest

The CameraServiceRegisterOnCcdModeChangedRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.

Message CameraServiceRegisterOnCcdModeChangedResponse

Response object for the get CCD mode.

Field	Number	Type	Presence	Description
mode	1	zen_api.em.hardware.v1.CcdMode	singular	The CCD mode.
message	2	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceRegisterOnContrastChangedRequest

The CameraServiceRegisterOnContrastChangedRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.

Message CameraServiceRegisterOnContrastChangedResponse

Response object for the get contrast.

Field	Number	Type	Presence	Description
contrast	1	double	singular	The contrast.
message	2	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceSetBrightnessRequest

The CameraServiceSetBrightnessRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.
brightness	2	double	singular	The brightness to set[0..100]%.

Message CameraServiceSetBrightnessResponse

Response object for the set brightness.

Field	Number	Type	Presence	Description
brightness	1	double	singular	The brightness.
success	2	bool	singular	A value indicating whether setting the brightness was successful.
message	3	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceSetCcdModeRequest

The CameraServiceSetCcdModeRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.
mode	2	zen_api.em.hardware.v1.CcdMode	singular	The CCD mode to set.

Message CameraServiceSetCcdModeResponse

Response object for the set CCD mode.

Field	Number	Type	Presence	Description
mode	1	zen_api.em.hardware.v1.CcdMode	singular	The CCD mode.
success	2	bool	singular	A value indicating whether setting the CCD mode was successful.
message	3	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceSetContrastRequest

The CameraServiceSetContrastRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.
contrast	2	double	singular	The contrast to set[0..100]%.

Message CameraServiceSetContrastResponse

Response object for the set contrast.

Field	Number	Type	Presence	Description
contrast	1	double	singular	The contrast.
success	2	bool	singular	A value indicating whether setting the contrast was successful.
message	3	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

Message CameraServiceStartLiveAcquisitionRequest

The CameraServiceStartLiveAcquisitionRequest class.

Field	Number	Type	Presence	Description
settings	1	zen_api.em.hardware.v1.CameraAcquisitionSettings	singular	The imaging settings used to acquire multiple frames.

Message CameraServiceStartLiveAcquisitionResponse

Response object of the camera live image acquisition.

Field	Number	Type	Presence	Description
result_type	1	zen_api.em.hardware.v1.AcquisitionResponseType	singular	A value indicating the type of response returned by the camera live image acquisition stream.
width	2	int32	singular	The overall width of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.
height	3	int32	singular	The overall height of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.
bytes_per_pixel	4	uint32	singular	The number of bytes per pixel. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.
total_image_size	5	int32	singular	The total size of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.
image_data	6	bytes	singular	The data buffer of this part of the image. This may be less than the total image size, in which case the client should expect more data to follow.

Message CameraServiceStartSingleAcquisitionRequest

The CameraServiceStartSingleAcquisitionRequest class.

Field	Number	Type	Presence	Description
settings	1	zen_api.em.hardware.v1.CameraAcquisitionSettings	singular	The imaging settings used to acquire a frame.

Message CameraServiceStartSingleAcquisitionResponse

Response object of the camera single image acquisition.

Field	Number	Type	Presence	Description
result_type	1	zen_api.em.hardware.v1.AcquisitionResponseType	singular	A value indicating the type of response returned by the camera live image acquisition stream.
width	2	int32	singular	The overall width of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.
height	3	int32	singular	The overall height of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.
bytes_per_pixel	4	uint32	singular	The number of bytes per pixel. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.
total_image_size	5	int32	singular	The total size of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.
image_data	6	bytes	singular	The data buffer of this part of the image. This may be less than the total image size, in which case the client should expect more data to follow.

Message CameraServiceStopLiveAcquisitionRequest

The CameraServiceStopLiveAcquisitionRequest class.

Field	Number	Type	Presence	Description
camera_id	1	string	singular	The camera ID.

Message CameraServiceStopLiveAcquisitionResponse

Response object of the camera stop acquisition.

Field	Number	Type	Presence	Description
task_success	1	bool	singular	A value indicating whether the task to acquire an image succeeded or not.
message	2	string	singular	A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.