BaseSink

This class represents a generic sink and provides properties and methods that all sinks have in common. A BaseSink can hold either a FrameHandlerSink or a MediaStreamSink. A FrameHandlerSink is used to access individual frames out of the image stream, while MediaStreamSink writes the image stream to a media file.

Example

The following example illustrates how to use the BaseSink type, when handling a sink object whose actual type is unknown:

Private Sub captureImageSequence(IC As ICImagingControl)
 
    ' Save the currently set sink object, using a BaseSink reference.
    Dim oldSink As BaseSink
    Set oldSink = IC.Sink
    
    ' Create a new sink object.
    Dim fhs As New FrameHandlerSink
    
    ' Initialize the new sink.
    fhs.BufferCount = 10
    
    ' Set the new sink.
    IC.Sink = fhs
   
    ' Use the new sink.
    IC.LiveStart
    fhs.SnapImageSequence 10, -1
    ' ...
    IC.LiveStop
    
    ' Restore the old sink.
    IC.Sink = oldSink
    
End Sub

Information

Introduced in IC Imaging Control 3.0

Inheritance

    BaseSink
            FrameHandlerSink
            MediaStreamSink

Properties

	Property		Description


	SinkModeRunning		Gets or sets the "running" state of the sink.

Methods

	Method		Description


	SinkType		This property returns a member of the BaseSinkTypes enumeration that describes the type of this sink object.

<< Classes