IC Imaging Control C++

Classes

Classes

Complete list of all classes.

AnalogChannelItem

An AnalogChannelItem represents an input of a video capture device.

AviSink

[Deprecated] The AviSink writes the image stream that comes from the currently active video capture device, to an avi file. If a codec is specified in the constructor AviSink::AviSink, the image stream is compressed using this codec.

Codec

The Codec class represents a video compressor. It replaces the deprecated FilterInfoObject, that was used in previous versions of IC Imaging Control.

DeBayerTransform

The DeBayerTransform class allows you to control the automatic debayering process of IC Imaging Control.

Error

The Error class gives information about an errors that occur during a call to the class library. Grabber::getLastError returns the error object which is associated to the last call of a method of the Grabber instance.

FilterInfoObject

[Deprecated] A FilterInfoObject contains the name of a video codec used for avi file compression.

FilterLoader

This static class contains methods to create instances of frame filters that are loaded from filter modules ( *.ftf ).

FrameFilterImpl

To implement a transform filter, you have to derive from this class.

FrameGrabberSink

[Deprecated] The FrameGrabberSink is the SinkType used to grab (copy) frames from the image stream to the buffers of the currently active MemBufferCollection. Frames are copied one after another, starting with the first buffer of MemBufferCollection. When a frame is copied into the last buffer, the next frame is copied to the first buffer and so on.

FrameHandlerSink

The FrameHandlerSink is the SinkType used to grab (copy) frames from the image stream. It replaces the deprecated FrameGrabberSink and contains a MemBufferCollection and optionally allows you to specify one or more IFrameFilters that are responsible for copying the image data to the buffers of the MemBufferCollection. The IFrameFilter implementation can perform user-defined transformations while copying the data, and they can intentionally drop unwanted frames. If no frame filter is registered, the frames are copied to the MemBufferCollection without being changed.

FrameTypeInfo

This structure contains all information to describe the layout (pixel depth and pixel organization) and the extents of one frame (image buffer) in the image stream.

FrameTypeInfoArray

This class is a list of FrameTypeInfo objects. It is used in the communication between FrameFilterImpl-derived classes when the image stream is setup and the filters are inserted in the image stream.

FrameUpdateFilterImpl

To implement an update filter, you have to derive from this class.

Grabber

This is the main class of the IC Imaging Control Class Library. It provides the basic functionality to control the flow of image buffers in an image stream from the source (a video capture device) to the sink (a collection of image buffers or a media file). The display of a live image can be toggled on and off. The idea behind this class is to provide the functionality of a standard frame grabber to users of WDM streaming devices.

GrabberListener

The GrabberListener class is the base class for all classes implementing a callback handler. A callback handler class has to be derived from GrabberListener and has to overwrite one or more callback methods. Every instance of a callback handler class has to be registered in Grabber by a call to Grabber::addListener. The available methods are:

GrabberSinkType

This is the abstract base class for all sinks which cannot be instantiated. A sink specifies the format to which the image stream is converted and it specifies the way in which single frames can be accessed.

IFrame

Interface to an image buffer.

IFrameFilter

IFrameFilter is the base class of all frame filters. It contains methods to access the filter's parameters, display a configuration dialog and save filter settings. This class provides the interface to use an existing filter.

IVCDAbsoluteValueProperty

This class represents an absolute value interface to a value of a video capture device property.

IVCDButtonProperty

This class represents a button interface to a value of a video capture device property.

IVCDMapStringsProperty

This class represents an interface to a video capture device property, which uses a string representation for every value.

IVCDPropertyElement

This class represents an element of video capture device property.

IVCDPropertyInterface

This class represents an interface to a value of a video capture device property.

IVCDPropertyItem

This class represents an item of a video capture device property.

IVCDPropertyItems

This class is a collection of IVCDPropertyItem objects.

IVCDRangeProperty

This class represents a range interface to a value of a video capture device property.

IVCDSwitchProperty

This class represents a switch interface to a value of a video capture device property.

MediaSampleInfo

The MediaSampleInfo can be retrieved from the MediaSampleInfoDataStore and may contain several pieces of information of a specific IFrame.

MediaSampleInfoDataStore

The MediaSampleInfoDataStore object is used to retrieve extended frame information in the form of chunked data blobs.

MediaStreamContainer

A MediaStreamContainer describes a video file format. The most common video file format is AVI, which is identified by the GUID MSC_AviContainer.

MediaStreamSink

The MediaStreamSink replaces the deprecated AVISink. A MediaStreamSink can save image data in video files and optionally allows you to specify one or more IFrameFilters that can analyze and/or transform the image data before it is written to the video file.

MemBuffer

A MemBuffer represents a single buffer in a MemBufferCollection (organized as a ring buffer).

MemBufferCollection

The MemBufferCollection stores several MemBuffers. The MemBufferCollection is organized as a ring buffer: If a frame is grabbed to the last buffer of the collection, the next frame will be grabbed to the first one.

OverlayBitmap

The OverlayBitmap object is used to draw graphical elements like lines and text onto the video stream.

VideoCaptureDeviceItem

The VideoCaptureDeviceItem identifies a video capture device. A VideoCaptureDeviceItem is a temporary object and may not be stored permanently. For permanent storage use the string representation as returned by c_str, toString, getName and operator const char*.

VideoFormatDesc

A VideoFormatDesc describes an available video format using the media subtype, horizontal and vertical binning and skipping factors and size constraints. The size constraints are described by a minimum size, a maximum size and a step size.

VideoFormatItem

The VideoFormatItem represents a video format that describes the width, height and the color format of an image stream generated by a video capture device. The available video formats depend on the selected video norm.

VideoNormItem

The VideoNormItem represents a video norm supported by a video capture device.

smart_com

smart_com is a reference counting pointer to COM objects. It releases reference to the IUnknown interface when it is destroyed.

smart_ptr

The smart_ptr is a reference counting pointer object. Whenever a method of the IC Imaging Control Class Library returns a pointer, it will be an object of this class.

<< Class Library Reference

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