# Omegonprocam API Manual

# 1. Version & Platform

- Version: 55.24718.$WCDATE=%Y%m%d$

- Platform
  - Win32:
    - x64: Win7 or above
    - x86: XP SP3 or above; CPU supports SSE2 instruction set or above
    - arm64: Win10 or above
    - arm: Win10 or above
  - WinRT/UWP: x64, x86, arm64, arm; Windows10 or above
  - macOS:
    - x64+x86: macOS 10.10 or above
    - x64+arm64: macOS 11.0 or above, support x64 and Apple silicon (such as M1, M2, etc)
  - Linux: kernel 2.6.27 or above
    - x64: GLIBC 2.14 or above
    - x86: CPU supports SSE3 instruction set or above; GLIBC 2.8 or above
    - arm64: GLIBC 2.17 or above; built by aarch64-linux-gnu (version 5.4.0)
    - armhf: GLIBC 2.8 or above; built by arm-linux-gnueabihf (version 5.4.0)
    - armel: GLIBC 2.8 or above; built by arm-linux-gnueabi (version 5.4.0)
  - Android: __ANDROID_API__ >= 24 (Android 7.0); built by android-ndk-r18b; see here
    - arm64: arm64-v8a
    - arm: armeabi-v7a
    - x64: x86_64
    - x86

# 2. Introduction

Omegonprocam 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:

- inc

> omegonprocam.h, C/C++ head file

- win: For Microsoft Windows
  - dotnet

    > omegonprocam.cs, for C#. The omegonprocam.cs use P/Invoke to call into omegonprocam.dll. Please copy omegonprocam.cs to your C# project to use it.
    > omegonprocam.vb, for VB.NET. The omegonprocam.vb use P/Invoke to call into omegonprocam.dll. Please copy omegonprocam.vb to your VB.NET project to use it.

  - x86

    > omegonprocam.dll, omegonprocam.lib
    > updatefw.exe: firmware upgrade tool
    > *.exe: demo exe files

  - x64

    > omegonprocam.dll, omegonprocam.lib
    > *.exe: demo exe files

  - arm: omegonprocam.dll, omegonprocam.lib
  - arm64: omegonprocam.dll, omegonprocam.lib
  - 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, omegonprocam.cs wrapper class can be used to P/Invoke into omegonprocam.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 omegonprocam.cat, omegonprocam.inf and omegonprocam.sys.
    2. x64 folder contains the kennel mode driver for x64, including omegonprocam.cat, omegonprocam.inf and omegonprocam.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-omegonprocam.rules, udev rule file. Please see: http://reactivated.net/writing_udev_rules.html

    > Reload rule without reboot:

    >     udevadm control --reload-rules && udevadm trigger

  - x86: libomegonprocam.so, so file for x86
  - x64: libomegonprocam.so, so file for x64
  - armel: libomegonprocam.so, so file for armel, use toolchain arm-linux-gnueabi
  - armhf: libomegonprocam.so, so file for armhf, use toolchain arm-linux-gnueabihf
  - arm64: libomegonprocam.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: libomegonprocam.so for Android on arm, arm64, x86 and x64

- mac: For macOS, universal dylib: x64+x86, x64+arm64

- python: omegonprocam.py and sample code

- java: omegonprocam.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 & Terminology

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

Omegonprocam 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, omegonprocam plays a passive role and the application 'PULL' image data from omegonprocam. The internal thread of omegonprocam 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 Omegonprocam_PullImageV3 or Omegonprocam_PullImage(WithRowPitch)(V2), Omegonprocam_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 Omegonprocam_StartPullModeWithWndMsg. When event occurs, omegonprocam will post message (PostMessage) to the specified window. Parameter WPARAM is the event type, refer to the definition of OMEGONPROCAM_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 Omegonprocam_StartPullModeWithCallback. When event occurs, omegonprocam will callback the function POMEGONPROCAM_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
> OMEGONPROCAM_EVENT_EXPOSURE | Software | exposure time changed
> OMEGONPROCAM_EVENT_TEMPTINT | white balance changed. Temp/Tint Mode, please see here.
> OMEGONPROCAM_EVENT_WBGAIN | white balance changed. RGB Gain Mode, please see here.
> OMEGONPROCAM_EVENT_IMAGE | Video image data arrives. Use Omegonprocam_PullImageXXXX to 'pull' the image data
> OMEGONPROCAM_EVENT_STILLIMAGE | Still image which is triggered by function Omegonprocam_Snap or Omegonprocam_SnapN or Omegonprocam_SnapR arrives. Use Omegonprocam_PullImageXXXX to 'pull' the image data
> OMEGONPROCAM_EVENT_ERROR | Generic error, data acquisition cannot continue
> OMEGONPROCAM_EVENT_DISCONNECTED | Camera disconnected, maybe has been pulled out
> OMEGONPROCAM_EVENT_NOFRAMETIMEOUT | No frame was not captured within the specified time. see OMEGONPROCAM_OPTION_NOFRAME_TIMEOUT
> OMEGONPROCAM_EVENT_NOPACKETIMEOUT | No packet was not captured within the specified time. see OMEGONPROCAM_OPTION_NOPACKET_TIMEOUT
> OMEGONPROCAM_EVENT_TRIGGERFAIL | trigger failed (for example, bad frame data or timeout)
> OMEGONPROCAM_EVENT_BLACK | black balance changed
> OMEGONPROCAM_EVENT_FFC | flat field correction status changed
> OMEGONPROCAM_EVENT_DFC | dark field correction status changed
> OMEGONPROCAM_EVENT_FPNC | fixed pattern noise correction status changed
> OMEGONPROCAM_EVENT_ROI | roi changed
> OMEGONPROCAM_EVENT_LEVELRANGE | level range changed
> OMEGONPROCAM_EVENT_AUTOEXPO_CONV | auto exposure convergence
> OMEGONPROCAM_EVENT_AUTOEXPO_CONVFAIL | auto exposure once mode convergence failed
> OMEGONPROCAM_EVENT_FACTORY | restore factory settings. Please note that restoring factory settings may cause resolution changes.
> OMEGONPROCAM_EVENT_EXPO_START | Hardware | exposure start
> OMEGONPROCAM_EVENT_EXPO_STOP | exposure stop
> OMEGONPROCAM_EVENT_TRIGGER_ALLOW | next trigger allow
> OMEGONPROCAM_EVENT_TRIGGER_IN | trigger in
> OMEGONPROCAM_EVENT_HEARTBEAT | heartbeat, can be used to monitor whether the camera is alive. see OMEGONPROCAM_OPTION_HEARTBEAT

- In Push Mode, omegonprocam plays an active role. Once the video data is obtained from camera by internal thread, omegonprocam will 'PUSH' the image data to the application through POMEGONPROCAM_DATA_CALLBACK. Call the function Omegonprocam_StartPushMode to start push mode. Push mode is more complex. There are some special precautions, such as multithread issues, being impossible to call Omegonprocam_Close and Omegonprocam_Stop in callback function POMEGONPROCAM_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 Omegonprocam_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, OMEGONPROCAM_EVENT_STILLIMAGE will be sent out for external acknowledgement. The external application should call Omegonprocam_PullImageV3 or Omegonprocam_PullStillImage(V2) to get the still captured image.

> b) In push mode operation, after the still capture, the callback function POMEGONPROCAM_DATA_CALLBACK_V4/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 Omegonprocam_get_StillResolutionNumber function or check the still field of the struct OmegonprocamModelV2.

## c. Data format: RGB vs RAW

Omegonprocam supports two data formats: RGB format (default) and RAW format. RAW format could be enabled by assigning OMEGONPROCAM_OPTION_RAW parameter to 1 when calling Omegonprocam_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 Omegonprocam_put_Hue or Omegonprocam_AwbOnce function and so on.

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

Users could change RGB bits by calling Omegonprocam_put_Option with different value setting to OMEGONPROCAM_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. Omegonprocam 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. Omegonprocam_get_TempTint function is used to acquire the temp and tint values and Omegonprocam_put_TempTint is used to set the temp and tint values. Function Omegonprocam_AwbOnce is used to execute the auto white balance. When the white balance parameters change, OMEGONPROCAM_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. Omegonprocam_get_WhiteBalanceGain is used to acquire the parameters and Omegonprocam_put_WhiteBalanceGain is used to set the white balance parameters. Omegonprocam_AwbInit is used to execute the execute the auto white balance. When the white balance parameters change, OMEGONPROCAM_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 Omegonprocam_get_TempTint and Omegonprocam_put_TempTint and Omegonprocam_AwbOnce. Omegonprocam_get_WhiteBalanceGain and Omegonprocam_put_WhiteBalanceGain and Omegonprocam_AwbInit cannot be used, they always return E_NOTIMPL.
> > b) In RGB Gain mode, please use Omegonprocam_get_WhiteBalanceGain and Omegonprocam_put_WhiteBalanceGain and Omegonprocam_AwbInit. Omegonprocam_get_TempTint and Omegonprocam_put_TempTint and Omegonprocam_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. Omegonprocam 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

> Omegonprocam 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 Omegonprocam 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 OMEGONPROCAM_FLAG_TRIGGER_SOFTWARE   0x00080000  /* support software trigger */
> >     #define OMEGONPROCAM_FLAG_TRIGGER_EXTERNAL   0x00100000  /* support external trigger */
> >     #define OMEGONPROCAM_FLAG_TRIGGER_SINGLE     0x00200000  /* only support trigger single: one trigger, one image */

