Methods
Top  Previous  Next

ActiveDcam control provides the following methods to a container application:

DCAM Acquisition

Grab
Grabs a single frame into the internal memory
SoftTrigger
Sets/resets the software trigger signal
GetIsoSpeed
Returns the camera's isochronous transmission speed
SetIsoSpeed
Sets the camera's isochronous transmission speed


DCAM Information

GetCameraList
Returns the list of DCAM cameras connected to the 1394 board
GetModeList
Returns the list of video mode supported by the currently selected camera
GetRateList
Returns the list of frame rates supported by the currently selected video mode
GetWidth
Returns the maximum horizontal size of the video frame
GetHeight
Returns the maximum vertical size of the video frame
GetBytesPerPixel
Returns the number of bytes per pixel in the video
GetBitsPerChannel
Return the number of bits per color component of a pixel
GetTriggerInfo
Returns the information related to triggering
GetTriggerList
Returns the list of supported trigger sources
IsVideoModeAvailable
Checks the availability of the specified DCAM (IIDC-1394) video mode
GetF7Info
Returns the information related to Format 7 (partial scan) video modes


DCAM Features

GetFeature
Returns the value of the specified camera feature
SetFeature
Sets the value of the specified camera feature
GetFeatureCapability
Checks for available operational modes of the specified camera feature
GetFeatureControl
Returns the status of the specified control mode for the selected camera feature
SetFeatureControl
Sets the specified control mode for the selected camera feature
GetFeatureMin
Returns the minimum value allowed for the specified camera feature
GetFeatureMax
Returns the maximum value allowed for the specified camera feature
GetShutterMin
Returns the minimum shutter value
GetShutterMax
Returns the maximum shuttervalue
GetGainMin
Returns the minimum gain value
GetGainMax
Returns the maximum gain value
GetIrisMin
Returns the minimum iris value
GetIrisMax
Returns the maximum iris value
GetExposureMin
Returns the minimum autoexposure reference value
GetExposureMax
Returns the maximum autoexposure reference value
GetSaturationMin
Returns the minimum saturation value
GetSaturationMax
Returns the maximum saturation value
GetHueMin
Returns the minimum hue value
GetHueMax
Returns the maximum hue value
GetWhiteBalanceMin
Returns the minimum white balance value
GetWhiteBalanceMax
Returns the maximum white balance value

GetBrightnessMin
Returns the minimum brightness value
GetBrightnessMax
Returns the maximum brightness value
GetGammaMin
Returns the minimum gamma value
GetGammaMax
Returns the maximum gamma value
GetSharpnessMin
Returns the minimum sharpness value
GetSharpnessMax
Returns the maximum sharpness value
GetFocusMin
Returns the minimum focus value
GetFocusMax
Returns the maximum focus value
GetZoomMin
Returns the minimum zoom value
GetZoomMax
Returns the maximum zoom value
GetPanMin
Returns the minimum pan value
GetPanMax
Returns the maximum pan value
GetTiltMin
Returns the minimum tilt value
GetTiltMax
Returns the maximum tilt value
GetOpticalFilterMin
Returns the minimum optical filter value
GetOpticalFilterMax
Returns the maximum optical filter value
GetWhiteShadingMin
Returns the minimum white shading value
GetWhiteShadingMax
Returns the maximum white shading value
GetTriggerDelayMin
Returns the minimum trigger delay value
GetTriggerDelayMax
Returns the maximum trigger delay value

GetSlopeExposure
Returns the exposure levels for the mutli-slope integration mode
SetSlopeExposure
Sets the exposure levels for the multi-slope integration mode
GetSlopeReset
Returns the voltage levels values for the mutli-slope integration mode
SetSlopeReset
Sets the voltage reset levels for the mutli-slope integration mode

DCAM Service

ReadRegister
Reads a quadlet from a selected camera's register
WriteRegister
Writes a quadlet to a selected camera's register
ReadBlock
Performs an asynchronous 1394 block transfer from a specified 1394 offset
WriteBlock
Performs an asynchronous 1394 block transfer to a specified 1394 offset
LoadChannel
Loads previously stored settings from the internal camera's memory channel
SaveChannel
Writes the current settings into the camera's memory channel
GetMaxChannel
Returns the maximum index of the camera's memory channel


DCAM I/O

ReadPIO
Reads the voltage levels on the parallel input/output (PIO) pins
WritePIO
Sets the voltage levels on the parallel input/output (PIO) pins
SetSIO
Sets the configuration of serial input/output (SIO)
ReadSIO
Reads the string of characters from the serial input/output port (SIO)
WriteSIO
Writes the string of characters to the serial input/output port (SIO)
SetStrobe
Sets the status, duration and delay of a strobe signal


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 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
SetCodec
Sets the video codec to be used for the AVI capture
GetCodec
Returns the name of the current video codec
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
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


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 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 ActiveDcam 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 an empty or filled rectangle in the current image frame
DrawEllipse
Draws an empty or filled ellipse in the current image frame
DrawText
Draws a srting 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


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
LoadSettings
Loads previously saved camera settings from the system registry
SaveSettings
Stores the camera settings in the system registry
BusReset
Performs the software reset of the FireWire (IEEE-1394) bus
GetBarcode
Returns the character string decoded from a barcode found in the current frame