Basler_UniversalStreamParams::CUniversalStreamParams_Params#

A parameter class containing all parameters as members that are available for pylon stream grabbers. More…

#include <pylon/_BaslerUniversalStreamParams.h>

Inherits from Basler_UniversalStreamParams::CUniversalStreamParams_Params_v9_0_0

Public Attributes#

Detailed Description#

class Basler_UniversalStreamParams::CUniversalStreamParams_Params;

A parameter class containing all parameters as members that are available for pylon stream grabbers.

The parameter class is used by the Pylon::CBaslerUniversalInstantCamera class. The [ParametrizeCamera_NativeParameterAccess] code sample shows how to access camera parameters via the Pylon::CBaslerUniversalInstantCamera class.

Public Attributes Documentation#

variable AccessMode#

Pylon::IEnumParameterT< AccessModeEnums > & AccessMode;

Indicates the mode of access the current application has to the device - Applies to: GigE and blaze.

Visibility: Guru

The feature documentation may provide more information.

variable Status#

Pylon::IEnumParameterT< StatusEnums > & Status;

Indicates the current status of the stream grabber - Applies to: GigE.

Visibility: Guru

The feature documentation may provide more information.

variable TypeIsSocketDriverAvailable#

Pylon::IIntegerEx & TypeIsSocketDriverAvailable;

Indicates whether the socket driver is currently available - Applies to: GigE and blaze.

Visibility: Guru

The feature documentation may provide more information.

variable TypeIsWindowsFilterDriverAvailable#

Pylon::IIntegerEx & TypeIsWindowsFilterDriverAvailable;

Indicates whether the pylon GigE Vision Filter Driver is currently available - Applies to: GigE and blaze.

Visibility: Guru

The feature documentation may provide more information.

variable TypeIsWindowsIntelPerformanceDriverAvailable#

Pylon::IIntegerEx & TypeIsWindowsIntelPerformanceDriverAvailable;

Indicates whether the pylon GigE Vision Performance Driver is currently available - Applies to: GigE and blaze.

Visibility: Guru

The feature documentation may provide more information.

variable AutoPacketSize#

Pylon::IBooleanEx & AutoPacketSize;

Enables negotiation of the packet size to find the largest possible packet size - Applies to: GigE.

Enables negotiation of the packet size to find the largest possible packet size. Using large packets reduces the overhead for transferring images. The maximum packet size depends on the network hardware and its configuration.

Visibility: Guru

The feature documentation may provide more information.

variable FirewallTraversalInterval#

Pylon::IIntegerEx & FirewallTraversalInterval;

Firewall traversal interval value in milliseconds This applies to the stream channel If set to 0, this feature is disabled - Applies to: GigE.

Visibility: Guru

The feature documentation may provide more information.

variable MaxTransferSize#

Pylon::IIntegerEx & MaxTransferSize;

Maximum USB data transfer size in bytes - Applies to: USB.

Maximum USB data transfer size in bytes. The default value is appropriate for most applications. Decreasing the value may increase the CPU load. USB host adapter drivers may require decreasing the value if the application fails to receive the image stream. The maximum value also depends on the operating system.

Visibility: Guru

The feature documentation may provide more information.

variable NumMaxQueuedUrbs#

Pylon::IIntegerEx & NumMaxQueuedUrbs;

Maximum number of USB request blocks (URBs) to be enqueued simultaneously - Applies to: USB.

Maximum number of USB request blocks (URBs) to be enqueued simultaneously. Increasing this value may improve stability and reduce jitter, but requires more resources on the host computer.

Visibility: Guru

The feature documentation may provide more information.

variable ProbePacketSize#

Pylon::ICommandEx & ProbePacketSize;

Determines the largest possible packet size - Applies to: GigE.

Determines the largest possible packet size. Using large packets reduces the overhead for transmitting images. Whether large packets can be transmitted depends on the network hardware used and its configuration.

Visibility: Guru

The feature documentation may provide more information.

variable ReceiveThreadPriority#

Pylon::IIntegerEx & ReceiveThreadPriority;

Thread priority of the receive thread - Applies to: GigE.

Thread priority of the receive thread. Only available if the socket driver is used. To assign the priority, the Receive Thread Priority Override parameter must be set to true.

Visibility: Guru

The feature documentation may provide more information.

variable ReceiveThreadPriorityOverride#

Pylon::IBooleanEx & ReceiveThreadPriorityOverride;

