Image Manager (CVCDriver.dll) 14.0
IStreamEnum

Interface for collecting information about data stream modules. More...

Typedefs

typedef void * CVDSTREAM
 Handle to logical data stream object. More...
 

Functions

cvbbool_t CVDCanStreamEnum (DEVOBJ DeviceObject)
 This function verifies if the handle implements IStreamEnum. More...
 
cvbres_t CVDDeviceGetStreamAt (DEVOBJ DeviceObject, size_t Index, CVDSTREAM &Stream)
 Returns the handle of the specified data stream module. More...
 
cvbres_t CVDDeviceGetStreamCount (DEVOBJ DeviceObject, size_t &Count)
 Returns the number of data stream modules that the target data streaming device holds. More...
 

Detailed Description

Interface for collecting information about data stream modules.

This is a collection of features that aim to provide information about the data stream module. The information is required when a data stream module needs to be controlled.

See also
IAcquisitionEngine IStreamControl

Typedef Documentation

◆ CVDSTREAM

Handle to logical data stream object.

The CVDSTREAM is a reference counted handle. It provides several interfaces for acquisition.

See also

Function Documentation

◆ CVDCanStreamEnum()

cvbbool_t CVDCanStreamEnum ( DEVOBJ  DeviceObject)

This function verifies if the handle implements IStreamEnum.

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

◆ CVDDeviceGetStreamAt()

cvbres_t CVDDeviceGetStreamAt ( DEVOBJ  DeviceObject,
size_t  Index,
CVDSTREAM Stream 
)

Returns the handle of the specified data stream module.

Parameters
[in]DeviceObjectThe handle of a target data streaming device.
[in]IndexThe index of a target data stream module; the handle of the specified data stream module will be retured through Stream.
[out]StreamThe handle of a target data stream module that is specified ny Index.
Returns
  • #CVC_ERROR (#CVC_E_OK) if the execution was successful.

◆ CVDDeviceGetStreamCount()

cvbres_t CVDDeviceGetStreamCount ( DEVOBJ  DeviceObject,
size_t &  Count 
)

Returns the number of data stream modules that the target data streaming device holds.

Parameters
[in]DeviceObjectThe handle of a target data streaming device.
[out]CountThe number of data stream modules that the target data streaming device holds.
Returns
  • #CVC_ERROR (#CVC_E_OK) if the execution was successful.