zebra::camera_sdk::ZebraCamera Class Reference

#include <zebra_camera.h>

Public Member Functions
std::vector< uint8_t >	GetProperty (Get function, uint8_t unit_or_terminal_id, uint8_t property_id)
void	SetProperty (Set function, uint8_t unit_or_terminal_id, uint8_t property_id, std::vector< uint8_t > value)
AttributeInfo	GetPropertyInfo (uint8_t unit_or_terminal_id, uint8_t property_id)
bool	IsPropertySupported (uint8_t unit_or_terminal_id, uint8_t property_id)
std::string	GetSerialNumber ()
std::string	GetModelNumber ()
std::string	GetDateOfManufacture ()
std::string	GetDateOfFirstProgram ()
std::string	GetFirstServiceDate ()
std::string	GetFirmwareVersion ()
std::string	GetHardwareVersion ()
std::vector< FrameType >	GetSupportedFrameTypes ()
FrameType	GetCurrentFrameType ()
void	SetCurrentFrameType (FrameType frame_type)
void	AddContinuousImageEventListener (ContinuousImageEventListener &listener)
void	RemoveContinuousImageEventListener (ContinuousImageEventListener &listener)
void	AddSnapshotImageEventListener (SnapshotImageEventListener &listener)
void	RemoveSnapshotImageEventListener (SnapshotImageEventListener &listener)
void	AddProduceImageEventListener (ProduceImageEventListener &listener)
void	RemoveProduceImageEventListener (ProduceImageEventListener &listener)
void	AddDecodeImageEventListener (DecodeImageEventListener &listener)
void	RemoveDecodeImageEventListener (DecodeImageEventListener &listener)
void	AddDecodeSessionStatusChangeEventListener (DecodeSessionStatusChangeEventListener &listener)
void	RemoveDecodeSessionStatusChangeEventListener (DecodeSessionStatusChangeEventListener &listener)
void	SetDefaults ()
void	WriteToFlash ()
Image	CaptureSnapshot ()

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

Friends
class	ZebraCameraManager
class	VideoFrameSink
class	FirmwareUpdater
template<typename T , CameraPropertyId ID>
class	Property
template<typename T , CameraPropertyId ID>
class	PropertyAuto

Detailed Description

Represents a Zebra camera device the user can interact with.

Member Function Documentation

AddContinuousImageEventListener()

void zebra::camera_sdk::ZebraCamera::AddContinuousImageEventListener

(

ContinuousImageEventListener &

listener

)

Add a listener for continuous-image events.

Parameters

listener

Reference to the listener object.

AddDecodeImageEventListener()

void zebra::camera_sdk::ZebraCamera::AddDecodeImageEventListener

(

DecodeImageEventListener &

listener

)

Add a listener for decode-image events.

Parameters

listener

Reference to the listener object.

AddDecodeSessionStatusChangeEventListener()

void zebra::camera_sdk::ZebraCamera::AddDecodeSessionStatusChangeEventListener

(

DecodeSessionStatusChangeEventListener &

listener

)

Add a listener for decode session status change events.

Parameters

listener

Reference to the listener object.

AddProduceImageEventListener()

void zebra::camera_sdk::ZebraCamera::AddProduceImageEventListener

(

ProduceImageEventListener &

listener

)

Add a listener for produce-image events.

Parameters

listener

Reference to the listener object.

AddSnapshotImageEventListener()

void zebra::camera_sdk::ZebraCamera::AddSnapshotImageEventListener

(

SnapshotImageEventListener &

listener

)

Add a listener for snapshot-image events.

Parameters

listener

Reference to the listener object.

CaptureSnapshot()

Image zebra::camera_sdk::ZebraCamera::CaptureSnapshot

(

)

Capture a single frame of image (Snapshot).

GetCurrentFrameType()

FrameType zebra::camera_sdk::ZebraCamera::GetCurrentFrameType

(

)

Get the current setting for the frame type.

Returns

Frame type.

GetDateOfFirstProgram()

std::string zebra::camera_sdk::ZebraCamera::GetDateOfFirstProgram

(

)

Get date of first program as a string.

Returns

Date of first program.

GetDateOfManufacture()

