#include <zebra_camera_client.h>

Inheritance diagram for zebra::camera_sdk::ZebraCameraClient:

Public Member Functions
virtual std::vector< uint8_t >	GetProperty (Get function, uint8_t unit_or_terminal_id, uint8_t property_id)=0

virtual void	SetProperty (Set function, uint8_t unit_or_terminal_id, uint8_t property_id, std::vector< uint8_t > value)=0

virtual AttributeInfo	GetPropertyInfo (uint8_t unit_or_terminal_id, uint8_t property_id)=0

virtual bool	IsPropertySupported (uint8_t unit_or_terminal_id, uint8_t property_id)=0

virtual bool	IsAutoSupported (uint8_t unit_or_terminal_id, uint8_t property_id)=0

virtual bool	IsAutoEnabled (uint8_t unit_or_terminal_id, uint8_t property_id)=0

virtual void	AutoEnable (bool enable, uint8_t unit_or_terminal_id, uint8_t property_id)=0

virtual std::string	GetSerialNumber ()=0

virtual std::string	GetModelNumber ()=0

virtual std::string	GetDateOfManufacture ()=0

virtual std::string	GetDateOfFirstProgram ()=0

virtual std::string	GetFirstServiceDate ()=0

virtual std::string	GetFirmwareVersion ()=0

virtual std::string	GetHardwareVersion ()=0

virtual std::vector< FrameType >	GetSupportedFrameTypes ()=0

virtual FrameType	GetCurrentFrameType ()=0

virtual void	SetCurrentFrameType (FrameType frame_type)=0

virtual void	AddContinuousImageEventListener (ContinuousImageEventListener &listener)=0

virtual void	RemoveContinuousImageEventListener (ContinuousImageEventListener &listener)=0

virtual void	AddSnapshotImageEventListener (SnapshotImageEventListener &listener)=0

virtual void	RemoveSnapshotImageEventListener (SnapshotImageEventListener &listener)=0

virtual void	AddProduceImageEventListener (ProduceImageEventListener &listener)=0

virtual void	RemoveProduceImageEventListener (ProduceImageEventListener &listener)=0

virtual void	AddDecodeImageEventListener (DecodeImageEventListener &listener)=0

virtual void	RemoveDecodeImageEventListener (DecodeImageEventListener &listener)=0

virtual void	AddDecodeSessionStatusChangeEventListener (DecodeSessionStatusChangeEventListener &listener)=0

virtual void	RemoveDecodeSessionStatusChangeEventListener (DecodeSessionStatusChangeEventListener &listener)=0

virtual void	SetDefaults ()=0

virtual void	WriteToFlash ()=0

virtual Image	CaptureSnapshot ()=0

Public Attributes
Property< int16_t, CameraPropertyId::BRIGHTNESS >	Brightness

PropertyAuto< int16_t, CameraPropertyId::CONTRAST >	Contrast

Property< int16_t, CameraPropertyId::SATURATION >	Saturation

Property< int16_t, CameraPropertyId::SHARPNESS >	Sharpness

Property< int16_t, CameraPropertyId::GAMMA >	Gamma

PropertyAuto< WhiteBalance, CameraPropertyId::WHITE_BALANCE_COMPONENT >	WhiteBalanceComponent

Property< int16_t, CameraPropertyId::BACKLIGHT_COMPENSATION >	BacklightCompensation

Property< int16_t, CameraPropertyId::GAIN >	Gain

PropertyAuto< uint32_t, CameraPropertyId::EXPOSURE_TIME_ABSOLUTE >	AbsoluteExposureTime

PropertyEx< VideoMode, CameraPropertyId::VIDEO_MODE >	VideoModeSetting

PropertyEx< IlluminationMode, CameraPropertyId::ILLUMINATION_MODE >	IlluminationModeSetting

PropertyEx< PowerUserMode, CameraPropertyId::POWER_USER_MODE >	PowerUserModeSetting

Detailed Description

Zebra Camera Client interface.

Member Function Documentation

◆ AddContinuousImageEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::AddContinuousImageEventListener ( ContinuousImageEventListener & listener )

pure virtual

Add a listener for continuous-image events.

Parameters

