Explorecam API Manual

1. Version & Platform

Version: 53.20694.20220417

Platform
- Win32:
  - x86: XP SP3 or above; CPU supports SSE2 instruction set or above
  - x64: Win7 or above
  - arm: Win10 or above
  - arm64: Win10 or above
- WinRT: x86, x64, arm, arm64; Windows10 or above
- macOS: universal (x64 + x86); macOS 10.10 or above
- Linux: kernel 2.6.27 or above
  - x86: CPU supports SSE3 instruction set or above; GLIBC 2.8 or above
  - x64: GLIBC 2.14 or above
  - armel: GLIBC 2.8 or above; built by arm-linux-gnueabi (version 5.4.0)
  - armhf: GLIBC 2.8 or above; built by arm-linux-gnueabihf (version 5.4.0)
  - arm64: GLIBC 2.17 or above; built by aarch64-linux-gnu (version 5.4.0)
- Android: built by android-ndk-r18b; __ANDROID_API__ = 23; see here
  - arm: armeabi-v7a
  - arm64: arm64-v8a
  - x86
  - x64: x86_64

2. Introduction

Explorecam cameras support various kinds of APIs (Application Program Interface), namely Native C/C++, .NET/C#/VB.NET, Python, Java, DirectShow, Twain, LabView, MabLab and so on. Compared with other APIs, Native C/C++ API, as a low level API, don't depend any other runtime libraries. Besides, this interface is simple, flexible and easy to be integrated into the customized applications. The SDK zip file contains all of the necessary resources and information:

explore.h, C/C++ head file

win: For Microsoft Windows
- dotnet
  
  explore.cs, for C#. The explore.cs use P/Invoke to call into explore.dll. Please copy explore.cs to your C# project to use it.
  explore.vb, for VB.NET. The explore.vb use P/Invoke to call into explore.dll. Please copy explore.vb to your VB.NET project to use it.
- x86
  
  explore.lib, lib file for x86
  explore.dll, dll file for x86
  updatefw.exe, firmware upgrade tool
  *.exe, some demo program exe files
- x64
  
  explore.lib, lib file for x64
  explore.dll, dll file for x64
  *.exe, some demo program exe files
- arm
  
  explore.lib, lib file for arm
  explore.dll, dll file for arm
- arm64
  
  explore.lib, lib file for arm64
  explore.dll, dll file for arm64
- winrt
  DLL files for WinRT / UWP (Universal Windows Platform) / Windows Store App.
  These dll files are compatible with Windows Runtime, and can be consumed from a Universal Windows Platform app.
  If use C# to develop the UWP, explore.cs wrapper class can be used to P/Invoke into explore.dll.
  Please pay attation to:
  1. uwp must use winusb, cannot use the proprietary driver. If the proprietary driver has already been installed, please uninstall it in the device manager, after this, Windows will use winusb automatically.
  2. DeviceCapability of uwp, see: How to add USB device capabilities to the app manifest.
- drivers (The cameras produced after Jan. 1, 2017 support WinUSB, It is strongly recommended not to install the driver on Windows 8 and above)
  1. x86 folder contains the kernel mode drivers for x86, including explore.cat, explore.inf and explore.sys.
  2. x64 folder contains the kennel mode driver for x64, including explore.cat, explore.inf and explore.sys.
  3. It is recommended to use DPInst.exe to automatically install the driver. If you use NSIS to make the installation file, you can use a statement similar to the following:
    ExecWait '"$INSTDIR\drivers\x64\DPInst.exe" /SA /SW /PATH "$INSTDIR\drivers\x64"'

linux: For Linux

udev: 99-explore.rules, udev rule file. Please see: http://reactivated.net/writing_udev_rules.html
Reload rule without reboot:
udevadm control --reload-rules && udevadm trigger
x86: libexplore.so, so file for x86
x64: libexplore.so, so file for x64
armel: libexplore.so, so file for armel, use toolchain arm-linux-gnueabi
armhf: libexplore.so, so file for armhf, use toolchain arm-linux-gnueabihf
arm64: libexplore.so, so file for arm64, use toolchain aarch64-linux-gnu

***An easy way to distinguish the target platform armel/armhf/arm64, Execute file /bin/ls on the target platform. The following is the result under a Raspberry Pi, it can be seen that it belongs to armhf:
$ file /bin/ls
/bin/ls: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux-armhf.so.3, for GNU/Linux 3.2.0, BuildID[sha1]=67a394390830ea3ab4e83b5811c66fea9784ee69, stripped
Another example, which can be seen to belong to x64:
$ file /bin/ls
/bin/ls: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for GNU/Linux 2.6.32, BuildID[sha1]=c8ada1f7095f6b2bb7ddc848e088c2d615c3743e, stripped

android: libexplore.so for Android on arm, arm64, x86 and x64

mac: For macOS

python: explore.py and sample code

java: explore.java and sample code

doc: User manuals in English and Simplified Chinese

extras
- directshow: DirectShow SDK and demo
- twain: TWAIN SDK
- labview: Labview SDK and demo
- matlab: MatLab demo

3. Concepts and terminology

a. Modes for accessing image data: "Pull" Mode vs "Push" Mode

Explorecam offers two modes to obtain image data: Pull Mode and Push Mode. The former is recommended since it's simpler and the application seldom gets stuck in multithreading conditions, especially when using windows message to notify the events.

In Pull Mode, explore plays a passive role and the application 'PULL' image data from explore. The internal thread of explore obtains image data from the camera hardware and saves them to the internal buffers, then notify the application (see below). The application then call functions Explorecam_PullImageV3 or Explorecam_PullImage(WithRowPitch)(V2), Explorecam_PullStillImage(WithRowPitch)(V2) to access image data.

There are to ways to notify applications:

a) Use Windows message: Start pull mode by using the function Explorecam_StartPullModeWithWndMsg. When event occurs, explore will post message (PostMessage) to the specified window. Parameter WPARAM is the event type, refer to the definition of EXPLORE_EVENT_xxxx. This model avoids the multithreading issues, so it's the most simple way. (Obviously, this is only supported in Windows systems, and not supported in Linux and macOS.)

b) Use Callback function: Start pull mode by using the function Explorecam_StartPullModeWithCallback. When event occurs, explore will callback the function PEXPLORE_EVENT_CALLBACK.

In Pull Mode, the SDK could not only notify the application that the image data or still image are available for 'PULL', but also inform you of the other events, such as:

Event Source Description

EXPLORE_EVENT_EXPOSURE Software exposure time changed

EXPLORE_EVENT_TEMPTINT white balance changed. Temp/Tint Mode, please see here.

EXPLORE_EVENT_WBGAIN white balance changed. RGB Gain Mode, please see here.

EXPLORE_EVENT_IMAGE Video image data arrives. Use Explorecam_PullImage(V3/V2) to 'pull' the image data

EXPLORE_EVENT_STILLIMAGE Still image which is triggered by function Explorecam_Snap or Explorecam_SnapN arrives. Use Explorecam_PullImageV3 or Explorecam_PullStillImage(V2) to 'pull' the image data

EXPLORE_EVENT_ERROR Generic error, data acquisition cannot continue

EXPLORE_EVENT_DISCONNECTED Camera disconnected, maybe has been pulled out

EXPLORE_EVENT_NOFRAMETIMEOUT Grab image no frame timeout error, data acquisition cannot continue

EXPLORE_EVENT_NOPACKETIMEOUT Grab image no packet timeout

EXPLORE_EVENT_TRIGGERFAIL trigger failed (for example, bad frame data or timeout)

EXPLORE_EVENT_BLACK black balance changed

EXPLORE_EVENT_FFC flat field correction status changed

EXPLORE_EVENT_DFC dark field correction status changed

EXPLORE_EVENT_ROI roi changed

EXPLORE_EVENT_LEVELRANGE level range changed

EXPLORE_EVENT_AUTOEXPO_FINISH auto exposure once mode finish

EXPLORE_EVENT_FACTORY restore factory settings. Please note that restoring factory settings may cause resolution changes.

EXPLORE_EVENT_EXPO_START Hardware exposure start

EXPLORE_EVENT_EXPO_STOP exposure stop

EXPLORE_EVENT_TRIGGER_ALLOW next trigger allow

EXPLORE_EVENT_HEARTBEAT heartbeat, can be used to monitor whether the camera is alive. see EXPLORE_OPTION_HEARTBEAT

In Push Mode, explore plays an active role. Once the video data is obtained from camera by internal thread, explore will 'PUSH' the image data to the application through PEXPLORE_DATA_CALLBACK. Call the function Explorecam_StartPushMode to start push mode. Push mode is more complex. There are some special precautions, such as multithread issues, being impossible to call Explorecam_Close and Explorecam_Stop in callback function PEXPLORE_DATA_CALLBACK_V4/V3, etc.

b. Still Capture (Still Image)

Most cameras support the so-called still capture capability. This function switches the camera to another resolution temporarily when the camera is in preview mode, after a "still" image in the new resolution is captured and then switch back to the original resolution and resume preview mode.

For example, UCMOS05100KPA support 3 resolutions and the current one in preview mode is 1280 * 960. Call Explorecam_Snap(h, 0) to "still capture" an image in 2592 * 1944 resolution. To realize this function, the camera will temporarily switch to 2592 * 1944 firstly, get an image in 2592 * 1944 resolution and then switch back to 1280 * 960 and resume preview.

a) In pull mode operation, after the still capture, EXPLORE_EVENT_STILLIMAGE will be sent out for external acknowledgement. The external application should call Explorecam_PullImageV3 or Explorecam_PullStillImage(V2) to get the still captured image.

b) In push mode operation, after the still capture, the callback function PEXPLORE_DATA_CALLBACK_V3 will be called with bSnap parameter setting TRUE. The image information including the resolution information will be obtained via the parameter pHeader.

To check whether the camera have the still capture capability, call Explorecam_get_StillResolutionNumber function or check the still field of the struct ExplorecamModelV2.

c. Data format: RGB vs RAW

Explorecam supports two data formats: RGB format (default) and RAW format. RAW format could be enabled by assigning EXPLORE_OPTION_RAW parameter to 1 when calling Explorecam_put_Option function.

RGB format: The output of every pixel contains 3 componants which stand for R/G/B value respectively. This output is a processed output from the internal color processing engine.

RAW format: In this format, the output is the raw data directly output from the sensor. The RAW format is for the users that want to skip the internal color processing and obtain the raw data for user-specific purpose. With the raw format output enabled, the functions that are related to the internal color processing will not work, such as Explorecam_put_Hue or Explorecam_AwbOnce function and so on.

Users could switch these two format by calling Explorecam_put_Option function with different value setting to EXPLORE_OPTION_RAW. You change this option only when camera is NOT running.

Users could change RGB bits by calling Explorecam_put_Option with different value setting to EXPLORE_OPTION_RGB. You change this option only when camera is NOT running.

d. White Balance and Auto White Balance: Temp/Tint mode vs RGB Gain mode

1. Explorecam sdk supports two independent modes for white balance: a) Temp/Tint Mode; b) RGB Gain Mode

a) Temp/Tint mode is the default white balance mode. In this mode, temp and tint are the parameters that could be used to control the white balance. Explorecam_get_TempTint function is used to acquire the temp and tint values and Explorecam_put_TempTint is used to set the temp and tint values. Function Explorecam_AwbOnce is used to execute the auto white balance. When the white balance parameters change, EXPLORE_EVENT_TEMPTINT event will be notified for external use.

b) In RGB Gain mode, the while balace is controled by the gain values of the R,G,B channels. Explorecam_get_WhiteBalanceGain is used to acquire the parameters and Explorecam_put_WhiteBalanceGain is used to set the white balance parameters. Explorecam_AwbInit is used to execute the execute the auto white balance. When the white balance parameters change, EXPLORE_EVENT_WBGAIN event will be notified for external use.

The functions for these two modes cannot be misused:

a) In Temp/Tint mode, please use Explorecam_get_TempTint and Explorecam_put_TempTint and Explorecam_AwbOnce. Explorecam_get_WhiteBalanceGain and Explorecam_put_WhiteBalanceGain and Explorecam_AwbInit cannot be used, they always return E_NOTIMPL.
b) In RGB Gain mode, please use Explorecam_get_WhiteBalanceGain and Explorecam_put_WhiteBalanceGain and Explorecam_AwbInit. Explorecam_get_TempTint and Explorecam_put_TempTint and Explorecam_AwbOnce cannot be used, they always return E_NOTIMPL

This mode is specified when the camera is opened and cannot be changed unless the camera is closed and opened again. Please see here.

2. There are two auto white balance mechanisms available in this field: one is continuous auto white balance and the other is a "once" auto white balance. The white balance parameters will be always calculated and updated for the continuous auto white balance mechanism. For "once" auto white balance mechanism, the white balance parameters will be calculated and updated only when triggered. Explorecam cameras support "once" auto white balance mechanism since it is more accurate and propriate for the microscope application, especially when the background is in pure color. Continuous white balance mechanism will encounter some problem in some cases.

3. Monochromatic camera does not support white balance. The functions metioned above always return E_NOTIMPL.

e. Trigger Mode

1. What is Trigger Mode

Explorecam camera has two working modes: video mode and trigger mode. When in trigger mode, no images will be available until the trigger conditions are met. Cameras have 2 types for triggering according to the types of trigger source, including software trigger mode, external trigger mode and simulated trigger mode.

2. The Difference between Trigger and Snap

Trigger mode is designed for accurate control of the camera and images would be acquired only when the conditions are met. Users could get the images by controlling the trigger conditions. Trigger mode must be pre-specified. Once the trigger mode is entered, no images will come out from the camera until the trigger conditions are met. The triggered images will stay the same property as the pre-specified resolution. Snap is designed to acquire the images from the camera in video mode. The resolution of the snapped image could be the same resolution as the video or could be different.

3. Software Trigger Mode

Camera could be triggered by software. In software trigger mode, images burst out only when users trigger the camera from the software. Numbers of the images of the triggering could also be controlled by software.

4. External Trigger Mode

Camera could be triggered by external trigger signal. By now Explorecam camera only supports positive-edge trigger mode.

5. Mix Trigger Mode

Both external and software trigger are enabled.

6. Simulated Trigger Mode

For cameras that do not support software trigger and external trigger, simulated trigger mode could be available. When in simulated trigger mode, the camera hardware actually works in the same mode as the video mode. But the up-level software will not obtain any images from the camera. The software buffer will stay empty until the user set the trigger conditions by software.

7. How to Enter the Trigger Mode