> Function Omegonprocam_put_Option(HOmegonprocam h, unsigned iOption, int iValue) could be used to set the camera to trigger mode when assign OMEGONPROCAM_OPTION_TRIGGER to the iOption parameter. iValue is used to specify the types of the trigger modes. Please see the following for reference.

> >     #define OMEGONPROCAM_OPTION_TRIGGER   0x0b    /* 0 = video mode, 1 = software or simulated trigger mode, 2 = external trigger mode, 3 = external + software trigger, default value = 0 */

> Function Omegonprocam_get_Option(HOmegonprocam 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 Omegonprocam_Trigger(HOmegonprocam 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 OMEGONPROCAM_FLAG_TRIGGER_SINGLE flag is checked, the nNumber parameter must be assigned to 1 and 1 image will come out from the camera when Omegonprocam_Trigger is called.
> Enter the trigger mode first and then call Omegonprocam_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 | Remark | Value
  S_OK | Success |  | 0x00000000
  S_FALSE | Yet another success | Different from S_OK, such as internal values and user-set values have coincided, equivalent to noop | 0x00000001
  E_ACCESSDENIED | Permission denied | The program on Linux does not have permission to open the USB device, please enable udev rules file or run as root | 0x80070005
  E_INVALIDARG | One or more arguments are not valid |  | 0x80070057
  E_NOTIMPL | Not supported or not implemented | This feature is not supported on this model of camera | 0x80004001
  E_POINTER | Pointer that is not valid | Pointer is NULL | 0x80004003
  E_UNEXPECTED | Catastrophic failure | Generally indicates that the conditions are not met, such as calling put_Option setting some options that do not support modification when the camera is running, and so on | 0x8000ffff
  E_WRONG_THREAD | Call function in the wrong thread | See here, here, here | 0x8001010e
  E_GEN_FAILURE | Device not functioning | It is generally caused by hardware errors, such as cable problems, USB port problems, poor contact, camera hardware damage, etc | 0x8007001f
  E_BUSY | The requested resource is in use | The camera is already in use, such as duplicated opening/starting the camera, or being used by other application, etc | 0x800700aa
  E_PENDING | The data necessary to complete this operation is not yet available | No data is available at this time | 0x8000000a
  E_TIMEOUT | This operation returned because the timeout period expired |  | 0x8001011f
  E_FAIL | Unspecified failure |  | 0x80004005

      #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 OMEGONPROCAM_HRESULT_ERRORCODE_NEEDED before #include "omegonprocam.h". See below:

      #define OMEGONPROCAM_HRESULT_ERRORCODE_NEEDED
      #include "omegonprocam.h"

- ## Calling Convention

  Win: __stdcall, please see here

  macOS, Linux and Android: __cdecl

- ## Callback: POMEGONPROCAM_EVENT_CALLBACK and POMEGONPROCAM_DATA_CALLBACK_V4/V3

  These callback functions are called back from the internal thread in omegonprocam.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, OMEGONPROCAM_OPTION_CALLBACK_THREAD can be setted to use a dedicated thread for callback.

  Due to the need to wait for the callback function to return when performing the following actions, the callback function context has the following limitations:
  (a) Do NOT call Omegonprocam_Stop and Omegonprocam_Close in this callback function, otherwise, deadlocks.
  (b) Do NOT call Omegonprocam_put_Option with OMEGONPROCAM_OPTION_TRIGGER, OMEGONPROCAM_OPTION_BITDEPTH, OMEGONPROCAM_OPTION_PIXEL_FORMAT, OMEGONPROCAM_OPTION_BINNING, OMEGONPROCAM_OPTION_ROTATE, it will fail with the error code E_WRONG_THREAD.
  (c) Do NOT call Omegonprocam_put_Roi, it will fail with the error code E_WRONG_THREAD.
  (d) If try to acquire the same lock when performing the above operations and when callback functions, it will cause waiting forever for the callback to end, deadlock

- ## Coordinate

  Functions with coordinate parameters, such as Omegonprocam_put_Roi, Omegonprocam_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 upside down (see here), the coordinate must be also upsize down.

- ## Omegonprocam_EnumV2

  Return value: non-negative integer, enumerated camera number

  Parameters:

  > OmegonprocamDeviceV2 arr[OMEGONPROCAM_MAX]: OmegonprocamDeviceV2 buffer

  Remarks: call this function to enumerate Omegonprocam cameras that are currently connected to computer and when it is returned, OmegonprocamDeviceV2 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:

      OmegonprocamDeviceV2 arr[OMEGONPROCAM_MAX];
      unsigned cnt = Omegonprocam_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;     /* OMEGONPROCAM_FLAG_xxx */
          unsigned           maxspeed; /* maximum speed level, Omegonprocam_get_MaxSpeed, the speed range = [0, maxspeed], closed interval */
          unsigned           preview;  /* number of preview resolution, Omegonprocam_get_ResolutionNumber */
          unsigned           still;    /* number of still resolution, Omegonprocam_get_StillResolutionNumber */
          unsigned           maxfanspeed; /* maximum fan speed, fan speed range = [0, max], closed interval */
          unsigned           ioctrol;     /* number of input/output control */
          float              xpixsz;      /* physical pixel size in micrometer */
          float              ypixsz;      /* physical pixel size in micrometer */
          OmegonprocamResolution  res[OMEGONPROCAM_MAX];
      }OmegonprocamModelV2;

  name | The name of this model
  flag | Bitwise flag
  OMEGONPROCAM_FLAG_CMOS | cmos sensor
  OMEGONPROCAM_FLAG_CCD_PROGRESSIVE | progressive ccd sensor
  OMEGONPROCAM_FLAG_CCD_INTERLACED | interlaced ccd sensor
  OMEGONPROCAM_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.
  OMEGONPROCAM_FLAG_MONO | monochromatic sensor
  OMEGONPROCAM_FLAG_BINSKIP_SUPPORTED | support bin/skip mode, see Omegonprocam_put_Mode and Omegonprocam_get_Mode
  OMEGONPROCAM_FLAG_USB30 | usb3.0
  OMEGONPROCAM_FLAG_TEC | Thermoelectric Cooler
  OMEGONPROCAM_FLAG_USB30_OVER_USB20 | usb3.0 camera connected to usb2.0 port
  OMEGONPROCAM_FLAG_ST4 | ST4 port
  OMEGONPROCAM_FLAG_GETTEMPERATURE | support to get the temperature of the sensor, Omegonprocam_get_Temperature
  OMEGONPROCAM_FLAG_HIGH_FULLWELL | support high fullwell capacity
  OMEGONPROCAM_FLAG_RAW10 | OMEGONPROCAM_PIXELFORMAT_RAW10 Pixel format, RAW 10 bits
  OMEGONPROCAM_FLAG_RAW11 | OMEGONPROCAM_PIXELFORMAT_RAW11 Pixel format, RAW 11 bits
  OMEGONPROCAM_FLAG_RAW12 | OMEGONPROCAM_PIXELFORMAT_RAW12 Pixel format, RAW 12 bits
  OMEGONPROCAM_FLAG_RAW12PACK | OMEGONPROCAM_PIXELFORMAT_RAW12PACK Pixel format, RAW 12 bits, packed
  OMEGONPROCAM_FLAG_RAW14 | OMEGONPROCAM_PIXELFORMAT_RAW14 Pixel format, RAW 14 bits
  OMEGONPROCAM_FLAG_RAW16 | OMEGONPROCAM_PIXELFORMAT_RAW16 Pixel format, RAW 16 bits
  OMEGONPROCAM_FLAG_FAN | cooling fan
  OMEGONPROCAM_FLAG_TEC_ONOFF | Thermoelectric Cooler can be turn on or off, target temperature of TEC, see: OMEGONPROCAM_OPTION_TEC OMEGONPROCAM_OPTION_TECTARGET
  OMEGONPROCAM_FLAG_ISP | ISP (Image Signal Processing) chip
  OMEGONPROCAM_FLAG_TRIGGER_SOFTWARE | support software trigger
  OMEGONPROCAM_FLAG_TRIGGER_EXTERNAL | support external trigger
  OMEGONPROCAM_FLAG_TRIGGER_SINGLE | only support trigger single, one trigger, one image
  OMEGONPROCAM_FLAG_BLACKLEVEL | support set and get the black level
  OMEGONPROCAM_FLAG_FOCUSMOTOR | support focus motor
  OMEGONPROCAM_FLAG_AUTO_FOCUS | support auto focus
  OMEGONPROCAM_FLAG_BUFFER | frame buffer
  OMEGONPROCAM_FLAG_DDR | use very large capacity DDR (Double Data Rate SDRAM) for frame buffer. The capacity is not less than one full frame.
  OMEGONPROCAM_FLAG_CG | Conversion Gain: LCG, HCG
  OMEGONPROCAM_FLAG_CGHDR | Conversion Gain: LCG, HCG, HDR
  OMEGONPROCAM_FLAG_EVENT_HARDWARE | hardware event, such as exposure start & stop. see here and here
  OMEGONPROCAM_FLAG_YUV411 | OMEGONPROCAM_PIXELFORMAT_YUV411 Pixel format
  OMEGONPROCAM_FLAG_YUV422 | OMEGONPROCAM_PIXELFORMAT_YUV422 Pixel format
  OMEGONPROCAM_FLAG_YUV444 | OMEGONPROCAM_PIXELFORMAT_YUV444 Pixel format
  OMEGONPROCAM_FLAG_RGB888 | OMEGONPROCAM_PIXELFORMAT_RGB888 Pixel format
  OMEGONPROCAM_FLAG_RAW8 | OMEGONPROCAM_PIXELFORMAT_RAW8 Pixel format, RAW 8 bits
  OMEGONPROCAM_FLAG_GMCY8 | OMEGONPROCAM_PIXELFORMAT_GMCY8 Pixel format, GMCY 8 bits
  OMEGONPROCAM_FLAG_GMCY12 | OMEGONPROCAM_PIXELFORMAT_GMCY12 Pixel format, GMCY 12 btis
  OMEGONPROCAM_FLAG_GLOBALSHUTTER | global shutter
  OMEGONPROCAM_FLAG_PRECISE_FRAMERATE | support precise framerate & bandwidth, see OMEGONPROCAM_OPTION_PRECISE_FRAMERATE & OMEGONPROCAM_OPTION_BANDWIDTH
  OMEGONPROCAM_FLAG_HEAT | support heat to prevent fogging up, see OMEGONPROCAM_OPTION_HEAT & OMEGONPROCAM_OPTION_HEAT_MAX
  OMEGONPROCAM_FLAG_LOW_NOISE | support low noise mode, see OMEGONPROCAM_OPTION_LOW_NOISE
  OMEGONPROCAM_FLAG_LEVELRANGE_HARDWARE | hardware level range
  OMEGONPROCAM_FLAG_GIGE | 1 Gigabit GigE
  OMEGONPROCAM_FLAG_10GIGE | 10 Gigabit GigE
  OMEGONPROCAM_FLAG_5GIGE | 5 Gigabit GigE
  OMEGONPROCAM_FLAG_25GIGE | 2.5 Gigabit GigE
  OMEGONPROCAM_FLAG_CAMERALINK | camera link
  OMEGONPROCAM_FLAG_CXP | CXP: CoaXPress
  OMEGONPROCAM_FLAG_FILTERWHEEL | astro filter wheel
  OMEGONPROCAM_FLAG_AUTOFOCUSER | astro auto focuser
  OMEGONPROCAM_FLAG_LIGHTSOURCE | embedded light source
  OMEGONPROCAM_FLAG_LIGHT_SOURCE | stand alone light source
  OMEGONPROCAM_FLAG_GHOPTO | ghopto sensor
  maxspeed | Maximum speed level, same with Omegonprocam_get_MaxSpeed. The speed range is [0, maxspeed]. see Omegonprocam_put_Speed and Omegonprocam_get_Speed
  preview | Number of preview resolution. Same with Omegonprocam_get_ResolutionNumber
  still | Number of still resolution, zero means still capture is not supported. Same with Omegonprocam_get_StillResolutionNumber
  ioctrol | Number of input/output control
  xpixsz ypixsz | Physical pixel size in micrometer, see Omegonprocam_get_PixelSize
  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.

- ## Omegonprocam_HotPlug

  Return value: NA

  Parameters:

  > POMEGONPROCAM_HOTPLUG funHotPlug: callback function

  > > typedef void (*POMEGONPROCAM_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 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 Omegonprocam_EnumV2(...) again to enum the cameras.
  > - On macOS, IONotificationPortCreate series APIs can also be used as an alternative.

- ## Omegonprocam_GigeEnable

  Return value: HRESULT type means success or failure

  Parameters:

  > POMEGONPROCAM_HOTPLUG funHotPlug: callback function, used to notify GigE cameras online/offline. If online/offline notifications are not required, this callback function can be set to NULL.

  > void* ctxHotPlug: callback context

  Remarks: Initialize support for GigE cameras, it only needs to be called once when the process starts.

- ## Omegonprocam_Open

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

  Parameters:

  > camId: Omegonprocam camera instance, enumerated by Omegonprocam_EnumV2. If camId is NULL, Omegonprocam_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, Omegonprocam_EnumV2 is optional, we can simply use NULL as the parameter.

  Remarks: open the camera instance.

  (1) Supports attaching some additional parameters after camId parameter (Use semicolon (;) to split, case sensitive), such as:

  > Omegonprocam_Open(L"\\?\usb#vid_0547&pid_1134#d&397c94f3&0&3;registry=;wb=rgb")

  see table below:

  Camera Configuration | No parameter is required after camId 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) | Specify to use the relative path of the registry key HKEY_CURRENT_USER. Empty after “=” means that the default registry path will be used: Software\XXX(CompanyName)\capi\YYY(Camera model name)
  ;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 Omegonprocam_Open. And then, there is no difference after getting the HOmegonprocam handle. See below:

      usbManager = (UsbManager)getApplicationContext().getSystemService(Context.USB_SERVICE);
      HashMap<String, UsbDevice> deviceList = usbManager.getDeviceList();
      for (UsbDevice usbDevice : deviceList.values()) {
          ModelV2 model = omegonprocam.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
                  omegonprocam cam = omegonprocam.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 omegonprocam object as usual
                  }
              }
          }
      }

  3. Omegonprocam_Open/Close, Start/Stop are relatively heavyweight calls, frequent operation is not recommended unless necessary.