listener Reference to the listener object.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ AddDecodeImageEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::AddDecodeImageEventListener ( DecodeImageEventListener & listener )

pure virtual

Add a listener for decode-image events.

Parameters

listener Reference to the listener object.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ AddDecodeSessionStatusChangeEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::AddDecodeSessionStatusChangeEventListener ( DecodeSessionStatusChangeEventListener & listener )

pure virtual

Add a listener for decode session status change events.

Parameters

listener Reference to the listener object.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ AddProduceImageEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::AddProduceImageEventListener ( ProduceImageEventListener & listener )

pure virtual

Add a listener for produce-image events.

Parameters

listener Reference to the listener object.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ AddSnapshotImageEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::AddSnapshotImageEventListener ( SnapshotImageEventListener & listener )

pure virtual

Add a listener for snapshot-image events.

Parameters

listener Reference to the listener object.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ AutoEnable()

virtual void zebra::camera_sdk::ZebraCameraClient::AutoEnable	(	bool	enable,
		uint8_t	unit_or_terminal_id,
		uint8_t	property_id
	)

pure virtual

Enable/disable auto functionality of an auto supported property.

Parameters

unit_or_terminal_id	UVC unit or terminal id.
property_id	UVC property of the unit or the terminal specified in unit_or_terminal_id.

Exceptions

An	exception in an error.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ CaptureSnapshot()

virtual Image zebra::camera_sdk::ZebraCameraClient::CaptureSnapshot ( )

pure virtual

Capture a single frame of image (Snapshot).

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetCurrentFrameType()

virtual FrameType zebra::camera_sdk::ZebraCameraClient::GetCurrentFrameType ( )

pure virtual

Get the current setting for the frame type.

Returns: Frame type.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetDateOfFirstProgram()

virtual std::string zebra::camera_sdk::ZebraCameraClient::GetDateOfFirstProgram ( )

pure virtual

Get date of first program as a string.

Returns: Date of first program.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetDateOfManufacture()

virtual std::string zebra::camera_sdk::ZebraCameraClient::GetDateOfManufacture ( )

pure virtual

Get date of manufacture as a string.

Returns: Date of manufacture.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetFirmwareVersion()

virtual std::string zebra::camera_sdk::ZebraCameraClient::GetFirmwareVersion ( )

pure virtual

Get firmware version as a string.

Returns: Camera firmware version.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetFirstServiceDate()

virtual std::string zebra::camera_sdk::ZebraCameraClient::GetFirstServiceDate ( )

pure virtual

Get first service date as a string.

Returns: First service date.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetHardwareVersion()

virtual std::string zebra::camera_sdk::ZebraCameraClient::GetHardwareVersion ( )

pure virtual

Get hardware version as a string.

Returns: Camera hardware version.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetModelNumber()

virtual std::string zebra::camera_sdk::ZebraCameraClient::GetModelNumber ( )

pure virtual

Get camera model number as a string.

Returns: Camera model number.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetProperty()

virtual std::vector<uint8_t> zebra::camera_sdk::ZebraCameraClient::GetProperty	(	Get	function,
		uint8_t	unit_or_terminal_id,
		uint8_t	property_id
	)

pure virtual

Get property value as a buffer.

Parameters

function	The Get operation to perform.
unit_or_terminal_id	UVC unit or terminal id.
property_id	UVC property of the unit or the terminal specified in unit_or_terminal_id.

Returns: The value of the property as a vector<uint8_t> if success.

Exceptions

An	exception in an error.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetPropertyInfo()

virtual AttributeInfo zebra::camera_sdk::ZebraCameraClient::GetPropertyInfo	(	uint8_t	unit_or_terminal_id,
		uint8_t	property_id
	)

pure virtual

Get property attributes.

Parameters

unit_or_terminal_id	UVC unit or terminal id.
property_id	UVC property of the unit or the terminal specified in unit_or_terminal_id.

Returns: AttributeInfo if success.

Exceptions

An	exception in an error.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetSerialNumber()

virtual std::string zebra::camera_sdk::ZebraCameraClient::GetSerialNumber ( )

pure virtual

Get camera serial number as a string.

Returns: Camera serial number.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ GetSupportedFrameTypes()