After the numeration of the connected camera, you can check the flag and find out what trigger mode does the camera support according to the following definition.
#define EXPLORE_FLAG_TRIGGER_SOFTWARE   0x00080000  /* support software trigger */
#define EXPLORE_FLAG_TRIGGER_EXTERNAL   0x00100000  /* support external trigger */
#define EXPLORE_FLAG_TRIGGER_SINGLE     0x00200000  /* only support trigger single: one trigger, one image */
Function Explorecam_put_Option(HExplorecam h, unsigned iOption, int iValue) could be used to set the camera to trigger mode when assign EXPLORE_OPTION_TRIGGER to the iOption parameter. iValue is used to specify the types of the trigger modes. Please see the following for reference.
#define EXPLORE_OPTION_TRIGGER   0x0b    /* 0 = video mode, 1 = software or simulated trigger mode, 2 = external trigger mode, 3 = external + software trigger, default value = 0 */
Function Explorecam_get_Option(HExplorecam h, unsigned iOption, int* piValue) could be used to get what type of trigger mode the camera is in.

8. How to Trigger the camera

Function Explorecam_Trigger(HExplorecam h, unsigned short nNumber) could be used to trigger the camera. Assigning different value to nNumber means different:
nNumber = 0 means stop the trigger.
nNumber = 0xFFFF means trigger continuously, the same as video mode;
nNumber = other valid values means nNumber images will come out from the camera.

If the EXPLORE_FLAG_TRIGGER_SINGLE flag is checked, the nNumber parameter must be assigned to 1 and 1 image will come out from the camera when Explorecam_Trigger is called.
Enter the trigger mode first and then call Explorecam_Trigger function to trigger the camera.

9. Trigger timeout

The timeout is recommended for not less than (Exposure Time * 102% + 4 Seconds).

4. Functions

HRESULT return value

HRESULT is not uncommon on the Windows platform. It's borrowed to macOS and Linux, see table below:

Please note that the return value >= 0 means success (especially S_FALSE is also successful, indicating that the internal value and the value set by the user is equivalent, which means "no operation"). Therefore, the SUCCEEDED and FAILED macros should generally be used to determine whether the return value is successful or failed.
(Unless there are special needs, do not use "==S_OK" or "==0" to judge the return value)

Name	Description	Value
S_OK	Success	0x00000000
S_FALSE	Success with noop	0x00000001
E_FAIL	Unspecified failure	0x80004005
E_ACCESSDENIED	General access denied error	0x80070005
E_INVALIDARG	One or more arguments are not valid	0x80070057
E_NOTIMPL	Not supported or not implemented	0x80004001
E_POINTER	Pointer that is not valid	0x80004003
E_UNEXPECTED	Catastrophic failure	0x8000FFFF
E_WRONG_THREAD	Call function in the wrong thread	0x8001010E
E_GEN_FAILURE	Device not functioning	0x8007001F
E_PENDING	The data necessary to complete this operation is not yet available	0x8000000a

#define SUCCEEDED(hr)   (((HRESULT)(hr)) >= 0)
#define FAILED(hr)      (((HRESULT)(hr)) < 0)

On windows platform, these HRESULT constants are already defined in the system header file. On other platforms, if you need to use these constants, you can #define EXPLORE_HRESULT_ERRORCODE_NEEDED before #include "explore.h". See below:

#define EXPLORE_HRESULT_ERRORCODE_NEEDED
#include "explore.h"

Calling Convention

Win: __stdcall, please see here

macOS, Linux and Android: __cdecl

Callback: PEXPLORE_EVENT_CALLBACK and PEXPLORE_DATA_CALLBACK_V3

These callback functions are called back from the internal thread in explore.dll, so great attention should be paid to multithread issue.
Please ensure that the callback funcion is simple and return quickly.
Otherwise, in callback mode, EXPLORE_OPTION_CALLBACK_THREAD can be setted to use a dedicated thread for callback.

There are limitations in the callback context:

(a) Do NOT call Explorecam_Stop and Explorecam_Close in this callback function, otherwise, deadlocks.

(b) Do NOT call Explorecam_put_Option with EXPLORE_OPTION_TRIGGER, EXPLORE_OPTION_BITDEPTH, EXPLORE_OPTION_PIXEL_FORMAT, EXPLORE_OPTION_BINNING, EXPLORE_OPTION_ROTATE, the return value is E_WRONG_THREAD.

Coordinate

Functions with coordinate parameters, such as Explorecam_put_Roi, Explorecam_put_AEAuxRect, etc., the coordinate is always relative to the original resolution, even that the video has been flipped, rotated, digital binning, ROI, or combination of the previous operations.

If the image is upsize down (see here), the coordinate must be also upsize down.

Explorecam_EnumV2

Return value: non-negative integer, enumerated camera number

Parameters:

ExplorecamDeviceV2 pti[EXPLORE_MAX]: ExplorecamDeviceV2 buffer

Remarks: call this function to enumerate Explorecam cameras that are currently connected to computer and when it is returned, ExplorecamDeviceV2 buffer contains the information of each camera instance enumerated.If we don't care about that multiple cameras connect to the computer simultaneously, it's optional to call this function to enumerate the camera instances.

(1) The code snippet shows as below:

ExplorecamDeviceV2 arr[EXPLORE_MAX];
unsigned cnt = Explorecam_EnumV2(arr);
for (unsigned i = 0; i < cnt; ++i)
    ......

typedef struct{
#ifdef _WIN32
    const wchar_t*     name;     /* model name */
#else
    const char*        name;
#endif
    unsigned long long flag;     /* EXPLORE_FLAG_xxx */
    unsigned           maxspeed; /* maximum speed level, Explorecam_get_MaxSpeed, the speed range = [0, maxspeed], closed interval */
    unsigned           preview;  /* number of preview resolution, Explorecam_get_ResolutionNumber */
    unsigned           still;    /* number of still resolution, Explorecam_get_StillResolutionNumber */
    unsigned           maxfanspeed; /* maximum fan speed, fan speed range = [0, max], closed interval */
    ExplorecamResolution  res[EXPLORE_MAX];
}ExplorecamModelV2;

name	The name of this model
flag	Bitwise flag
	EXPLORE_FLAG_CMOS	cmos sensor
	EXPLORE_FLAG_CCD_PROGRESSIVE	progressive ccd sensor
	EXPLORE_FLAG_CCD_INTERLACED	interlaced ccd sensor
	EXPLORE_FLAG_ROI_HARDWARE	support hardware ROI. Hardware ROI means only the ROI part of image is output from the sensor and the software cropping operation is not required. Higher frame rate is achieved when using hardware ROI method. Software ROI means the image with the complete field of view of the sensor will be output and software cropping operation is required to obtain the ROI image.
	EXPLORE_FLAG_MONO	monochromatic sensor
	EXPLORE_FLAG_BINSKIP_SUPPORTED	support bin/skip mode, see Explorecam_put_Mode and Explorecam_get_Mode
	EXPLORE_FLAG_USB30	usb3.0
	EXPLORE_FLAG_TEC	Thermoelectric Cooler
	EXPLORE_FLAG_USB30_OVER_USB20	usb3.0 camera connected to usb2.0 port
	EXPLORE_FLAG_ST4	ST4 port
	EXPLORE_FLAG_GETTEMPERATURE	support to get the temperature of the sensor, Explorecam_get_Temperature
	EXPLORE_FLAG_RAW10	Pixel format, RAW 10 bits
	EXPLORE_FLAG_RAW12	Pixel format, RAW 12 bits
	EXPLORE_FLAG_RAW14	Pixel format, RAW 14 bits
	EXPLORE_FLAG_RAW16	Pixel format, RAW 16 bits
	EXPLORE_FLAG_FAN	cooling fan
	EXPLORE_FLAG_TEC_ONOFF	Thermoelectric Cooler can be turn on or off, target temperature of TEC, see: EXPLORE_OPTION_TEC EXPLORE_OPTION_TECTARGET
	EXPLORE_FLAG_ISP	ISP (Image Signal Processing) chip
	EXPLORE_FLAG_TRIGGER_SOFTWARE	support software trigger
	EXPLORE_FLAG_TRIGGER_EXTERNAL	support external trigger
	EXPLORE_FLAG_TRIGGER_SINGLE	only support trigger single, one trigger, one image
	EXPLORE_FLAG_BLACKLEVEL	support set and get the black level
	EXPLORE_FLAG_FOCUSMOTOR	support focus motor
	EXPLORE_FLAG_AUTO_FOCUS	support auto focus
	EXPLORE_FLAG_BUFFER	frame buffer
	EXPLORE_FLAG_DDR	use very large capacity DDR (Double Data Rate SDRAM) for frame buffer. The capacity is not less than one full frame.
	EXPLORE_FLAG_CG	Conversion Gain: LCG, HCG
	EXPLORE_FLAG_CGHDR	Conversion Gain: LCG, HCG, HDR
	EXPLORE_FLAG_EVENT_HARDWARE	hardware event, such as exposure start & stop. see here and here
	EXPLORE_FLAG_YUV411	pixel format, yuv411
	EXPLORE_FLAG_YUV422	pixel format, yuv422
	EXPLORE_FLAG_YUV444	pixel format, yuv444
	EXPLORE_FLAG_RGB888	pixel format, RGB888
	EXPLORE_FLAG_RAW8	pixel format, RAW 8 bits
	EXPLORE_FLAG_GMCY8	pixel format, GMCY, 8 bits
	EXPLORE_FLAG_GMCY12	pixel format, GMCY, 12 btis
	EXPLORE_FLAG_GLOBALSHUTTER	global shutter
	EXPLORE_FLAG_PRECISE_FRAMERATE	support precise framerate & bandwidth, see EXPLORE_OPTION_PRECISE_FRAMERATE & EXPLORE_OPTION_BANDWIDTH
	EXPLORE_FLAG_HEAT	support heat to prevent fogging up, see EXPLORE_OPTION_HEAT & EXPLORE_OPTION_HEAT_MAX
	EXPLORE_FLAG_LOW_NOISE	support low noise mode, see EXPLORE_OPTION_LOW_NOISE
	EXPLORE_FLAG_LEVELRANGE_HARDWARE	hardware level range
	EXPLORE_FLAG_LIGHTSOURCE	light source
	EXPLORE_FLAG_FILTERWHEEL	filter wheel
maxspeed	Maximum speed level, same with Explorecam_get_MaxSpeed. The speed range is [0, maxspeed]. see Explorecam_put_Speed and Explorecam_get_Speed
preview	Number of preview resolution. Same with Explorecam_get_ResolutionNumber
still	Number of still resolution, zero means still capture is not supported. Same with Explorecam_get_StillResolutionNumber
res	Resolution, width and height

(2) On the Android platform, if the camera cannot be enumerated, it is possible that NDK has been restricted from enumerating USB devices. See here.

Explorecam_HotPlug

Return value: NA

Parameters:

PEXPLORE_HOTPLUG funHotPlug: callback function

typedef void (*PEXPLORE_HOTPLUG)(void* ctxHotPlug);

void* ctxHotPlug: callback context

Remarks:
This function is only available on macOS, Linux. To process the device plug in / pull out:
- On Windows, please refer to the MSDN(Device Management, Detecting Media Insertion or Removal).
- On Android, please refer here
- On Linux/macOS, please call this function to register the callback function. When the device is inserted or pulled out, you will be notified by the callback funcion, and then call Explorecam_EnumV2(...) again to enum the cameras.
- On macOS, IONotificationPortCreate series APIs can also be used as an alternative.
Recommendation: for better rubustness, when notify of device insertion arrives, don't open handle of this device immediately, but open it after delaying a short time (e.g., 200 milliseconds).

Explorecam_Open

Return value: HExplorecam handle. Return NULL when fails (Such as the device has been pulled out).

Parameters:

id: Explorecam camera instance, enumerated by Explorecam_EnumV2. If id is NULL, Explorecam_Open will open the first enumerated camera which connects to the computer. So, if we don't care about that multiple cameras connect to the computer simultaneously, Explorecam_EnumV2 is optional, we can simply use NULL as the parameter.

Remarks: open the camera instance.

(1) Supports attaching some additional parameters after id parameter, see table below: (Use ; to split, such as: Explorecam_Open(L"0-1010;registry=;wb=rgb"))

Camera Configuration	No parameter is required after id parameter if automatic parameter saving or loading is not required. Attach parameters, the camera configuration are automatically loaded when the camera is opened, and is automatically saved when the camera is close.
	;registry=xxxx\yyyy	Registry (Windows only)	use the registry that the camera parameters are saved to or load from. Empty after “=” means that the default registry location will be used
	;ini=x:\yyyy\zzzz.ini	ini file	Use x:\yyyy\zzzz.ini as the file where camera parameters are saved to or load from. Complete directory must be specified and empty is not allowed. Please Make sure that the target directory exists and is readable and writeable
	;json=x:\yyyy\zzzz.json	json file	Use x:\yyyy\zzzz.json as the file where camera parameters are saved to or load from. Complete directory must be specified and empty is not allowed. Please Make sure that the target directory exists and is readable and writeable
	;eeprom=xxxx	EEPROM	Use EEPROM as the device where the camera parameters are saved to or load from. xxxx is the starting address in EEPROM and empty means the starting address is 0
White Balance Mode	;wb=temptint or rgb	White Balance use Temp/Tint mode or RGB Gain mode, see here Default: Temp/Tint
Zerocopy on linux platform	;zerocopy=1 or 0	Helps to reduce memory copy and improve efficiency. Requires kernel version >= 4.6 and hardware platform support. If the image is wrong, this indicates that the hardware platform does not support this feature, please disable it. Disabled by default on Android or ARM, enabled on non-Android x86/x64

2. Android

(a) If the NDK has been granted permission to enumerate the usb device, the same as the normal process, there is no difference.

(b) If the NDK has NOT been granted permission to enumerate the usb device, so, we can only get device permissions on the Java side, and then transfer the file descriptor to Explorecam_Open. And then, there is no difference after getting the HExplorecam handle. See below:

usbManager = (UsbManager)getApplicationContext().getSystemService(Context.USB_SERVICE);
HashMap<String, UsbDevice> deviceList = usbManager.getDeviceList();
for (UsbDevice usbDevice : deviceList.values()) {
    ModelV2 model = explore.get_Model((short)usbDevice.getVendorId(), (short)usbDevice.getProductId()); //Get the camera model by VID/PID, return null for non-supported devices
    if (model != null) {
        usbManager.requestPermission(usbDevice, mPermissionIntent);
        UsbDeviceConnection usbDeviceConnection = usbManager.openDevice(camDevice);
        if (usbDeviceConnection != null) {
            int fileDescriptor = usbDeviceConnection.getFileDescriptor();                               //Get the native FileDescriptor
            explore cam = explore.Open(String.format("fd-%d-%04x-%04x", fileDescriptor, usbDevice.getVendorId(), usbDevice.getProductId())); //Open the camera
            usbDeviceConnection.close(); //Java side usb connection is no longer needed and is strongly recommended to be closed explicitly and immediately
            if (cam != null) {
                ... //From this point we can regularly use the explore object as usual
            }
        }
    }
}

Explorecam_Close

Return value: void

Parameters:

HExplorecam h: camera instance handle

Remarks: close the camera instance. After it is closed, never use the HExplorecam handle any more.

Explorecam_StartPullModeWithWndMsg
Explorecam_StartPullModeWithCallback

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