- ## Omegonprocam_Close

  Return value: void

  Parameters:

  > HOmegonprocam h: camera handle

  Remarks: close the camera. After the handle is closed, never use the HOmegonprocam handle any more.

- ## Omegonprocam_StartPullModeWithWndMsg
  Omegonprocam_StartPullModeWithCallback

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

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

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

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

  > typedef void (*POMEGONPROCAM_EVENT_CALLBACK)(unsigned nEvent, void* ctxEvent);

  > see here.

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

- ## Omegonprocam_PullImageV3
  Omegonprocam_WaitImageV3
  Omegonprocam_PullImageV2
  Omegonprocam_PullStillImageV2
  Omegonprocam_PullImageWithRowPitchV2
  Omegonprocam_PullStillImageWithRowPitchV2
  Omegonprocam_PullImage
  Omegonprocam_PullStillImage
  Omegonprocam_PullImageWithRowPitch
  Omegonprocam_PullStillImageWithRowPitch

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

  Parameters:

  > HOmegonprocam h: camera handle

  > nWaitMS: The timeout interval, in milliseconds. If a non-zero value is specified, the function either successfully fetches the image or waits for a timeout. If nWaitMS is zero, the function does not wait when there are no images to fetch; It always returns immediately; this is equal to Omegonprocam_PullImageV3.

  > 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 OMEGONPROCAM_OPTION_RGB. This parameter is ignored in RAW mode.

  > int rowPitch: the distance from one row to the next row, =0 means using the default row pitch, =-1 means minimum row pitch (zero padding)

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

  > OmegonprocamFrameInfoV3/V2* pInfo: out parameter, frame info:

  >     #define OMEGONPROCAM_FRAMEINFO_FLAG_SEQ          0x0001 /* frame sequence number */
  >     #define OMEGONPROCAM_FRAMEINFO_FLAG_TIMESTAMP    0x0002 /* timestamp */
  >     #define OMEGONPROCAM_FRAMEINFO_FLAG_EXPOTIME     0x0004 /* exposure time */
  >     #define OMEGONPROCAM_FRAMEINFO_FLAG_EXPOGAIN     0x0008 /* exposure gain */
  >     #define OMEGONPROCAM_FRAMEINFO_FLAG_BLACKLEVEL   0x0010 /* black level */
  >     #define OMEGONPROCAM_FRAMEINFO_FLAG_SHUTTERSEQ   0x0020 /* sequence shutter counter */
  >     #define OMEGONPROCAM_FRAMEINFO_FLAG_STILL        0x8000 /* still image */

  >     typedef struct {
  >         unsigned            width;      /* image width, always available */
  >         unsigned            height;     /* image height, always available */
  >         unsigned            flag;       /* OMEGONPROCAM_FRAMEINFO_FLAG_xxxx, the flag is bit set, which means the corresponding value is valid, this depends on camera model */
  >         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 */
  >     } OmegonprocamFrameInfoV3;

  > Note: Except that the image width and height are always valid, everything else depends on whether the underlying hardware of the camera model supports it. Determine whether the corresponding value is valid by testing whether the corresponding flag bit is set.

  Remarks: when pImageData is NULL, while pInfo or pnWidth, pnHeight are not NULL, you can "peek" the meta data of images such as width and height.

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

  > OMEGONPROCAM_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 Minimum Row Pitch (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

- ## Omegonprocam_StartPushModeV4
  Omegonprocam_StartPushModeV3

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle.

  > funData, void* ctxData: the callback function and callback context parameters that are specified by the user's program. Omegonprocam.dll gets image data from the camera, then calls back this function.

  > typedef void (*POMEGONPROCAM_DATA_CALLBACK_V4)(const void* pData, const OmegonprocamFrameInfoV3* pInfo, int bSnap, void* ctxData);
  > typedef void (*POMEGONPROCAM_DATA_CALLBACK_V3)(const void* pData, const OmegonprocamFrameInfoV2* pInfo, int bSnap, void* ctxData);

  > 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 Omegonprocam_Snap or Omegonprocam_SnapN function, FALSE means ordinary previewed pictures / videos.

  Remarks: start camera instance.

- ## Omegonprocam_Stop

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam handle

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

  > Step 1: call Omegonprocam_Stop to stop

  > Step 2: call Omegonprocam_put_Size or Omegonprocam_put_eSize to set the new resolution

  > Step 3: call Omegonprocam_StartPullModeWithWndMsg or Omegonprocam_StartPullModeWithCallback or Omegonprocam_StartPushModeV4/V3 to restart

- ## Omegonprocam_Pause

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > int bPause: 1 => pause, 0 => continue

  Remarks: temporarily pause the video stream

- ## Omegonprocam_SnapN
  Omegonprocam_SnapR
  Omegonprocam_Snap

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned nResolutionIndex: resolution index. 0xffffffff means use the cureent preview resolution

  > 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 OMEGONPROCAM_EVENT_STILLIMAGE.

  > > b) If we use Push Mode, the image will be returned by callback function POMEGONPROCAM_DATA_CALLBACK_V4/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 Omegonprocam_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 Omegonprocam_put_Size, or Omegonprocam_put_eSize.
  > Whether it supports "still snap" or not, see "still" domain in OmegonprocamModelV2.

  > Omegonprocam_SnapR is used to snap "RAW" still image, bypass the hardware ISP if any.

  > Omegonprocam_Snap(h, index) == Omegonprocam_SnapN(h, index, 1)

