Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvStreamU3V Class Reference

Receive data from a USB3 Vision transmitter. More...

Public Member Functions

 PvStreamU3V ()
 Constructor.
 
virtual ~PvStreamU3V ()
 Destructor.
 
PvResult Open (const PvDeviceInfo *aDeviceInfo)
 Begin receiving blocks (images or raw data) unicasted from a USB3 Vision transmitter. More...
 
PvResult Open (const PvDeviceInfo *aDeviceInfo, uint16_t aChannel, uint32_t aBuffersCapacity=64, uint32_t aSmallImageThreshold=512, uint32_t aMaximumNumberOfPendingURB=64)
 Begin receiving blocks (images or raw data) unicasted from a USB3 Vision transmitter. More...
 
PvResult Open (const PvString &aInfo)
 Begin receiving blocks (images or raw data) unicasted from a USB3 Vision transmitter. More...
 
PvResult Open (const PvString &aInfo, uint16_t aChannel, uint32_t aBuffersCapacity=64, uint32_t aSmallImageThreshold=512, uint32_t aMaximumNumberOfPendingURB=64)
 Begin receiving blocks (images or raw data) unicasted from a USB3 Vision transmitter. More...
 
PvString GetGUID ()
 Get the stream's GUID property. More...
 
virtual PvStreamType GetType () const
 Returns whether the object is a GigE Vision or USB3 Vision stream receiver. More...
 
- Public Member Functions inherited from PvStream
virtual ~PvStream ()
 Destructor.
 
uint32_t GetQueuedBufferCount () const
 Get the number of buffers (PvBuffer objects) waiting to be filled with images by the data receiver. More...
 
uint32_t GetQueuedBufferMaximum () const
 Get the maximum number of buffers (PvBuffer objects) that can be queued at a time. More...
 
PvResult Close ()
 Close the stream channel receiver. More...
 
PvResult AbortQueuedBuffers ()
 Abort all pending block requests. More...
 
PvResult QueueBuffer (PvBuffer *aBuffer)
 Queue a buffer to receive a block. More...
 
PvResult RetrieveBuffer (PvBuffer **aBuffer, PvResult *aOperationResult, uint32_t aTimeout=0xFFFFFFFF)
 Attempt to retrieve a queued buffer. More...
 
uint16_t GetChannel ()
 Get the stream's Channel property. More...
 
bool IsOpen () const
 Test if the stream is open. More...
 
PvResult RegisterEventSink (PvStreamEventSink *aEventSink)
 Register an event sink used for callbacks. More...
 
PvResult UnregisterEventSink (PvStreamEventSink *aEventSink)
 Unregister an event sink. More...
 
PvGenParameterArrayGetParameters ()
 Get the parameters defining how data is received from a GigE Vision transmitter. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from PvStream
static PvStreamCreateAndOpen (const PvDeviceInfo *aDeviceInfo, PvResult *aResult)
 Dynamically allocates a PvStream of the right type. More...
 
static PvStreamCreateAndOpen (const PvString &aInfo, PvResult *aResult)
 Dynamically allocates a PvStream of the right type. More...
 
static void Free (PvStream *aStream)
 Frees an object allocated with CreateAndOpen. More...
 
- Protected Member Functions inherited from PvStream
 PvStream ()
 Constructor.
 

Detailed Description

Receive data from a USB3 Vision transmitter.

This provides a means of opening a connection to the data receiver and obtaining data from it.

Member Function Documentation

◆ GetGUID()

PvString PvStreamU3V::GetGUID ( )

Get the stream's GUID property.

Returns
The stream's GUID property.

◆ GetType()

PvStreamType PvStreamU3V::GetType ( ) const
virtual

Returns whether the object is a GigE Vision or USB3 Vision stream receiver.

Returns
Specific object type.

Reimplemented from PvStream.

◆ Open() [1/4]

PvResult PvStreamU3V::Open ( const PvDeviceInfo aDeviceInfo)
virtual

Begin receiving blocks (images or raw data) unicasted from a USB3 Vision transmitter.

Parameters
[in]aDeviceInfoDevice info retrieved from finder for the USB3 Vision to open the stream from.
Returns
Includes:

Implements PvStream.

◆ Open() [2/4]

PvResult PvStreamU3V::Open ( const PvDeviceInfo aDeviceInfo,
uint16_t  aChannel,
uint32_t  aBuffersCapacity = 64,
uint32_t  aSmallImageThreshold = 512,
uint32_t  aMaximumNumberOfPendingURB = 64 
)

Begin receiving blocks (images or raw data) unicasted from a USB3 Vision transmitter.

Parameters
[in]aDeviceInfoDevice info retrieved from finder for the USB3 Vision to open the stream from.
[in]aChannelThe USB3 Vision transmitter's streaming channel (default 0).
[in]aBuffersCapacityThe maximum number of buffers that can be stored simultaneously in the data receiver.
[in]aSmallImageThresholdThreashold where the exchange of memory with the driver is making copy to decrease overall overhead due to memory mapping
[in]aMaximumNumberOfPendingURBMaximum of pending URBs in the controller at one time
Returns
Includes:

◆ Open() [3/4]

PvResult PvStreamU3V::Open ( const PvString aInfo)
virtual

Begin receiving blocks (images or raw data) unicasted from a USB3 Vision transmitter.

Parameters
[in]aInfoThe USB3 Vision GUID transmitter's U3VGUID
Returns
Includes:

Implements PvStream.

◆ Open() [4/4]

PvResult PvStreamU3V::Open ( const PvString aInfo,
uint16_t  aChannel,
uint32_t  aBuffersCapacity = 64,
uint32_t  aSmallImageThreshold = 512,
uint32_t  aMaximumNumberOfPendingURB = 64 
)

Begin receiving blocks (images or raw data) unicasted from a USB3 Vision transmitter.

Parameters
[in]aInfoThe USB3 Vision GUID transmitter's U3VGUID
[in]aChannelThe USB3 Vision transmitter's streaming channel (default 0).
[in]aBuffersCapacityThe maximum number of buffers that can be stored simultaneously in the data receiver.
[in]aSmallImageThresholdThreashold where the exchange of memory with the driver is making copy to decrease overall overhead due to memory mapping
[in]aMaximumNumberOfPendingURBMaximum of pending URBs in the controller at one time
Returns
Includes:

The documentation for this class was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com