Image Manager (CVCDriver.dll) 14.0
Functions
IStreamControl
Data Acquisition

Interface for controlling a data stream module. More...

Functions

cvbbool_t CVDCanStreamControl (CVDSTREAM Stream)
 This function verifies if the handle implements IStreamControl. More...
 
cvbres_t CVDStreamControlAbort (CVDSTREAM Stream)
 Gives a data stream module a cue to abort the data streaming processes. More...
 
cvbres_t CVDStreamControlStart (CVDSTREAM Stream, cvbint64_t FrameCountToAcquire)
 Gives a data stream module a cue to start the data streaming processes. More...
 
cvbres_t CVDStreamControlStop (CVDSTREAM Stream)
 Gives a data stream module a cue to stop the data streaming processes. More...
 

Detailed Description

Interface for controlling a data stream module.

Data acquisition is done by the data acquisition engine and this interface offers you a set of features that help you to start or stop the engine. Note that you will have to control the data acquisition engine in parallel to achieve data acquisition.

See also
IAcquisitionEngine IStreamEnum

Function Documentation

◆ CVDCanStreamControl()

cvbbool_t CVDCanStreamControl ( CVDSTREAM  Stream)

This function verifies if the handle implements IStreamControl.

Parameters
[in]StreamHandle to be examined.
Returns
TRUE if the handle implements IStreamControl, FALSE otherwise.
Supported platforms:
Win32
Win64
Linux

◆ CVDStreamControlAbort()

cvbres_t CVDStreamControlAbort ( CVDSTREAM  Stream)

Gives a data stream module a cue to abort the data streaming processes.

Unlike CVDStreamControlStop, this function call gives the target stereaming device a cue to immediately stop all ongoing data streaming processes.

Parameters
[in]StreamThe handle of a target data stream module.
Returns
  • #CVC_ERROR (#CVC_E_OK) if the data streaming process has aborted successfully.
  • #CVC_ERROR (#CVC_E_WRONGOBJECT) if Stream is not a CVDSTREAM.
See also
CVDStreamAcquisitionEngineAbort CVDStreamAcquisitionEngineStop

◆ CVDStreamControlStart()

cvbres_t CVDStreamControlStart ( CVDSTREAM  Stream,
cvbint64_t  FrameCountToAcquire 
)

Gives a data stream module a cue to start the data streaming processes.

Gives the target data stream module a cue to start the data streaming process. In general, GenICam compliant streaming devices require a host to give them a cue to start data streaming. See CVDStreamAcquisitionEngineStart for the required instructions.

Parameters
[in]StreamThe handle of a target data stream module.
[in]FrameCountToAcquireThe number of complete frames to transmit; set -1 for infinite acquisition.
Returns
  • #CVC_ERROR (#CVC_E_OK) if the data streaming process has started successfully.
  • #CVC_ERROR (#CVC_E_WRONGOBJECT) if Stream is not a CVDSTREAM.
See also
CVDStreamAcquisitionEngineStart

◆ CVDStreamControlStop()

cvbres_t CVDStreamControlStop ( CVDSTREAM  Stream)

Gives a data stream module a cue to stop the data streaming processes.

Unlike CVDStreamControlAbort, this function call also gives the target device a cue to stop all ongoing data streaming processes but it requires the device to wait for the completion of the processes.

Parameters
[in]StreamThe handle of a target data stream module.
Returns
  • #CVC_ERROR (#CVC_E_OK) if the data streaming process has stopped successfully.
  • #CVC_ERROR (#CVC_E_WRONGOBJECT) if Stream is not a CVDSTREAM.
See also
CVDStreamAcquisitionEngineAbort CVDStreamAcquisitionEngineStop