Methods
Top  Previous  Next

ActiveUSB provides the following methods to a container application:

Acquisition

Grab
Grabs a single frame into the internal memory
SoftTrigger
Generates an internal trigger signal



Information

GetCameraList
Returns the list of USB3 Vision cameras connected to the system
GetFormatList
Returns the list of pixel formats supported by the currently selected camera
GetBitsPerChannel
Returns the bit depth of each component of the internal image
GetBytesPerPixel
Returns the byte depth of the internal image
GetOptimalPacketSize
Returns the optimal packet size for the current network configuration

Features

GetCategoryList
Returns the array of categories under which the camera features are grouped
GetFeatureList
Returns the array of features grouped under the specified category
IsFeatureAvailable
Checks availability of the specified camera feature
GetFeature
Returns the numerical value of the specified camera feature
SetFeature
Sets the numerical value of the specified camera feature
GetFeature64
Returns the numerical value of the specified 64-bit camera feature
SetFeature64
Sets the numerical value of the specified 64-bit camera feature
GetFeatureString
Returns the string value of the specified camera feature
SetFeatureString
Sets the string value of the specified camera feature
GetFeatureArray
Returns the array of values associated with the specified camera feature
SetFeatureArray
Sets the array of values associated with the specified camera feature
GetFeatureMin
Returns the minimum value allowed for the specified camera feature
GetFeatureMax
Returns the maximum value allowed for the specified camera feature
GetFeatureIncrement
Returns the increment value for the specified integer feature
GetEnumList
Returns the array of string values representing the specified enumerated feature
GetFeatureAccess
Returns the information on the access to the specified camera feature
GetFeatureDependents
Returns the names of features dependent on the specified camera feature
GetFeatureTip
Returns the short description of the specified camera feature
GetFeatureDescription
Returns the detailed description of the specified camera feature
GetFeatureType
Returns the type of the specified camera feature
GetFeatureVisibility
Returns the information on the suggested visibility for the specified camera feature
GetFeatureRepresentation
Returns the information on the suggested representation for the specified camera feature

GetAcquisitionFrameRateMax
Returns the maximum value allowed for the camera's frame rate
GetAcquisitionFrameRateMin
Returns the minimum value allowed for the camera's frame rate
GetBalanceRatioMax
Returns the maximum value allowed for the white balance ratio
GetBalanceRatioMin
Returns the minimum value allowed for the white balance ratio
GetBlackLevelMax
Returns the maximum value allowed for the camera's black level
GetBalanceRatioMin
Returns the minimum value allowed for the camera's black level
GetExposureTimeMax
Returns the maximum value allowed for the camera's exposure time
GetExposureTimeMin
Returns the minimum value allowed for the camera's exposure time
GetGainMax
Returns the maximum value allowed for the camera's gain
GetGainMin
Returns the minimum value allowed for the camera's gain
GetTriggerDelayMax
Returns the maximum value allowed for the camera's trigger delay
GetTriggerDelayMin
Returns the minimum value allowed for the camera's trigger delay


Image Access

GetPixel
Returns the pixel value at the specified coordinates
GetRGBPixel
Returns the array of RGB values at the specified coordinates
GetImageLine
Returns the array of pixel values in the specified horizontal line
GetComponentLine
Returns the array of pixel values of the color component in the specified horizontal line
GetImageWindow
Returns the 2D array of pixel values in the specified rectangular area of the current frame
SetImageWindow
Copies the 2D array of pixel values to the selected window of the current frame
GetImageData
Returns the two dimensional array of pixel values in the currently acquired frame
GetComponentData
Returns the two dimensional array of pixel values in the specified color component
GetRawData
Returns the 2D array of raw values in the currently acquired data buffer
GetImagePointer
Returns the memory pointer to the specified pixel
GetDIB
Returns the handler to a Device Independent Bitmap
GetPicture
Returns the Picture object corresponding to the currently acquired frame
GetChunkPointer
Returns the pointer to the data associated with the specified chunk feature
GetChunkSize
Returns the size of the data associated with the specified chunk feature


Image and Video Capture

SaveImage
Saves the current frame buffer in the specified image file
LoadImage
Loads and displays the image from the specified image file
StartCapture
Starts video capture to the specified AVI file or series of image files
StopCapture
Stops video capture
GetCodecList
Returns the names of video codecs available in the system
GetCodec
Return the name of the currently selected video codec
SetCodec
Sets the video codec to be used for the AVI capture
ShowCodecDlg
Shows the configuration dialog of the currently selected video codec
ShowCompressionDlg
Shows the video compression dialog


Advanced Video Recording (DVR version only)

CreateVideo
Creates an AVI file for the video recording and preallocates its size
StartVideoCapture
Starts time-lapse video capture to the previously created AVI file
StopVideoCapture
Stops video capture to the AVI file
SetCodecProperties
Sets the generic parameters of the currently selected compression codec
GetCodecProperties
Returns the generic parameters of the currently selected compression codec
GetAudioList
Returns the names of audio recording devices available in the system
SetAudioSource
Sets the index of the audio recording device to be used during the AVI capture
GetAudioSource
Returns the index of the currently selected audio recording device for the AVI capture
ShowAudioDlg
Displays the audio Input dialog for adjusting the mixer properties of the audio source
SetAudioLevel
Sets the recording level of the currently selected audio device
GetAudioLevel
Returns the recording level of the currently selected audio device
SetWebStreamer
Configures parameters of the RTSP web streaming