std::string zebra::camera_sdk::ZebraCamera::GetDateOfManufacture

(

)

Get date of manufacture as a string.

Returns

Date of manufacture.

GetFirmwareVersion()

std::string zebra::camera_sdk::ZebraCamera::GetFirmwareVersion

(

)

Get firmware version as a string.

Returns

Camera firmware version.

GetFirstServiceDate()

std::string zebra::camera_sdk::ZebraCamera::GetFirstServiceDate

(

)

Get first service date as a string.

Returns

First service date.

GetHardwareVersion()

std::string zebra::camera_sdk::ZebraCamera::GetHardwareVersion

(

)

Get hardware version as a string.

Returns

Camera hardware version.

GetModelNumber()

std::string zebra::camera_sdk::ZebraCamera::GetModelNumber

(

)

Get camera model number as a string.

Returns

Camera model number.

GetProperty()

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

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.

GetPropertyInfo()

AttributeInfo zebra::camera_sdk::ZebraCamera::GetPropertyInfo	(	uint8_t	unit_or_terminal_id,
		uint8_t	property_id
	)

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.

GetSerialNumber()

std::string zebra::camera_sdk::ZebraCamera::GetSerialNumber

(

)

Get camera serial number as a string.

Returns

Camera serial number.

GetSupportedFrameTypes()

std::vector<FrameType> zebra::camera_sdk::ZebraCamera::GetSupportedFrameTypes

(

)

Get supported frame types.

Returns

FrameType vector.

IsPropertySupported()

bool zebra::camera_sdk::ZebraCamera::IsPropertySupported	(	uint8_t	unit_or_terminal_id,
		uint8_t	property_id
	)

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.

RemoveContinuousImageEventListener()

void zebra::camera_sdk::ZebraCamera::RemoveContinuousImageEventListener

(

ContinuousImageEventListener &

listener

)

Remove the specified continuous-image events listener.

Parameters

listener

Reference to the listener object to remove.

RemoveDecodeImageEventListener()

void zebra::camera_sdk::ZebraCamera::RemoveDecodeImageEventListener

(

DecodeImageEventListener &

listener

)

Remove the specified decode-image events listener.

Parameters

listener

Reference to the listener object to remove.

RemoveDecodeSessionStatusChangeEventListener()

void zebra::camera_sdk::ZebraCamera::RemoveDecodeSessionStatusChangeEventListener

(

DecodeSessionStatusChangeEventListener &

listener

)

Remove the specified decode session status change event listener.

Parameters

listener

Reference to the listener object to remove.

RemoveProduceImageEventListener()

void zebra::camera_sdk::ZebraCamera::RemoveProduceImageEventListener

(

ProduceImageEventListener &

listener

)

Remove the specified produce-image events listener.

Parameters

listener

Reference to the listener object to remove.

RemoveSnapshotImageEventListener()

void zebra::camera_sdk::ZebraCamera::RemoveSnapshotImageEventListener

(

SnapshotImageEventListener &

listener

)

Remove the specified snapshot-image events listener.

Parameters

listener

Reference to the listener object to remove.

SetCurrentFrameType()

void zebra::camera_sdk::ZebraCamera::SetCurrentFrameType

(

FrameType

frame_type

)

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.

SetDefaults()

void zebra::camera_sdk::ZebraCamera::SetDefaults

(

)

Set values of the parameters to their default values.

SetProperty()

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

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.

WriteToFlash()

void zebra::camera_sdk::ZebraCamera::WriteToFlash

(

)

Write current property values to flash memory.

Member Data Documentation

AbsoluteExposureTime

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

Exposure Time (Absolute) property.

BacklightCompensation

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

Backlight Compensation property.

Brightness

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

Brightness property.

Contrast

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

Contrast property.

Gain

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

Gain property.

Gamma

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

Gamma property.

IlluminationModeSetting

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

Illumination Mode property.

PowerUserModeSetting

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

Power-User Mode property.

Saturation

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

Saturation property.

Sharpness

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

Sharpness property.

VideoModeSetting

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

Video Mode property.

WhiteBalanceComponent

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

White Balance Component property.

---

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

• camera_sdk/inc/zebra_camera.h