HWND hWnd: event occurs, message will be posted in this window

UINT nMsg: Windows custom message type. Its WPARAM parameter means event type EXPLORE_EVENT_xxxx, LPARAM is useless (always zero)

PEXPLORE_EVENT_CALLBACK funEvent, void* ctxEvent: callback function specified by user's application and callback context parameter.

typedef void (*PEXPLORE_EVENT_CALLBACK)(unsigned nEvent, void* ctxEvent);

see here.

Remarks: Obviously, Explorecam_StartPullModeWithWndMsg is only supported in Windows OS.

Explorecam_PullImageV3
Explorecam_PullImageV2
Explorecam_PullStillImageV2
Explorecam_PullImageWithRowPitchV2
Explorecam_PullStillImageWithRowPitchV2
Explorecam_PullImage
Explorecam_PullStillImage
Explorecam_PullImageWithRowPitch
Explorecam_PullStillImageWithRowPitch

Return value: HRESULT type means success or failure. Return E_PENDING when there isn't image ready for pull.

Parameters:

HExplorecam h: camera instance handle

void* pImageData: Data buffer. Users have to make sure that the data buffer capacity is enough to save the image data, data buffer capacity must >= rowPitch * nHeight.

int bStill: to pull still image, set to 1, otherwise 0

int bits: 24, 32, 48, 8, 16, 64, means RGB24, RGB32, RGB48, 8 bits grey, 16 bits grey or RGB64 images. bits = 0 means using default bits base on EXPLORE_OPTION_RGB. This parameter is ignored in RAW mode.

int rowPitch: the distance from one row to the next row. rowPitch = 0 means using the default row pitch. rowPitch = -1 means zero padding

unsigned* pnWidth, unsigned* pnHeight: out parameter. width and height of image.

ExplorecamFrameInfoV3/V2* pInfo: out parameter, frame info:
#define EXPLORE_FRAMEINFO_FLAG_SEQ          0x01 /* frame sequence number */
#define EXPLORE_FRAMEINFO_FLAG_TIMESTAMP    0x02 /* timestamp */
#define EXPLORE_FRAMEINFO_FLAG_EXPOTIME     0x04 /* exposure time */
#define EXPLORE_FRAMEINFO_FLAG_EXPOGAIN     0x08 /* exposure gain */
#define EXPLORE_FRAMEINFO_FLAG_BLACKLEVEL   0x10 /* black level */
#define EXPLORE_FRAMEINFO_FLAG_SHUTTERSEQ   0x20 /* sequence shutter counter */

typedef struct {
    unsigned            width;      /* image width */
    unsigned            height;     /* image height */
    unsigned            flag;       /* EXPLORE_FRAMEINFO_FLAG_xxxx, the flag is bit set, which means the corresponding value is valid */
    unsigned            seq;        /* frame sequence number */
    unsigned long long  timestamp;  /* microsecond */
    unsigned            shutterseq; /* sequence shutter counter */
    unsigned            expotime;   /* exposure time */
    unsigned short      expogain;   /* exposure gain */
    unsigned short      blacklevel; /* black level */
} ExplorecamFrameInfoV3;

Remarks: when pImageData is NULL, while pnWidth and pnHeight are not NULL, you can "peek" the width and height of images.

(a) When bits and EXPLORE_OPTION_RGB are inconsistent, format conversion will have to be performed, resulting in loss of efficiency. See the following bits and EXPLORE_OPTION_RGB correspondence table:

EXPLORE_OPTION_RGB 0 (RGB24) 1 (RGB48) 2 (RGB32) 3 (Grey8) 4 (Grey16) 5 (RGB64)

bits = 0 24 48 32 8 16 64

bits = 24 24 NA Convert to 24 Convert to 24 NA NA

bits = 32 Convert to 32 NA 32 Convert to 32 NA NA

bits = 48 NA 48 NA NA Convert to 48 Convert to 48

bits = 8 Convert to 8 NA Convert to 8 8 NA NA

bits = 16 NA Convert to 16 NA NA 16 Convert to 16

bits = 64 NA Convert to 64 NA NA Convert to 64 64

(b) Please ensure that the pImageData buffer is large enough to hold the entire frame data, see table below:

Format =0 means Default Row Pitch =-1 means zero paddding

RGB RGB24 TDIBWIDTHBYTES(24 * Width) Width * 3

RGB32 Width * 4 Width * 4

RGB48 TDIBWIDTHBYTES(48 * Width) Width * 6

GREY8 grey image TDIBWIDTHBYTES(8 * Width) Width

GREY16 grey image TDIBWIDTHBYTES(16 * Width) Width * 2

RGB64 Width * 8 Width * 8

RAW 8bits Mode Width Width

10bits, 12bits, 14bits, 16bits Mode Width * 2 Width * 2

#ifndef TDIBWIDTHBYTES
#define TDIBWIDTHBYTES(bits) ((unsigned)(((bits) + 31) & (~31)) / 8)
#endif

Explorecam_StartPushModeV4
Explorecam_StartPushModeV3

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle.

PEXPLORE_DATA_CALLBACK_V3 funDataV3, void* ctxDataV3: the callback function and callback context parameters that are specified by the user's program. Explorecam.dll gets image data from the camera, then calls back this function.

typedef void (*PEXPLORE_DATA_CALLBACK_V3)(const void* pData, const ExplorecamFrameInfoV2* pInfo, int bSnap, void* ctxDataV3);

see here.

when calls back, if Parameter pData == NULL, then internal error occurs (eg: the camera is pulled out suddenly).
The row pitch of pData is always the default value.
For parameter int bSnap, TRUE means still image snap by Explorecam_Snap or Explorecam_SnapN function, FALSE means ordinary previewed pictures / videos.

Remarks: start camera instance.

Explorecam_Stop

Return value: HRESULT type means success or failure

Parameters:

HExplorecam handle

Remarks: stop the camera instance. After stopped, it can be restart again. For example, switching the video resolution:

Step 1: call Explorecam_Stop to stop

Step 2: call Explorecam_put_Size or Explorecam_put_eSize to set the new resolution

Step 3: call Explorecam_StartPullModeWithWndMsg or Explorecam_StartPullModeWithCallback or Explorecam_StartPushModeV4/V3 to restart

Explorecam_Pause

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

Remarks: pause/continue camera instance.

Explorecam_Snap
Explorecam_SnapN

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned nResolutionIndex: resolution index.

unsigned nNum: the number to be snapped.

Remarks: snap 'still' image, please see here. When snap successfully:

a) If we use Pull Mode, it will be notified by EXPLORE_EVENT_STILLIMAGE.

b) If we use Push Mode, the image will be returned by callback function PEXPLORE_DATA_CALLBACK_V3 with the parameter int bSnap is TRUE.

Most cameras can snap still image with different resolutions under continuous preview. For example, UCMOS03100KPA's previewed resolution is 1024*768, if we call Explorecam_Snap(h, 0), we get so called "still image" with 2048*1536 resolution.
Some cameras hasn't this ability, so nResolutionIndex must be equal the preview resolution which is set by Explorecam_put_Size, or Explorecam_put_eSize.
Whether it supports "still snap" or not, see "still" domain in ExplorecamModelV2.

Explorecam_Snap(h, index) == Explorecam_SnapN(h, index, 1)

Explorecam_Trigger

Return value: HRESULT type means success or failure.

Parameters:

HExplorecam h: camera instance handle

unsigned short nNumber: 0xffff(trigger continuously), 0(stop / cancel trigger), others(number of images to be triggered)

Remarks: in trigger mode, call this function to trigger an image:

a) If we use Pull Mode, it will be notified by EXPLORE_EVENT_IMAGE.

b) If we use Push Mode, the image will be returned by callback function PEXPLORE_DATA_CALLBACK_V3 with the parameter int bSnap is FALSE.

Explorecam_put_Size
Explorecam_get_Size
Explorecam_put_eSize
Explorecam_get_eSize

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned nResolutionIndex: current/present resolution index

int nWidth, int nHeight: width and height of current resolution index

Remarks: set/get current resolution

Set resolution while camera is NOT running
There are two ways to set current resolution: one is by resolution index, the other by width/height. Both ways are equivalent. For example, UCMOS03100KPA supports the following three kinds of resolution:
    Index 0: 2048, 1536
    Index 1: 1024, 768
    Index 2: 680, 510
So Explorecam_put_Size(h, 1024, 768) is as effective as Explorecam_put_eSize(h, 1)

Explorecam_put_Roi
Explorecam_get_Roi

Return value: HRESULT type means success or failure.

Parameters:

HExplorecam h: camera instance handle

unsigned xOffset: x offset, must be even number

unsigned yOffset: y offset, must be even number

unsigned xWidth: width, must be even number and must not be less than 16

unsigned yHeight: height, must be even number and must not be less than 16

Remarks: set/get the ROI. Explorecam_put_Roi(h, 0, 0, 0, 0) means to clear the ROI and restore the original size.

Important: It is forbidden to call Explorecam_put_Roi in the callback context of PEXPLORE_EVENT_CALLBACK and PEXPLORE_DATA_CALLBACK_V3, the return value is E_WRONG_THREAD.

Pay attention to that the coordinate is always relative to the original resolution, see here.

The second resolution of UHCCD03100KPB, UHCCD05000KPA, UHCCD05100KPA don't support ROI, so the return value is E_NOTIMPL.

Explorecam_get_ResolutionNumber
Explorecam_get_Resolution

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned nResolutionIndex: resolution index

int* pWidth, int* pHeight: width/height

Remarks: Explorecam_get_ResolutionNumber means the number of resolution supported. Take UCMOS03100KPA as an example, if we call the function Explorecam_get_ResolutionNumber and get "3", which means it can support three kinds of resolution. Explorecam_get_Resolution gets the width/height of each kind of resolution.

These parameters have also been contained in ExplorecamModelV2.

Explorecam_get_RawFormat

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned* nFourCC: raw format, see table below

unsigned* bitdepth: bit depth, such as 8, 10, 12, 14, 16

#ifndef MAKEFOURCC
#define MAKEFOURCC(a, b, c, d) ((unsigned)(unsigned char)(a) | ((unsigned)(unsigned char)(b) << 8) | ((unsigned)(unsigned char)(c) << 16) | ((unsigned)(unsigned char)(d) << 24))
#endif

MAKEFOURCC('G', 'B', 'R', 'G') GBGBGB...
RGRGRG...
GBGBGB...
RGRGRG...
...
see here

MAKEFOURCC('R', 'G', 'G', 'B') RGRGRG...
GBGBGB...
RGRGRG...
GBGBGB...
...

MAKEFOURCC('B', 'G', 'G', 'R') BGBGBG...
GRGRGR...
BGBGBG...
GRGRGR...
...

MAKEFOURCC('G', 'R', 'B', 'G') GRGRGR...
BGBGBG...
GRGRGR...
BGBGBG...
...

MAKEFOURCC('V', 'U', 'Y', 'Y') YUV4:2:2, please see: http://www.fourcc.org

MAKEFOURCC('U', 'Y', 'V', 'Y') YUV4:2:2

MAKEFOURCC('Y', 'Y', 'Y', 'Y') Black / White camera

Explorecam_put_Option
Explorecam_get_Option

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned iOption: see table below

int iValue: see table below

Option Description Default Can be changed when camera is running?
(Before Explorecam_StartXXXX or after Explorecam_Stop)

EXPLORE_OPTION_RAW 0 means RGB mode.
1 means RAW mode, read the CMOS or CCD raw data. 0 No
(The return value is E_UNEXPECTED when set this option while camera is running)

EXPLORE_OPTION_BITDEPTH Some cameras support the bit depth which is more than 8 such as 10, 12, 14, 16.
0 = use 8 bits depth.
1 = use the maximum bits depth of this camera. NA Yes.
But not recommended to modify frequently while camera is running.

EXPLORE_OPTION_TRIGGER 0 = video mode
1 = software or simulated trigger mode
2 = external trigger mode
3 = external + software trigger 0 Yes

EXPLORE_OPTION_RGB 0 = RGB24
1 = RGB48 format when bitdepth > 8
2 = RGB32
3 = 8 bits grey (only for mono camera)
4 = 16 bits grey (only for mono camera and bitdepth > 8)
5 = RGB64 format when bitdepth > 8 0 No
(The return value is E_UNEXPECTED when set this option while camera is running)

EXPLORE_OPTION_BYTEORDER Byte order:
1: BGR
0: RGB Win: 1
Linux/MacOS/Android: 0 Yes.
But not recommended to modify frequently while camera is running.

EXPLORE_OPTION_UPSIDE_DOWN Upside down:
1: yes
0: no
Please distinguish it from Explorecam_put_VFlip, which requires the CPU to perform data moving work on each frame of data Win: 1
Linux/MacOS/Android: 0 Yes

EXPLORE_OPTION_FAN Some cameras support the cooling fan.
0 = turn off the cooling fan
[1, max] = fan speed NA Yes

EXPLORE_OPTION_TEC Some cameras support to turn on or off the thermoelectric cooler.
0 = turn off the thermoelectric cooler
1 = turn on the thermoelectric cooler 1 Yes

EXPLORE_OPTION_TECTARGET get or set the target temperature of the thermoelectric cooler, in 0.1℃. For example, 125 means 12.5℃, -35 means -3.5℃ NA Yes

EXPLORE_OPTION_AUTOEXP_POLICY Auto Exposure Policy:
0: Exposure Only
1: Exposure Preferred
2: Gain Only
3: Gain Preferred 1 Yes

EXPLORE_OPTION_AUTOEXP_THRESHOLD threshold of auto exposure, range: [2~15] 5 Yes

EXPLORE_OPTION_FRAMERATE limit the frame rate, range=[0, 63].
frame rate control is disabled automatically in trigger mode. 0
(means no limit) No
(The return value is E_UNEXPECTED when set this option while camera is running)

EXPLORE_OPTION_BLACKLEVEL Black Level
Always return E_NOTIMPL for camera that don't support black level. 0 Yes

EXPLORE_OPTION_MULTITHREAD multithread image processing 1 No
(The return value is E_UNEXPECTED when set this option while camera is running)

EXPLORE_OPTION_BINNING digital binning:

0x01 (no binning)

n: (saturating add, n*n), 0x02(2*2), 0x03(3*3), 0x04(4*4), 0x05(5*5), 0x06(6*6), 0x07(7*7), 0x08(8*8). The Bitdepth of the data remains unchanged.

0x40 | n: (unsaturated add in RAW mode, n*n), 0x42(2*2), 0x43(3*3), 0x44(4*4), 0x45(5*5), 0x46(6*6), 0x47(7*7), 0x48(8*8). The Bitdepth of the data is increased. For example, the original data with bitdepth of 12 will increase the bitdepth by 2 bits and become 14 after 2*2 binning.

0x80 | n: (average, n*n), 0x82(2*2), 0x83(3*3), 0x84(4*4), 0x85(5*5), 0x86(6*6), 0x87(7*7), 0x88(8*8). The Bitdepth of the data remains unchanged.