- ## Omegonprocam_Trigger

  Return value: HRESULT type means success or failure.

  Parameters:

  > HOmegonprocam h: camera 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 OMEGONPROCAM_EVENT_IMAGE.

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

- ## Omegonprocam_TriggerSync

  Return value: HRESULT type means success or failure.

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned nWaitMS: The timeout interval, in milliseconds. If nWaitMS is zero, it means using the default value (exposure time * 102% + 4000 milliseconds), 0xffffffff means waiting forever, and other values represent the specific number of milliseconds.

  > 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 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 OMEGONPROCAM_OPTION_RGB. This parameter is ignored in RAW mode.

  > int rowPitch: the distance from one row to the next row, =0 means using the default row pitch, =-1 means minimum row pitch (zero padding)

  > OmegonprocamFrameInfoV3* pInfo: out parameter, frame info

  Remarks: In trigger mode, call this function for a single software trigger and wait for the image to arrive.

- ## Omegonprocam_put_Size
  Omegonprocam_get_Size
  Omegonprocam_put_eSize
  Omegonprocam_get_eSize

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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 Omegonprocam_put_Size(h, 1024, 768) is as effective as Omegonprocam_put_eSize(h, 1)

- ## Omegonprocam_put_Roi
  Omegonprocam_get_Roi

  Return value: HRESULT type means success or failure.

  Parameters:

  > HOmegonprocam h: camera 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. Omegonprocam_put_Roi(h, 0, 0, 0, 0) means to clear the ROI and restore the original size.

  > Important: It is forbidden to call Omegonprocam_put_Roi in the callback context of POMEGONPROCAM_EVENT_CALLBACK and POMEGONPROCAM_DATA_CALLBACK_V4/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.

- ## Omegonprocam_get_ResolutionNumber
  Omegonprocam_get_Resolution

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned nResolutionIndex: resolution index

  > int* pWidth, int* pHeight: width/height

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

  > These parameters have also been contained in OmegonprocamModelV2.

- ## Omegonprocam_get_RawFormat

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned* pFourCC: One of 4 Bayer pixel arrangement(MAKEFOURCC('G', 'B', 'R', 'G'), MAKEFOURCC('R', 'G', 'G', 'B'), MAKEFOURCC('B', 'G', 'G', 'R'), MAKEFOURCC('G', 'R', 'B', 'G'), see here). Please note that the Y-axis direction of the coordinate system used by different software to define Bayer may be different (Y-axis upward or downward), so some mapping may be required during interoperation. Like the same pixel arrangement, Bayer is GRBG when the Y-axis is downward, and BGGR when the Y-axis is upward.

  > unsigned* pBitsPerPixel: bitdepth, 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

- ## Omegonprocam_get_PixelFormatSupport

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > char cmd:

  > > -1: query the number
  > > 0~number: query the nth pixel format

  > int* piValue: output, OMEGONPROCAM_PIXELFORMAT_xxxx, see here

- ## Omegonprocam_get_PixelFormatName

  Return value: name of pixel format, such as "RAW10", "HDR12HL", etc

  Parameters:

  > int val: OMEGONPROCAM_PIXELFORMAT_xxxx, see here

