Class PvStreamGEV
Receive data from a GigE Vision.
Implements
Inherited Members
Namespace: eBUSDotNetReceive
Assembly: eBUSDotNetReceive.dll
Syntax
public class PvStreamGEV : PvStream, IDisposable
Constructors
View SourcePvStreamGEV()
Constructor.
Declaration
public PvStreamGEV()
Properties
View SourceDataReceiverType
Gets the type of GigE Vision data receiving used by the stream receiver.
Declaration
public PvDataReceiverType DataReceiverType { get; }
Property Value
| Type | Description |
|---|---|
| PvDataReceiverType |
DeviceIPAddress
Gets the IP address of the device this stream receives data from.
Declaration
public string DeviceIPAddress { get; }
Property Value
| Type | Description |
|---|---|
| string |
LocalIPAddress
Gets the local IP address upon which the stream receives incoming data.
Declaration
public string LocalIPAddress { get; }
Property Value
| Type | Description |
|---|---|
| string |
LocalPort
Gets the local port upon which the stream receives incoming data.
Declaration
public ushort LocalPort { get; }
Property Value
| Type | Description |
|---|---|
| ushort |
MulticastIPAddress
Gets the multicast IP address the stream subscribes to.
Declaration
public string MulticastIPAddress { get; }
Property Value
| Type | Description |
|---|---|
| string |
SpecificLocalPort
Gets the local UDP port requested when opening the stream.
Declaration
public ushort SpecificLocalPort { get; }
Property Value
| Type | Description |
|---|---|
| ushort |
Type
Type property of PvStreamGEV.
Declaration
public override PvStreamType Type { get; }
Property Value
| Type | Description |
|---|---|
| PvStreamType |
Overrides
View SourceUserModeDataReceiverThreadPriority
Gets or sets the priority of the thread used to run the user mode data receiver.
Declaration
public uint UserModeDataReceiverThreadPriority { get; set; }
Property Value
| Type | Description |
|---|---|
| uint |
WaitForFirstPacketOfBlockToStart
Gets or sets whether to wait for the first packet of the block to start stream capture.
Declaration
public bool WaitForFirstPacketOfBlockToStart { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Methods
View SourceDispose(bool)
Declaration
protected override void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing |
Overrides
View SourceFlushPacketQueue()
Flushes all non-processed UDP packets from the data receiver.
Declaration
public PvResult FlushPacketQueue()
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
GetUserModeSocketRxBufferSize(out uint)
Read the current Receive Buffer Size set by the PvStreamGEV that the socket uses.
Declaration
public PvResult GetUserModeSocketRxBufferSize(out uint aBufferSize)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | aBufferSize | Output parameter to receive the buffer size. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
IsDriverInstalled(out string, out bool)
Test if the specified GigE Vision device is currently reachable through an eBUS driver
Declaration
public static PvResult IsDriverInstalled(out string aIPAddress, out bool aInstalled)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aIPAddress | The GigE Vision transmitter's IP address. |
| bool | aInstalled | True if the device is reachable through an eBUS driver; otherwise, false. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
IsDriverInstalled(out string, out bool, string)
Test if the specified GigE Vision device is currently reachable through an eBUS driver
Declaration
public static PvResult IsDriverInstalled(out string aIPAddress, out bool aInstalled, string aLocalIPAddress)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aIPAddress | The GigE Vision transmitter's IP address. |
| bool | aInstalled | True if the device is reachable through an eBUS driver; otherwise, false. |
| string | aLocalIPAddress | Deprecated and ignored. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(PvDeviceInfo)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public override PvResult Open(PvDeviceInfo aDeviceInfo)
Parameters
| Type | Name | Description |
|---|---|---|
| PvDeviceInfo | aDeviceInfo | Device information as retrieved from a device finder. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Overrides
View SourceOpen(PvDeviceInfo, string, ushort)
Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(PvDeviceInfo aDeviceInfo, string aMulticastAddr, ushort aDataPort)
Parameters
| Type | Name | Description |
|---|---|---|
| PvDeviceInfo | aDeviceInfo | Device information as retrieved from a device finder. |
| string | aMulticastAddr | The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aDataPort | The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(PvDeviceInfo, string, ushort, ushort)
Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(PvDeviceInfo aDeviceInfo, string aMulticastAddr, ushort aDataPort, ushort aChannel)
Parameters
| Type | Name | Description |
|---|---|---|
| PvDeviceInfo | aDeviceInfo | Device information as retrieved from a device finder. |
| string | aMulticastAddr | The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aDataPort | The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(PvDeviceInfo, string, ushort, ushort, string)
Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(PvDeviceInfo aDeviceInfo, string aMulticastAddr, ushort aDataPort, ushort aChannel, string aLocalIPAddress)
Parameters
| Type | Name | Description |
|---|---|---|
| PvDeviceInfo | aDeviceInfo | Device information as retrieved from a device finder. |
| string | aMulticastAddr | The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aDataPort | The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
| string | aLocalIPAddress | Deprecated and ignored. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(PvDeviceInfo, string, ushort, ushort, string, uint)
Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(PvDeviceInfo aDeviceInfo, string aMulticastAddr, ushort aDataPort, ushort aChannel, string aLocalIPAddress, uint aBuffersCapacity)
Parameters
| Type | Name | Description |
|---|---|---|
| PvDeviceInfo | aDeviceInfo | Device information as retrieved from a device finder. |
| string | aMulticastAddr | The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aDataPort | The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
| string | aLocalIPAddress | Deprecated and ignored. |
| uint | aBuffersCapacity | The maximum number of buffers that can be stored simultaneously in the data receiver. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(PvDeviceInfo, ushort)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(PvDeviceInfo aDeviceInfo, ushort aLocalPort)
Parameters
| Type | Name | Description |
|---|---|---|
| PvDeviceInfo | aDeviceInfo | Device information as retrieved from a device finder. |
| ushort | aLocalPort | The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call #GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(PvDeviceInfo, ushort, ushort)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(PvDeviceInfo aDeviceInfo, ushort aLocalPort, ushort aChannel)
Parameters
| Type | Name | Description |
|---|---|---|
| PvDeviceInfo | aDeviceInfo | Device information as retrieved from a device finder. |
| ushort | aLocalPort | The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call #GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination. |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(PvDeviceInfo, ushort, ushort, string)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(PvDeviceInfo aDeviceInfo, ushort aLocalPort, ushort aChannel, string aLocalIpAddress)
Parameters
| Type | Name | Description |
|---|---|---|
| PvDeviceInfo | aDeviceInfo | Device information as retrieved from a device finder. |
| ushort | aLocalPort | The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call #GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination. |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
| string | aLocalIpAddress | The local IP address to bind to. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(PvDeviceInfo, ushort, ushort, string, uint)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(PvDeviceInfo aDeviceInfo, ushort aLocalPort, ushort aChannel, string aLocalIpAddress, uint aBuffersCapacity)
Parameters
| Type | Name | Description |
|---|---|---|
| PvDeviceInfo | aDeviceInfo | Device information as retrieved from a device finder. |
| ushort | aLocalPort | The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call #GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination. |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
| string | aLocalIpAddress | The local IP address to bind to. |
| uint | aBuffersCapacity | The maximum number of buffers that can be stored simultaneously in the data receiver. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(string)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public override PvResult Open(string aInfo)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aInfo | The GigE Vision transmitter's IP address. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Overrides
View SourceOpen(string, string, ushort)
Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(string aInfo, string aMulticastAddr, ushort aDataPort)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aInfo | The GigE Vision transmitter's IP address. |
| string | aMulticastAddr | The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aDataPort | The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(string, string, ushort, ushort)
Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(string aInfo, string aMulticastAddr, ushort aDataPort, ushort aChannel)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aInfo | The GigE Vision transmitter's IP address. |
| string | aMulticastAddr | The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aDataPort | The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(string, string, ushort, ushort, string)
Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(string aInfo, string aMulticastAddr, ushort aDataPort, ushort aChannel, string aLocalIPAddress)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aInfo | The GigE Vision transmitter's IP address. |
| string | aMulticastAddr | The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aDataPort | The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
| string | aLocalIPAddress | The local IP address upon which the stream object will begin receiving incoming data. An empty string (default) indicates that the local ip address will be assigned automatically. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(string, string, ushort, ushort, string, uint)
Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(string aInfo, string aMulticastAddr, ushort aDataPort, ushort aChannel, string aLocalIPAddress, uint aBuffersCapacity)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aInfo | The GigE Vision transmitter's IP address. |
| string | aMulticastAddr | The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aDataPort | The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination.) |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
| string | aLocalIPAddress | The local IP address upon which the stream object will begin receiving incoming data. An empty string (default) indicates that the local ip address will be assigned automatically. |
| uint | aBuffersCapacity | The maximum number of buffers that can be stored simultaneously in the data receiver. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(string, ushort)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(string aInfo, ushort aLocalPort)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aInfo | The GigE Vision transmitter's IP address. |
| ushort | aLocalPort | The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call #GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(string, ushort, ushort)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(string aInfo, ushort aLocalPort, ushort aChannel)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aInfo | The GigE Vision transmitter's IP address. |
| ushort | aLocalPort | The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call #GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination. |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(string, ushort, ushort, string)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(string aInfo, ushort aLocalPort, ushort aChannel, string aLocalIpAddress)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aInfo | The GigE Vision transmitter's IP address. |
| ushort | aLocalPort | The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call #GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination. |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
| string | aLocalIpAddress | The local IP address to bind to. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
Open(string, ushort, ushort, string, uint)
Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter.
Declaration
public PvResult Open(string aInfo, ushort aLocalPort, ushort aChannel, string aLocalIpAddress, uint aBuffersCapacity)
Parameters
| Type | Name | Description |
|---|---|---|
| string | aInfo | The GigE Vision transmitter's IP address. |
| ushort | aLocalPort | The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call #GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling #PvDeviceGEV::SetStreamDestination. |
| ushort | aChannel | The GigE Vision transmitter's streaming channel (default 0). |
| string | aLocalIpAddress | The local IP address to bind to. |
| uint | aBuffersCapacity | The maximum number of buffers that can be stored simultaneously in the data receiver. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
SetUserModeRxPacketBufferSize(uint)
Set ther Receive Packet Buffer Size used by PvStreamGEV.
Declaration
public PvResult SetUserModeRxPacketBufferSize(uint aSize)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | aSize | The Receive Packet Buffer Size to use when using User Mode DataReceiver. Minimum supported value is 17000 bytes, Maximum is 65500 bytes. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|
SetUserModeSocketRxBufferSize(uint)
Set the Receive Buffer Size through socket option SO_RCVBUF by PvStreamGEV.
Declaration
public PvResult SetUserModeSocketRxBufferSize(uint aSize)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | aSize | The Receive Buffer Size to use with socket option SO_RCVBUF. |
Returns
| Type | Description |
|---|---|
| PvResult | Includes:
|