The final image size is rounded down to an even number, such as 640/3 to get 212 1 Yes

EXPLORE_OPTION_ROTATE rotate clockwise: 0, 90, 180, 270 0 Yes

EXPLORE_OPTION_CG Conversion Gain:
0: LCG
1: HCG
2: HDR NA Yes

EXPLORE_OPTION_PIXEL_FORMAT pixel format NA Yes.
But not recommended to modify frequently while camera is running.

EXPLORE_OPTION_DDR_DEPTH the number of the frames that DDR can cache:
1: DDR cache only one frame
0: Auto:
=> one for video mode when auto exposure is enabled

=> full capacity for others
-1: DDR can cache frames to full capacity 0 Yes

EXPLORE_OPTION_FFC Flat Field Correction:
set:
0: disable
1: enable
-1: reset
(0xff000000 | n): set the average number to n, [1~255]
get:
(val & 0xff): 0 => disable, 1 => enable, 2 => inited
((val & 0xff00) >> 8): sequence
((val & 0xff0000) >> 8): average number
0 Yes

EXPLORE_OPTION_DFC Dark Field Correction:
set:
0: disable
1: enable
-1: reset
(0xff000000 | n): set the average number to n, [1~255]
get:
(val & 0xff): 0 => disable, 1 => enable, 2 => inited
((val & 0xff00) >> 8): sequence
((val & 0xff0000) >> 8): average number
0 Yes

EXPLORE_OPTION_SHARPENING Sharpening, (threshold << 24) | (radius << 16) | strength)
strength: [0, 500], default: 0 (disable)
radius: [1, 10]
threshold: [0, 255]
0 Yes

EXPLORE_OPTION_FACTORY restore the factory settings Always 0 Yes

EXPLORE_OPTION_TEC_VOLTAGE get the current TEC voltage in 0.1V, 59 mean 5.9V;
Please do not get this value too frequently, the recommended interval is 2 seconds or more NA NA

EXPLORE_OPTION_TEC_VOLTAGE_MAX get the TEC maximum voltage in 0.1V NA NA

EXPLORE_OPTION_POWER get power consumption, unit: milliwatt NA NA

EXPLORE_OPTION_GLOBAL_RESET_MODE global reset mode 0 Yes

EXPLORE_OPTION_DEVICE_RESET reset usb device, simulate a replug NA NA

EXPLORE_OPTION_FOCUSPOS focus positon NA Yes

EXPLORE_OPTION_AFMODE auto focus mode:
0: manul focus
1: auto focus
2: once focus
3: conjugate calibration NA Yes

EXPLORE_OPTION_AFZONE auto focus zone NA Yes

EXPLORE_OPTION_AFFEEDBACK auto focus information feedback:
0: unknown
1: focused
2: focusing
3: defocus
4: up
5: down NA Yes

EXPLORE_OPTION_TESTPATTERN test pattern:
0: TestPattern Off
3: monochrome diagonal stripes
5: monochrome vertical stripes
7: monochrome horizontal stripes
9: chromatic diagonal stripes 0 Yes

EXPLORE_OPTION_NOFRAME_TIMEOUT Report error if cannot grab frame in maximum exposure time.
1 = enable this feature;
0 = disable this feature. 0 Yes

EXPLORE_OPTION_NOPACKET_TIMEOUT Report event if cannot grab packet in the set time.
0 = disable this feature
positive value = timeout milliseconds 0 Yes

EXPLORE_OPTION_BANDWIDTH bandwidth, range:[1-100]%
After setting the bandwidth, get the accurate frame rate range, and then set the precise frame rate 90% Yes

EXPLORE_OPTION_MAX_PRECISE_FRAMERATE get the precise frame maximum value in 0.1fps, such as 115 means 11.5fps
the maximum value depends the bandwidth/resolution/bitdepth/ROI
E_NOTIMPL means not supported NA NA

EXPLORE_OPTION_MIN_PRECISE_FRAMERATE get the precise frame minimum value in 0.1fps, such as 15 means 1.5fps
the minimum value depends the bandwidth/resolution/bitdepth/ROI
E_NOTIMPL means not supported NA NA

EXPLORE_OPTION_PRECISE_FRAMERATE in 0.1fps, such as 115 means 11.5fps. range:[1~maximum] 90% of the maximum Yes

EXPLORE_OPTION_RELOAD Reload the last frame in the trigger mode
get return value S_OK means supporting this feature, E_NOTIMPL means not supported NA Yes

EXPLORE_OPTION_CALLBACK_THREAD dedicated thread for callback, only available in pull mode 0 No

EXPLORE_OPTION_FRONTEND_DEQUE_LENGTH
or
EXPLORE_OPTION_FRAME_DEQUE_LENGTH frontend (raw) frame deque length, range: [2, 1024]
All the memory will be pre-allocated when the camera starts, so, please attention to memory usage 4 No

EXPLORE_OPTION_BACKEND_DEQUE_LENGTH backend (pipelined) frame deque length (Only available in pull mode), range: [2, 1024]
All the memory will be pre-allocated when the camera starts, so, please attention to memory usage 3 No

EXPLORE_OPTION_SEQUENCER_ONOFF sequencer trigger: on/off 0 Yes

EXPLORE_OPTION_SEQUENCER_NUMBER sequencer trigger: number, range = [1, 255] NA Yes

EXPLORE_OPTION_SEQUENCER_EXPOTIME sequencer trigger: exposure time
iOption = EXPLORE_OPTION_SEQUENCER_EXPOTIME | index
iValue = exposure time (no 50/60 HZ constraint)

For example, to set the exposure time of the third group to 50ms, call
Explorecam_put_Option(EXPLORE_OPTION_SEQUENCER_EXPOTIME | 3, 50000) NA Yes

EXPLORE_OPTION_SEQUENCER_EXPOGAIN sequencer trigger: exposure gain
iOption = EXPLORE_OPTION_SEQUENCER_EXPOGAIN | index
iValue = gain NA Yes

EXPLORE_OPTION_DENOISE Denoise
strength range: [0, 100], 0 means disable 0 Yes

EXPLORE_OPTION_HEAT_MAX get maximum level: heat to prevent fogging up
[0, max], 0 means off NA NA

EXPLORE_OPTION_HEAT heat to prevent fogging up max level Yes

EXPLORE_OPTION_LIGHTSOURCE_MAX get maximum level: light source
[0, max], 0 means off NA NA

EXPLORE_OPTION_LIGHTSOURCE light source level 50% max level Yes

EXPLORE_OPTION_HEARTBEAT Heartbeat interval in millisecond
range: [EXPLORE_HEARTBEAT_MIN, EXPLORE_HEARTBEAT_MAX]
0: disable disable Yes

TOUCPAM_OPTION_EVENT_HARDWARE enable or disable hardware event notify: 0 => disable, 1 => enable
(1) iOption = EXPLORE_OPTION_EVENT_HARDWARE, master switch for notification of all hardware events
(2) iOption = EXPLORE_OPTION_EVENT_HARDWARE | (event type), a specific type of sub-switch
Only if both the master switch and the sub-switch of a specific type remain on are actually enabled for that type of event notification.
see here and here disable Master switch: No
Sub-switch: Yes

EXPLORE_OPTION_LOW_NOISE low noise mode (Higher signal noise ratio, lower frame rate) 0 Yes

EXPLORE_OPTION_AUTOEXPOSURE_PERCENT auto exposure percent to average
1~99: top percent average
0 or 100: full roi average 10 Yes

EXPLORE_OPTION_DEFECT_PIXEL Defect Pixel Correction
0 => disable, 1 => enable enable (1) Yes

EXPLORE_OPTION_THREAD_PRIORITY set the priority of the internal thread which grab data from the usb device.
Win:
0 = THREAD_PRIORITY_NORMAL;
1 = THREAD_PRIORITY_ABOVE_NORMAL;
2 = THREAD_PRIORITY_HIGHEST;
3 = THREAD_PRIORITY_TIME_CRITICAL;
Please refer to SetThreadPriority
Linux & macOS:
The high 16 bits for the scheduling policy, and the low 16 bits for the priority.
Please refer to pthread_setschedparam
Win: 1
Linux / macOS: NA Yes

EXPLORE_OPTION_LINEAR 0 = turn off the builtin linear tone mapping
1 = turn on the builtin linear tone mapping 1 Yes

EXPLORE_OPTION_CURVE 0 = turn off the builtin curve tone mapping
1 = turn on the builtin polynomial curve tone mapping
2 = turn on the builtin logarithmic curve tone mapping 2 Yes

EXPLORE_OPTION_COLORMATIX 0 = turn off the builtin color matrix
1 = turn on the builtin color matrix 1 Yes

EXPLORE_OPTION_WBGAIN 0 = turn off the builtin white balance gain
1 = turn on the builtin white balance gain 1 Yes