- ## Omegonprocam_put_Option
  Omegonprocam_get_Option

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned iOption: see table below

  > int iValue: see table below

  > Option | Description | Default | Can be changed when camera is running? (Before Omegonprocam_StartXXXX or after Omegonprocam_Stop)
  > OMEGONPROCAM_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)
  > OMEGONPROCAM_OPTION_ISP | Enable hardware ISP: 0 => auto (disable in RAW mode, otherwise enable) 1 => enable -1 => disable | 0(Auto) | No (The return value is E_UNEXPECTED when set this option while camera is running)
  > OMEGONPROCAM_OPTION_BITDEPTH | Some cameras support the bitdepth which is more than 8 such as 10, 12, 14, 16. 0 = use 8 bitdepth. 1 = use the maximum bitdepth of this camera. | Model Specific | Yes. But not recommended to modify too frequently while camera is running, it's relatively heavy operation.
  > OMEGONPROCAM_OPTION_TRIGGER | 0 = video mode 1 = software or simulated trigger mode 2 = external trigger mode 3 = external + software trigger | 0 | Yes

  > OMEGONPROCAM_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)

  > OMEGONPROCAM_OPTION_BYTEORDER | Byte order: 1: BGR 0: RGB | Win: 1 Linux/MacOS/Android: 0 | Yes. But not recommended to modify too frequently while camera is running, it's relatively heavy operation.
  > OMEGONPROCAM_OPTION_UPSIDE_DOWN | Upside down: 1: yes 0: no Please distinguish it from Omegonprocam_put_VFlip, which requires the CPU to perform data moving work on each frame of data | Win: 1 Linux/MacOS/Android: 0 | No (The return value is E_UNEXPECTED when set this option while camera is running)
  > OMEGONPROCAM_OPTION_FAN | Some cameras support the cooling fan. 0 = turn off the cooling fan [1, max] = fan speed set to "-1" means to use default fan speed | Model Specific | Yes
  > OMEGONPROCAM_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
  > OMEGONPROCAM_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℃. Set the target temperature to "-2730" or below means using the default for that model. | Model Specific | Yes
  > OMEGONPROCAM_OPTION_AUTOEXP_POLICY | Auto Exposure Policy: 0: Exposure Only 1: Exposure Preferred 2: Gain Only 3: Gain Preferred | 1 | Yes
  > OMEGONPROCAM_OPTION_AUTOEXP_THRESHOLD | threshold of auto exposure, range: [2~15] | 5 | Yes
  > OMEGONPROCAM_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)
  > OMEGONPROCAM_OPTION_BLACKLEVEL | Black Level Always return E_NOTIMPL for camera that don't support black level. | 0 | Yes
  > OMEGONPROCAM_OPTION_MULTITHREAD | multithread image processing | 1 | No (The return value is E_UNEXPECTED when set this option while camera is running)

  > OMEGONPROCAM_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, n*n, works only in RAW mode), 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

  > OMEGONPROCAM_OPTION_ROTATE | rotate clockwise: 0, 90, 180, 270 | 0 | Yes
  > OMEGONPROCAM_OPTION_CG | Conversion Gain: 0: LCG 1: HCG 2: HDR (for camera with flag OMEGONPROCAM_FLAG_CGHDR) 2: MCG (for camera with flag OMEGONPROCAM_FLAG_GHOPTO) | Model Specific | Yes

  > OMEGONPROCAM_OPTION_PIXEL_FORMAT

  > OMEGONPROCAM_PIXELFORMAT_RAW8
  > OMEGONPROCAM_PIXELFORMAT_RAW10
  > OMEGONPROCAM_PIXELFORMAT_RAW12
  > OMEGONPROCAM_PIXELFORMAT_RAW14
  > OMEGONPROCAM_PIXELFORMAT_RAW16
  > OMEGONPROCAM_PIXELFORMAT_YUV411
  > OMEGONPROCAM_PIXELFORMAT_VUYY
  > OMEGONPROCAM_PIXELFORMAT_YUV444
  > OMEGONPROCAM_PIXELFORMAT_RGB888
  > OMEGONPROCAM_PIXELFORMAT_GMCY8 (map to RGGB 8 bits)
  > OMEGONPROCAM_PIXELFORMAT_GMCY12 (map to RGGB 12 bits)
  > OMEGONPROCAM_PIXELFORMAT_UYVY
  > OMEGONPROCAM_PIXELFORMAT_RAW12PACK
  > OMEGONPROCAM_PIXELFORMAT_RAW11
  > OMEGONPROCAM_PIXELFORMAT_HDR8HL (HDR, Bitdepth: 8, Conversion Gain: High + Low)
  > OMEGONPROCAM_PIXELFORMAT_HDR10HL (HDR, Bitdepth: 10, Conversion Gain: High + Low)
  > OMEGONPROCAM_PIXELFORMAT_HDR11HL (HDR, Bitdepth: 11, Conversion Gain: High + Low)
  > OMEGONPROCAM_PIXELFORMAT_HDR12HL (HDR, Bitdepth: 12, Conversion Gain: High + Low)
  > OMEGONPROCAM_PIXELFORMAT_HDR14HL (HDR, Bitdepth: 14, Conversion Gain: High + Low)

  > Model Specific

  > Yes.
  > But not recommended to modify too frequently while camera is running, it's relatively heavy operation.

  > OMEGONPROCAM_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

  > OMEGONPROCAM_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) >> 16): average number

  > 0

  > Yes

  > OMEGONPROCAM_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) >> 16): average number

  > 0

  > Yes

  > OMEGONPROCAM_OPTION_FPNC

  > Fixed Pattern Noise 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) >> 16): average number

  > 0

  > Yes

  > OMEGONPROCAM_OPTION_SHARPENING

  > Sharpening, (threshold << 24) | (radius << 16) | strength)

  > > strength: [0, 500], default: 0 (disable)
  > > radius: [1, 10]
  > > threshold: [0, 255]

  > strength: Model Specific
  > radius: 2
  > threshold: 0

  > Yes

  > OMEGONPROCAM_OPTION_FACTORY | restore the factory settings | Always 0 | Yes
  > OMEGONPROCAM_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
  > OMEGONPROCAM_OPTION_TEC_VOLTAGE_MAX | TEC maximum voltage in 0.1V | NA | NA
  > OMEGONPROCAM_OPTION_TEC_VOLTAGE_MAX_RANGE | get the TEC maximum voltage range in 0.1V high 16 bits: max low 16 bits: min | NA | NA
  > OMEGONPROCAM_OPTION_POWER | get power consumption, unit: milliwatt | NA | NA
  > OMEGONPROCAM_OPTION_GLOBAL_RESET_MODE | global reset mode | 0 | Yes
  > OMEGONPROCAM_OPTION_DEVICE_RESET | reset usb device, simulate a replug | NA | NA
  > OMEGONPROCAM_OPTION_FOCUSPOS | focus positon | NA | Yes
  > OMEGONPROCAM_OPTION_AFMODE | auto focus mode: see OmegonprocamAFMode | NA | Yes
  > OMEGONPROCAM_OPTION_AFSTATUS | auto focus status: see OmegonprocamAFStaus | NA | NA

  > OMEGONPROCAM_OPTION_TESTPATTERN

  > test pattern:
  > 0: off
  > 3: monochrome diagonal stripes
  > 5: monochrome vertical stripes
  > 7: monochrome horizontal stripes
  > 9: chromatic diagonal stripes

  > 0

  > Yes

  > TOMEGONPROCAM_OPTION_NOFRAME_TIMEOUT | Timeout for grabbing no frame. Trigger an event when no frame is acquired within the set time, see OMEGONPROCAM_EVENT_NOFRAMETIMEOUT 0 => disable positive value (>=OMEGONPROCAM_NOFRAME_TIMEOUT_MIN) => timeout milliseconds | 0 | Yes
  > OMEGONPROCAM_OPTION_NOPACKET_TIMEOUT | Timeout for grabbing no packet. Trigger an event when no packet is acquired within the set time, see OMEGONPROCAM_EVENT_NOPACKETTIMEOUT 0 => disable positive value (>=OMEGONPROCAM_NOPACKET_TIMEOUT_MIN) => timeout milliseconds | 0 | Yes
  > OMEGONPROCAM_OPTION_BANDWIDTH | bandwidth, range:[1-100]% After setting the bandwidth, get the accurate precise rate range, and then set the precise frame rate | 100 | Yes
  > OMEGONPROCAM_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 The return value is E_UNEXPECTED if camera is NOT running, E_NOTIMPL means not supported | NA | NA
  > OMEGONPROCAM_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 The return value is E_UNEXPECTED if camera is NOT running, E_NOTIMPL means not supported | NA | NA
  > OMEGONPROCAM_OPTION_PRECISE_FRAMERATE | in 0.1fps, such as 115 means 11.5fps. range:[1~maximum] | 90% of the maximum | Yes
  > OMEGONPROCAM_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
  > OMEGONPROCAM_OPTION_CALLBACK_THREAD | dedicated thread for callback, only available in pull mode: 0 => disable, 1 => enable | 0 | No (The return value is E_UNEXPECTED when set this option while camera is running)
  > OMEGONPROCAM_OPTION_FRONTEND_DEQUE_LENGTH or OMEGONPROCAM_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 (The return value is E_UNEXPECTED when set this option while camera is running)
  > OMEGONPROCAM_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 (The return value is E_UNEXPECTED when set this option while camera is running)
  > OMEGONPROCAM_OPTION_SEQUENCER_ONOFF | sequencer trigger: on/off | 0 | Yes
  > OMEGONPROCAM_OPTION_SEQUENCER_NUMBER | sequencer trigger: number, range = [1, 255] | NA | Yes
  > OMEGONPROCAM_OPTION_SEQUENCER_EXPOTIME | sequencer trigger: exposure time iOption = OMEGONPROCAM_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 Omegonprocam_put_Option(OMEGONPROCAM_OPTION_SEQUENCER_EXPOTIME | 3, 50000) | NA | Yes
  > OMEGONPROCAM_OPTION_SEQUENCER_EXPOGAIN | sequencer trigger: exposure gain iOption = OMEGONPROCAM_OPTION_SEQUENCER_EXPOGAIN | index iValue = gain | NA | Yes
  > OMEGONPROCAM_OPTION_DENOISE | Denoise strength range: [0, 100], 0 means disable | Model Specific | Yes
  > OMEGONPROCAM_OPTION_HEAT_MAX | get maximum level: heat to prevent fogging up [0, max], 0 means off | NA | NA
  > OMEGONPROCAM_OPTION_HEAT | heat to prevent fogging up | Model Specific | Yes
  > OMEGONPROCAM_OPTION_LIGHTSOURCE_MAX | get maximum level: light source [0, max], 0 means off | NA | NA
  > OMEGONPROCAM_OPTION_LIGHTSOURCE | light source level | 50% max level | Yes
  > OMEGONPROCAM_OPTION_HEARTBEAT | Heartbeat interval in millisecond range: [OMEGONPROCAM_HEARTBEAT_MIN, OMEGONPROCAM_HEARTBEAT_MAX] 0: disable | disable | Yes

  > TOUCPAM_OPTION_EVENT_HARDWARE

  > enable or disable hardware event notify: 0 => disable, 1 => enable

  > > (1) iOption = OMEGONPROCAM_OPTION_EVENT_HARDWARE, master switch for notification of all hardware events
  > > (2) iOption = OMEGONPROCAM_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

  > OMEGONPROCAM_OPTION_LOW_POWERCONSUMPTION | Low Power Consumption: 0 => disable, 1 => enable | Model Specific | Yes
  > OMEGONPROCAM_OPTION_LOW_NOISE | low noise mode (Higher signal noise ratio, lower frame rate): 0 => disable, 1 => enable | Model Specific | Yes
  > OMEGONPROCAM_OPTION_HIGH_FULLWELL | high fullwell capacity: 0 => disable, 1 => enable | Model Specific | Yes

  > OMEGONPROCAM_OPTION_AUTOEXPOSURE_PERCENT

  > Peak mode of brightness calculation method: Calculate the average brightness of specified percentage top brightest pixels in interest area. Enable this option when the background is dark and the target is overexposed in average mode. Frame rate may be affected when this option is enabled due to higher CPU consumption
  > 1~99: average brightness of specified percentage top brightest pixels in ROI
  > 0 or 100: average brightness of whole pixels in ROI, means "disabled"

  > 0(Disabled)

  > Yes

  > OMEGONPROCAM_OPTION_DEFECT_PIXEL | Defect Pixel Correction 0 => disable, 1 => enable | enable (1) | Yes
  > OMEGONPROCAM_OPTION_HDR_KB | HDR synthesize K (high 16 bits): [1, 25500] B (low 16 bits): [0, 65535] 0xffffffff => set to default | Model Specific | Yes
  > OMEGONPROCAM_OPTION_HDR_THRESHOLD | HDR synthesize threshold: [1, 4094] 0xffffffff => set to default | Model Specific | Yes
  > OMEGONPROCAM_OPTION_DYNAMIC_DEFECT | Dynamic Defect Pixel Correction threshold, t1: (high 16 bits): [10, 100], means: [1.0, 10.0] value, t2: (low 16 bits): [0, 100], means: [0.00, 1.00] | disable (t1=10, t2=0) | Yes
  > OMEGONPROCAM_OPTION_ANTI_SHUTTER_EFFECT | anti shutter effect: 1 => disable, 0 => disable | disable (0) | Yes
  > OMEGONPROCAM_OPTION_OVERCLOCK_MAX | maximum overclock | NA | Yes
  > OMEGONPROCAM_OPTION_OVERCLOCK | overclock | 0 | Yes
  > OMEGONPROCAM_OPTION_RESET_SENSOR | reset sensor | NA | Yes
  > OMEGONPROCAM_OPTION_CHAMBER_HT | get chamber humidity & temperature: high 16 bits: humidity, in 0.1%, such as: 325 means humidity is 32.5% low 16 bits: temperature, in 0.1 degrees Celsius, such as: 32 means 3.2 degrees Celsius | NA | NA
  > OMEGONPROCAM_OPTION_ENV_HT | get environment humidity & temperature | NA | NA
  > OMEGONPROCAM_OPTION_EXPOSURE_PRE_DELAY | exposure signal pre-delay, microsecond | 0 | Yes
  > OMEGONPROCAM_OPTION_EXPOSURE_POST_DELAY | exposure signal post-delay, microsecond | 0 | Yes
  > OMEGONPROCAM_OPTION_LINE_PRE_DELAY | specified line signal pre-delay, microsecond | 0 | Yes
  > OMEGONPROCAM_OPTION_LINE_POST_DELAY | specified line signal post-delay, microsecond | 0 | Yes
  > OMEGONPROCAM_OPTION_AUTOEXPO_CONV | get auto exposure convergence status: 1(YES) or 0(NO), -1(NA) |  | NA
  > OMEGONPROCAM_OPTION_AUTOEXP_EXPOTIME_DAMP | Auto exposure damp: time (thousandths) | 0 | Yes
  > OMEGONPROCAM_OPTION_AUTOEXP_GAIN_STEP | Auto exposure damp: gain (thousandths) | 0 | Yes

  > OMEGONPROCAM_OPTION_OVEREXP_POLICY

  > Auto exposure over exposure policy: when overexposed,

  > > 0 => directly reduce the exposure time/gain to the minimum value; or
  > > 1 => reduce exposure time/gain in proportion to current and target brightness.

  > The advantage of policy 0 is that the convergence speed is faster, but there is black screen.
  > Policy 1 avoids the black screen, but the convergence speed is slower.

  > 0

  > Yes

  > OMEGONPROCAM_OPTION_AUTOEXPO_TRIGGER | auto exposure on trigger mode: 1(Enable) or 0(Disable) | 0 | Yes

  > OMEGONPROCAM_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

  > OMEGONPROCAM_OPTION_LINEAR | Builtin linear tone mapping: 0 = turn off 1 = turn on | 1 | Yes
  > OMEGONPROCAM_OPTION_CURVE | Builtin curve tone mapping: 0 = turn off 1 = turn on polynomial 2 = turn on logarithmic | 2 | Yes
  > OMEGONPROCAM_OPTION_COLORMATIX | 0 = turn off the builtin color matrix 1 = turn on the builtin color matrix | 1 | Yes
  > OMEGONPROCAM_OPTION_WBGAIN | 0 = turn off the builtin white balance gain 1 = turn on the builtin white balance gain | 1 | Yes

  > OMEGONPROCAM_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

  > OMEGONPROCAM_OPTION_DEMOSAIC_VIDEO | Demosaic mothod for video | 0 | Yes
  > OMEGONPROCAM_OPTION_DEMOSAIC_STILL | Demosaic mothod for still image | 0 | Yes
  > OMEGONPROCAM_OPTION_OPEN_USB_ERRORCODE | get the open usb error code | NA | NA
  > OMEGONPROCAM_OPTION_FLUSH | 1: hard flush, discard frames cached by camera DDR (if any) 2: soft flush, discard frames cached by omegonprocam.dll (if any) 3: both Omegonprocam_Flush means 'both' return the number of soft flushed frames if successful, HRESULT if failed | NA | NA
  > OMEGONPROCAM_OPTION_PSEUDO_COLOR_START | Pseudo: start color, BGR format |  | Yes
  > OMEGONPROCAM_OPTION_PSEUDO_COLOR_END | Pseudo: end color, BGR format |  | Yes

  > OMEGONPROCAM_OPTION_PSEUDO_COLOR_ENABLE

  > Pseudo:
  > -1 => custom: use startcolor & endcolor to generate the colormap
  > 0 => disable
  > 1 => spot
  > 2 => spring
  > 3 => summer
  > 4 => autumn
  > 5 => winter
  > 6 => bone
  > 7 => jet
  > 8 => rainbow
  > 9 => deepgreen
  > 10 => ocean
  > 11 => cool
  > 12 => hsv
  > 13 => pink
  > 14 => hot
  > 15 => parula
  > 16 => magma
  > 17 => inferno
  > 18 => plasma
  > 19 => viridis
  > 20 => cividis
  > 21 => twilight
  > 22 => twilight_shifted
  > 23 => turbo

  > 0

  > Yes

  > OMEGONPROCAM_OPTION_NUMBER_DROP_FRAME | get the number of frames that have been grabbed from the USB but dropped by the software | NA | NA
  > OMEGONPROCAM_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
  > OMEGONPROCAM_OPTION_FRONTEND_DEQUE_CURRENT | get the current number in frontend deque | NA | NA
  > OMEGONPROCAM_OPTION_BACKEND_DEQUE_CURRENT | get the current number in backend deque | NA | NA
  > OMEGONPROCAM_OPTION_PACKET_NUMBER | get the received packet number | NA | NA

  > OMEGONPROCAM_OPTION_GIGETIMEOUT

  > For GigE cameras, the application periodically sends heartbeat signals to the camera to keep the connection to the camera alive. If the camera doesn't receive heartbeat signals within the time period specified by the heartbeat timeout counter, the camera resets the connection. When the application is stopped by the debugger, the application cannot create the heartbeat signals.
  > 0 => auto: when the camera is opened, disable if debugger is present or enable if no debugger is present
  > 1 => enable
  > 2 => disable

  > 0

  > Yes

  > OMEGONPROCAM_OPTION_FILTERWHEEL_SLOT | filter wheel slot number | 7 | Yes

  > OMEGONPROCAM_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 Omegonprocam_put_Option with OMEGONPROCAM_OPTION_TRIGGER, OMEGONPROCAM_OPTION_BITDEPTH, OMEGONPROCAM_OPTION_PIXEL_FORMAT, OMEGONPROCAM_OPTION_BINNING, OMEGONPROCAM_OPTION_ROTATE in the callback context of POMEGONPROCAM_EVENT_CALLBACK and POMEGONPROCAM_DATA_CALLBACK_V4/V3, the return value is E_WRONG_THREAD.

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