Enables assigning a custom priority to the thread which receives incoming stream packets - Applies to: GigE.

Enables assigning a custom priority to the thread which receives incoming stream packets. Only available if the socket driver is used. To assign the priority, use the Receive Thread Priority parameter.

Visibility: Guru

The feature documentation may provide more information.

variable TransferLoopThreadPriority#

Pylon::IIntegerEx & TransferLoopThreadPriority;

Priority of the thread that handles USB requests from the stream interface - Applies to: USB.

Visibility: Guru

The feature documentation may provide more information.

variable UseExtendedIdIfAvailable#

Pylon::IBooleanEx & UseExtendedIdIfAvailable;

Use Extended ID if available in the camera and supported by the driver - Applies to: GigE.

Enabling this setting will use Extended ID if it is supported by the camera and driver. If it is not supported, it will not be used and this setting has no negative side effects.

Visibility: Guru

The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=UseExtendedIdIfAvailable" target="_blank">feature documentation</a> may provide more information.```


### variable DestinationAddr

```cpp
Pylon::IStringEx & DestinationAddr;

IP address to which the stream grabber sends all stream data - Applies to: GigE and blaze.

Visibility: Expert

Selected by: TransmissionType

The feature documentation may provide more information.

variable DestinationPort#

Pylon::IIntegerEx & DestinationPort;

Port to which the stream grabber sends all stream data - Applies to: GigE and blaze.

Port to which the stream grabber sends all stream data. If the parameter is set to zero, pylon automatically selects an unused port.

Visibility: Expert

Selected by: TransmissionType

The feature documentation may provide more information.

variable TransmissionType#

Pylon::IEnumParameterT< TransmissionTypeEnums > & TransmissionType;

Sets how stream data is transferred within the network - Applies to: GigE and blaze.

Sets how stream data is transferred within the network. The stream grabber can send the stream data to one specific device or to multiple devices in the network.

Visibility: Expert

Selecting Parameters: DestinationAddr and DestinationPort

The feature documentation may provide more information.

variable EnableResend#

Pylon::IBooleanEx & EnableResend;

Enables the packet resend mechanism - Applies to: GigE and blaze.

Enables the packet resend mechanism. The pylon GigE Vision Filter Driver and the GigE Vision Performance Driver use different packet resend mechanisms.

Visibility: Expert

The feature documentation may provide more information.

variable FrameRetention#

Pylon::IIntegerEx & FrameRetention;

Maximum time in milliseconds to receive all packets of a frame - Applies to: GigE and blaze.

Maximum time in milliseconds to receive all packets of a frame. The timer starts when the first packet has been received. If the transmission is not completed within the given time, the corresponding frame is delivered with the status 'Failed'.

Visibility: Guru

The feature documentation may provide more information.

variable MaxBufferSize#

Pylon::IIntegerEx & MaxBufferSize;

Maximum size (in bytes) of a buffer used for grabbing images - Applies to: GigE, USB and blaze.

Maximum size (in bytes) of a buffer used for grabbing images. A grab application must set this parameter before grabbing starts.

Visibility: Expert

The feature documentation may provide more information.

variable MaxNumBuffer#

Pylon::IIntegerEx & MaxNumBuffer;

Maximum number of buffers that can be used simultaneously for grabbing images - Applies to: GigE, USB and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable MaximumNumberResendRequests#

Pylon::IIntegerEx & MaximumNumberResendRequests;

Maximum number of resend requests per missing packet - Applies to: GigE and blaze.

Maximum number of resend requests per missing packet. Only available if the pylon GigE Vision Performance Driver is used.

Visibility: Guru

The feature documentation may provide more information.

variable PacketTimeout#

Pylon::IIntegerEx & PacketTimeout;

Timeout period in milliseconds between two packets within one frame - Applies to: GigE and blaze.

Timeout period in milliseconds between two packets within one frame. The timeout is reset each time a packet is received. If the timeout expires, e.g., no packet was received during the given period, the packet resend mechanism takes effect. For more information, see the Enable Resends parameter.

Visibility: Guru

The feature documentation may provide more information.

variable ReceiveWindowSize#

Pylon::IIntegerEx & ReceiveWindowSize;

Size (in frames) of the receive window in which the stream grabber looks for missing packets - Applies to: GigE and blaze.

Size (in frames) of the receive window in which the stream grabber looks for missing packets. Only available if the pylon GigE Vision Performance Driver is used.

Visibility: Guru

The feature documentation may provide more information.

variable ResendRequestBatching#

Pylon::IIntegerEx & ResendRequestBatching;

Amount of packet resend requests to be batched, i e , sent together - Applies to: GigE and blaze.

Amount of packet resend requests to be batched, i.e., sent together. The parameter value is set in percent of the amount of frames between the resend request threshold and the start of the receive window. Only available if the pylon GigE Vision Performance Driver is used.

Visibility: Guru

The feature documentation may provide more information.

variable ResendRequestResponseTimeout#

Pylon::IIntegerEx & ResendRequestResponseTimeout;

Time to wait (in milliseconds) between sending a resend request and considering the request as lost - Applies to: GigE and blaze.

Time to wait (in milliseconds) between sending a resend request and considering the request as lost. Only available if the pylon GigE Vision Performance Driver is used.

Visibility: Guru

The feature documentation may provide more information.

variable ResendRequestThreshold#

Pylon::IIntegerEx & ResendRequestThreshold;

Threshold after which resend requests are initiated - Applies to: GigE and blaze.

Threshold after which resend requests are initiated. The parameter value is set in percent of the receive window size (Receive Window Size parameter). Only available if the pylon GigE Vision Performance Driver is used.

Visibility: Guru

The feature documentation may provide more information.

variable ResendTimeout#

Pylon::IIntegerEx & ResendTimeout;

Time to wait (in milliseconds) between detecting a missing packet and sending a resend request - Applies to: GigE and blaze.

Time to wait (in milliseconds) between detecting a missing packet and sending a resend request. Only available if the pylon GigE Vision Performance Driver is used.

Visibility: Guru

The feature documentation may provide more information.

variable SocketBufferSize#

Pylon::IIntegerEx & SocketBufferSize;

Socket buffer size in kilobytes - Applies to: GigE and blaze.

Socket buffer size in kilobytes. Only available if the socket driver is used.

Visibility: Guru

The feature documentation may provide more information.

variable Type#

Pylon::IEnumParameterT< TypeEnums > & Type;

Sets the driver type to be used by the stream grabber - Applies to: GigE and blaze.

Visibility: Beginner

The feature documentation may provide more information.

variable PayloadSize#

Pylon::IIntegerEx & PayloadSize;

Size of the payload in bytes - Applies to: CoaXPress.

Size of the payload in bytes. This is the total number of bytes of the image data payload produced by the frame grabber. This value is computed by the frame grabber implementation. The pylon stream grabber needs to be open to be able to compute the payload size.

Visibility: Expert

The feature documentation may provide more information.

variable StreamAnnounceBufferMinimum#

Pylon::IIntegerEx & StreamAnnounceBufferMinimum;

Minimum number of buffers to announce to enable selected buffer handling mode - Applies to: CoaXPress and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable StreamAnnouncedBufferCount#

Pylon::IIntegerEx & StreamAnnouncedBufferCount;

Number of announced (known) buffers on this stream - Applies to: CoaXPress and blaze.

Number of announced (known) buffers on this stream. This value is volatile. It may change if additional buffers are announced and/or buffers are revoked by the GenTL Consumer.

Visibility: Expert

The feature documentation may provide more information.

variable StreamBufferAlignment#

Pylon::IIntegerEx & StreamBufferAlignment;

Alignment size in bytes of the buffers passed to DSAnnounceBuffer - Applies to: CoaXPress and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable StreamBufferHandlingMode#

Pylon::IEnumParameterT< StreamBufferHandlingModeEnums > & StreamBufferHandlingMode;

Sets the buffer handling mode of this data stream - Applies to: CoaXPress and blaze.

Visibility: Beginner

The feature documentation may provide more information.

variable StreamChunkCountMaximum#

Pylon::IIntegerEx & StreamChunkCountMaximum;

Maximum number of chunks to be expected in a buffer - Applies to: CoaXPress.

Maximum number of chunks to be expected in a buffer (can be used to allocate the array for the DSGetBufferChunkData function).

Visibility: Expert

The feature documentation may provide more information.

variable StreamDeliveredFrameCount#

Pylon::IIntegerEx & StreamDeliveredFrameCount;

Number of delivered frames since last acquisition start - Applies to: CoaXPress and blaze.

Number of delivered frames since last acquisition start. It isn't reset until the stream is closed.

Visibility: Expert

The feature documentation may provide more information.

variable StreamInputBufferCount#

Pylon::IIntegerEx & StreamInputBufferCount;

Number of buffers in the input buffer pool plus the buffers currently being filled - Applies to: CoaXPress and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable StreamIsGrabbing#

Pylon::IBooleanEx & StreamIsGrabbing;

Indicates whether the acquisition engine is started or not - Applies to: CoaXPress and blaze.

Indicates whether the acquisition engine is started or not. This is independent of the acquisition status of the remote device.

Visibility: Expert

The feature documentation may provide more information.

variable StreamLostFrameCount#

Pylon::IIntegerEx & StreamLostFrameCount;

Number of lost frames due to queue underrun - Applies to: CoaXPress and blaze.

Number of lost frames due to queue underrun. This number is initialized with zero at the time the stream is opened and incremented every time data couldn't be acquired because there was no buffer in the input buffer pool. It isn't reset until the stream is closed.

Visibility: Expert

The feature documentation may provide more information.

variable StreamOutputBufferCount#

Pylon::IIntegerEx & StreamOutputBufferCount;

Number of buffers in the output buffer queue - Applies to: CoaXPress and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable StreamStartedFrameCount#

Pylon::IIntegerEx & StreamStartedFrameCount;

Number of frames started in the acquisition engine - Applies to: CoaXPress and blaze.

Number of frames started in the acquisition engine. This number is incremented every time a new buffer is started and then filled regardless of whether the buffer is later delivered to the user or discarded for any reason. This number is initialized with 0 at at the time the stream is opened. It isn't reset until the stream is closed.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Buffer_Underrun_Count#

Pylon::IIntegerEx & Statistic_Buffer_Underrun_Count;

Number of frames lost because there were no buffers in the queue - Applies to: GigE and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Failed_Buffer_Count#

Pylon::IIntegerEx & Statistic_Failed_Buffer_Count;

GigE cameras: Number of buffers with at least one failed packet A packet is considered failed if its status is not 'success' Other cameras: Number of buffers that returned with an error status - Applies to: GigE, USB and blaze.

GigE cameras: Number of buffers with at least one failed packet. A packet is considered failed if its status is not 'success'. Other cameras: Number of buffers that returned an error.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Failed_Packet_Count#

Pylon::IIntegerEx & Statistic_Failed_Packet_Count;

Number of failed packets - Applies to: GigE and blaze.

Number of failed packets, i.e., the number of packets whose status is not 'success'.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Last_Block_Id#

Pylon::IIntegerEx & Statistic_Last_Block_Id;

Last grabbed block ID - Applies to: USB.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Last_Failed_Buffer_Status#

Pylon::IIntegerEx & Statistic_Last_Failed_Buffer_Status;

Status code of the last failed buffer - Applies to: USB.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Last_Failed_Buffer_Status_Text#

Pylon::IStringEx & Statistic_Last_Failed_Buffer_Status_Text;

Status code of the last failed buffer - Applies to: USB.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Missed_Frame_Count#

Pylon::IIntegerEx & Statistic_Missed_Frame_Count;

Number of corrupt or lost frames between successfully grabbed images - Applies to: USB.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Out_Of_Memory_Error_Count#

Pylon::IIntegerEx & Statistic_Out_Of_Memory_Error_Count;

Number of out-of-memory errors - Applies to: USB.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Resend_Packet_Count#

Pylon::IIntegerEx & Statistic_Resend_Packet_Count;

Number of packets requested by packet resend commands - Applies to: GigE and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Resend_Request_Count#

Pylon::IIntegerEx & Statistic_Resend_Request_Count;

Number of emitted packet resend commands sent - Applies to: GigE and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Resynchronization_Count#

Pylon::IIntegerEx & Statistic_Resynchronization_Count;

Number of stream resynchronizations - Applies to: USB.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Total_Buffer_Count#

Pylon::IIntegerEx & Statistic_Total_Buffer_Count;

GigE cameras: Number of frames received Other cameras: Number of buffers processed - Applies to: GigE, USB and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable Statistic_Total_Packet_Count#

Pylon::IIntegerEx & Statistic_Total_Packet_Count;

Number of packets received - Applies to: GigE and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable StreamID#

Pylon::IStringEx & StreamID;

Device-wide unique ID of the data stream - Applies to: CoaXPress and blaze.

Visibility: Expert

The feature documentation may provide more information.

variable StreamType#

Pylon::IEnumParameterT< StreamTypeEnums > & StreamType;

Sets the transport layer of the data stream - Applies to: CoaXPress.

Visibility: Expert

The feature documentation may provide more information.