MegaXV USB 2.0 API Function List

USB COMMANDS

SI_OpenCamera (int iCamID, PCHAR devname)

SI_CloseCamera (int iCamID)

 

 

INITIALIZE CAMERA SETTINGS

SI_InitWindowMode (int iCamID, int iStartRow, int iEndRow, int iStartColumn,  int iEndColumn, int iFrameTime, int iExposureTime)

 

 

IMAGE TRANSFER

SI_SnapBulkImage (int iCamID, int iColumns, int iRows, int iPixelDepth, unsigned char* ImageBuffer, int* iBytesRead)

SI_SetImageBuffers (int iCamID, unsigned char* pBuffer1, unsigned char* pBuffer2)

SI_SnapBulkDoubleBuffer (int iCamID, int iColumns, int iRows, int iPixelDepth, int iCaptureBuffer, HANDLE hEvent, int* iBytesRead)

SI_SnapBulkLiveStart(int iCamID, int iColumns, int iRows, int iPixelDepth, int  iSequenceCount,  unsigned char* ImageBuffer, 

      HANDLE hEvent1, HANDLE hEvent2, HANDLE hEvent3)

SI_SnapBulkLiveStop(int iCamID))

SI_SaveBinFileB(unsigned char* pBuffer, int iSize, char* cBinFileName)

SI_SaveTiffFile(unsigned char* pBuffer, int iColumns, int iRows, int iBitDepth, int iColor, char* cTiffFileName)

 

 

EXPOSURE & GAIN

SI_SetExposure (int iCamID, int iExposure, int iRange, int iCount)

SI_SetExposureValue (int iCamID, int iExposure)

SI_SetGlobalGain (int iCamID, int iGain)

SI_SetGlobalGainB (int iCamID, int iGainIndex)

SI_GetGainString((int iCamID, int iGainIndex, char** cGain)

SI_SetRGBGain(int iCamID, int iRedGain, int iGreenGain, int iBlueGain)

SI_SetRGGBGain(int iCamID, int iRedGain, int iGreenGain1, int iGreenGain2, int iBlueGain)

SI_SetRGBGainB(int iCamID, int iRedGainIndex, int iGreenGainIndex, int iBlueGainIndex)

SI_SetBlackOffset (int iCamID, int iBlackOffset)

SI_SetGammaMode(int iCamID, bool bGammaMode)

SI_SetColumnOffset (int iCamID, int iColOffset)

SI_SetAECBrightnessTargets(int iCamID, int iLowTarget, int iHighTarget)

SI_SetBlackLevels(int iCamID, int iRedLevel, int iGreenBLevel, int iGreenRLevel, int iBlueLevel)

SI_GetRGBAverages(int iCamID, int *iBAverage, int* iGBAverage, int* iGRAverage, int* iRAverage, int* iLuminance)

SI_SetAutoMode(int iCamID, int iMode)

SI_SetADC (int iCamID, int iADC)

SI_SetGPIO (int iCamID, int iIONumber, int iStatus)

SI_SetShutterDelay (int iCamID, int iShutterDelay)         

SI_SetMaxAGCGain(int iCamID, int iMaxAGCGain)

SI_SetAWBThreshold(int iCamID, int iWhiteBalanceThresh, int iWhtetBalanceSpeed)

SI_SetAECThreshold(int iCamID, int iLowThresh, int iHighThreshold);

SI_TransferDefBalanceOffset(int iCamID, unsigned char* cBalanceOffsetArray, int iDirection)

SI_SetDefBalanceOffset(int iCamID)

SI_SetAutoExposure(int iCamNumber, int iWidth, int iHeight, unsigned char* buffer)

  

CLOCK

SI_ReadClockFile(char* cCamClockFile, int* iClockTableSize,   CLOCKSETTING* ClockSettings)

SI_SetClock ( int iCamID,  int iCamClockMode,    CLOCKSETTING*  ClockSettings)

SI_SetClockB ( int iCamID,  int iClockIndex)

SI_ReadStatusClock (int iCamID, int* iStatus, int* iClock)

SI_SetVerticalBlanking(int( iCamID, int iVertBlanking);

SI_SetHorizontalBlanking(int( iCamID, int iVertBlanking);

 

 

WINDOW SIZE, POSITION & FRAME TIME

SI_SetFrameTime (int iCamID, int iFrameTime)

SI_SetRowStartEnd (int iCamID, int iStartRow, int iEndRow)

SI_SetColStartEnd (int iCamID, int iStartColumn, iEndColumn)

SI_SetWindowPosition (int iCamID, int iStartRow, int iStartColumn)

SI_SetWindowPositionExposure (int iCamID, int iStartRow, int iStartColumn, int iExposureTime)

 

 

BIT-DEPTH & SUBSAMPLING

SI_SetSubsampleMode (int iCamID, int iSubSampMode)

SI_SetZoomMode(int iCamID, intiRowOrigin, int iColumnOrigin, int iSubSampMode)

SI_SetPixelDepth (int iCamID, int iPixelDepth) 

 

 

GENERIC CAMERA REGISTER COMMAND

SI_TransferControlData (int iCamID, int iVendorRequestCode, int iIndex, int iValue, int iDirection, int iBufferSize, unsigned char* buffer)

 

 

ASYNC CONTROL MODE & DRIVER

SI_SetAsyncControlMode(int iCamID, BOOL  iAsyncMode)

SI_SetDriverDelay(int iCamID, int iDriverDelay)

 

 

FIRMWARE & PRESETS

SI_ReadSerialNumber (int iCamID, char* cCamSerialNumber)

SI_ReadVersion (int iCamID, char* cCamVersion)

SI_TransferFirmware(int iCamID, char* cFirmwareFile, int iDirection)

 

 

TRIGGER CAPTURE

SI_ArmTriggerWait(int iCamID)

SI_DisarmTrigger (int iCamID)

SI_SetGlobalShutterMode(int iCamNumber, int iShutterMode);

 

 

USB PIPE COMMANDS

SI_AbortPipe (int iCamID, int iPipe)

SI_ResetPipe (int iCamID, int iPipe)

SI_GetPipeInfo(int iCamID, unsigned char* interfaceInfo, unsigned int* iInterfaceSize)

  

 

SI USB2.0 HIGH-LEVEL API FUNCTIONS

SI_ReadConfig

SI_DefaultImageProcParam

SI_BeginCapture

SI_CaptureBlackReferenceImage

SI_GetBlackrefereceImage

SI_CaptureDIB

SI_GetLastCapturedBinImage

SI_GetLastCapturedDIBImage

SI_EndCapture