EXPLORE_OPTION_DEMOSAIC Demosaic mothod for both video and still image: (Please refrence https://en.wikipedia.org/wiki/Demosaicing)
0 = BILINEAR
1 = VNG(Variable Number of Gradients)
2 = PPG(Patterned Pixel Grouping)
3 = AHD(Adaptive Homogeneity Directed)
4 = EA(Edge Aware)
Always return E_NOTIMPL for monochromatic camera. 0 Yes

EXPLORE_OPTION_DEMOSAIC_VIDEO Demosaic mothod for video 0 Yes

EXPLORE_OPTION_DEMOSAIC_STILL Demosaic mothod for still image 0 Yes

EXPLORE_OPTION_OPEN_USB_ERRORCODE get the open usb error code NA NA

EXPLORE_OPTION_FLUSH 1: hard flush, discard frames cached by camera DDR (if any)
2: soft flush, discard frames cached by explore.dll (if any)
3: both
Explorecam_Flush means 'both'
return the number of soft flushed frames if successful, HRESULT if failed NA NA

EXPLORE_OPTION_NUMBER_DROP_FRAME get the number of frames that have been grabbed from the USB but dropped by the software NA NA

EXPLORE_OPTION_DUMP_CFG 0 = when camera is stopped, do not dump configuration automatically
1 = when camera is stopped, dump configuration automatically
-1 = explicitly dump configuration once 1 Yes

EXPLORE_OPTION_FRONTEND_DEQUE_CURRENT get the current number in frontend deque NA NA

EXPLORE_OPTION_BACKEND_DEQUE_CURRENT get the current number in backend deque NA NA

EXPLORE_OPTION_PACKET_NUMBER get the received packet number NA NA

EXPLORE_OPTION_FILTERWHEEL_SLOT filter wheel slot number 7 Yes

EXPLORE_OPTION_FILTERWHEEL_POSITION filter wheel position:
set:
-1: calibrate
val & 0xff: position between 0 and N-1, where N is the number of filter slots
(val >> 8) & 0x1: direction, 0 => clockwise spinning, 1 => auto direction spinning
get:
-1: in motion
val: position arrived
NA Yes

Important:

a. Some options cannot be changed while the camera is running.

b. It is forbidden to call Explorecam_put_Option with EXPLORE_OPTION_TRIGGER, EXPLORE_OPTION_BITDEPTH, EXPLORE_OPTION_PIXEL_FORMAT, EXPLORE_OPTION_BINNING, EXPLORE_OPTION_ROTATE in the callback context of PEXPLORE_EVENT_CALLBACK and PEXPLORE_DATA_CALLBACK_V3, the return value is E_WRONG_THREAD.

c. The second resolution of UHCCD03100KPB, UHCCD05000KPA, UHCCD05100KPA don't support RAW mode.

Explorecam_put_RealTime
Explorecam_get_RealTime

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

int val:

0: stop grab frame when frame buffer deque is full, until the frames in the queue are pulled away and the queue is not full
1: realtime
use minimum frame buffer. When new frame arrive, drop all the pending frame regardless of whether the frame buffer is full
If DDR present, also limit the DDR frame buffer to only one frame.
2: soft realtime
Drop the oldest frame when the queue is full and then enqueue the new frame

Remarks: If you set RealTime mode as 1, then you get shorter frame delay but lower frame rate which damages fluency. The default value is 0.

Explorecam_get_AutoExpoEnable
Explorecam_put_AutoExpoEnable
Explorecam_get_AutoExpoTarget
Explorecam_put_AutoExpoTarget
Explorecam_put_MaxAutoExpoTimeAGain
Explorecam_get_MaxAutoExpoTimeAGain
Explorecam_put_MinAutoExpoTimeAGain
Explorecam_get_MinAutoExpoTimeAGain

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

int bAutoExposure:

0: disable auto exposure
1: auto exposure continue mode
2: auto exposure once mode

unsigned short Target: auto-exposure target

unsigned maxTime, unsigned short maxAGain: the maximum time and maximum gain of auto exposure. The default values are 350ms and 500.

unsigned minTime, unsigned short minAGain: the minimal time and minimal gain of auto exposure. The default values are 0 and 100.

Remarks: If auto exposure is enabled, the exposure time and gain are controlled by software to make the average brightness of the target rectangle as close as possible to the auto exposure target. The auto exposure target value is the target brightness of the target rectangle (see Explorecam_put_AEAuxRect, Explorecam_get_AEAuxRect).

Explorecam_get_ExpoTime
Explorecam_put_ExpoTime
Explorecam_get_ExpTimeRange
Explorecam_get_RealExpoTime

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned Time: exposure time, unit: microsecond

unsigned* nMin, unsigned* nMax, unsigned* nDef: the minimum, maximum and default value of exposure time.

Remarks: exposure time related. Explorecam_get_RealExpoTime get the real exposure time based on 50HZ/60HZ.

Explorecam_get_ExpoAGain
Explorecam_put_ExpoAGain
Explorecam_get_ExpoAGainRange

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned short AGain: gain, shown in percentage, eg, 200 means the gain is 200%

unsigned short* nMin, unsigned short* nMax, unsigned short* nDef: the minimum, maximum and default value of gain.

Remarks: gain related.

Explorecam_put_Hue
Explorecam_get_Hue
Explorecam_put_Saturation
Explorecam_get_Saturation
Explorecam_put_Brightness
Explorecam_get_Brightness
Explorecam_get_Contrast
Explorecam_put_Contrast
Explorecam_get_Gamma
Explorecam_put_Gamma

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

Remarks: set or get hue, saturation, brightness, contrast and gamma.

Explorecam_get_Chrome
Explorecam_put_Chrome

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

int bChrome: TRUE or FALSE

Remarks: color or grey mode

Explorecam_get_VFlip
Explorecam_put_VFlip
Explorecam_get_HFlip
Explorecam_put_HFlip

Return value: HRESULT type means success or failure

Parameters: HExplorecam h: camera instance handle

Remarks: vertical/horizontal flip.

Explorecam_put_Speed
Explorecam_get_Speed
Explorecam_get_MaxSpeed

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned short nSpeed: frame rate level

Remarks: the minimum frame rate level is "0", the maximum one can be achieved through Function "Explorecam_get_MaxSpeed" which equals to maxspeed in ExplorecamModelV2.
For some cameras that support the so-called precise frame rate, it is recommended to use precise frame rate control. In order to maintain compatibility, Speed is still valid, and the mapping mechanism is: MaxSpeed is 9 (10 levels in total), corresponding to the maximum frame rate when Bandwidth is from 10% to 100%. For example, set the speed to 8, which is equivalent to: The precise frame rate is set to the maximum frame rate with bandwith is set to 90%.

Explorecam_put_HZ
Explorecam_get_HZ

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

int nHZ: 0: 60Hz alternating current, 1: 50Hz alternating current, 2: direct current

Remarks: set the light source power frequency

Explorecam_get_Temperature
Explorecam_put_Temperature

Return value: HRESULT type means success or failure, E_NOTIMPL means not supporting get or set the temperature

Parameters:

HExplorecam h: camera instance handle

short nTemperature: in 0.1℃ (32 means 3.2℃, -35 means -3.5℃).

Remarks: get the temperature of the sensor. see EXPLORE_FLAG_GETTEMPERATURE.

set the target temperature of the sensor, equivalent to Explorecam_put_Option(, EXPLORE_OPTION_TECTARGET, ).

Explorecam_put_Mode
Explorecam_get_Mode

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

int bSkip: Bin mode or Skip mode.

Remarks: set Bin mode or Skip mode. Cameras with higher resolution can support two sampling modes, one is Bin mode (Neighborhood averaging), the other is Skip (sampling extraction). In comparison, the former is with better image effect but decreasing frame rate while the latter is just the reverse.

Explorecam_put_TempTint
Explorecam_get_TempTint

Return value: HRESULT type means success or failure. Works int Temp/Tint mode. Does not work int RGB Gain mode, E_NOTIMPL will be return.

Parameters:

HExplorecam h: camera instance handle

int nTemp, int nTint: color temperature and Tint

Remarks: set/get the color temperature and Tint parameters of white balance (Temp/Tint Mode, please see here).

Explorecam_AwbOnce

Return value: HRESULT type means success or failure. Works int Temp/Tint mode. Does not work int RGB Gain mode, E_NOTIMPL will be return.

Parameters:

HExplorecam h: camera instance handle

PIEXPLORE_TEMPTINT_CALLBACK funTT, void* ctxTT: callback function and callback context when the automatic white balance completes.

Remarks: Call this function to perform one "auto white balance" in Temp/Tint Mode. When the "auto white balance" completes, EXPLORE_EVENT_TEMPTINT event notify the application (In Pull Mode) and callback happens. In pull mode, this callback is useless, set it to NULL.

Explorecam_put_WhiteBalanceGain
Explorecam_get_WhiteBalanceGain

Return value: HRESULT type means success or failure. Works int RGB Gain mode. Does not work int Temp/Tint Gain mode, E_NOTIMPL will be return.

Parameters:

HExplorecam h: camera instance handle

int aGain[3]: RGB Gain

Remarks: set/get the RGB gain parameters of white balance (RGB Gain Mode, please see here).

Explorecam_AwbInit

Return value: HRESULT type means success or failure. Works int RGB Gain mode. Does not work int Temp/Tint mode, E_NOTIMPL will be return.

Parameters:

HExplorecam h: camera instance handle

PIEXPLORE_WHITEBALANCE_CALLBACK funWB, void* ctxWB: callback function and callback context when the automatic white balance completes.

Remarks: Call this function to perform one "auto white balance" in RGB Gain Mode. When the "auto white balance" completes, EXPLORE_EVENT_WBGAIN event notify the application (In Pull Mode) and callback happens. In pull mode, this callback is useless, set it to NULL.

Explorecam_AbbOnce

Return value: HRESULT type means success or failure.

Parameters:

HExplorecam h: camera instance handle

PIEXPLORE_BLACKBALANCE_CALLBACK funBB, void* ctxBB: callback function and callback context when the automatic black balance completes.

Remarks: Call this function to perform one "auto black balance". When the "auto black balance" completes, EXPLORE_EVENT_BLACK event notify the application (In Pull Mode) and callback happens. In pull mode, this callback is useless, set it to NULL.

Explorecam_put_BlackBalance
Explorecam_get_BlackBalance

Return value: HRESULT type means success or failure.

Parameters:

HExplorecam h: camera instance handle

unsigned short aSub[3]: RGB Offset

Remarks: set/get the RGB offset parameters of black balance.

Explorecam_put_AWBAuxRect
Explorecam_get_AWBAuxRect
Explorecam_put_AEAuxRect
Explorecam_get_AEAuxRect
Explorecam_put_ABBAuxRect
Explorecam_get_ABBAuxRect

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

Remarks: set/get the rectangle of automatic white balance and auto-exposure and automatic black balance. The default Rectangle is in the center of the image, its width is 20% image with, its height is 20% image height.

Pay attention to that the coordinate is always relative to the original resolution, see here.

Explorecam_get_MonoMode

Return value: S_OK means mono mode, S_FALSE means color mode

Parameters:

Explorecam h: camera instance handle

Remarks: grey camera or not, find the flag in ExplorecamModelV2: EXPLORE_FLAG_MONO

Explorecam_get_MaxBitDepth

Return value: the maximum bit depth this camera supports.

Parameters:

HExplorecam h: camera instance handle

Remarks: Some cameras support the bit depth which is more than 8 such as 10, 12, 14, 16.

Explorecam_get_StillResolutionNumber
Explorecam_get_StillResolution

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned nResolutionIndex: resolution index

int* pWidth, int* pHeight: width/height

Remarks: Explorecam_get_StillResolutionNumber means the number of supported still resolution. Take UCMOS03100KPA as an example, if we call the function Explorecam_get_StillResolutionNumber and get "3", which means it can support three kinds of resolution. If it doesn't support "still snap", then we get "0". Explorecam_get_Resolution gs the width/height of each kind of resolution.

Explorecam_get_SerialNumber
Explorecam_get_FwVersion
Explorecam_get_HwVersion
Explorecam_get_ProductionDate
Explorecam_get_Revision

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

char sn[32]: buffer to the serial number, such as: TP110826145730ABCD1234FEDC56787

char fwver[16]: buffer to the firmware version, such as: 3.2.1.20140922

char hwver[16]: buffer to the hardware version, such as: 3.12

char pdate[10]: buffer to the production date, such as: 20150327

unsigned short pRevision: revision

Remarks: each camera has a unique serial number with 31 letters.

Explorecam_get_PixelSize

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned nResolutionIndex: resolution index

float* x, float* y: physical pixel size(µm)

Explorecam_put_LEDState

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned short iLed: the index of LED light

unsigned short iState: LED status, 1 => Ever bright; 2 => Flashing; other => Off

unsigned short iPeriod: Flashing Period (>= 500ms)

Remarks: One or more LED lights installed on some camera. This function controls the status of these lights.

Explorecam_read_EEPROM
Explorecam_write_EEPROM

Return value: HRESULT type means failure or byte(s) transferred

Parameters:

HExplorecam h: camera instance handle

unsigned addr: EEPROM address

const unsigned char* pBuffer: data buffer to be written

unsigned char* pBuffer: read EEPROM to buffer

unsigned nBufferLen: buffer length

Remarks: In some cameras, EEPROM is available for read and write. If failed to read or write, a negative HRESULT error code will be return, when success, the bytes number has been read or written will be return.

Explorecam_IoControl

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned ioLineNumber:

0 => Opto-isolated input
1 => Opto-isolated output
2 => GPIO0
3 => GPIO1

unsigned nType: type of control

int outVal: output control value

int* inVal: input control value

EXPLORE_IOCONTROLTYPE_GET_SUPPORTEDMODE get the supported mode:
0x01 => Input
0x02 => Output
(0x01 | 0x02) => support both Input and Output

EXPLORE_IOCONTROLTYPE_GET_GPIODIR 0x00 => Input, 0x01 => Output

EXPLORE_IOCONTROLTYPE_SET_GPIODIR

EXPLORE_IOCONTROLTYPE_GET_FORMAT format:
0x00 => not connected
0x01 => Tri-state
0x02 => TTL
0x03 => LVDS
0x04 => RS422
0x05 => Opto-coupled

EXPLORE_IOCONTROLTYPE_SET_FORMAT

EXPLORE_IOCONTROLTYPE_GET_OUTPUTINVERTER boolean, only support output signal

EXPLORE_IOCONTROLTYPE_SET_OUTPUTINVERTER

EXPLORE_IOCONTROLTYPE_GET_INPUTACTIVATION 0x00 => Positive, 0x01 => Negative

EXPLORE_IOCONTROLTYPE_SET_INPUTACTIVATION

EXPLORE_IOCONTROLTYPE_GET_DEBOUNCERTIME debouncer time in microseconds, [0, 20000]

EXPLORE_IOCONTROLTYPE_SET_DEBOUNCERTIME

EXPLORE_IOCONTROLTYPE_GET_TRIGGERSOURCE 0x00 => Opto-isolated input
0x01 => GPIO0
0x02 => GPIO1
0x03 => Counter
0x04 => PWM
0x05 => Software

EXPLORE_IOCONTROLTYPE_SET_TRIGGERSOURCE

EXPLORE_IOCONTROLTYPE_GET_TRIGGERDELAY Trigger delay time in microseconds, [0, 5000000]

EXPLORE_IOCONTROLTYPE_SET_TRIGGERDELAY

EXPLORE_IOCONTROLTYPE_GET_BURSTCOUNTER Burst Counter, range: [1 ~ 65535]

EXPLORE_IOCONTROLTYPE_SET_BURSTCOUNTER

EXPLORE_IOCONTROLTYPE_GET_COUNTERSOURCE 0x00 => Opto-isolated input
0x01 => GPIO0
0x02 => GPIO1

EXPLORE_IOCONTROLTYPE_SET_COUNTERSOURCE

EXPLORE_IOCONTROLTYPE_GET_COUNTERVALUE Counter Value, range: [1 ~ 65535]

EXPLORE_IOCONTROLTYPE_SET_COUNTERVALUE

EXPLORE_IOCONTROLTYPE_SET_RESETCOUNTER

EXPLORE_IOCONTROLTYPE_GET_PWMSOURCE 0x00 => Opto-isolated input
0x01 => GPIO0
0x02 => GPIO1

EXPLORE_IOCONTROLTYPE_SET_PWMSOURCE

EXPLORE_IOCONTROLTYPE_GET_OUTPUTMODE 0x00 => Frame Trigger Wait
0x01 => Exposure Active
0x02 => Strobe
0x03 => User output

EXPLORE_IOCONTROLTYPE_SET_OUTPUTMODE

EXPLORE_IOCONTROLTYPE_GET_STROBEDELAYMODE boolean, 0 => pre-delay, 1 => delay; compared to exposure active signal

EXPLORE_IOCONTROLTYPE_SET_STROBEDELAYMODE

EXPLORE_IOCONTROLTYPE_GET_STROBEDELAYTIME Strobe delay or pre-delay time in microseconds, [0, 5000000]

EXPLORE_IOCONTROLTYPE_SET_STROBEDELAYTIME

EXPLORE_IOCONTROLTYPE_GET_STROBEDURATION Strobe duration time in microseconds, [0, 5000000]

EXPLORE_IOCONTROLTYPE_SET_STROBEDURATION

EXPLORE_IOCONTROLTYPE_GET_USERVALUE bit0 => Opto-isolated output
bit1 => GPIO0 output
bit2 => GPIO1 output

EXPLORE_IOCONTROLTYPE_SET_USERVALUE

EXPLORE_IOCONTROLTYPE_GET_UART_ENABLE UART enable: 1 => on; 0 => off

EXPLORE_IOCONTROLTYPE_SET_UART_ENABLE

EXPLORE_IOCONTROLTYPE_GET_UART_BAUDRATE baud rate:
0 => 9600
1 => 19200
2 => 38400
3 => 57600
4 => 115200

EXPLORE_IOCONTROLTYPE_SET_UART_BAUDRATE

EXPLORE_IOCONTROLTYPE_GET_UART_LINEMODE Line Mode:
0 => TX(GPIO_0)/RX(GPIO_1)
1 => TX(GPIO_1)/RX(GPIO_0)

EXPLORE_IOCONTROLTYPE_SET_UART_LINEMODE

EXPLORE_IOCONTROLTYPE_GET_EXPO_ACTIVE_MODE 0 => specified lines
1 => common exposure time
default: 0

EXPLORE_IOCONTROLTYPE_SET_EXPO_ACTIVE_MODE

EXPLORE_IOCONTROLTYPE_GET_EXPO_START_LINE exposure start line, default: 0

EXPLORE_IOCONTROLTYPE_SET_EXPO_START_LINE

EXPLORE_IOCONTROLTYPE_GET_EXPO_END_LINE exposure end line, default: 0
end line must be no less than start line

EXPLORE_IOCONTROLTYPE_SET_EXPO_END_LINE

Explorecam_read_UART
Explorecam_write_UART

Return value: HRESULT type means failure or byte(s) transferred

Parameters:

HExplorecam h: camera instance handle

const unsigned char* pBuffer: data buffer to be written

unsigned char* pBuffer: read buffer

unsigned nBufferLen: buffer length

Remarks: If failed to read or write, a negative HRESULT error code will be return, when success, the bytes number has been read or written will be return.

Explorecam_FfcOnce

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

Explorecam_DfcOnce

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

Explorecam_LevelRangeAuto

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

Remarks: auto Level Range.

Explorecam_put_LevelRange
Explorecam_get_LevelRange

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned short aLow[4], unsigned short aHigh[4]: Level Range of R, G, B, and Grey. RGB is only available for color image, and grey is only available for grey image.

Remarks: level range related.

Explorecam_put_LevelRangeV2
Explorecam_get_LevelRangeV2

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

unsigned short mode:

EXPLORE_LEVELRANGE_MANUAL Manual mode

EXPLORE_LEVELRANGE_ONCE Once

EXPLORE_LEVELRANGE_CONTINUE Continue mode

EXPLORE_LEVELRANGE_ROI Update the ROI rectangle

RECT* pRoiRect: ROI rectangle

unsigned short aLow[4], unsigned short aHigh[4]: Level Range of R, G, B, and Grey. RGB is only available for color image, and grey is only available for grey image.

Remarks: level range related.

Explorecam_Update

Return value: HRESULT type means success or failure

Parameters:

camId: camera ID

filePath: ufw file full path

pFun, ctxProgress: progress percent callback

Remarks: firmware update. Please do not unplug the camera or lost power during the upgrade process, this is very very important. Once an unplugging or power outage occurs during the upgrade process, the camera will no longer be available and can only be returned to the factory for repair.

Explorecam_Replug

Return value: >0: the number of device has been replug; = 0: no device found; E_ACCESSDENIED: no UAC Administrator privileges

Parameters:

id: camera ID

Remarks: simulate replug. for each device found, it will take about 3 seconds.

Explorecam_GetHistogram

Return value: HRESULT type means success or failure

Parameters:

HExplorecam h: camera instance handle

PIEXPLORE_HISTOGRAM_CALLBACK funHistogram, void* ctxHistogram: callback function and callback context of histogram data.

Remarks: get histogram data.

Ranges and default value of some parameters

Parameters			Range	Default value	Get	Set	Auto
Auto Exposure Target			16~220	120	Explorecam_get_AutoExpoTarget	Explorecam_put_AutoExpoTarget
Exposure Gain			100~	100	Explorecam_get_ExpoAGain	Explorecam_put_ExpoAGain
White Balance	Temp/Tint Mode	Color Temperature	2000~15000	6503	Explorecam_get_TempTint	Explorecam_put_TempTint	Explorecam_AwbOnce
		Tint	200~2500	1000
	RGB Gain Mode	Red Gain	-127~127	0	Explorecam_get_WhiteBalanceGain	Explorecam_put_WhiteBalanceGain	Explorecam_AwbInit
		Green Gain
		Blue Gain
LevelRange		Software	0~255	Low = 0 High = 255	Explorecam_get_LevelRange	Explorecam_put_LevelRange	Explorecam_LevelRangeAuto
		Hardware			Explorecam_get_LevelRangeV2	Explorecam_put_LevelRangeV2
Contrast			-100~100	0	Explorecam_get_Contrast	Explorecam_put_Contrast
Hue			-180~180	0	Explorecam_get_Hue	Explorecam_put_Hue
Saturation			0~255	128	Explorecam_get_Saturation	Explorecam_put_Saturation
Brightness			-64~64	0	Explorecam_get_Brightness	Explorecam_put_Brightness
Gamma			20~180	100	Explorecam_get_Gamma	Explorecam_put_Gamma
Black Level			0~31 (bit depth=8) 0~31 * 4 (bit depth=10) 0~31 * 16 (bit depth=12) 0~31 * 64 (bit depth=14) 0~31 * 256 (bit depth=16)		Explorecam_get_Option	Explorecam_put_Option
Auto Exposure	Max	Exposure Time		350ms	Explorecam_get_MaxAutoExpoTimeAGain	Explorecam_put_MaxAutoExpoTimeAGain
		Gain		500
	Min	Exposure Time		0	Explorecam_get_MinAutoExpoTimeAGain	Explorecam_put_MinAutoExpoTimeAGain
		Gain		100
	Percent		0~100	10	EXPLORE_OPTION_AUTOEXPOSURE_PERCENT
TEC Target			-300 ~ 300 (-30℃ ~ 30℃)	0	EXPLORE_OPTION_TECTARGET

5. .NET and C# and VB.NET

Explorecam does support .NET development environment (C# and VB.NET).

explore.cs use P/Invoke to call into explore.dll. Copy explore.cs to your C# project, please reference samples.

Please pay attation to that the object of the C# class Explorecam. Explorecam must be obtained by static mothod Open or OpenByIndex, it cannot be obtained by obj = new Explorecam (The constructor is private on purpose).

Most properties and methods of the Explorecam class P/Invoke into the corresponding Explorecam_xxxx functions of explore.dll/so. So, the descriptions of the Explorecam_xxxx function are also applicable for the corresponding C# properties or methods. For example, the C# Snap method call the function Explorecam_Snap, the descriptions of the Explorecam_Snap function is applicable for C# Snap method:

[DllImport("explore.dll", ExactSpelling = true, CallingConvention = CallingConvention.StdCall)]
private static extern int Explorecam_Snap(SafeHExplorecamHandle h, uint nResolutionIndex);

public bool Snap(uint nResolutionIndex)
{
    if (_handle == null || _handle.IsInvalid || _handle.IsClosed)
        return false;
    return (Explorecam_Snap(_handle, nResolutionIndex) >= 0);
}

VB.NET is similar with C#, not otherwise specified.

6. Python

Explorecam does support Python (version 3.0 or above), please import explore to use explore.py and reference the sample code simplest.py and qt.py.

Please pay attation to that the object of the python class explore.Explorecam must be obtained by classmethod Open or OpenByIndex, it cannot be obtained by obj = explore.Explorecam()

Most methods of the Explorecam class use ctypes to call into the corresponding Explorecam_xxxx functions of explore.dll/so/dylib. So, the descriptions of the Explorecam_xxxx function are also applicable for the corresponding python methods.

Please reference __errcheck in explore.py, the original HRESULT return code is mapped to HRESULTException exception (in win32 it's inherited from OSError).

Please make sure the explore dll/so/dylib library file is in the same directory with explore.py.

7. Java

Explorecam does support Java, explore.java use JNA to call into explore.dll/so/dylib. Copy explore.java to your java project, please reference the sample code simplest.java (Console), javafx.java, swing.java.

Please pay attation to that the object of the java class explore must be obtained by static method Open or OpenByIndex, it cannot be obtained by obj = new explore()(The constructor is private on purpose).

Most methods of the explore class use JNA to call into the corresponding Explorecam_xxxx functions of explore.dll/so/dylib. So, the descriptions of the Explorecam_xxxx function are also applicable for the corresponding java methods.

Please reference errcheck in explore.java, the original HRESULT return code is mapped to HRESULTException exception.

Remark: (1) Download jna-*.jar from github; (2) Make sure explore.dll/so/dylib is placed in the correct directory.

8. Samples

Name		Platform	Language	Dependency	UI	Description
demosimplest		Win32 Linux macOS Android	C++		console	simplest sample, about 70 lines of code. snapshot.
demostill						simplest sample to demo snap still image, about 120 lines of code
demosofttrigger						simplest sample to demo soft trigger, about 80 lines of code
demoexternaltrigger						simplest sample to demo external trigger, about 120 lines of code
demoraw						raw data and snap still image, about 120 lines of code. snapshot.
demoqt		Win32 Linux macOS		Qt	GUI	Qt sample, snapshot. Enumerate device, open device, video preview, (still) image capture, preview resolution, image save to file, etc. This sample use Pull Mode, StartPullModeWithCallback.
democpp		Win32		ATL/WTL		snapshot. demonstrates to enumerate device, open device, video preview, image capture, preview resolution, trigger, image saving multi-format (.bmp, .jpg, .png, etc), wmv format video recording, trigger mode, IO control, etc. This sample use Pull Mode. To keep the code clean, this sample uses the WTL library which can be downloaded from http://sourceforge.net/projects/wtl
democallback						snapshot. use Pull Mode, StartPullModeWithCallback
demopush						snapshot. use Push Mode, StartPushModeV4
demomono						demonstrates to use mono camera with 8 or 16 bits
democns						snapshot. Consistency test: The image is evenly divided into m*n zones, and each zone takes a small area in the center to calculate the average value, connect the average value into a line, and check the fluctuation range of the line up and down
demomfc				MFC		snapshot. use MFC as the GUI library. It demonstrates to open device, video preview, image capture, set the preview resolution, multi-format image saving (.bmp, .jpg, .png, etc). This sample use Pull Mode
autotest						snapshot. auto test tool used to automatically test, such as open/close the camera, change the resolution, snap, ROI, bitdepth, etc
demowpf		.NET	C#	WPF		WPF sample, snapshot. Enum camera, open camera, preview video, captuare (still) image, save image to file, auto exposure, white balance, calculate fps (frame per second), etc. This sample use Pull Mode, StartPullModeWithCallback
demowinformcs				WinForm		winform sample, snapshot. Enum camera, open camera, preview video, captuare (still) image, save image to file, auto exposure, white balance, calculate fps (frame per second), etc. This sample use Pull Mode, StartPullModeWithCallback
demotwocs						winform sample, snapshot. Use two cameras simultaneously. This sample use Pull Mode, StartPullModeWithCallback
demowinformvb			VB.NET			winform sample, snapshot. Enum camera, open camera, preview video, captuare (still) image, save image to file, auto exposure, white balance, calculate fps (frame per second), etc. This sample use Pull Mode, StartPullModeWithCallback
demouwp		WinRT	C#			UWP (Universal Windows Platform) simple demo, snapshot. Before build and run this demo, please pay attention to the value of vid in file Package.appxmanifest
demoandroid		Android	Java C++			Android sample
demojava	simplest	Win32 Linux macOS	Java	jna	console	simplest java sample. IntelliJ project
	javafx				GUI	javafx sample. IntelliJ project
	swing					swing sample. IntelliJ project
demopython	simplest		Python		console	simplest python sample
	qt			PyQt	GUI	PyQt sample, snapshot.
demodshow		DirectShow	C++	MFC		DirectShow sample
amcap						copy from Microsoft DirectShow SDK
LVDemo1		LabView				Labview program which works with one camera
LVDemo2						Labview program which opens two cameras and control them respectively

9. Changelog

v53: Add ExplorecamFrameInfoV3, Explorecam_PullImageV3, Explorecam_StartPushModeV4

v52: Android Java side transfer file descriptor to Explorecam_Open to open camera. Please see here

v51: Add support auto exposure "once" mode. Please see here

v50: SIMD optimize in Windows(x86/x64), Linux(x64) and Android(x64)
frontend and backend deque length: EXPLORE_OPTION_FRONTEND_DEQUE_LENGTH, EXPLORE_OPTION_BACKEND_DEQUE_LENGTH

v49: Add support to save & load configuration. Please see here

v48: hardware event. Please see here, here and here

v47: hardware level range. Please see here and here

v46: Add support denose. Please see here

v45: Add sequencer trigger, UART, mix trigger (external and software trigger both are enabled)

v44: Extend the realtime mode, Please see here
Add EXPLORE_OPTION_CALLBACK_THREAD and EXPLORE_OPTION_FRAME_DEQUE_LENGTH

v43: Reload the last frame in the trigger mode. Please see EXPLORE_OPTION_RELOAD

v42: Precise frame rate and bandwidth. Please see here and EXPLORE_FLAG_PRECISE_FRAMERATE

v41: no packet timeout. Please see here

v40: Auto test tool, see samples\autotest

v39: Update C#/VB.NET/Java/Python

v38: Add support to byte order, change BGR/RGB. Please see here

v37: Add Android support
Add Explorecam_StartPushModeV3 (Explorecam_StartPushModeV2 and Explorecam_StartPushMode are obsoleted)

v36: Add Java support. Please see here

v35: Add Python support. Please see here

v34: Auto Focus and Focus Motor

v33: extend EXPLORE_OPTION_AGAIN to EXPLORE_OPTION_AUTOEXP_POLICY, support more options. Please see here

v32: Addd support to Windows 10 on ARM and ARM64, both desktop and WinRT

v31: Add Explorecam_deBayerV2, support RGB48 and RGB64

v30: Add EXPLORE_FLAG_CGHDR

v29: Add ExplorecamFrameInfoV2, a group of functions (PullImageV2 and StartPushModeV2), some cameras support frame sequence number and timestamp. Please see here

v28: Add Explorecam_read_Pipe, Explorecam_write_Pipe, Explorecam_feed_Pipe

v27: Add Explorecam_SnapN, support to snap multiple images, please see here and democpp

v26: Add support to restore factory settings, EXPLORE_OPTION_FACTORY

v25: Add sharpening, EXPLORE_OPTION_SHARPENING

v24: Add support to Exposure time with the 50/60 HZ constraint

v23: Add support to Linux armhf, armel and arm64
Add FFC and DFC, please see here and here

v22: Add EXPLORE_OPTION_DDR_DEPTH, please see here

v21: Add Explorecam_IoControl

v20: Add Explorecam_EnumV2, ExplorecamModelV2, ExplorecamDeviceV2; (Explorecam_Enum, ExplorecamModel and ExplorecamDevice are obsoleted)
Add Pixel Format, see EXPLORE_OPTION_PIXEL_FORMAT; (EXPLORE_OPTION_PIXEL_FORMAT is the super set of EXPLORE_OPTION_BITDEPTH)
Add Flat Field Correction

v19: Add Black Balance: please see here

v18: Add Explorecam_get_Revision

v17: Add EXPLORE_OPTION_ROTATE

v16: Add EXPLORE_FLAG_DDR, use very large capacity DDR (Double Data Rate SDRAM) for frame buffer

v15: Add EXPLORE_OPTION_BINNING

v14: Add support to WinRT / UWP (Universal Windows Platform) / Windows Store App

v13: support row pitch, please see Explorecam_PullImageWithRowPitch and Explorecam_PullStillImageWithRowPitch

v12: support RGB32, 8 bits Grey, 16 bits Grey, please see here

v11: black level: please see here

v10: demosaic method: please see here

v9: change the histogram data type from double to float

v8: support simulated trigger, please see here

v7: support RGB48 when bit depth > 8, please see here

v6: support trigger mode, please see here

v5: White Balance: Temp/Tint Mode vs RGB Gain Mode, please see here

v4: ROI (Region Of Interest) supported: please see here

v3: more bit depth supported: 10bits, 12bits, 14bits, 16bits

v2: support RAW format, please see here and here; support Linux and macOS

v1: initial release

Event	Source	Description
EXPLORE_EVENT_EXPOSURE	Software	exposure time changed
EXPLORE_EVENT_TEMPTINT		white balance changed. Temp/Tint Mode, please see here.
EXPLORE_EVENT_WBGAIN		white balance changed. RGB Gain Mode, please see here.
EXPLORE_EVENT_IMAGE		Video image data arrives. Use Explorecam_PullImage(V3/V2) to 'pull' the image data
EXPLORE_EVENT_STILLIMAGE		Still image which is triggered by function Explorecam_Snap or Explorecam_SnapN arrives. Use Explorecam_PullImageV3 or Explorecam_PullStillImage(V2) to 'pull' the image data
EXPLORE_EVENT_ERROR		Generic error, data acquisition cannot continue
EXPLORE_EVENT_DISCONNECTED		Camera disconnected, maybe has been pulled out
EXPLORE_EVENT_NOFRAMETIMEOUT		Grab image no frame timeout error, data acquisition cannot continue
EXPLORE_EVENT_NOPACKETIMEOUT		Grab image no packet timeout
EXPLORE_EVENT_TRIGGERFAIL		trigger failed (for example, bad frame data or timeout)
EXPLORE_EVENT_BLACK		black balance changed
EXPLORE_EVENT_FFC		flat field correction status changed
EXPLORE_EVENT_DFC		dark field correction status changed
EXPLORE_EVENT_ROI		roi changed
EXPLORE_EVENT_LEVELRANGE		level range changed
EXPLORE_EVENT_AUTOEXPO_FINISH		auto exposure once mode finish
EXPLORE_EVENT_FACTORY		restore factory settings. Please note that restoring factory settings may cause resolution changes.
EXPLORE_EVENT_EXPO_START	Hardware	exposure start
EXPLORE_EVENT_EXPO_STOP		exposure stop
EXPLORE_EVENT_TRIGGER_ALLOW		next trigger allow
EXPLORE_EVENT_HEARTBEAT		heartbeat, can be used to monitor whether the camera is alive. see EXPLORE_OPTION_HEARTBEAT

EXPLORE_OPTION_RGB	0 (RGB24)	1 (RGB48)	2 (RGB32)	3 (Grey8)	4 (Grey16)	5 (RGB64)
bits = 0	24	48	32	8	16	64
bits = 24	24	NA	Convert to 24	Convert to 24	NA	NA
bits = 32	Convert to 32	NA	32	Convert to 32	NA	NA
bits = 48	NA	48	NA	NA	Convert to 48	Convert to 48
bits = 8	Convert to 8	NA	Convert to 8	8	NA	NA
bits = 16	NA	Convert to 16	NA	NA	16	Convert to 16
bits = 64	NA	Convert to 64	NA	NA	Convert to 64	64

Format		=0 means Default Row Pitch	=-1 means zero paddding
RGB	RGB24	TDIBWIDTHBYTES(24 * Width)	Width * 3
	RGB32	Width * 4	Width * 4
	RGB48	TDIBWIDTHBYTES(48 * Width)	Width * 6
	GREY8 grey image	TDIBWIDTHBYTES(8 * Width)	Width
	GREY16 grey image	TDIBWIDTHBYTES(16 * Width)	Width * 2
	RGB64	Width * 8	Width * 8
RAW	8bits Mode	Width	Width
RAW	10bits, 12bits, 14bits, 16bits Mode	Width * 2	Width * 2

MAKEFOURCC('G', 'B', 'R', 'G')	GBGBGB... RGRGRG... GBGBGB... RGRGRG... ... see here
MAKEFOURCC('R', 'G', 'G', 'B')	RGRGRG... GBGBGB... RGRGRG... GBGBGB... ...
MAKEFOURCC('B', 'G', 'G', 'R')	BGBGBG... GRGRGR... BGBGBG... GRGRGR... ...
MAKEFOURCC('G', 'R', 'B', 'G')	GRGRGR... BGBGBG... GRGRGR... BGBGBG... ...
MAKEFOURCC('V', 'U', 'Y', 'Y')	YUV4:2:2, please see: http://www.fourcc.org
MAKEFOURCC('U', 'Y', 'V', 'Y')	YUV4:2:2
MAKEFOURCC('Y', 'Y', 'Y', 'Y')	Black / White camera

Option	Description	Default	Can be changed when camera is running? (Before Explorecam_StartXXXX or after Explorecam_Stop)
EXPLORE_OPTION_RAW	0 means RGB mode. 1 means RAW mode, read the CMOS or CCD raw data.	0	No (The return value is E_UNEXPECTED when set this option while camera is running)
EXPLORE_OPTION_BITDEPTH	Some cameras support the bit depth which is more than 8 such as 10, 12, 14, 16. 0 = use 8 bits depth. 1 = use the maximum bits depth of this camera.	NA	Yes. But not recommended to modify frequently while camera is running.
EXPLORE_OPTION_TRIGGER	0 = video mode 1 = software or simulated trigger mode 2 = external trigger mode 3 = external + software trigger	0	Yes
EXPLORE_OPTION_RGB	0 = RGB24 1 = RGB48 format when bitdepth > 8 2 = RGB32 3 = 8 bits grey (only for mono camera) 4 = 16 bits grey (only for mono camera and bitdepth > 8) 5 = RGB64 format when bitdepth > 8	0	No (The return value is E_UNEXPECTED when set this option while camera is running)
EXPLORE_OPTION_BYTEORDER	Byte order: 1: BGR 0: RGB	Win: 1 Linux/MacOS/Android: 0	Yes. But not recommended to modify frequently while camera is running.
EXPLORE_OPTION_UPSIDE_DOWN	Upside down: 1: yes 0: no Please distinguish it from Explorecam_put_VFlip, which requires the CPU to perform data moving work on each frame of data	Win: 1 Linux/MacOS/Android: 0	Yes
EXPLORE_OPTION_FAN	Some cameras support the cooling fan. 0 = turn off the cooling fan [1, max] = fan speed	NA	Yes
EXPLORE_OPTION_TEC	Some cameras support to turn on or off the thermoelectric cooler. 0 = turn off the thermoelectric cooler 1 = turn on the thermoelectric cooler	1	Yes
EXPLORE_OPTION_TECTARGET	get or set the target temperature of the thermoelectric cooler, in 0.1℃. For example, 125 means 12.5℃, -35 means -3.5℃	NA	Yes
EXPLORE_OPTION_AUTOEXP_POLICY	Auto Exposure Policy: 0: Exposure Only 1: Exposure Preferred 2: Gain Only 3: Gain Preferred	1	Yes
EXPLORE_OPTION_AUTOEXP_THRESHOLD	threshold of auto exposure, range: [2~15]	5	Yes
EXPLORE_OPTION_FRAMERATE	limit the frame rate, range=[0, 63]. frame rate control is disabled automatically in trigger mode.	0 (means no limit)	No (The return value is E_UNEXPECTED when set this option while camera is running)
EXPLORE_OPTION_BLACKLEVEL	Black Level Always return E_NOTIMPL for camera that don't support black level.	0	Yes
EXPLORE_OPTION_MULTITHREAD	multithread image processing	1	No (The return value is E_UNEXPECTED when set this option while camera is running)
EXPLORE_OPTION_BINNING	digital binning: 0x01 (no binning) n: (saturating add, nn), 0x02(22), 0x03(33), 0x04(44), 0x05(55), 0x06(66), 0x07(77), 0x08(88). The Bitdepth of the data remains unchanged. 0x40 \| n: (unsaturated add in RAW mode, nn), 0x42(22), 0x43(33), 0x44(44), 0x45(55), 0x46(66), 0x47(77), 0x48(88). The Bitdepth of the data is increased. For example, the original data with bitdepth of 12 will increase the bitdepth by 2 bits and become 14 after 22 binning. 0x80 \| n: (average, nn), 0x82(22), 0x83(33), 0x84(44), 0x85(55), 0x86(66), 0x87(77), 0x88(8*8). The Bitdepth of the data remains unchanged. The final image size is rounded down to an even number, such as 640/3 to get 212	1	Yes
EXPLORE_OPTION_ROTATE	rotate clockwise: 0, 90, 180, 270	0	Yes
EXPLORE_OPTION_CG	Conversion Gain: 0: LCG 1: HCG 2: HDR	NA	Yes
EXPLORE_OPTION_PIXEL_FORMAT	pixel format	NA	Yes. But not recommended to modify frequently while camera is running.
EXPLORE_OPTION_DDR_DEPTH	the number of the frames that DDR can cache: 1: DDR cache only one frame 0: Auto: => one for video mode when auto exposure is enabled => full capacity for others -1: DDR can cache frames to full capacity	0	Yes
EXPLORE_OPTION_FFC	Flat Field Correction: set: 0: disable 1: enable -1: reset (0xff000000 \| n): set the average number to n, [1~255] get: (val & 0xff): 0 => disable, 1 => enable, 2 => inited ((val & 0xff00) >> 8): sequence ((val & 0xff0000) >> 8): average number	0	Yes
EXPLORE_OPTION_DFC	Dark Field Correction: set: 0: disable 1: enable -1: reset (0xff000000 \| n): set the average number to n, [1~255] get: (val & 0xff): 0 => disable, 1 => enable, 2 => inited ((val & 0xff00) >> 8): sequence ((val & 0xff0000) >> 8): average number	0	Yes
EXPLORE_OPTION_SHARPENING	Sharpening, (threshold << 24) \| (radius << 16) \| strength) strength: [0, 500], default: 0 (disable) radius: [1, 10] threshold: [0, 255]	0	Yes
EXPLORE_OPTION_FACTORY	restore the factory settings	Always 0	Yes
EXPLORE_OPTION_TEC_VOLTAGE	get the current TEC voltage in 0.1V, 59 mean 5.9V; Please do not get this value too frequently, the recommended interval is 2 seconds or more	NA	NA
EXPLORE_OPTION_TEC_VOLTAGE_MAX	get the TEC maximum voltage in 0.1V	NA	NA
EXPLORE_OPTION_POWER	get power consumption, unit: milliwatt	NA	NA
EXPLORE_OPTION_GLOBAL_RESET_MODE	global reset mode	0	Yes
EXPLORE_OPTION_DEVICE_RESET	reset usb device, simulate a replug	NA	NA
EXPLORE_OPTION_FOCUSPOS	focus positon	NA	Yes
EXPLORE_OPTION_AFMODE	auto focus mode: 0: manul focus 1: auto focus 2: once focus 3: conjugate calibration	NA	Yes
EXPLORE_OPTION_AFZONE	auto focus zone	NA	Yes
EXPLORE_OPTION_AFFEEDBACK	auto focus information feedback: 0: unknown 1: focused 2: focusing 3: defocus 4: up 5: down	NA	Yes
EXPLORE_OPTION_TESTPATTERN	test pattern: 0: TestPattern Off 3: monochrome diagonal stripes 5: monochrome vertical stripes 7: monochrome horizontal stripes 9: chromatic diagonal stripes	0	Yes
EXPLORE_OPTION_NOFRAME_TIMEOUT	Report error if cannot grab frame in maximum exposure time. 1 = enable this feature; 0 = disable this feature.	0	Yes
EXPLORE_OPTION_NOPACKET_TIMEOUT	Report event if cannot grab packet in the set time. 0 = disable this feature positive value = timeout milliseconds	0	Yes
EXPLORE_OPTION_BANDWIDTH	bandwidth, range:[1-100]% After setting the bandwidth, get the accurate frame rate range, and then set the precise frame rate	90%	Yes
EXPLORE_OPTION_MAX_PRECISE_FRAMERATE	get the precise frame maximum value in 0.1fps, such as 115 means 11.5fps the maximum value depends the bandwidth/resolution/bitdepth/ROI E_NOTIMPL means not supported	NA	NA
EXPLORE_OPTION_MIN_PRECISE_FRAMERATE	get the precise frame minimum value in 0.1fps, such as 15 means 1.5fps the minimum value depends the bandwidth/resolution/bitdepth/ROI E_NOTIMPL means not supported	NA	NA
EXPLORE_OPTION_PRECISE_FRAMERATE	in 0.1fps, such as 115 means 11.5fps. range:[1~maximum]	90% of the maximum	Yes
EXPLORE_OPTION_RELOAD	Reload the last frame in the trigger mode get return value S_OK means supporting this feature, E_NOTIMPL means not supported	NA	Yes
EXPLORE_OPTION_CALLBACK_THREAD	dedicated thread for callback, only available in pull mode	0	No
EXPLORE_OPTION_FRONTEND_DEQUE_LENGTH or EXPLORE_OPTION_FRAME_DEQUE_LENGTH	frontend (raw) frame deque length, range: [2, 1024] All the memory will be pre-allocated when the camera starts, so, please attention to memory usage	4	No
EXPLORE_OPTION_BACKEND_DEQUE_LENGTH	backend (pipelined) frame deque length (Only available in pull mode), range: [2, 1024] All the memory will be pre-allocated when the camera starts, so, please attention to memory usage	3	No
EXPLORE_OPTION_SEQUENCER_ONOFF	sequencer trigger: on/off	0	Yes
EXPLORE_OPTION_SEQUENCER_NUMBER	sequencer trigger: number, range = [1, 255]	NA	Yes
EXPLORE_OPTION_SEQUENCER_EXPOTIME	sequencer trigger: exposure time iOption = EXPLORE_OPTION_SEQUENCER_EXPOTIME \| index iValue = exposure time (no 50/60 HZ constraint) For example, to set the exposure time of the third group to 50ms, call Explorecam_put_Option(EXPLORE_OPTION_SEQUENCER_EXPOTIME \| 3, 50000)	NA	Yes
EXPLORE_OPTION_SEQUENCER_EXPOGAIN	sequencer trigger: exposure gain iOption = EXPLORE_OPTION_SEQUENCER_EXPOGAIN \| index iValue = gain	NA	Yes
EXPLORE_OPTION_DENOISE	Denoise strength range: [0, 100], 0 means disable	0	Yes
EXPLORE_OPTION_HEAT_MAX	get maximum level: heat to prevent fogging up [0, max], 0 means off	NA	NA
EXPLORE_OPTION_HEAT	heat to prevent fogging up	max level	Yes
EXPLORE_OPTION_LIGHTSOURCE_MAX	get maximum level: light source [0, max], 0 means off	NA	NA
EXPLORE_OPTION_LIGHTSOURCE	light source level	50% max level	Yes
EXPLORE_OPTION_HEARTBEAT	Heartbeat interval in millisecond range: [EXPLORE_HEARTBEAT_MIN, EXPLORE_HEARTBEAT_MAX] 0: disable	disable	Yes
TOUCPAM_OPTION_EVENT_HARDWARE	enable or disable hardware event notify: 0 => disable, 1 => enable (1) iOption = EXPLORE_OPTION_EVENT_HARDWARE, master switch for notification of all hardware events (2) iOption = EXPLORE_OPTION_EVENT_HARDWARE \| (event type), a specific type of sub-switch Only if both the master switch and the sub-switch of a specific type remain on are actually enabled for that type of event notification. see here and here	disable	Master switch: No Sub-switch: Yes
EXPLORE_OPTION_LOW_NOISE	low noise mode (Higher signal noise ratio, lower frame rate)	0	Yes
EXPLORE_OPTION_AUTOEXPOSURE_PERCENT	auto exposure percent to average 1~99: top percent average 0 or 100: full roi average	10	Yes
EXPLORE_OPTION_DEFECT_PIXEL	Defect Pixel Correction 0 => disable, 1 => enable	enable (1)	Yes
EXPLORE_OPTION_THREAD_PRIORITY	set the priority of the internal thread which grab data from the usb device. Win: 0 = THREAD_PRIORITY_NORMAL; 1 = THREAD_PRIORITY_ABOVE_NORMAL; 2 = THREAD_PRIORITY_HIGHEST; 3 = THREAD_PRIORITY_TIME_CRITICAL; Please refer to SetThreadPriority Linux & macOS: The high 16 bits for the scheduling policy, and the low 16 bits for the priority. Please refer to pthread_setschedparam	Win: 1 Linux / macOS: NA	Yes
EXPLORE_OPTION_LINEAR	0 = turn off the builtin linear tone mapping 1 = turn on the builtin linear tone mapping	1	Yes
EXPLORE_OPTION_CURVE	0 = turn off the builtin curve tone mapping 1 = turn on the builtin polynomial curve tone mapping 2 = turn on the builtin logarithmic curve tone mapping	2	Yes
EXPLORE_OPTION_COLORMATIX	0 = turn off the builtin color matrix 1 = turn on the builtin color matrix	1	Yes
EXPLORE_OPTION_WBGAIN	0 = turn off the builtin white balance gain 1 = turn on the builtin white balance gain	1	Yes
EXPLORE_OPTION_DEMOSAIC	Demosaic mothod for both video and still image: (Please refrence https://en.wikipedia.org/wiki/Demosaicing) 0 = BILINEAR 1 = VNG(Variable Number of Gradients) 2 = PPG(Patterned Pixel Grouping) 3 = AHD(Adaptive Homogeneity Directed) 4 = EA(Edge Aware) Always return E_NOTIMPL for monochromatic camera.	0	Yes
EXPLORE_OPTION_DEMOSAIC_VIDEO	Demosaic mothod for video	0	Yes
EXPLORE_OPTION_DEMOSAIC_STILL	Demosaic mothod for still image	0	Yes
EXPLORE_OPTION_OPEN_USB_ERRORCODE	get the open usb error code	NA	NA
EXPLORE_OPTION_FLUSH	1: hard flush, discard frames cached by camera DDR (if any) 2: soft flush, discard frames cached by explore.dll (if any) 3: both Explorecam_Flush means 'both' return the number of soft flushed frames if successful, HRESULT if failed	NA	NA
EXPLORE_OPTION_NUMBER_DROP_FRAME	get the number of frames that have been grabbed from the USB but dropped by the software	NA	NA
EXPLORE_OPTION_DUMP_CFG	0 = when camera is stopped, do not dump configuration automatically 1 = when camera is stopped, dump configuration automatically -1 = explicitly dump configuration once	1	Yes
EXPLORE_OPTION_FRONTEND_DEQUE_CURRENT	get the current number in frontend deque	NA	NA
EXPLORE_OPTION_BACKEND_DEQUE_CURRENT	get the current number in backend deque	NA	NA
EXPLORE_OPTION_PACKET_NUMBER	get the received packet number	NA	NA
EXPLORE_OPTION_FILTERWHEEL_SLOT	filter wheel slot number	7	Yes
EXPLORE_OPTION_FILTERWHEEL_POSITION	filter wheel position: set: -1: calibrate val & 0xff: position between 0 and N-1, where N is the number of filter slots (val >> 8) & 0x1: direction, 0 => clockwise spinning, 1 => auto direction spinning get: -1: in motion val: position arrived	NA	Yes

EXPLORE_IOCONTROLTYPE_GET_SUPPORTEDMODE	get the supported mode: 0x01 => Input 0x02 => Output (0x01 \| 0x02) => support both Input and Output
EXPLORE_IOCONTROLTYPE_GET_GPIODIR	0x00 => Input, 0x01 => Output
EXPLORE_IOCONTROLTYPE_SET_GPIODIR
EXPLORE_IOCONTROLTYPE_GET_FORMAT	format: 0x00 => not connected 0x01 => Tri-state 0x02 => TTL 0x03 => LVDS 0x04 => RS422 0x05 => Opto-coupled
EXPLORE_IOCONTROLTYPE_SET_FORMAT
EXPLORE_IOCONTROLTYPE_GET_OUTPUTINVERTER	boolean, only support output signal
EXPLORE_IOCONTROLTYPE_SET_OUTPUTINVERTER
EXPLORE_IOCONTROLTYPE_GET_INPUTACTIVATION	0x00 => Positive, 0x01 => Negative
EXPLORE_IOCONTROLTYPE_SET_INPUTACTIVATION
EXPLORE_IOCONTROLTYPE_GET_DEBOUNCERTIME	debouncer time in microseconds, [0, 20000]
EXPLORE_IOCONTROLTYPE_SET_DEBOUNCERTIME
EXPLORE_IOCONTROLTYPE_GET_TRIGGERSOURCE	0x00 => Opto-isolated input 0x01 => GPIO0 0x02 => GPIO1 0x03 => Counter 0x04 => PWM 0x05 => Software
EXPLORE_IOCONTROLTYPE_SET_TRIGGERSOURCE
EXPLORE_IOCONTROLTYPE_GET_TRIGGERDELAY	Trigger delay time in microseconds, [0, 5000000]
EXPLORE_IOCONTROLTYPE_SET_TRIGGERDELAY
EXPLORE_IOCONTROLTYPE_GET_BURSTCOUNTER	Burst Counter, range: [1 ~ 65535]
EXPLORE_IOCONTROLTYPE_SET_BURSTCOUNTER
EXPLORE_IOCONTROLTYPE_GET_COUNTERSOURCE	0x00 => Opto-isolated input 0x01 => GPIO0 0x02 => GPIO1
EXPLORE_IOCONTROLTYPE_SET_COUNTERSOURCE
EXPLORE_IOCONTROLTYPE_GET_COUNTERVALUE	Counter Value, range: [1 ~ 65535]
EXPLORE_IOCONTROLTYPE_SET_COUNTERVALUE
EXPLORE_IOCONTROLTYPE_SET_RESETCOUNTER
EXPLORE_IOCONTROLTYPE_GET_PWMSOURCE	0x00 => Opto-isolated input 0x01 => GPIO0 0x02 => GPIO1
EXPLORE_IOCONTROLTYPE_SET_PWMSOURCE
EXPLORE_IOCONTROLTYPE_GET_OUTPUTMODE	0x00 => Frame Trigger Wait 0x01 => Exposure Active 0x02 => Strobe 0x03 => User output
EXPLORE_IOCONTROLTYPE_SET_OUTPUTMODE
EXPLORE_IOCONTROLTYPE_GET_STROBEDELAYMODE	boolean, 0 => pre-delay, 1 => delay; compared to exposure active signal
EXPLORE_IOCONTROLTYPE_SET_STROBEDELAYMODE
EXPLORE_IOCONTROLTYPE_GET_STROBEDELAYTIME	Strobe delay or pre-delay time in microseconds, [0, 5000000]
EXPLORE_IOCONTROLTYPE_SET_STROBEDELAYTIME
EXPLORE_IOCONTROLTYPE_GET_STROBEDURATION	Strobe duration time in microseconds, [0, 5000000]
EXPLORE_IOCONTROLTYPE_SET_STROBEDURATION
EXPLORE_IOCONTROLTYPE_GET_USERVALUE	bit0 => Opto-isolated output bit1 => GPIO0 output bit2 => GPIO1 output
EXPLORE_IOCONTROLTYPE_SET_USERVALUE
EXPLORE_IOCONTROLTYPE_GET_UART_ENABLE	UART enable: 1 => on; 0 => off
EXPLORE_IOCONTROLTYPE_SET_UART_ENABLE
EXPLORE_IOCONTROLTYPE_GET_UART_BAUDRATE	baud rate: 0 => 9600 1 => 19200 2 => 38400 3 => 57600 4 => 115200
EXPLORE_IOCONTROLTYPE_SET_UART_BAUDRATE
EXPLORE_IOCONTROLTYPE_GET_UART_LINEMODE	Line Mode: 0 => TX(GPIO_0)/RX(GPIO_1) 1 => TX(GPIO_1)/RX(GPIO_0)
EXPLORE_IOCONTROLTYPE_SET_UART_LINEMODE
EXPLORE_IOCONTROLTYPE_GET_EXPO_ACTIVE_MODE	0 => specified lines 1 => common exposure time default: 0
EXPLORE_IOCONTROLTYPE_SET_EXPO_ACTIVE_MODE
EXPLORE_IOCONTROLTYPE_GET_EXPO_START_LINE	exposure start line, default: 0
EXPLORE_IOCONTROLTYPE_SET_EXPO_START_LINE
EXPLORE_IOCONTROLTYPE_GET_EXPO_END_LINE	exposure end line, default: 0 end line must be no less than start line
EXPLORE_IOCONTROLTYPE_SET_EXPO_END_LINE

EXPLORE_LEVELRANGE_MANUAL	Manual mode
EXPLORE_LEVELRANGE_ONCE	Once
EXPLORE_LEVELRANGE_CONTINUE	Continue mode
EXPLORE_LEVELRANGE_ROI	Update the ROI rectangle

Explorecam API Manual

1. Version & Platform

2. Introduction

3. Concepts and terminology

a. Modes for accessing image data: "Pull" Mode vs "Push" Mode

b. Still Capture (Still Image)

e. Trigger Mode

4. Functions

Calling Convention

Explorecam_EnumV2

Explorecam_HotPlug

Explorecam_Close

Explorecam_StartPullModeWithWndMsgExplorecam_StartPullModeWithCallback

Explorecam_PullImageV3Explorecam_PullImageV2Explorecam_PullStillImageV2Explorecam_PullImageWithRowPitchV2Explorecam_PullStillImageWithRowPitchV2 Explorecam_PullImageExplorecam_PullStillImageExplorecam_PullImageWithRowPitchExplorecam_PullStillImageWithRowPitch

Explorecam_StartPushModeV4Explorecam_StartPushModeV3

Explorecam_Stop

Explorecam_Pause

Explorecam_SnapExplorecam_SnapN

Explorecam_Trigger

Explorecam_put_SizeExplorecam_get_SizeExplorecam_put_eSizeExplorecam_get_eSize

Explorecam_get_ResolutionNumberExplorecam_get_Resolution

Explorecam_get_RawFormat

Explorecam_put_OptionExplorecam_get_Option

Explorecam_get_AutoExpoEnableExplorecam_put_AutoExpoEnableExplorecam_get_AutoExpoTarget Explorecam_put_AutoExpoTargetExplorecam_put_MaxAutoExpoTimeAGainExplorecam_get_MaxAutoExpoTimeAGainExplorecam_put_MinAutoExpoTimeAGainExplorecam_get_MinAutoExpoTimeAGain

Explorecam_get_ExpoTimeExplorecam_put_ExpoTimeExplorecam_get_ExpTimeRangeExplorecam_get_RealExpoTime

Explorecam_get_ExpoAGainExplorecam_put_ExpoAGainExplorecam_get_ExpoAGainRange

Explorecam_put_HueExplorecam_get_HueExplorecam_put_SaturationExplorecam_get_Saturation Explorecam_put_BrightnessExplorecam_get_BrightnessExplorecam_get_ContrastExplorecam_put_ContrastExplorecam_get_GammaExplorecam_put_Gamma

Explorecam_get_ChromeExplorecam_put_Chrome

Explorecam_get_VFlipExplorecam_put_VFlipExplorecam_get_HFlipExplorecam_put_HFlip

Explorecam_put_SpeedExplorecam_get_SpeedExplorecam_get_MaxSpeed

Explorecam_put_HZExplorecam_get_HZ

Explorecam_get_TemperatureExplorecam_put_Temperature

Explorecam_put_ModeExplorecam_get_Mode

Explorecam_put_TempTintExplorecam_get_TempTint

Explorecam_AwbOnce

Explorecam_put_WhiteBalanceGainExplorecam_get_WhiteBalanceGain

Explorecam_AwbInit

Explorecam_put_BlackBalanceExplorecam_get_BlackBalance

Explorecam_put_AWBAuxRectExplorecam_get_AWBAuxRectExplorecam_put_AEAuxRectExplorecam_get_AEAuxRectExplorecam_put_ABBAuxRectExplorecam_get_ABBAuxRect

Explorecam_get_MonoMode

Explorecam_get_MaxBitDepth

Explorecam_get_StillResolutionNumberExplorecam_get_StillResolution

Explorecam_get_SerialNumberExplorecam_get_FwVersionExplorecam_get_HwVersionExplorecam_get_ProductionDateExplorecam_get_Revision

Explorecam_get_PixelSize

Explorecam_put_LEDState

Explorecam_read_EEPROMExplorecam_write_EEPROM

Explorecam_IoControl

Explorecam_read_UARTExplorecam_write_UART

Explorecam_FfcOnce

Explorecam_DfcOnce

Explorecam_LevelRangeAuto

Explorecam_put_LevelRangeExplorecam_get_LevelRange

Explorecam_Update

Explorecam_Replug

Explorecam_GetHistogram

Ranges and default value of some parameters

8. Samples

9. Changelog

Explorecam_StartPullModeWithWndMsg
Explorecam_StartPullModeWithCallback

Explorecam_PullImageV3
Explorecam_PullImageV2
Explorecam_PullStillImageV2
Explorecam_PullImageWithRowPitchV2
Explorecam_PullStillImageWithRowPitchV2
Explorecam_PullImage
Explorecam_PullStillImage
Explorecam_PullImageWithRowPitch
Explorecam_PullStillImageWithRowPitch

Explorecam_StartPushModeV4
Explorecam_StartPushModeV3

Explorecam_Snap
Explorecam_SnapN

Explorecam_put_Size
Explorecam_get_Size
Explorecam_put_eSize
Explorecam_get_eSize

Explorecam_get_ResolutionNumber
Explorecam_get_Resolution

Explorecam_put_Option
Explorecam_get_Option

Explorecam_get_AutoExpoEnable
Explorecam_put_AutoExpoEnable
Explorecam_get_AutoExpoTarget
Explorecam_put_AutoExpoTarget
Explorecam_put_MaxAutoExpoTimeAGain
Explorecam_get_MaxAutoExpoTimeAGain
Explorecam_put_MinAutoExpoTimeAGain
Explorecam_get_MinAutoExpoTimeAGain

Explorecam_get_ExpoTime
Explorecam_put_ExpoTime
Explorecam_get_ExpTimeRange
Explorecam_get_RealExpoTime

Explorecam_get_ExpoAGain
Explorecam_put_ExpoAGain
Explorecam_get_ExpoAGainRange

Explorecam_put_Hue
Explorecam_get_Hue
Explorecam_put_Saturation
Explorecam_get_Saturation
Explorecam_put_Brightness
Explorecam_get_Brightness
Explorecam_get_Contrast
Explorecam_put_Contrast
Explorecam_get_Gamma
Explorecam_put_Gamma

Explorecam_get_Chrome
Explorecam_put_Chrome

Explorecam_get_VFlip
Explorecam_put_VFlip
Explorecam_get_HFlip
Explorecam_put_HFlip

Explorecam_put_Speed
Explorecam_get_Speed
Explorecam_get_MaxSpeed

Explorecam_put_HZ
Explorecam_get_HZ

Explorecam_get_Temperature
Explorecam_put_Temperature

Explorecam_put_Mode
Explorecam_get_Mode

Explorecam_put_TempTint
Explorecam_get_TempTint

Explorecam_put_WhiteBalanceGain
Explorecam_get_WhiteBalanceGain

Explorecam_put_BlackBalance
Explorecam_get_BlackBalance

Explorecam_put_AWBAuxRect
Explorecam_get_AWBAuxRect
Explorecam_put_AEAuxRect
Explorecam_get_AEAuxRect
Explorecam_put_ABBAuxRect
Explorecam_get_ABBAuxRect

Explorecam_get_StillResolutionNumber
Explorecam_get_StillResolution

Explorecam_get_SerialNumber
Explorecam_get_FwVersion
Explorecam_get_HwVersion
Explorecam_get_ProductionDate
Explorecam_get_Revision

Explorecam_read_EEPROM
Explorecam_write_EEPROM

Explorecam_read_UART
Explorecam_write_UART

Explorecam_put_LevelRange
Explorecam_get_LevelRange