Methods

ActiveGige 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 GigE Vision cameras connected to the system
GetFormatList	Returns the list of pixel formats supported by the currently selected camera
GetCameraIP	Returns the IP address of the currently selected camera
GetCameraMAC	Returns the MAC address of 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
IsMaster	Checks if the application has an exclusive control over the selected camera

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
GetFeatureString	Returns the numerical value of the specified camera feature
SetFeatureString	Sets the numerical value of 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

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

Image and Video Recording

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

Sequence Capture

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 Playback

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

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

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
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
LoadSettings	Loads previously saved camera settings from the system registry
SaveSettings	Stores the camera settings in the system registry