virtual std::vector<FrameType> zebra::camera_sdk::ZebraCameraClient::GetSupportedFrameTypes ( )

pure virtual

Get supported frame types.

Returns: FrameType vector.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ IsAutoEnabled()

virtual bool zebra::camera_sdk::ZebraCameraClient::IsAutoEnabled	(	uint8_t	unit_or_terminal_id,
		uint8_t	property_id
	)

pure virtual

Check whether auto functionality of an auto supported property is enabled.

Parameters

unit_or_terminal_id	UVC unit or terminal id.
property_id	UVC property of the unit or the terminal specified in unit_or_terminal_id.

Returns: true if auto functionality is enabled. false otherwise.

Exceptions

An	exception in an error.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ IsAutoSupported()

virtual bool zebra::camera_sdk::ZebraCameraClient::IsAutoSupported	(	uint8_t	unit_or_terminal_id,
		uint8_t	property_id
	)

pure virtual

Check whether the property supports auto control.

Parameters

unit_or_terminal_id	UVC unit or terminal id.
property_id	UVC property of the unit or the terminal specified in unit_or_terminal_id.

Returns: true if auto is supported. false otherwise.

Exceptions

An	exception in an error.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ IsPropertySupported()

virtual bool zebra::camera_sdk::ZebraCameraClient::IsPropertySupported	(	uint8_t	unit_or_terminal_id,
		uint8_t	property_id
	)

pure virtual

Whether the specified property of the unit or terminal supported.

Parameters

unit_or_terminal_id	UVC unit or terminal id.
property_id	UVC property of the unit or the terminal specified in unit_or_terminal_id.

Returns: true if the property is supported. false otherwise.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ RemoveContinuousImageEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::RemoveContinuousImageEventListener ( ContinuousImageEventListener & listener )

pure virtual

Remove the specified continuous-image events listener.

Parameters

listener Reference to the listener object to remove.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ RemoveDecodeImageEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::RemoveDecodeImageEventListener ( DecodeImageEventListener & listener )

pure virtual

Remove the specified decode-image events listener.

Parameters

listener Reference to the listener object to remove.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ RemoveDecodeSessionStatusChangeEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::RemoveDecodeSessionStatusChangeEventListener ( DecodeSessionStatusChangeEventListener & listener )

pure virtual

Remove the specified decode session status change event listener.

Parameters

listener Reference to the listener object to remove.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ RemoveProduceImageEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::RemoveProduceImageEventListener ( ProduceImageEventListener & listener )

pure virtual

Remove the specified produce-image events listener.

Parameters

listener Reference to the listener object to remove.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ RemoveSnapshotImageEventListener()

virtual void zebra::camera_sdk::ZebraCameraClient::RemoveSnapshotImageEventListener ( SnapshotImageEventListener & listener )

pure virtual

Remove the specified snapshot-image events listener.

Parameters

listener Reference to the listener object to remove.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ SetCurrentFrameType()

virtual void zebra::camera_sdk::ZebraCameraClient::SetCurrentFrameType ( FrameType frame_type )

pure virtual

Set the current setting for the frame type. Use GetSupportedFrameTypes to query the supported formats and then set one of them as the current frame type. Note: Do not modify what is returned from GetSupportedFrameTypes. SetCurrentFrameType will throw an exception if an invalid frame type is specified.

Parameters

frame_type Requested frame type.

Exceptions

Throws exception if the specified frame type is not supported.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ SetDefaults()

virtual void zebra::camera_sdk::ZebraCameraClient::SetDefaults ( )

pure virtual

Set values of the parameters to their default values.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ SetProperty()

virtual void zebra::camera_sdk::ZebraCameraClient::SetProperty	(	Set	function,
		uint8_t	unit_or_terminal_id,
		uint8_t	property_id,
		std::vector< uint8_t >	value
	)

pure virtual

Set property value as a buffer.

Parameters

function	The Set operation to perform.
unit_or_terminal_id	UVC unit or terminal id.
property_id	UVC property of the unit or the terminal specified in unit_or_terminal_id.
value	The value of the property as a vector<uint8_t>.

Exceptions

An	exception in an error.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

◆ WriteToFlash()

virtual void zebra::camera_sdk::ZebraCameraClient::WriteToFlash ( )

