IC Imaging Control ActiveX

ICImagingControl

ICImagingControl

The ICImagingControl object provides the main functionality of this library. It enables you to select and set up devices, control image acquisition and manage image buffers and image streams.

The ICImagingControl object is created by the framework when the IC Imaging Control ActiveX is inserted into a form.

Information

Introduced in IC Imaging Control 1.x

Properties

Property Description
AviCompressors

Returns a collection of available avi compressors (video codecs).

BacklightCompensation

Returns or sets the backlight compensation value of the current video source.

Brightness

Returns or sets the brightness value of the current video source.

ColorEnable

Returns or sets the color enable value of the current video source.

Contrast

Returns or sets the contrast value of the current video source.

DeBayerActive

Returns whether automatic de-bayering of BY8 image data is enabled.

DeBayerMode

This property selects the algorithm used to de-bayer BY8 image data.

DeBayerStartPattern

This property controls how the automatic de-bayering of BY8 image data should treat the pixel data.

Device

Returns or sets a video capture device. A list of all available video capture devices can be obtained using the Devices collection, which can be retrieved with a call to ICImagingControl.Devices.

DeviceCountOfFramesDropped

Returns the number dropped frames.

DeviceCountOfFramesNotDropped

Returns the number of frames that were not dropped.

DeviceCurrentActualFrameRate

Returns the frame rate currently used by the video capture device. A value of 0 indicates that this property is not supported by the video capture device.

DeviceFlipHorizontal

Returns or sets the horizontal flipping of the live video image.

DeviceFlipHorizontalAvailable

This property determines whether horizontal flip is available for the currently selected device.

DeviceFlipVertical

Returns or sets the vertical flipping of the live video image.

DeviceFlipVerticalAvailable

This property determines whether vertical flip is available for the currently selected device.

DeviceFrameFilters

The DeviceFrameFilters property provides a FrameFilters collection that contains the frame filters that are inserted in the device path.

DeviceFrameRate

Returns or sets the desired frame rate (in frames per second) of the current video capture device.

DeviceFrameRateAvailable

Returns True, if setting of frame rates is supported by the video capture device.

DeviceFrameRates

Returns a collection of frame rates supported by the video capture device. May be empty if the device does not support frame rates.

DeviceTrigger

Enables/disables external triggering of the current video capture device.

DeviceTriggerAvailable

Returns True if the device has an external trigger.

DeviceValid

Returns True when a device is open and valid, otherwise False.

Devices

Returns a collection of all available video capture devices.

DisplayFrameFilters

The DisplayFrameFilters property provides a FrameFilters collection that contains the frame filters that are inserted in the display path.

Exposure

Returns or sets the exposure value of the current video source.

ExternalTransportAvailable

Returns True if the video capture device has an external transport interface (e.g. DV-Devices).

ExternalTransportMode

Returns or sets the mode of the external transport device, if available.

Focus

Returns or sets the focus value of the current video source.

FrameFilterInfos

This property returns a list, containing FrameFilterInfo objects that describe the available frame filters, which can be loaded from frame filter modules (.ftf files).

FrameFilterPath

Sets a path from which frame filters are loaded.

Gain

Returns or sets the gain value of the current video source.

Gamma

Returns or sets the gamma value of the current video source.

Hue

Returns or sets the hue value of the current video source.

ImageActiveBuffer

Returns the ImageBuffer to which the control copied the last frame.

ImageBitsPerPixel

Returns the bits per pixel of the buffers in the control. The bytes per pixel are calculated by dividing ImageBitsPerPixel by 8. The value of this property is determined by the value of the ICImagingControl.MemoryCurrentGrabberColorformat property.

ImageBuffers

Returns a collection of ImageBuffers, which represent the buffers in the ringbuffer.

ImageHeight

Returns the image height (in pixels) of the current video source.

ImageRingBufferSize

