Class PvStreamU3V

Receive data from a USB3 Vision transmitter.

Inheritance

object

PvStream

PvStreamU3V

Implements

IDisposable

Inherited Members

PvStream.swigCMemOwn

PvStream.Dispose()

PvStream.CreateAndOpen(PvDeviceInfo, ref PvResult)

PvStream.CreateAndOpen(string, ref PvResult)

PvStream.Free(PvStream)

PvStream.Close()

PvStream.GetType()

PvStream.AbortQueuedBuffers()

PvStream.QueueBuffer(PvBuffer)

PvStream.RetrieveBuffer(out PvBuffer, ref PvResult, uint)

PvStream.RetrieveBuffer(out PvBuffer, ref PvResult)

PvStream.RegisterEventSink(PvStreamEventSink)

PvStream.UnregisterEventSink(PvStreamEventSink)

PvStream.QueuedBufferCount

PvStream.QueuedBufferMaximum

PvStream.Channel

PvStream.IsOpen

PvStream.Parameters

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNetReceive

Assembly: eBUSDotNetReceive.dll

Syntax

public class PvStreamU3V : PvStream, IDisposable

Constructors

PvStreamU3V()

Constructor.

Declaration

public PvStreamU3V()

Properties

GUID

Gets the USB3 Vision stream GUID.

Declaration

public string GUID { get; }

Property Value

Type	Description
string

Type

Type property of PvStreamU3V.

Declaration

public override PvStreamType Type { get; }

Property Value

Type	Description
PvStreamType

Overrides

PvStream.Type

Methods

Dispose(bool)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

PvStream.Dispose(bool)

Open(PvDeviceInfo)

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

Declaration

public override PvResult Open(PvDeviceInfo aDeviceInfo)

Parameters

Type	Name	Description
PvDeviceInfo	aDeviceInfo	Device info retrieved from finder for the USB3 Vision to open the stream from.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Overrides

PvStream.Open(PvDeviceInfo)

Open(PvDeviceInfo, ushort)

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

Declaration

public PvResult Open(PvDeviceInfo aDeviceInfo, ushort aChannel)

Parameters

Type	Name	Description
PvDeviceInfo	aDeviceInfo	Device info retrieved from finder for the USB3 Vision to open the stream from.
ushort	aChannel	The USB3 Vision transmitter's streaming channel (default 0).

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Open(PvDeviceInfo, ushort, uint)

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

Declaration

public PvResult Open(PvDeviceInfo aDeviceInfo, ushort aChannel, uint aBuffersCapacity)

Parameters

Type	Name	Description
PvDeviceInfo	aDeviceInfo	Device info retrieved from finder for the USB3 Vision to open the stream from.
ushort	aChannel	The USB3 Vision transmitter's streaming channel (default 0).
uint	aBuffersCapacity	The maximum number of buffers that can be stored simultaneously in the data receiver.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Open(PvDeviceInfo, ushort, uint, uint)

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

Declaration

public PvResult Open(PvDeviceInfo aDeviceInfo, ushort aChannel, uint aBuffersCapacity, uint aSmallImageThreshold)

Parameters

Type	Name	Description
PvDeviceInfo	aDeviceInfo	Device info retrieved from finder for the USB3 Vision to open the stream from.
ushort	aChannel	The USB3 Vision transmitter's streaming channel (default 0).
uint	aBuffersCapacity	The maximum number of buffers that can be stored simultaneously in the data receiver.
uint	aSmallImageThreshold	Threashold where the exchange of memory with the driver is making copy to decrease overall overhead due to memory mapping

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Open(PvDeviceInfo, ushort, uint, uint, uint)

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

Declaration

public PvResult Open(PvDeviceInfo aDeviceInfo, ushort aChannel, uint aBuffersCapacity, uint aSmallImageThreshold, uint aMaximumNumberOfPendingURB)

Parameters

Type	Name	Description
PvDeviceInfo	aDeviceInfo	Device info retrieved from finder for the USB3 Vision to open the stream from.
ushort	aChannel	The USB3 Vision transmitter's streaming channel (default 0).
uint	aBuffersCapacity	The maximum number of buffers that can be stored simultaneously in the data receiver.
uint	aSmallImageThreshold	Threashold where the exchange of memory with the driver is making copy to decrease overall overhead due to memory mapping
uint	aMaximumNumberOfPendingURB	Maximum of pending URBs in the controller at one time

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Open(string)

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

Declaration

public override PvResult Open(string aInfo)

Parameters

Type	Name	Description
string	aInfo	The USB3 Vision GUID transmitter's U3VGUID

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Overrides

PvStream.Open(string)

Open(string, ushort)

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

Declaration

public PvResult Open(string aInfo, ushort aChannel)

Parameters

Type	Name	Description
string	aInfo	The USB3 Vision GUID transmitter's U3VGUID
ushort	aChannel	The USB3 Vision transmitter's streaming channel (default 0).

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Open(string, ushort, uint)

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

Declaration

public PvResult Open(string aInfo, ushort aChannel, uint aBuffersCapacity)

Parameters

Type	Name	Description
string	aInfo	The USB3 Vision GUID transmitter's U3VGUID
ushort	aChannel	The USB3 Vision transmitter's streaming channel (default 0).
uint	aBuffersCapacity	The maximum number of buffers that can be stored simultaneously in the data receiver.

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Open(string, ushort, uint, uint)

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

Declaration

public PvResult Open(string aInfo, ushort aChannel, uint aBuffersCapacity, uint aSmallImageThreshold)

Parameters

Type	Name	Description
string	aInfo	The USB3 Vision GUID transmitter's U3VGUID
ushort	aChannel	The USB3 Vision transmitter's streaming channel (default 0).
uint	aBuffersCapacity	The maximum number of buffers that can be stored simultaneously in the data receiver.
uint	aSmallImageThreshold	Threashold where the exchange of memory with the driver is making copy to decrease overall overhead due to memory mapping

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Open(string, ushort, uint, uint, uint)

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

Declaration

public PvResult Open(string aInfo, ushort aChannel, uint aBuffersCapacity, uint aSmallImageThreshold, uint aMaximumNumberOfPendingURB)

Parameters

Type	Name	Description
string	aInfo	The USB3 Vision GUID transmitter's U3VGUID
ushort	aChannel	The USB3 Vision transmitter's streaming channel (default 0).
uint	aBuffersCapacity	The maximum number of buffers that can be stored simultaneously in the data receiver.
uint	aSmallImageThreshold	Threashold where the exchange of memory with the driver is making copy to decrease overall overhead due to memory mapping
uint	aMaximumNumberOfPendingURB	Maximum of pending URBs in the controller at one time

Returns

Type	Description
PvResult	Includes: #PvResult::Code::OK #PvResult::Code::BUSY Only one instance to one transmitter can be opened at the time #PvResult::Code::NOT_CONNECTED #PvResult::Code::GENERIC_ERROR #PvResult::Code::NOT_FOUND #PvResult::Code::CANNOT_OPEN_FILE #PvResult::Code::NOT_SUPPORTED

Implements

IDisposable