Click or drag to resize

IMcCaptDevice2BeginStream Method

Start a muliple-frame streaming operation on the capture device.

Namespace:  MediaCy.IQL.Capture
Assembly:  MediaCy.IQL.Capture (in MediaCy.IQL.Capture.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function BeginStream ( 
	CaptFrames As McCaptFrames,
	Optional Flags As mcImageCreateFlags = mcImageCreateFlags.mcicfDefault,
	<OptionalAttribute> Image As Object
) As mcCaptureErrorCodes

Parameters

CaptFrames
Type: MediaCy.IQL.CaptureMcCaptFrames
Capture frames collection to use for this streaming operation
Flags (Optional)
Type: MediaCy.IQL.EnginemcImageCreateFlags
Image creation flags if Snap is creating image
Image (Optional)
Type: SystemObject
McImage passed in to stream to if stream is not creating image

Return Value

Type: mcCaptureErrorCodes
Remarks
Calling this method starts a multiple-frame asynchronous stream on the device. Before calling this method, call CreateFrames to create the collection to be passed in to the first argument of this call. You should also call IsStreamSupported to verify that the capture device supports streaming operations. Call the EndStream method to poll if the operation is complete or to cancel. Also, a StreamComplete event will be sent when the operation is finished that can be used as a completion trigger. Call EndStream to retrieve the McImage that has the snap data if an image wasn't passed into this call. This method will fail if the capture device is closed or a stream or snap operation is currently in progress.
See Also