Sequence Capture (DVR version only)

CreateSequence
Allocates memory for capturing a sequence of frames
StartSequenceCapture
Starts acquiring a sequence of frames into the memory
StopSequenceCapture
Stops acquiring a sequence of frames into the memory
GetSequenceFrameCount
Returns the current number of frames in the memory sequence
SaveSequence
Saves the memory sequence in the specified video file
LoadSequence
Loads the specified video file into the memory sequence
GetSequenceWindow
Returns 2D-array of pixel values of the selected window in a frame in the memory sequence
GetSequenceRawData
Returns 2D-array of raw pixel values in a frame in the memory sequence
GetSequencePixel
Returns the pixel value in the selected coordinates of the frame in the memory sequence
GetSequencePointer
Returns the memory pointer to a selected pixel of the frame in the memory sequence
GetSequencePicture
Returns the Picture object corresponding to a frame in the memory sequence
GetSequenceTimestamp
Returns the timestamp of the selected frame in the memory sequence


Video and Sequence Playback (DVR version only)

OpenVideo
Opens the specified video file or memory sequence for the playback
PlayVideo
Plays the currently open video file or memory sequence
StopVideo
Stops the playback of the video file or memory sequence
CloseVideo
Closes the currently open video file
GetVideoFrameCount
Returns the number of the frame in the currently open video file or memory sequence
GetVideoPosition
Returns the position of the current frame in the open video file or memory sequence
SetVideoPosition
Seeks, extracts and display the specified frame from the open video file or sequence
GetVideoFPS
Returns the frame rate of the currently opened video file or memory sequence
SetVideoFPS
Sets the frame rate of the currently opened video file or memory sequence
GetVideoVolume
Returns the playback volume level of the currently open AVI file
SetVideoVolume
Sets the playback volume level of the currently open AVI file
SetVideoSync
Sets the playback synchronization mode of the currently open AVI file
TriggerVideo
Advances the AVI playback to the next frame


Drawing

Draw
Displays the current frame in ActiveUSB window.
OverlayClear
Clears graphics and text from the overlay
OverlayEllipse
Draws an empty or filled ellipse in the overlay
OverlayLine
Draws a line in the overlay
OverlayPixel
Draws a pixel in the overlay
OverlayRectangle
Draws an empty or filled rectangle in the overlay
OverlayText
Draws a string of text in the overlay
DrawPixel
Draws a pixel in the current image frame
DrawLine
Draws a line in the current image frame
DrawRectangle
Draws a rectangle in the current image frame
DrawEllipse
Draws an ellipse in the current image frame
DrawText
Draws a string of text in the current image frame

DrawAlphaClear
Clears the alpha plane
DrawAlphaPixel
Draws a pixel in the alpha plane
DrawAlphaLine
Draws a line in the alpha plane
DrawAlphaRectangle
Draws an empty or filled rectangle in the alpha plane
DrawAlphaEllipse
Draws an empty or filled ellipse in the alpha plane
DrawAlphaText
Draws a srting of text in the alpha plane


Image Processing

SaveBkg
Stores a dark or bright background image on the hard drive
SetROI
Sets the rectangular region of interest and luminance range
GetROI
Returns the settings of the currently selected ROI
GetImageStat
Returns the array containing statistical data of the current image frame
GetHistogram
Returns the histogram of the current image frame
SetLUT
Assigns the array of values for the software lookup table
GetLUT
Returns the array of values for the software lookup table
SetGains
Set the levels for the software gain control
SetLevels
Set the minimum and maximum levels for the Window/Level operation
GetLevels
Returns the minimum and maximum levels for the Window/Level operation
SetColorMatrix
Sets the matrix coefficients for the color correction operation
SetLensDistortion
Sets distortion parameters for the lens distortion correction
GetBarcode
Returns the character string decoded from a barcode found in the current frame


File Access

GetFileList
Returns the array of names of all files hosted in the device
GetFileSize
Returns the size of the specified file in the device
GetFileAccessMode
Returns the access mode in which the specified file can be opened in the device
ReadFile
Transfers the indicated amount of bytes from the specified file in the device
WriteFile
Transfers the indicated amount of bytes to the specified file in the device
GetFileTransferProgress
Returns the progress of the current file access operation in percent


Utilities

GetFPS
Returns the actual frame rate of the camera
GetFPSAcquired
Returns the acquired (displayed) frame rate of the application
GetTimestamp
Returns the timestamp of the last captured frame
GetBlockId
Returns the block ID of the last captured frame
ShowProperties
Displays property pages in run-time
ReadRegister
Reads a 32-bit value from the specified bootstrap register of the currently selected camera
WriteRegister
Write a 32-bit value to the specified bootstrap register of the currently selected camera
ReadBlock
Reads the block of data from the camera starting from the specified bootstrap address
WriteBlock
Writes the block of data to the camera starting from the specified bootstrap address
LoadSettings
Loads previously saved camera settings from the data file
SaveSettings
Stores the camera settings in the data file