PvStream USB3 Vision Parameters
For the latest eBUS SDK documentation and support, visit https://supportcenter.pleora.com
Category: Root/Connection
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| DeviceGUID | USB3 Vision GUID of the device the controller is connected to. | String | Beginner |
| ConnectionSpeed | Effective connection speed to the device once connected. | Enumeration. Entries: LowSpeed, FullSpeed, HighSpeed, SuperSpeed, NotConnected |
Beginner |
| MaxPacketSize | USB wMaxPacketSize parameter. | Unbound unsigned 64 bits integer | Expert |
| MaxBurst | USB bMaxBurst parameter. | Unbound unsigned 64 bits integer | Expert |
| Channel | The USB3 Vision streaming channel from which data is received. | Unbound unsigned 64 bits integer | Beginner |
Category: Root/General
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| Reset | Resets all stream statistic counters | Command | Beginner |
| BitsCount | Number of data payload bits received by the stream. | Unbound unsigned 64 bits integer | Beginner |
| BytesCount | Number of data payload bytes received by the stream. | Unbound unsigned 64 bits integer | Beginner |
| BlockCount | Number of blocks received from the device. | Unbound unsigned 64 bits integer | Beginner |
| SamplingTime | The time elapsed (in ms) between the first block received and the latest block received. Note the definition of the first block in this case would be the first block received after having either opening the stream or issuing the Reset command. | Unbound unsigned 64 bits integer | Beginner |
| AcquisitionRate | Instant acquisition rate. | Float | Beginner |
| AcquisitionRateAverage | Average acquisition rate since the first block was received. | Float | Beginner |
| Bandwidth | Instant throughput in bits per second. Note that this value is calculated based on a finite sequence of received blocks within a finite period of time. | Float | Beginner |
| BandwidthAverage | Average throughput since the last reset in bits per second. | Float | Beginner |
| AbortCountedAsError | When enabled, aborted buffers are considered errors. Depending on the nature and behavior of an application, aborted buffers can be normal occurrences or represent real errors. | Boolean | Guru |
| ResyncCountedAsError | When enabled, buffers released by the driver because of resychronization issues are considered errors. Depending on the nature and behavior of an application, resynchronized buffers can be normal occurrences or be interpreted as real errors. | Boolean | Guru |
| ErrorCount | Count of RetrieveBuffer operation result errors since the last reset. | Unbound unsigned 64 bits integer | Beginner |
| LastError | Last RetrieveBuffer operation result error. | Enumeration. Entries: None, NOT_INITIALIZED, NOT_FOUND, CANNOT_OPEN_FILE, NO_MORE_ITEM, NOT_CONNECTED, STATE_ERROR, THREAD_ERROR, INVALID_DATA_FORMAT, ABORTED, NOT_ENOUGH_MEMORY, GENERIC_ERROR, INVALID_PARAMETER, CANCEL, PENDING, TIMEOUT, NO_LICENSE, GENICAM_XML_ERROR, NOT_IMPLEMENTED, NOT_SUPPORTED, FILE_ERROR, ERR_OVERFLOW, IMAGE_ERROR, MISSING_PACKETS, BUFFER_TOO_SMALL, TOO_MANY_RESENDS, RESENDS_FAILURE, TOO_MANY_CONSECUTIVE_RESENDS, AUTO_ABORTED, BAD_VERSION, NO_MORE_ENTRY, NO_AVAILABLE_DATA, NETWORK_ERROR, RESYNC, BUSY, CORRUPTED_DATA |
Beginner |
| TimestampSourceEffective | Source of the buffer timestamps in use. Hardware refers to the device timestamp present in the GVSP header. Software refers to host-side timestamps recorded when a buffer is delivered by the data receiver. | Enumeration. Entries: Hardware, Software |
Guru |
| TimestampSourcePreferred | Preferred source of the buffer timestamps used to track statistics. Hardware refers to the device timestamp present in the GVSP header. Software refers to host-side timestamps recorded when a buffer is delivered by the data receiver. | Enumeration. Entries: Hardware, Software |
Guru |
Category: Root/Counters
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| BlockIDsMissing | The number of missing block IDs. Calculated using the block ID of incoming blocks to count blocks sent by the USB3 Vision device that were not successfully delivered. This is typically caused by the application not being able to de-queue and re-queue buffers quickly enough. | Unbound unsigned 64 bits integer | Beginner |
| PipelineBlocksDropped | Count of blocks dropped by the PvPipeline. The oldest blocks are dropped from the PvPipeline output queue if it runs out of resources. | Unbound unsigned 64 bits integer | Beginner |
Category: Root/Status
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| DataOverrun | Count of data overrun notifications received from the device. A data overrun notification is sent when the incoming (from a sensor) data rate exceeds the device's data capture rate. | Unbound unsigned 64 bits integer | Beginner |
| PartialLineMissing | Count of images that have at least one partial line missing. Only available for devices using a Pleora Video Interface. | Unbound unsigned 64 bits integer | Beginner |
| FullLineMissing | Count of images that have at least on full line missing. Only available for devices using a Pleora Video Interface. | Unbound unsigned 64 bits integer | Beginner |
| BlocksDropped | Count of dropped block notifications received from the device. Dropped block notifications are sent when the frame buffer is full and the incoming data cannot be processed. Only available for devices using a Pleora Video Interface. | Unbound unsigned 64 bits integer | Beginner |
| InterlacedEven | Count of interlaced even fields from an interlaced image. Only for devices using a Pleora Video Interface. | Unbound unsigned 64 bits integer | Beginner |
| InterlacedOdd | Count of interlaced odd fields from an interlaced image. Only for devices using a Pleora Video Interface. | Unbound unsigned 64 bits integer | Beginner |
Category: Root/Errors
| Parameter | Description | Additional Information | Visibility |
|---|---|---|---|
| ResultImageError | Count of failed buffers with operation result set to IMAGE_ERROR. Incremented when a corrupt image arrives due to discontinuities in data between the camera and the hardware responsible for transmitting URBs in the USB3 Vision device. This can include data overrun, partial and full lines missing. | Unbound unsigned 64 bits integer | Beginner |
| ResultBufferTooSmall | Count of failed buffers with operation result set to BUFFER_TOO_SMALL. Happens when a buffer queued for streaming was not large enough to contain the received payload. | Unbound unsigned 64 bits integer | Beginner |
| ResultAborted | Count of failed buffers with operation result set to ABORTED. After calling AbortQueuedBuffers all buffers in the stream are completed with the ABORTED operation result. | Unbound unsigned 64 bits integer | Beginner |
| ResultResync | Operation result assigned to buffers needing to be re-queued due to internal USB3 Vision driver contraints. Buffers from a previous acquisition sequence usually need to be re-queued. Not indicative of a streaming error. | Unbound unsigned 64 bits integer | Beginner |
| ResultInvalidDataFormat | Count of failed buffers with operation result set to INVALID_DATA_FORMAT. Poorly formatted data was received from the USB3 Vision transmitter. | Unbound unsigned 64 bits integer | Beginner |
| ResultNoLicense | Count of buffers with an operational state that no license was available and watermarking could not be used: the buffer was not an image or too small for watermarking. | Unbound unsigned 64 bits integer | Beginner |
eBUS SDK | Pleora Technologies Inc.
Copyright (c) 2002-2026 Pleora Technologies Inc.
Send comments on this topic to info@pleora.com