ICamera interface represents a Biotic Color Camera and its functionality. More...
import"camera_sdk.idl";
Public Member Functions | |
HRESULT | EnumerateDevices ([out] SAFEARRAY(VARIANT) *device_ids) |
Enumerate already connected camera devices. More... | |
HRESULT | Open ([in] BSTR deviceID) |
Open the camera with provides device_id. More... | |
HRESULT | Close () |
Close the currently opened camera. | |
HRESULT | SetVideoMode ([in] INT value) |
Sets the video mode. More... | |
HRESULT | GetVideoMode ([out] INT *value) |
HRESULT | SetIlluminationMode ([in] INT value) |
Sets the illumination mode. More... | |
HRESULT | GetIlluminationMode ([out] INT *value) |
Get the illumination mode. More... | |
HRESULT | SetFrameType ([in] FrameTypeInfo *value) |
Sets the frame type of the camera. More... | |
HRESULT | GetSupportedFrameTypes ([out] SAFEARRAY(FrameTypeInfo) *value) |
Get list of supported FrameTypeInfo array. More... | |
HRESULT | GetBrightness ([out] INT *value, [out] BOOL *isAutoEnabled) |
Get Brightness. More... | |
HRESULT | SetBrightness ([in] INT value, [in] BOOL isAutoEnabled) |
Set Brightness. More... | |
HRESULT | GetBrightnessInfo ([out] INT *min, [out] INT *max, [out] INT *defaultValue, [out] INT *step, [out] BOOL *isAutoSupported) |
Get BrightnessInfo. More... | |
HRESULT | GetContrast ([out] INT *value, [out] BOOL *isAutoEnabled) |
Get Contrast. More... | |
HRESULT | SetContrast ([in] INT value, [in] BOOL isAutoEnabled) |
Set Contrast. More... | |
HRESULT | GetContrastInfo ([out] INT *min, [out] INT *max, [out] INT *defaultValue, [out] INT *step, [out] BOOL *isAutoSupported) |
Get ContrastInfo. More... | |
HRESULT | GetSaturation ([out] INT *value, [out] BOOL *isAutoEnabled) |
Get Saturation. More... | |
HRESULT | SetSaturation ([in] INT value, [in] BOOL isAutoEnabled) |
Set Saturation. More... | |
HRESULT | GetSaturationInfo ([out] INT *min, [out] INT *max, [out] INT *defaultValue, [out] INT *step, [out] BOOL *isAutoSupported) |
Get SaturationInfo. More... | |
HRESULT | GetSharpness ([out] INT *value, [out] BOOL *isAutoEnabled) |
Get Sharpness. More... | |
HRESULT | SetSharpness ([in] INT value, [in] BOOL isAutoEnabled) |
Set Sharpness. More... | |
HRESULT | GetSharpnessInfo ([out] INT *min, [out] INT *max, [out] INT *defaultValue, [out] INT *step, [out] BOOL *isAutoSupported) |
Get SharpnessInfo. More... | |
HRESULT | GetGamma ([out] INT *value, [out] BOOL *isAutoEnabled) |
HRESULT | SetGamma ([in] INT value, [in] BOOL isAutoEnabled) |
Set Gamma. More... | |
HRESULT | GetGammaInfo ([out] INT *min, [out] INT *max, [out] INT *defaultValue, [out] INT *step, [out] BOOL *isAutoSupported) |
Get GammaInfo. More... | |
HRESULT | GetBacklight ([out] INT *value, [out] BOOL *isAutoEnabled) |
Get BacklightCompensation. More... | |
HRESULT | SetBacklight ([in] INT value, [in] BOOL isAutoEnabled) |
Set BacklightCompensation. More... | |
HRESULT | GetBacklightInfo ([out] INT *min, [out] INT *max, [out] INT *defaultValue, [out] INT *step, [out] BOOL *isAutoSupported) |
Get BackLightCompensationInfo. More... | |
HRESULT | GetGain ([out] INT *value, [out] BOOL *isAutoEnabled) |
Get Gain. More... | |
HRESULT | SetGain ([in] INT value, [in] BOOL isAutoEnabled) |
HRESULT | GetGainInfo ([out] INT *min, [out] INT *max, [out] INT *defaultValue, [out] INT *step, [out] BOOL *isAutoSupported) |
Get GainInfo. More... | |
HRESULT | GetExposure ([out] INT *value, [out] BOOL *isAutoEnabled) |
Get Exposure. More... | |
HRESULT | SetExposure ([in] INT value, [in] BOOL isAutoEnabled) |
Set Exposure. More... | |
HRESULT | GetExposureInfo ([out] INT *min, [out] INT *max, [out] INT *defaultValue, [out] INT *step, [out] BOOL *isAutoSupported) |
Get ExposureInfo. More... | |
HRESULT | GetWhiteBalance ([out] INT *value, [out] BOOL *isAutoEnabled) |
Get WhiteBalanceComonent. More... | |
HRESULT | SetWhiteBalance ([in] INT value, [in] BOOL isAutoEnabled) |
HRESULT | GetWhiteBalanceInfo ([out] INT *min, [out] INT *max, [out] INT *defaultValue, [out] INT *step, [out] BOOL *isAutoSupported) |
Get WhiteBalanceComponentInfo. More... | |
HRESULT | CancelFirmwareDownload () |
Cancel firmware download. | |
HRESULT | GetCurrentFrameType ([out] FrameTypeInfo *value) |
Get the active frame type of the camera. More... | |
HRESULT | SetImageType ([in] INT imageStreamType) |
Set the output image stream format (BMP or JPEG) More... | |
HRESULT | GetImageType ([out] INT *imageStreamType) |
Get the currently selected output image stream format (BMP or JPEG) More... | |
HRESULT | RebootCamera ([in] INT timeout) |
Reboots the camera. More... | |
HRESULT | SetDefaults () |
Set values of the parameters to their default values. | |
HRESULT | WriteToFlash () |
Write parameter values to flash memory. Once called this method the current parameter values will be persistent across device reboots. | |
HRESULT | CaptureSnapshot ([in, out] SAFEARRAY(BYTE) *imageBuffer, [out] LONG *length, [out] LONG *width, [out] LONG *height, [out] LONG *imageType) |
Capture Snapshot. More... | |
HRESULT | RegisterForContinuousImageEvent ([in] BOOL bReg) |
Register for continuous Image Event. More... | |
HRESULT | RegisterForSnapshotImageEvent ([in] BOOL bReg) |
HRESULT | RegisterForProduceImageEvent ([in] BOOL bReg) |
Register for Produce Image Event. More... | |
HRESULT | RegisterForDecodeImageEvent ([in] BOOL bReg) |
Register for Decode Image Event. More... | |
HRESULT | RegisterForDecodeSessionStatusChangeEvent ([in] BOOL bReg) |
Register for Decode Session Status Change Event. More... | |
HRESULT | DownloadFirmware ([in] BSTR val) |
Download firmware. More... | |
HRESULT | InstallFirmware () |
Installs the downloaded firmware on device. | |
HRESULT | RegisterForFirmwareDownloadProgressEvents ([in] BOOL bReg) |
Register / unregister for firmware download events. More... | |
HRESULT | GetPowerUserMode ([out] INT *value) |
Get the Power user mode. More... | |
HRESULT | SetPowerUserMode ([in] INT value) |
Sets the Power user mode. More... | |
HRESULT | LoadConfiguration ([in] BSTR configuration_xml) |
Load configurations to the camera. More... | |
HRESULT | LoadConfigurationFromFile ([in] BSTR configuration_file_path) |
Load configuration from a bcccfg file. More... | |
HRESULT | RetrieveConfiguration ([out] BSTR *configuration_xml) |
Retrieve the camera configuration as an XML stored in BSTR. More... | |
HRESULT | RetrieveConfigurationToFile ([in] BSTR configuration_file_path) |
Save the camera configuration to a file. More... | |
HRESULT | GetVersion ([out] INT *version_major, [out] INT *version_minor, [out] INT *version_patch, [out] INT *version_build) |
Provides the SDK version. More... | |
Properties | |
BSTR | SerialNumber [get] |
Serial Number. More... | |
BSTR | ModelNumber [get] |
Model Number. More... | |
BSTR | DateOfManufacture [get] |
Date Of Manufacture. More... | |
BSTR | DateOfService [get] |
Date Of Service. More... | |
BSTR | DateOfFirstProgram [get] |
Date Of First Program. More... | |
BSTR | FirmwareVersion [get] |
Return camera firmware version. More... | |
BSTR | HardwareVersion [get] |
Return camera hardware version. More... | |
BSTR | LastError [get] |
Last Error. More... | |
ICamera interface represents a Biotic Color Camera and its functionality.
HRESULT ICamera::CaptureSnapshot | ( | [in, out] SAFEARRAY(BYTE) * | imageBuffer, |
[out] LONG * | length, | ||
[out] LONG * | width, | ||
[out] LONG * | height, | ||
[out] LONG * | imageType | ||
) |
Capture Snapshot.
image_buffer | BYTE buffer which contains image data. |
length | Length of the image buffer. |
width | Width of the image. |
height | Height of the image. |
image_type | Image type. 0 - BMP 1 - JPEG, 3 - YUY2. |
HRESULT ICamera::DownloadFirmware | ( | [in] BSTR | val | ) |
Download firmware.
val | Path of DAT file (*.DAT). |
HRESULT ICamera::EnumerateDevices | ( | [out] SAFEARRAY(VARIANT) * | device_ids | ) |
Enumerate already connected camera devices.
device_ids | Array of device_ids (device paths) of already connected cameras. |
HRESULT ICamera::GetBacklight | ( | [out] INT * | value, |
[out] BOOL * | isAutoEnabled | ||
) |
Get BacklightCompensation.
value | BacklightCompensation value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::GetBacklightInfo | ( | [out] INT * | min, |
[out] INT * | max, | ||
[out] INT * | defaultValue, | ||
[out] INT * | step, | ||
[out] BOOL * | isAutoSupported | ||
) |
Get BackLightCompensationInfo.
min | Supported minimum value. |
max | Supported maximum value. |
default_value | Default value. |
isAutoSupported | True if this property support auto control. False otherwise. |
HRESULT ICamera::GetBrightness | ( | [out] INT * | value, |
[out] BOOL * | isAutoEnabled | ||
) |
Get Brightness.
[out] | value | Brightness value. |
[out] | isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::GetBrightnessInfo | ( | [out] INT * | min, |
[out] INT * | max, | ||
[out] INT * | defaultValue, | ||
[out] INT * | step, | ||
[out] BOOL * | isAutoSupported | ||
) |
Get BrightnessInfo.
min | Supported minimum value. |
max | Supported maximum value. |
default_value | Default value. |
isAutoSupported | True if this property support auto control. False otherwise. |
HRESULT ICamera::GetContrast | ( | [out] INT * | value, |
[out] BOOL * | isAutoEnabled | ||
) |
Get Contrast.
value | Contrast value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::GetContrastInfo | ( | [out] INT * | min, |
[out] INT * | max, | ||
[out] INT * | defaultValue, | ||
[out] INT * | step, | ||
[out] BOOL * | isAutoSupported | ||
) |
Get ContrastInfo.
min | Supported minimum value. |
max | Supported maximum value. |
default_value | Default value. |
isAutoSupported | True if this property support auto control. False otherwise. |
HRESULT ICamera::GetCurrentFrameType | ( | [out] FrameTypeInfo * | value | ) |
Get the active frame type of the camera.
value | Pointer to a FrameTypeInfo object which holds frame type information. |
HRESULT ICamera::GetExposure | ( | [out] INT * | value, |
[out] BOOL * | isAutoEnabled | ||
) |
Get Exposure.
value | Exposure value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::GetExposureInfo | ( | [out] INT * | min, |
[out] INT * | max, | ||
[out] INT * | defaultValue, | ||
[out] INT * | step, | ||
[out] BOOL * | isAutoSupported | ||
) |
Get ExposureInfo.
min | Supported minimum value. |
max | Supported maximum value. |
default_value | Default value. |
isAutoSupported | True if this property support auto control. False otherwise. |
HRESULT ICamera::GetGain | ( | [out] INT * | value, |
[out] BOOL * | isAutoEnabled | ||
) |
Get Gain.
value | Gain value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::GetGainInfo | ( | [out] INT * | min, |
[out] INT * | max, | ||
[out] INT * | defaultValue, | ||
[out] INT * | step, | ||
[out] BOOL * | isAutoSupported | ||
) |
Get GainInfo.
min | Supported minimum value. |
max | Supported maximum value. |
default_value | Default value. |
isAutoSupported | True if this property support auto control. False otherwise. |
HRESULT ICamera::GetGamma | ( | [out] INT * | value, |
[out] BOOL * | isAutoEnabled | ||
) |
Get Gamma.
[out] | Gamma | value. |
[out] | True | if auto control is enabled. Otherwise false. |
HRESULT ICamera::GetGammaInfo | ( | [out] INT * | min, |
[out] INT * | max, | ||
[out] INT * | defaultValue, | ||
[out] INT * | step, | ||
[out] BOOL * | isAutoSupported | ||
) |
Get GammaInfo.
min | Supported minimum value. |
max | Supported maximum value. |
default_value | Default value. |
isAutoSupported | True if this property support auto control. False otherwise. |
HRESULT ICamera::GetIlluminationMode | ( | [out] INT * | value | ) |
Get the illumination mode.
value | 0 - standard (default), 1 - always on, 2 - always off. |
HRESULT ICamera::GetImageType | ( | [out] INT * | imageStreamType | ) |
Get the currently selected output image stream format (BMP or JPEG)
ImageStreamtype. | 0 - BMP, 1 - JPEG. |
HRESULT ICamera::GetPowerUserMode | ( | [out] INT * | value | ) |
Get the Power user mode.
value | Power user mode. 0 - disable, 1 - enable. |
HRESULT ICamera::GetSaturation | ( | [out] INT * | value, |
[out] BOOL * | isAutoEnabled | ||
) |
Get Saturation.
value | Saturation value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::GetSaturationInfo | ( | [out] INT * | min, |
[out] INT * | max, | ||
[out] INT * | defaultValue, | ||
[out] INT * | step, | ||
[out] BOOL * | isAutoSupported | ||
) |
Get SaturationInfo.
min | Supported minimum value. |
max | Supported maximum value. |
default_value | Default value. |
isAutoSupported | True if this property support auto control. False otherwise. |
HRESULT ICamera::GetSharpness | ( | [out] INT * | value, |
[out] BOOL * | isAutoEnabled | ||
) |
Get Sharpness.
value | Sharpness value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::GetSharpnessInfo | ( | [out] INT * | min, |
[out] INT * | max, | ||
[out] INT * | defaultValue, | ||
[out] INT * | step, | ||
[out] BOOL * | isAutoSupported | ||
) |
Get SharpnessInfo.
min | Supported minimum value. |
max | Supported maximum value. |
default_value | Default value. |
isAutoSupported | True if this property support auto control. False otherwise. |
HRESULT ICamera::GetSupportedFrameTypes | ( | [out] SAFEARRAY(FrameTypeInfo) * | value | ) |
Get list of supported FrameTypeInfo array.
value | FrameTypeInfo object. |
HRESULT ICamera::GetVersion | ( | [out] INT * | version_major, |
[out] INT * | version_minor, | ||
[out] INT * | version_patch, | ||
[out] INT * | version_build | ||
) |
Provides the SDK version.
version_major | Major version number. |
version_minor | Minor version number. |
version_patch | Patch version number. |
version_build | Build version number. |
HRESULT ICamera::GetVideoMode | ( | [out] INT * | value | ) |
@brier Return the video mode.
value | Video mode. 0 - off: color camera will not transfer any video frame to host, 1 - device wakeup (default): color camera will transfer video to host when the scanner is waked up, 2 - continuous: color camera always transfer video to host. |
HRESULT ICamera::GetWhiteBalance | ( | [out] INT * | value, |
[out] BOOL * | isAutoEnabled | ||
) |
Get WhiteBalanceComonent.
value | WhiteBalanceComonent value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::GetWhiteBalanceInfo | ( | [out] INT * | min, |
[out] INT * | max, | ||
[out] INT * | defaultValue, | ||
[out] INT * | step, | ||
[out] BOOL * | isAutoSupported | ||
) |
Get WhiteBalanceComponentInfo.
min | Supported minimum value. |
max | Supported maximum value. |
default_value | Default value. |
isAutoSupported | True if this property support auto control. False otherwise. |
HRESULT ICamera::LoadConfiguration | ( | [in] BSTR | configuration_xml | ) |
Load configurations to the camera.
configuration_xml | Configuration XML as a BSTR. |
HRESULT ICamera::LoadConfigurationFromFile | ( | [in] BSTR | configuration_file_path | ) |
Load configuration from a bcccfg file.
configuration_file_path | Path to *.bcccfg file as BSTR. |
HRESULT ICamera::Open | ( | [in] BSTR | deviceID | ) |
Open the camera with provides device_id.
[in] | deviceID | device_id of the camera to open. |
HRESULT ICamera::RebootCamera | ( | [in] INT | timeout | ) |
Reboots the camera.
timeout | Timeout to wait before report a failure. |
HRESULT ICamera::RegisterForContinuousImageEvent | ( | [in] BOOL | bReg | ) |
Register for continuous Image Event.
bReg | True to register for continuous image events. False to unregister from continuous image events. |
HRESULT ICamera::RegisterForDecodeImageEvent | ( | [in] BOOL | bReg | ) |
Register for Decode Image Event.
bReg | True to register for Decode image events. False to unregister from Decode image events. |
HRESULT ICamera::RegisterForDecodeSessionStatusChangeEvent | ( | [in] BOOL | bReg | ) |
Register for Decode Session Status Change Event.
bReg | True to register for Session status change events. False to unregister from Session status change event. |
HRESULT ICamera::RegisterForFirmwareDownloadProgressEvents | ( | [in] BOOL | bReg | ) |
Register / unregister for firmware download events.
bReg | TRUE to register with firmware download progress events or FALSE to unregister. |
HRESULT ICamera::RegisterForProduceImageEvent | ( | [in] BOOL | bReg | ) |
Register for Produce Image Event.
bRegTrue | to register for Produce image events. False to unregister from Produce image events. |
HRESULT ICamera::RegisterForSnapshotImageEvent | ( | [in] BOOL | bReg | ) |
Register for Snapshot Image Event.
[in] | True | to register for Snapshot image events. False to unregister from Snapshot image events. |
HRESULT ICamera::RetrieveConfiguration | ( | [out] BSTR * | configuration_xml | ) |
Retrieve the camera configuration as an XML stored in BSTR.
configuration_xml | BSTR which hold configuration as an XML. |
HRESULT ICamera::RetrieveConfigurationToFile | ( | [in] BSTR | configuration_file_path | ) |
Save the camera configuration to a file.
configuration_file_path | Path to the configuration file which the configuration should be saved to. |
HRESULT ICamera::SetBacklight | ( | [in] INT | value, |
[in] BOOL | isAutoEnabled | ||
) |
Set BacklightCompensation.
value | BacklightCompensation value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::SetBrightness | ( | [in] INT | value, |
[in] BOOL | isAutoEnabled | ||
) |
Set Brightness.
value | Brightness value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::SetContrast | ( | [in] INT | value, |
[in] BOOL | isAutoEnabled | ||
) |
Set Contrast.
value | Contrast value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::SetExposure | ( | [in] INT | value, |
[in] BOOL | isAutoEnabled | ||
) |
Set Exposure.
value | Exposure value as an integer. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::SetFrameType | ( | [in] FrameTypeInfo * | value | ) |
Sets the frame type of the camera.
value | FrameTypeInfo object. |
HRESULT ICamera::SetGain | ( | [in] INT | value, |
[in] BOOL | isAutoEnabled | ||
) |
Set Gain.
[in] | Gain | value as an integer. |
[in] | Enable | Gain auto control. To enable set to true. otherwise false. |
HRESULT ICamera::SetGamma | ( | [in] INT | value, |
[in] BOOL | isAutoEnabled | ||
) |
Set Gamma.
value | Gamma value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::SetIlluminationMode | ( | [in] INT | value | ) |
Sets the illumination mode.
value | Illumination mode. 0 - standard (default), 1 - always on, 2 - always off. |
HRESULT ICamera::SetImageType | ( | [in] INT | imageStreamType | ) |
Set the output image stream format (BMP or JPEG)
ImageStreamtype | 0 - BMP, 1 - JPEG. |
HRESULT ICamera::SetPowerUserMode | ( | [in] INT | value | ) |
Sets the Power user mode.
value | Power user mode. 0 - disable, 1 - enable. |
HRESULT ICamera::SetSaturation | ( | [in] INT | value, |
[in] BOOL | isAutoEnabled | ||
) |
Set Saturation.
value | Saturation value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::SetSharpness | ( | [in] INT | value, |
[in] BOOL | isAutoEnabled | ||
) |
Set Sharpness.
value | Sharpness value. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
HRESULT ICamera::SetVideoMode | ( | [in] INT | value | ) |
Sets the video mode.
value | Video mode. 0 - off: color camera will not transfer any video frame to host, 1 - device wakeup (default): color camera will transfer video to host when the scanner is waked up, 2 - continuous: color camera always transfer video to host. |
HRESULT ICamera::SetWhiteBalance | ( | [in] INT | value, |
[in] BOOL | isAutoEnabled | ||
) |
Set WhaiteBalanceComponent.
value | WhaiteBalanceComponent value as an integer. |
isAutoEnabled | True if auto control is enabled. Otherwise false. |
|
getproperty |
Date Of First Program.
|
getproperty |
Date Of Manufacture.
|
getproperty |
Date Of Service.
|
getproperty |
Return camera firmware version.
|
getproperty |
Return camera hardware version.
|
getproperty |
Last Error.
|
getproperty |
Model Number.
|
getproperty |
Serial Number.