- ## Omegonprocam_put_RealTime
  Omegonprocam_get_RealTime

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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.

- ## Omegonprocam_get_AutoExpoEnable
  Omegonprocam_put_AutoExpoEnable
  Omegonprocam_get_AutoExpoTarget
  Omegonprocam_put_AutoExpoTarget
  Omegonprocam_put_MaxAutoExpoTimeAGain
  Omegonprocam_put_AutoExpoRange
  Omegonprocam_get_AutoExpoRange
  Omegonprocam_get_MaxAutoExpoTimeAGain
  Omegonprocam_put_MinAutoExpoTimeAGain
  Omegonprocam_get_MinAutoExpoTimeAGain

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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 Omegonprocam_put_AEAuxRect, Omegonprocam_get_AEAuxRect).

- ## Omegonprocam_get_ExpoTime
  Omegonprocam_put_ExpoTime
  Omegonprocam_get_ExpTimeRange
  Omegonprocam_get_RealExpoTime

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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. Omegonprocam_get_RealExpoTime get the real exposure time based on 50HZ/60HZ.

- ## Omegonprocam_get_ExpoAGain
  Omegonprocam_put_ExpoAGain
  Omegonprocam_get_ExpoAGainRange

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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.

- ## Omegonprocam_put_Hue
  Omegonprocam_get_Hue
  Omegonprocam_put_Saturation
  Omegonprocam_get_Saturation
  Omegonprocam_put_Brightness
  Omegonprocam_get_Brightness
  Omegonprocam_get_Contrast
  Omegonprocam_put_Contrast
  Omegonprocam_get_Gamma
  Omegonprocam_put_Gamma

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

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

- ## Omegonprocam_get_Chrome
  Omegonprocam_put_Chrome

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > int bChrome: 1(monochromatic) or color(0)

  Remarks: color or monochromatic mode

- ## Omegonprocam_get_VFlip
  Omegonprocam_put_VFlip
  Omegonprocam_get_HFlip
  Omegonprocam_put_HFlip

  Return value: HRESULT type means success or failure

  Parameters: HOmegonprocam h: camera handle

  Remarks: vertical/horizontal flip.

- ## Omegonprocam_put_Speed
  Omegonprocam_get_Speed
  Omegonprocam_get_MaxSpeed

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned short nSpeed: frame rate level

  Remarks: the minimum frame rate level is "0", the maximum one can be achieved through Function "Omegonprocam_get_MaxSpeed" which equals to maxspeed in OmegonprocamModelV2.
  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%.

- ## Omegonprocam_put_HZ
  Omegonprocam_get_HZ

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

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

  Remarks: set the light source power frequency

- ## Omegonprocam_get_Temperature
  Omegonprocam_put_Temperature

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

  Parameters:

  > HOmegonprocam h: camera handle

  > short nTemperature: in 0.1℃ (32 means 3.2℃, -35 means -3.5℃). Set "-2730" or below means using the default value of this model.

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

  > set the target temperature of the sensor, equivalent to Omegonprocam_put_Option(, OMEGONPROCAM_OPTION_TECTARGET, ).

- ## Omegonprocam_put_Mode
  Omegonprocam_get_Mode

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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.

- ## Omegonprocam_put_TempTint
  Omegonprocam_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. For mono camera, return value always is E_NOTIMPL.

  Parameters:

  > HOmegonprocam h: camera 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).

- ## Omegonprocam_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. For mono camera, return value always is E_NOTIMPL.

  Parameters:

  > HOmegonprocam h: camera handle

  > PIOMEGONPROCAM_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, OMEGONPROCAM_EVENT_TEMPTINT event notify the application (In Pull Mode) and callback happens. In pull mode, this callback is useless, set it to NULL.