Returns or sets the size of the internal ring buffer. Must lie in the range [1,...[.

ImageWidth

Returns the image width (in pixels) of the current video source.

InputChannel

Returns or sets the input channel of the current video capture device. Available input channels can be enumerated using the InputChannels collection, which can be retrieved with a call to ICImagingControl.InputChannels.

InputChannelAvailable

Returns True if the current video capture device supports input channels.

InputChannels

Returns a collection of available input channels for the current video capture device.

Iris

Returns or sets the iris value of the current video source.

LiveCaptureContinuous

Enables/disables the continuous capture mode. In this mode ICImagingControl.MemorySnapImage may not be called, because all frames are copied to the ring buffer automatically. After an image has been copied completely to a buffer, an ICImagingControl.ImageAvailable event is sent. If an ICImagingControl.ImageAvailable event is currently processed, a new event will not be sent.

LiveCaptureLastImage

Enables/disables the automatic call to ICImagingControl.MemorySnapImage in ICImagingControl.LiveStop. This property should be set to True if ICImagingControl is to display the last frame after LiveStop has been called.

LiveCapturePause

Returns or sets the pause for AVI capture.

LiveDisplay

Enables/disables live display in the control window. If live display is disabled, the image buffers may be shown by a call to ICImagingControl.Display.

LiveDisplayDefault

Returns or enables the use of the default size and position of the video display window.

LiveDisplayHeight

Returns or sets the height of the video display window.

LiveDisplayLeft

Returns or sets the left position of the video display window in IC Imaging Control's window.

LiveDisplayOutputHeight

Returns the actual height of the video format of the live display. Due to the use of frame filters, this height can differ from the height of the video capture device's video format and the sink's format.

LiveDisplayOutputWidth

Returns the actual width of the video format of the live display. Due to the use of frame filters, this width can differ from the width of the video capture device's video format and the sink's format.

LiveDisplayTop

Returns or sets the top position of the video display window in IC Imaging Control's window.

LiveDisplayWidth

Returns or sets the width of the video display window.

LiveDisplayZoomFactor

Returns or sets the zoom factor of the video display window.

LivePause

This property suspends and restarts the current delivery of images.

LiveShowLastBuffer

This property controls whether IC Imaging Control displays the buffer that was captured on LiveStop when LiveCaptureLastImage is enabled.

LiveVideoRunning

Indicates whether a live video is running, i.e. has been started with the LiveStart Method.

MediaStreamContainers

Returns a list containing all available MediaStreamContainers.

MemoryCurrentGrabberColorformat

Determines the color format of the image buffers in the internal ring buffer.

MemoryRingBufferSize

This property determines the size of the ring buffer that is used for the MemorySaveImageSequence and MemorySnapImageSequence methods.

MemorySnapTimeout

Returns or sets the snap timeout value. This is the time in milliseconds the functions ICImagingControl.MemorySnapImage and ICImagingControl.MemorySnapImageSequence wait until they abort.

OverlayBitmap

Returns an OverlayBitmap object.

OverlayBitmapAtPath

Returns the OverlayBitmap at a specified path position.

OverlayBitmapPosition

This property controls the positions of OverlayBitmap objects in the image stream.

OverlayUpdateEventEnable

This property is used to return or set whether the overlay update event should be called by IC Imaging Control.

Pan

Returns or sets the pan value of the current video source.

Picture

Returns a Picture object created from the data of the current buffer.

ReferenceTimeCurrent

Returns the current reference time.

ReferenceTimeStart

Returns the reference time at which the image stream was started.

Roll

Returns or sets the roll value of the current video source.

Saturation

Returns or sets the saturation value of the current video source.

ScrollBarsEnabled

Returns whether scrollbars are enabled or enables/disables scrollbars.

Sharpness

Returns or sets the sharpness value of the current video source.

SignalDetected

Returns whether a video signal is detected on the currently selected input channel of the selected video capture device.

SignalDetectedAvailable

Returns whether the current video capture device supports signal detection on its input ports.

Sink

Sets or retrieves the currently used sink. A sink is an object that receives the frames coming from the video capture device and either copies them to an ImageBuffers collection or saves them to a media stream file.

SinkCompatibilityMode

When SinkCompatibilityMode is enabled, TODO

Tilt

Returns or sets the tilt value of the current video source.

VCDPropertyItems

Returns a VCDPropertyItems collection representing the properties of the currently opened device.

VideoFormat

Returns or sets the video format of the current video capture device. A list of available video formats can be obtained using the VideoFormats collection, which can be retrieved with a call to ICImagingControl.VideoFormats.

VideoFormats

Returns a collection of available video formats for the current device and video norm.

VideoNorm

Returns or sets the video norm of the current video capture device. A list of available video norms can be obtained using the VideoNorms collection, which can be retrieved with by calling ICImagingControl.VideoNorms.

VideoNormAvailable

Returns whether the current device supports video norms.

VideoNorms

Returns a collection of available video norms for the current device.

WhiteBalance

Returns or sets the whitebalance value of the current video source.

Zoom

Returns or sets the zoom value of the current video source.

xxAuto

These properties can be used to enable the automatic setting of a feature. For instance, the BrightnessAuto property will enable the device's automatic brightness control.

xxAutoAvailable

These properties can be used to determine whether a feature is available for the currently selected device. for instance, the BrightnessAvailable property has a value of True if the Brightness property is supported.

xxAvailable

These properties can be used to determine whether a feature is available for the currently selected device. For instance, the BrightnessAvailable property has a value of True if the Brightness property is supported.

xxDefault

These properties can be used to retrieve the default value of a property for the currently selected device.

xxRange

These properties can be used to determine the valid range of values for a property. For instance, the BrightnessRange property will return the minimum and maximum brightness values supported by the selected device.

Methods

Method Description
AviStartCapture

This method writes a compressed AVI file to the computer's hard disk.

AviStopCapture

This method stops writing an AVI file.

Display

Displays the current image buffer in IC Imaging Control's window.

DisplayImageBuffer

When the property ICImagingControl.LiveDisplay is False , then a call to ICImagingControl.DisplayImageBuffer displays the given buffer in the control window

FrameFilterCreate

Creates a new instance of a FrameFilter from a FrameFilterInfo.

FrameFilterCreateString

Creates a new instance of a FrameFilter, by specifying the filter's name.

LiveStart

This method starts the processing of images delivered by the video capture device.

LiveStop

Calling this method stops the display of a live image previously started with the LiveStart method.

LoadDeviceState

Restores the device settings saved with ICImagingControl.SaveDeviceState.

LoadDeviceStateFromFile

Restores the device settings saved with ICImagingControl.SaveDeviceStateToFile.

MemoryGetDib

This method is used to pass a Device Independent Bitmap to other programming tools for further processing.

MemoryGetImageData

Provides direct access to the image data of Imaging Control.

MemoryReleaseImageData

This method releases an image buffer that was allocated by calling the ICImagingControl.MemoryGetImageData.

MemorySaveImage

This method saves the current buffer as a .png file.

MemorySaveImageSequence

This method saves a sequence of images as a sequence of single .png files.

MemorySnapImage

This method captures a still image from a live video stream and stores it in an internal buffer. The buffer can be saved to a file using the ICImagingControl.MemorySaveImage Method.

MemorySnapImageSequence

This method captures a sequence of still images from a live video stream and stores the images in a list of internal buffers. The images can be saved to individual files using the ICImagingControl.MemorySaveImageSequence method.

SaveDeviceState

Saves the currently opened device and its settings to a string.

SaveDeviceStateToFile

Saves the currently opened device and its settings to a file.

ShowDeviceSettingsDialog

This method opens a video capture device selection dialog.

ShowPropertyDialog

This method opens a dialog to adjust all properties of the currently opened video capture device.

Events

Event Description
DeviceLost

This event is called if the video capture device is no longer valid; for example if it was unplugged.

ImageAvailable

This event is called each time a frame has been copied completely to the internal ring buffer.

MouseDown

This event is called if the user presses a mouse button inside the control window.

MouseMove

This event is called if the user moves the mouse inside the control window.

MouseUp

This event is called if the user releases a mouse button inside the control window.

OnHScroll

This event is called after the user has scrolled the live video display horizontally.

OnVScroll

This event is called after the user scrolled the live video display vertically.

OverlayUpdate

This event is called after a new frame has been delivered by the video capture device.

<< Classes

Get in touch with us


About The Imaging Source

Established in 1990, The Imaging Source is one of the leading manufacturers of industrial cameras, frame grabbers and video converters for production automation, quality assurance, logistics, medicine, science and security.

Our comprehensive range of cameras with USB 3.1, USB 3.0, USB 2.0, GigE interfaces and other innovative machine vision products are renowned for their high quality and ability to meet the performance requirements of demanding applications.

Automated Imaging Association ISO 9001:2015 certified

Contact us