Static Public Attributes | List of all members
StreamInfo Class Reference

Queryable stream information. More...

Inherits object.

Static Public Attributes

int IsCameraDetected = 8
 Returns whether a camera is currently detected. More...
 
int NumBuffersAcquired = 0
 The number of image buffers acquired since start of the last acquisition start.
 
int NumBuffersAnnounced = 18
 Second 'NumAcquired exclusive lost' omitted (too confusing with first one) More...
 
int NumBuffersBeingFilled = 19
 Number of buffer currently being filled by the acquisition engine.
 
int NumBuffersCorruptOnArrival = 12
 Count that contains erroneous image buffer acquisition. More...
 
int NumBuffersCorruptOnDelivery = 13
 Count that contains erroneous image buffers delivered via the stream's wait method. More...
 
int NumBuffersDelivered = 11
 Number of image buffers successfully returned by the stream's wait method. More...
 
int NumBuffersLocked = 3
 Number of images currently in locked state.
 
int NumBuffersLost = 14
 Count that incorporates all lost image buffers despite their reason. More...
 
int NumBuffersLostLocked = 2
 Count that only contains lost images due to ring buffer overflow.
 
int NumBuffersLostTransfer = 1
 Count that only contains lost images during transfer.
 
int NumBuffersPending = 4
 Number of images acquired, but not retrieved via the stream's wait method.
 
int NumBuffersQueued = 17
 Number of buffers available to be filled by the acquisition engine. More...
 
int NumPacketsReceived = 20
 For packet based protocols this contains the actual number of packets received (parts of a whole image buffer)
 
int NumResends = 21
 Number of resend requests sent since start of the last acquisition.
 
int NumTriggersLost = 7
 Returns how many trigger signals where ignored by the device due to for example over-triggering.
 

Detailed Description

Queryable stream information.

All streams only provide a sub-set of the available queries. So always make sure, that the information is available, when switching devices / drivers.

Member Data Documentation

◆ IsCameraDetected

int IsCameraDetected = 8
static

Returns whether a camera is currently detected.

The value is interpreted as a C boolean: everything except 0 is true.

This information depends on the camera / frame grabber technology. It can be the presence of a signal from for example a CameraLink camera or an active heartbeat signal from a GigE Vision device.

◆ NumBuffersAnnounced

int NumBuffersAnnounced = 18
static

Second 'NumAcquired exclusive lost' omitted (too confusing with first one)

Number of buffers used in the acquisition engine. This is the number of images in the ring buffer.

◆ NumBuffersCorruptOnArrival

int NumBuffersCorruptOnArrival = 12
static

Count that contains erroneous image buffer acquisition.

Packet resend can alleviate this problem and result in complete buffer to be delivered via the stream's wait method. But higher counts indicate a bad connection either due to transfer errors or to high throughput.

◆ NumBuffersCorruptOnDelivery

int NumBuffersCorruptOnDelivery = 13
static

Count that contains erroneous image buffers delivered via the stream's wait method.

This count can only increase if corrupt images are delivered from the driver (default is yes). This means that either packet resend is disabled or packet resend could not complete the image buffer.

◆ NumBuffersDelivered

int NumBuffersDelivered = 11
static

Number of image buffers successfully returned by the stream's wait method.

This counts both corrupt and complete image buffers. Corrupt images are only delivered if enabled by the driver (normally defaults to yes).

◆ NumBuffersLost

int NumBuffersLost = 14
static

Count that incorporates all lost image buffers despite their reason.

Can be transfer, corruption, or overflown ring buffer.

◆ NumBuffersQueued

int NumBuffersQueued = 17
static

Number of buffers available to be filled by the acquisition engine.

That is image buffers that are not locked.