- ## Omegonprocam_put_WhiteBalanceGain
  Omegonprocam_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. For mono camera, return value always is E_NOTIMPL.

  Parameters:

  > HOmegonprocam h: camera handle

  > int aGain[3]: RGB Gain

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

- ## Omegonprocam_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. For mono camera, return value always is E_NOTIMPL.

  Parameters:

  > HOmegonprocam h: camera handle

  > PIOMEGONPROCAM_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, OMEGONPROCAM_EVENT_WBGAIN event notify the application (In Pull Mode) and callback happens. In pull mode, this callback is useless, set it to NULL.

- ## Omegonprocam_AbbOnce

  Return value: HRESULT type means success or failure. For mono camera, return value always is E_NOTIMPL.

  Parameters:

  > HOmegonprocam h: camera handle

  > PIOMEGONPROCAM_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, OMEGONPROCAM_EVENT_BLACK event notify the application (In Pull Mode) and callback happens. In pull mode, this callback is useless, set it to NULL.

- ## Omegonprocam_put_BlackBalance
  Omegonprocam_get_BlackBalance

  Return value: HRESULT type means success or failure.

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned short aSub[3]: RGB Offset

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

- ## Omegonprocam_put_AWBAuxRect
  Omegonprocam_get_AWBAuxRect
  Omegonprocam_put_AEAuxRect
  Omegonprocam_get_AEAuxRect
  Omegonprocam_put_ABBAuxRect
  Omegonprocam_get_ABBAuxRect

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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.

  For mono camera, white balance and black balance always return E_NOTIMPL.

- ## Omegonprocam_get_MonoMode

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

  Parameters:

  > Omegonprocam h: camera handle

  Remarks: grey camera or not, find the flag in OmegonprocamModelV2: OMEGONPROCAM_FLAG_MONO

- ## Omegonprocam_get_MaxBitDepth

  Return value: the maximum bitdepth this camera supports.

  Parameters:

  > HOmegonprocam h: camera handle

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

- ## Omegonprocam_get_StillResolutionNumber
  Omegonprocam_get_StillResolution

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned nResolutionIndex: resolution index

  > int* pWidth, int* pHeight: width/height

  Remarks: Omegonprocam_get_StillResolutionNumber means the number of supported still resolution. Take UCMOS03100KPA as an example, if we call the function Omegonprocam_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". Omegonprocam_get_Resolution gs the width/height of each kind of resolution.

- ## Omegonprocam_get_SerialNumber
  Omegonprocam_get_FwVersion
  Omegonprocam_get_HwVersion
  Omegonprocam_get_ProductionDate
  Omegonprocam_get_Revision

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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.

- ## Omegonprocam_get_PixelSize

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned nResolutionIndex: resolution index

  > float* x, float* y: sensor physical pixel size, such as 2.4μm × 2.4μm

- ## Omegonprocam_put_LEDState

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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.

- ## Omegonprocam_read_EEPROM
  Omegonprocam_write_EEPROM

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

  Parameters:

  > HOmegonprocam h: camera 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.

- ## Omegonprocam_IoControl

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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

  > OMEGONPROCAM_IOCONTROLTYPE_GET_SUPPORTEDMODE | get the supported mode: 0x01 => Input 0x02 => Output (0x01 | 0x02) => support both Input and Output
  > OMEGONPROCAM_IOCONTROLTYPE_GET_GPIODIR | 0x00 => Input, 0x01 => Output
  > OMEGONPROCAM_IOCONTROLTYPE_SET_GPIODIR

  > OMEGONPROCAM_IOCONTROLTYPE_GET_FORMAT

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

  > OMEGONPROCAM_IOCONTROLTYPE_SET_FORMAT
  > OMEGONPROCAM_IOCONTROLTYPE_GET_OUTPUTINVERTER | boolean, only support output signal
  > OMEGONPROCAM_IOCONTROLTYPE_SET_OUTPUTINVERTER
  > OMEGONPROCAM_IOCONTROLTYPE_GET_INPUTACTIVATION | 0x00 => Rising edge, 0x01 => Falling edge, 0x02 => Level high, 0x03 => Level low
  > OMEGONPROCAM_IOCONTROLTYPE_SET_INPUTACTIVATION
  > OMEGONPROCAM_IOCONTROLTYPE_GET_DEBOUNCERTIME | debouncer time in microseconds, [0, 20000]
  > OMEGONPROCAM_IOCONTROLTYPE_SET_DEBOUNCERTIME

  > OMEGONPROCAM_IOCONTROLTYPE_GET_TRIGGERSOURCE

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

  > OMEGONPROCAM_IOCONTROLTYPE_SET_TRIGGERSOURCE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_TRIGGERDELAY | Trigger delay time in microseconds, [0, 5000000]
  > OMEGONPROCAM_IOCONTROLTYPE_SET_TRIGGERDELAY
  > OMEGONPROCAM_IOCONTROLTYPE_GET_BURSTCOUNTER | Burst Counter, range: [1 ~ 65535]
  > OMEGONPROCAM_IOCONTROLTYPE_SET_BURSTCOUNTER
  > OMEGONPROCAM_IOCONTROLTYPE_GET_COUNTERSOURCE | 0x00 => Opto-isolated input 0x01 => GPIO0 0x02 => GPIO1
  > OMEGONPROCAM_IOCONTROLTYPE_SET_COUNTERSOURCE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_COUNTERVALUE | Counter Value, range: [1 ~ 65535]
  > OMEGONPROCAM_IOCONTROLTYPE_SET_COUNTERVALUE
  > OMEGONPROCAM_IOCONTROLTYPE_SET_RESETCOUNTER |
  > OMEGONPROCAM_IOCONTROLTYPE_GET_PWMSOURCE | 0x00 => Opto-isolated input 0x01 => GPIO0 0x02 => GPIO1
  > OMEGONPROCAM_IOCONTROLTYPE_SET_PWMSOURCE

  > OMEGONPROCAM_IOCONTROLTYPE_GET_OUTPUTMODE

  > 0x00 => Frame Trigger Wait
  > 0x01 => Exposure Active
  > 0x02 => Strobe
  > 0x03 => User output
  > 0x04 => Counter Output
  > 0x05 => Timer Output

  > OMEGONPROCAM_IOCONTROLTYPE_SET_OUTPUTMODE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_STROBEDELAYMODE | boolean, 0 => pre-delay, 1 => delay; compared to exposure active signal
  > OMEGONPROCAM_IOCONTROLTYPE_SET_STROBEDELAYMODE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_STROBEDELAYTIME | Strobe delay or pre-delay time in microseconds, [0, 5000000]
  > OMEGONPROCAM_IOCONTROLTYPE_SET_STROBEDELAYTIME
  > OMEGONPROCAM_IOCONTROLTYPE_GET_STROBEDURATION | Strobe duration time in microseconds, [0, 5000000]
  > OMEGONPROCAM_IOCONTROLTYPE_SET_STROBEDURATION
  > OMEGONPROCAM_IOCONTROLTYPE_GET_USERVALUE | bit0 => Opto-isolated output bit1 => GPIO0 output bit2 => GPIO1 output
  > OMEGONPROCAM_IOCONTROLTYPE_SET_USERVALUE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_UART_ENABLE | UART enable: 1 => on; 0 => off
  > OMEGONPROCAM_IOCONTROLTYPE_SET_UART_ENABLE

  > OMEGONPROCAM_IOCONTROLTYPE_GET_UART_BAUDRATE

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

  > OMEGONPROCAM_IOCONTROLTYPE_SET_UART_BAUDRATE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_UART_LINEMODE | Line Mode: 0 => TX(GPIO_0)/RX(GPIO_1) 1 => TX(GPIO_1)/RX(GPIO_0)
  > OMEGONPROCAM_IOCONTROLTYPE_SET_UART_LINEMODE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_EXPO_ACTIVE_MODE | exposure time signal: 0 => specified line 1 => common exposure time
  > OMEGONPROCAM_IOCONTROLTYPE_SET_EXPO_ACTIVE_MODE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_EXEVT_ACTIVE_MODE | exposure event: 0 => specified line 1 => common exposure time
  > OMEGONPROCAM_IOCONTROLTYPE_SET_EXEVT_ACTIVE_MODE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_EXPO_START_LINE | exposure start line, default: 1
  > OMEGONPROCAM_IOCONTROLTYPE_SET_EXPO_START_LINE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_EXPO_END_LINE | exposure end line, default: 0 end line must be no less than start line
  > OMEGONPROCAM_IOCONTROLTYPE_SET_EXPO_END_LINE
  > OMEGONPROCAM_IOCONTROLTYPE_GET_OUTPUTCOUNTERVALUE | Output Counter Value, range: [0 ~ 65535]
  > OMEGONPROCAM_IOCONTROLTYPE_SET_OUTPUTCOUNTERVALUE
  > OMEGONPROCAM_IOCONTROLTYPE_SET_OUTPUT_PAUSE | Output pause: 1 => puase, 0 => unpause

- ## Omegonprocam_read_UART
  Omegonprocam_write_UART

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

  Parameters:

  > HOmegonprocam h: camera 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.

- ## Omegonprocam_FfcOnce
  Omegonprocam_DfcOnce
  Omegonprocam_FpncOnce

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

- ## Omegonprocam_FfcExport
  Omegonprocam_FfcImport
  Omegonprocam_DfcExport
  Omegonprocam_DfcImport
  Omegonprocam_FpncExport
  Omegonprocam_FpncImport

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > filepath: file path

  Remarks: Export or import *.dfc, *.ffc or *.fpnc file.

