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 component is inserted into a form.
Namespace: TIS.Imaging
Introduced in version 1.x
Property | Description | ||
AviCompressors | [Deprecated] Returns a collection of available avi compressors (video codecs). |
||
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. |
||
DeviceCurrent | Returns a Device object that contains the currently used 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. |
||
DeviceListChangedExecutionMode | This property controls the execution mode of the DeviceListChanged event. |
||
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. |
||
DriverFrameDropInformation | Queries the driver of the current device for drop information data. |
||
ExternalTransportAvailable | Returns True if the video capture device has an external transport interface (e.g. DV-Devices). |
||
ExternalTransportMode | [Deprecated] Returns or sets the mode of the external transport device, if available. |
||
FrameFilterInfos | [Deprecated] 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 | [Deprecated] Sets a path from which frame filters are loaded. |
||
ImageActiveBuffer | [Deprecated] Returns the ImageBuffer to which the control copied the last frame. |
||
ImageAvailableExecutionMode | This property controls the execution mode of the ImageAvailable event. |
||
ImageBitsPerPixel | [Deprecated] 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 | [Deprecated] 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 | [Deprecated] Returns or sets the size of the internal ring buffer. Must lie in the range [1,...[. |
||
ImageSize | [Deprecated] Returns the image height and width in pixels of the current video format. |
||
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. |
||
IsLivePrepared | Returns whether the image stream was is prepared after a previous call to LivePrepare, or LiveSuspend. |
||
LiveCaptureContinuous | [Deprecated] 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 | [Deprecated] 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. |
||
LiveDisplayPosition | Returns or sets the top position of the video display window in IC Imaging Control's window. |
||
LiveDisplaySize | Returns or sets the height and width of the video display window. |
||
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 | [Deprecated] 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 | [Deprecated] Returns a list containing all available MediaStreamContainers. |
||
MemoryCurrentGrabberColorformat | [Deprecated] Determines the color format of the image buffers in the internal ring buffer. |
||
MemoryPixelFormat | [Deprecated] Sets the pixel format of the ring buffer. |
||
MemoryRingBufferSize | [Deprecated] This property determines the size of the ring buffer that is used for the MemorySaveImageSequence and MemorySnapImageSequence methods. |
||
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. |
||
ReferenceTimeCurrent | Returns the current reference time. |
||
ReferenceTimeStart | Returns the reference time at which the image stream was started. |
||
ScrollBarsEnabled | Returns whether scrollbars are enabled or enables/disables scrollbars. |
||
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. |
||
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. |
||
VideoFormatCurrent | Returns the selected Videoformat object. |
||
VideoFormatDescs | Returns a list of VideoFormatDesc objects describing all video formats supported by the current video capture device. |
||
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. |
||
Method | Description | ||
AviStartCapture | [Deprecated] This method writes a compressed AVI file to the computer's hard disk. |
||
AviStopCapture | [Deprecated] 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 | [Deprecated] Creates a new instance of a FrameFilter from a FrameFilterInfo. |
||
ICImagingControl | Creates a new ICImagingControl object. |
||
LivePrepare | This method tries to setup the image stream by connecting the device with the display and the sink and inserting frame filters and overlays. |
||
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. |
||
LiveSuspend | Suspends a prepared image stream and switches it into prepared state. |
||
LoadDeviceState | Restores the device settings saved with ICImagingControl.SaveDeviceState. |
||
LoadDeviceStateFromFile | Restores the device settings saved with ICImagingControl.SaveDeviceStateToFile. |
||
LoadShowSaveDeviceState | This executes the sequence ICImagingControl.LoadDeviceStateFromFile then ICImagingControl.ShowDeviceSettingsDialog and when a device was opened ICImagingControl.SaveDeviceStateToFile while ignoring errors. Then it returns the state of ICImagingControl.DeviceValid. |
||
MemorySaveImage | [Deprecated] This method saves the current buffer as a .bmp file. |
||
MemorySaveImageSequence | [Deprecated] This method saves a sequence of images as a sequence of single .bmp files. |
||
MemorySnapImage | [Deprecated] This method captures a still image from a live video stream. |
||
MemorySnapImageSequence | [Deprecated] 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. |
||
Event | Description | ||
DeviceListChanged | The DeviceListChanged event is raised when the list of available video capture devices (obtainable through Devices ) has changed. |
||
DeviceLost | This event is called if the video capture device is no longer valid; for example if it was unplugged. |
||
ImageAvailable | [Deprecated] This event is called each time a frame has been copied completely to the internal ring buffer. |
||
LivePrepared | This event is called after the LivePrepare was called. |
||
OverlayUpdate | This event is called after a new frame has been delivered by the video capture device. |
||