pure virtual

Write current property values to flash memory.

Implemented in zebra::camera_sdk::ZebraCameraClientConcrete.

Member Data Documentation

◆ AbsoluteExposureTime

PropertyAuto<uint32_t, CameraPropertyId::EXPOSURE_TIME_ABSOLUTE> zebra::camera_sdk::ZebraCameraClient::AbsoluteExposureTime

Exposure Time (Absolute) property.

◆ BacklightCompensation

Property<int16_t, CameraPropertyId::BACKLIGHT_COMPENSATION> zebra::camera_sdk::ZebraCameraClient::BacklightCompensation

Backlight Compensation property.

◆ Brightness

Property<int16_t, CameraPropertyId::BRIGHTNESS> zebra::camera_sdk::ZebraCameraClient::Brightness

Brightness property.

◆ Contrast

PropertyAuto<int16_t, CameraPropertyId::CONTRAST> zebra::camera_sdk::ZebraCameraClient::Contrast

Contrast property.

◆ Gain

Property<int16_t, CameraPropertyId::GAIN> zebra::camera_sdk::ZebraCameraClient::Gain

Gain property.

◆ Gamma

Property<int16_t, CameraPropertyId::GAMMA> zebra::camera_sdk::ZebraCameraClient::Gamma

Gamma property.

◆ IlluminationModeSetting

PropertyEx<IlluminationMode, CameraPropertyId::ILLUMINATION_MODE> zebra::camera_sdk::ZebraCameraClient::IlluminationModeSetting

Illumination Mode property.

◆ PowerUserModeSetting

PropertyEx<PowerUserMode, CameraPropertyId::POWER_USER_MODE> zebra::camera_sdk::ZebraCameraClient::PowerUserModeSetting

Power-User Mode property.

◆ Saturation

Property<int16_t, CameraPropertyId::SATURATION> zebra::camera_sdk::ZebraCameraClient::Saturation

Saturation property.

◆ Sharpness

Property<int16_t, CameraPropertyId::SHARPNESS> zebra::camera_sdk::ZebraCameraClient::Sharpness

Sharpness property.

◆ VideoModeSetting

PropertyEx<VideoMode, CameraPropertyId::VIDEO_MODE> zebra::camera_sdk::ZebraCameraClient::VideoModeSetting

Video Mode property.

◆ WhiteBalanceComponent

PropertyAuto<WhiteBalance, CameraPropertyId::WHITE_BALANCE_COMPONENT> zebra::camera_sdk::ZebraCameraClient::WhiteBalanceComponent

White Balance Component property.

The documentation for this class was generated from the following file:

camera_client/zebra_camera_client/zebra_camera_client.h

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ AddContinuousImageEventListener()

◆ AddDecodeImageEventListener()

◆ AddDecodeSessionStatusChangeEventListener()

◆ AddProduceImageEventListener()

◆ AddSnapshotImageEventListener()

◆ AutoEnable()

◆ CaptureSnapshot()

◆ GetCurrentFrameType()

◆ GetDateOfFirstProgram()

◆ GetDateOfManufacture()

◆ GetFirmwareVersion()

◆ GetFirstServiceDate()

◆ GetHardwareVersion()

◆ GetModelNumber()

◆ GetProperty()

◆ GetPropertyInfo()

◆ GetSerialNumber()

◆ GetSupportedFrameTypes()

◆ IsAutoEnabled()

◆ IsAutoSupported()

◆ IsPropertySupported()

◆ RemoveContinuousImageEventListener()

◆ RemoveDecodeImageEventListener()

◆ RemoveDecodeSessionStatusChangeEventListener()

◆ RemoveProduceImageEventListener()

◆ RemoveSnapshotImageEventListener()

◆ SetCurrentFrameType()

◆ SetDefaults()

◆ SetProperty()

◆ WriteToFlash()

Member Data Documentation

◆ AbsoluteExposureTime

◆ BacklightCompensation

◆ Brightness

◆ Contrast

◆ Gain

◆ Gamma

◆ IlluminationModeSetting

◆ PowerUserModeSetting

◆ Saturation

◆ Sharpness

◆ VideoModeSetting

◆ WhiteBalanceComponent