- ## Omegonprocam_LevelRangeAuto

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  Remarks: auto Level Range.

- ## Omegonprocam_put_LevelRange
  Omegonprocam_get_LevelRange

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera 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.

- ## Omegonprocam_put_LevelRangeV2
  Omegonprocam_get_LevelRangeV2

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > unsigned short mode:

  > OMEGONPROCAM_LEVELRANGE_MANUAL | Manual mode
  > OMEGONPROCAM_LEVELRANGE_ONCE | Once
  > OMEGONPROCAM_LEVELRANGE_CONTINUE | Continue mode
  > OMEGONPROCAM_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.

- ## Omegonprocam_put_Demosaic

  Return value: HRESULT type means success or failure

  Parameters:

  > funDemosaic: To replace the builtin demosaic function

  > > typedef void (*POMEGONPROCAM_DEMOSAIC_CALLBACK)(unsigned nFourCC, int nW, int nH, const void* input, void* output, unsigned char nBitDepth, void* ctxDemosaic);

  > ctxDemosaic: callback context

- ## Omegonprocam_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.

- ## Omegonprocam_Replug

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

  Parameters:

  > camId: camera ID

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

- ## Omegonprocam_GetHistogram

  Return value: HRESULT type means success or failure

  Parameters:

  > HOmegonprocam h: camera handle

  > PIOMEGONPROCAM_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 | Omegonprocam_get_AutoExpoTarget | Omegonprocam_put_AutoExpoTarget |
  Exposure Gain | 100~ | 100 | Omegonprocam_get_ExpoAGain | Omegonprocam_put_ExpoAGain |
  White Balance | Temp/Tint Mode | Color Temperature | 1000~25000 | 6503 | Omegonprocam_get_TempTint | Omegonprocam_put_TempTint | Omegonprocam_AwbOnce
  Tint | 100~2500 | 1000
  RGB Gain Mode | Red Gain | -127~127 | 0 | Omegonprocam_get_WhiteBalanceGain | Omegonprocam_put_WhiteBalanceGain | Omegonprocam_AwbInit
  Green Gain
  Blue Gain
  Black Balance | 0~255(bitdepth=8) 0~1023(bitdepth=10) 0~4095(bitdepth=12) 0~16383(bitdepth=14) 0~65535(bitdepth=16) | 0 | Omegonprocam_get_BlackBalance | Omegonprocam_put_BlackBalance | Omegonprocam_AbbOnce
  LevelRange | Software | 0~255 | Low = 0 High = 255 | Omegonprocam_get_LevelRange | Omegonprocam_put_LevelRange | Omegonprocam_LevelRangeAuto
  Hardware | Omegonprocam_get_LevelRangeV2 | Omegonprocam_put_LevelRangeV2
  Contrast | -150~150 | 0 | Omegonprocam_get_Contrast | Omegonprocam_put_Contrast |
  Hue | -180~180 | 0 | Omegonprocam_get_Hue | Omegonprocam_put_Hue |
  Saturation | 0~255 | 128 | Omegonprocam_get_Saturation | Omegonprocam_put_Saturation |
  Brightness | -128~128 | 0 | Omegonprocam_get_Brightness | Omegonprocam_put_Brightness |
  Gamma | 20~180 | 100 | Omegonprocam_get_Gamma | Omegonprocam_put_Gamma |
  Black Level | 0~31 (bitdepth=8) 0~31 * 4 (bitdepth=10) 0~31 * 16 (bitdepth=12) 0~31 * 64 (bitdepth=14) 0~31 * 256 (bitdepth=16) | Model Specific | Omegonprocam_get_Option | Omegonprocam_put_Option |
  Auto Exposure | Max | Exposure Time |  | 350ms | Omegonprocam_get_AutoExpoRange Omegonprocam_get_MaxAutoExpoTimeAGain Omegonprocam_get_MinAutoExpoTimeAGain | Omegonprocam_put_AutoExpoRange Omegonprocam_put_MaxAutoExpoTimeAGain Omegonprocam_put_MinAutoExpoTimeAGain |
  Gain | 500
  Min | Exposure Time |  | 0 | Omegonprocam_get_MinAutoExpoTimeAGain | Omegonprocam_put_MinAutoExpoTimeAGain |
  Gain | 100
  Percent | 0~100 | 0(Disable) 10(Enable) | OMEGONPROCAM_OPTION_AUTOEXPOSURE_PERCENT |
  TEC Target | -500 ~ 400 (-50℃ ~ 40℃) | Model Specific | OMEGONPROCAM_OPTION_TECTARGET |

# 5. .NET (C# & VB.NET)

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

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

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

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

    [DllImport("omegonprocam.dll", ExactSpelling = true, CallingConvention = CallingConvention.StdCall)]
    private static extern int Omegonprocam_Snap(SafeHOmegonprocamHandle h, uint nResolutionIndex);

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

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

# 6. Python

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

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

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

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

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

# 7. Java

Omegonprocam does support Java, omegonprocam.java use JNA to call into omegonprocam.dll/so/dylib. Copy omegonprocam.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 omegonprocam must be obtained by static method Open or OpenByIndex, it cannot be obtained by obj = new omegonprocam()(The constructor is private on purpose).

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

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

Remark: (1) Download jna-*.jar from github; (2) Make sure omegonprocam.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.
demowait | Instead of using the callback function, use the Omegonprocam_WaitImageV3 to get the image, about 60 lines of code
demomulti | Open all the enumerated cameras (possibly multiple) and pull image, about 90 lines of code
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
demotriggersync | simplest sample to demo soft trigger synchronously (TriggerSync), about 80 lines of code
demoexternaltrigger | simplest sample to demo external trigger, about 130 lines of code
demotriggerout | simplest sample to demo output signal, about 150 lines of code
demoraw | raw data, snap still image and save raw data to *.raw files, about 140 lines of code. snapshot.
demostillraw | snap still raw image and save to *.raw files, about 140 lines of code
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.
demotwoqt | Qt sample, snapshot. Use two cameras simultaneously
democpp | Win32 | ATL/WTL | snapshot. demonstrates to enumerate device (Respone to device plugin/unplug notifications), initialize support GigE, 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, read write EEPROM/FLASH, 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
triggertest | snapshot. Soft trigger test, use a background thread to save the image file to disk (SSD is recommended, otherwise, when the disk speed is insufficient, the storage speed will not be able to keep up, more and more images will be stored in the deque, and the memory consumption will also increase).
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 |  | Microsoft sample demonstrates various tasks related to video capture, see https://github.com/microsoft/Windows-classic-samples/tree/main/Samples/Win7Samples/multimedia/directshow/capture/amcap
LVDemo1 | LabView |  |  | Labview program which works with one camera
LVDemo2 | Labview program which opens two cameras and control them respectively
imagepro | liveedf | Win32 | C++ | Qt | Qt sample, snapshot.
C# | WinForm | C# sample, snapshot.
livestack | C++ | Qt | Qt sample, snapshot.
C# | WinForm | C# sample, snapshot.

# 9. Changelog

v55: Add Support to HDR Pixel Format

v54: Add support to GigE. Please see here

v53: Add OmegonprocamFrameInfoV3, Omegonprocam_PullImageV3, Omegonprocam_StartPushModeV4

v52: Android Java side transfer file descriptor to Omegonprocam_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: OMEGONPROCAM_OPTION_FRONTEND_DEQUE_LENGTH, OMEGONPROCAM_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 OMEGONPROCAM_OPTION_CALLBACK_THREAD and OMEGONPROCAM_OPTION_FRAME_DEQUE_LENGTH

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

v42: Precise frame rate and bandwidth. Please see here and OMEGONPROCAM_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 Omegonprocam_StartPushModeV3 (Omegonprocam_StartPushModeV2 and Omegonprocam_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 OMEGONPROCAM_OPTION_AGAIN to OMEGONPROCAM_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 Omegonprocam_deBayerV2, support RGB48 and RGB64

v30: Add OMEGONPROCAM_FLAG_CGHDR

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

v28: Add Omegonprocam_read_Pipe, Omegonprocam_write_Pipe, Omegonprocam_feed_Pipe

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

v26: Add support to restore factory settings, OMEGONPROCAM_OPTION_FACTORY

v25: Add sharpening, OMEGONPROCAM_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 OMEGONPROCAM_OPTION_DDR_DEPTH, please see here

v21: Add Omegonprocam_IoControl

v20: Add Omegonprocam_EnumV2, OmegonprocamModelV2, OmegonprocamDeviceV2; (Omegonprocam_Enum, OmegonprocamModel and OmegonprocamDevice are obsoleted)
Add Pixel Format, see OMEGONPROCAM_OPTION_PIXEL_FORMAT; (OMEGONPROCAM_OPTION_PIXEL_FORMAT is the super set of OMEGONPROCAM_OPTION_BITDEPTH)
Add Flat Field Correction

v19: Add Black Balance: please see here

v18: Add Omegonprocam_get_Revision

v17: Add OMEGONPROCAM_OPTION_ROTATE

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

v15: Add OMEGONPROCAM_OPTION_BINNING

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

v13: support row pitch, please see Omegonprocam_PullImageWithRowPitch and Omegonprocam_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 bitdepth > 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 bitdepth supported: 10bits, 12bits, 14bits, 16bits

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

v1: initial release