![]() |
![]() |
A parameter class containing all parameters as members that are available for pylon stream grabbers. More...
#include <pylon/_BaslerUniversalStreamParams.h>
Public Attributes | |
Categories: Debug | |
Pylon::IEnumParameterT< AccessModeEnums > & | AccessMode |
Indicates the mode of access the current application has to the device - Applies to: GigE. More... | |
Pylon::IEnumParameterT< StatusEnums > & | Status |
Indicates the current status of the stream grabber - Applies to: GigE. More... | |
Pylon::IIntegerEx & | TypeIsSocketDriverAvailable |
Indicates whether the socket driver is currently available - Applies to: GigE. More... | |
Pylon::IIntegerEx & | TypeIsWindowsFilterDriverAvailable |
Indicates whether the pylon GigE Vision Filter Driver is currently available - Applies to: GigE. More... | |
Pylon::IIntegerEx & | TypeIsWindowsIntelPerformanceDriverAvailable |
Indicates whether the pylon GigE Vision Performance Driver is currently available - Applies to: GigE. More... | |
Categories: Root | |
Pylon::IBooleanEx & | AutoPacketSize |
Enables negotiation of the packet size to find the largest possible packet size - Applies to: GigE. More... | |
Pylon::IBooleanEx & | EnableResend |
Enables the packet resend mechanism - Applies to: GigE. More... | |
Pylon::IIntegerEx & | FrameRetention |
Maximum time in milliseconds to receive all packets of a frame - Applies to: GigE. More... | |
Pylon::IIntegerEx & | MaxBufferSize |
Maximum size (in bytes) of a buffer used for grabbing images - Applies to: BCON, GigE and USB. More... | |
Pylon::IIntegerEx & | MaxNumBuffer |
Maximum number of buffers that can be used simultaneously for grabbing images - Applies to: BCON, GigE and USB. More... | |
Pylon::IIntegerEx & | MaxTransferSize |
Maximum USB data transfer size in bytes - Applies to: USB. More... | |
Pylon::IIntegerEx & | MaximumNumberResendRequests |
Maximum number of resend requests per missing packet - Applies to: GigE. More... | |
Pylon::IIntegerEx & | NumMaxQueuedUrbs |
Maximum number of USB request blocks (URBs) to be enqueued simultaneously - Applies to: USB. More... | |
Pylon::IIntegerEx & | PacketTimeout |
Timeout period in milliseconds between two packets within one frame - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ReceiveThreadPriority |
Thread priority of the receive thread - Applies to: GigE. More... | |
Pylon::IBooleanEx & | ReceiveThreadPriorityOverride |
Enables assigning a custom priority to the thread which receives incoming stream packets - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ReceiveWindowSize |
Size (in frames) of the receive window in which the stream grabber looks for missing packets - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ResendRequestBatching |
Amount of packet resend requests to be batched, i e , sent together - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ResendRequestResponseTimeout |
Time to wait (in milliseconds) between sending a resend request and considering the request as lost - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ResendRequestThreshold |
Threshold after which resend requests are initiated - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ResendTimeout |
Time to wait (in milliseconds) between detecting a missing packet and sending a resend request - Applies to: GigE. More... | |
Pylon::IIntegerEx & | SocketBufferSize |
Socket buffer size in kilobytes - Applies to: GigE. More... | |
Pylon::IIntegerEx & | TransferLoopThreadPriority |
Priority of the thread that handles USB requests from the stream interface - Applies to: USB. More... | |
Pylon::IEnumParameterT< TypeEnums > & | Type |
Sets the driver type to be used by the stream grabber - Applies to: GigE. More... | |
Categories: GrabberSettings | |
Pylon::IIntegerEx & | ClockFrequency |
Clock frequency on the host side in Hertz - Applies to: BCON. More... | |
Pylon::IIntegerEx & | Height |
Height of the image ROI on the host side - Applies to: BCON. More... | |
Pylon::IIntegerEx & | PixelFormatValue |
Pixel format on the host side - Applies to: BCON. More... | |
Pylon::IEnumParameterT< PixelPerClockCycleEnums > & | PixelPerClockCycle |
Sets the number of pixels per clock cycle on the host side - Applies to: BCON. More... | |
Pylon::IIntegerEx & | Width |
Width of the image ROI on the host side - Applies to: BCON. More... | |
Categories: IPConfig | |
Pylon::IStringEx & | DestinationAddr |
IP address to which the stream grabber sends all stream data - Applies to: GigE. More... | |
Pylon::IIntegerEx & | DestinationPort |
Port to which the stream grabber sends all stream data - Applies to: GigE. More... | |
Pylon::IEnumParameterT< TransmissionTypeEnums > & | TransmissionType |
Sets how stream data is transferred within the network - Applies to: GigE. More... | |
Categories: BufferHandlingControl and GrabberSettings | |
Pylon::IIntegerEx & | PayloadSize |
Size of the payload in bytes - Applies to: BCON and CoaXPress. More... | |
Categories: Statistic | |
Pylon::IIntegerEx & | Statistic_Buffer_Underrun_Count |
Number of frames lost because there were no buffers in the queue - Applies to: GigE. More... | |
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: BCON, GigE and USB. More... | |
Pylon::IIntegerEx & | Statistic_Failed_Packet_Count |
Number of failed packets - Applies to: GigE. More... | |
Pylon::IIntegerEx & | Statistic_Last_Block_Id |
Last grabbed block ID - Applies to: BCON and USB. More... | |
Pylon::IIntegerEx & | Statistic_Last_Failed_Buffer_Status |
Status code of the last failed buffer - Applies to: BCON and USB. More... | |
Pylon::IStringEx & | Statistic_Last_Failed_Buffer_Status_Text |
Status code of the last failed buffer - Applies to: BCON and USB. More... | |
Pylon::IIntegerEx & | Statistic_Missed_Frame_Count |
Number of corrupt or lost frames between successfully grabbed images - Applies to: BCON and USB. More... | |
Pylon::IIntegerEx & | Statistic_Out_Of_Memory_Error_Count |
Number of out-of-memory errors - Applies to: USB. More... | |
Pylon::IIntegerEx & | Statistic_Resend_Packet_Count |
Number of packets requested by packet resend commands - Applies to: GigE. More... | |
Pylon::IIntegerEx & | Statistic_Resend_Request_Count |
Number of emitted packet resend commands sent - Applies to: GigE. More... | |
Pylon::IIntegerEx & | Statistic_Resynchronization_Count |
Number of stream resynchronizations - Applies to: USB. More... | |
Pylon::IIntegerEx & | Statistic_Total_Buffer_Count |
GigE cameras: Number of frames received Other cameras: Number of buffers processed - Applies to: BCON, GigE and USB. More... | |
Pylon::IIntegerEx & | Statistic_Total_Packet_Count |
Number of packets received - Applies to: GigE. More... | |
Categories: BufferHandlingControl | |
Pylon::IIntegerEx & | StreamAnnounceBufferMinimum |
Minimum number of buffers to announce to enable selected buffer handling mode - Applies to: CoaXPress. More... | |
Pylon::IIntegerEx & | StreamAnnouncedBufferCount |
Number of announced (known) buffers on this stream - Applies to: CoaXPress. More... | |
Pylon::IIntegerEx & | StreamBufferAlignment |
Alignment size in bytes of the buffers passed to DSAnnounceBuffer - Applies to: CoaXPress. More... | |
Pylon::IEnumParameterT< StreamBufferHandlingModeEnums > & | StreamBufferHandlingMode |
Sets the buffer handling mode of this data stream - Applies to: CoaXPress. More... | |
Pylon::IIntegerEx & | StreamChunkCountMaximum |
Maximum number of chunks to be expected in a buffer - Applies to: CoaXPress. More... | |
Pylon::IIntegerEx & | StreamDeliveredFrameCount |
Number of delivered frames since last acquisition start - Applies to: CoaXPress. More... | |
Pylon::IIntegerEx & | StreamInputBufferCount |
Number of buffers in the input buffer pool plus the buffers currently being filled - Applies to: CoaXPress. More... | |
Pylon::IBooleanEx & | StreamIsGrabbing |
Indicates whether the acquisition engine is started or not - Applies to: CoaXPress. More... | |
Pylon::IIntegerEx & | StreamLostFrameCount |
Number of lost frames due to queue underrun - Applies to: CoaXPress. More... | |
Pylon::IIntegerEx & | StreamOutputBufferCount |
Number of buffers in the output buffer queue - Applies to: CoaXPress. More... | |
Pylon::IIntegerEx & | StreamStartedFrameCount |
Number of frames started in the acquisition engine - Applies to: CoaXPress. More... | |
Categories: StreamInformation | |
Pylon::IStringEx & | StreamID |
Device-wide unique ID of the data stream - Applies to: CoaXPress. More... | |
Pylon::IEnumParameterT< StreamTypeEnums > & | StreamType |
Sets the transport layer of the data stream - Applies to: CoaXPress. More... | |
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.
|
inherited |
Indicates the mode of access the current application has to the device - Applies to: GigE.
Visibility: Guru
The Basler Product Documentation may provide more information.
|
inherited |
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 Basler Product Documentation may provide more information.
|
inherited |
Clock frequency on the host side in Hertz - Applies to: BCON.
Clock frequency on the host side in Hertz. This parameter is linked with the BconClockFrequency camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
IP address to which the stream grabber sends all stream data - Applies to: GigE.
Visibility: Expert
Selected by: TransmissionType
The Basler Product Documentation may provide more information.
|
inherited |
Port to which the stream grabber sends all stream data - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Enables the packet resend mechanism - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Maximum time in milliseconds to receive all packets of a frame - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Height of the image ROI on the host side - Applies to: BCON.
Height of the image ROI on the host side. This parameter is linked with the Height camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Maximum size (in bytes) of a buffer used for grabbing images - Applies to: BCON, GigE and USB.
Maximum size (in bytes) of a buffer used for grabbing images. A grab application must set this parameter before grabbing starts.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Maximum number of resend requests per missing packet - Applies to: GigE.
Maximum number of resend requests per missing packet. Only available if the pylon GigE Vision Performance Driver is used.
Visibility: Guru
The Basler Product Documentation may provide more information.
|
inherited |
Maximum number of buffers that can be used simultaneously for grabbing images - Applies to: BCON, GigE and USB.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
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 Basler Product Documentation may provide more information.
|
inherited |
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 Basler Product Documentation may provide more information.
|
inherited |
Timeout period in milliseconds between two packets within one frame - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Size of the payload in bytes - Applies to: BCON and 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 Basler Product Documentation may provide more information.
|
inherited |
Pixel format on the host side - Applies to: BCON.
Pixel format on the host side. This parameter is linked with the Pixel Format camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Sets the number of pixels per clock cycle on the host side - Applies to: BCON.
Sets the number of pixels per clock cycle on the host side. This parameter is linked with the Pixels per Clock Cycle camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
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 Basler Product Documentation may provide more information.
|
inherited |
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 Basler Product Documentation may provide more information.
|
inherited |
Size (in frames) of the receive window in which the stream grabber looks for missing packets - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Amount of packet resend requests to be batched, i e , sent together - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Time to wait (in milliseconds) between sending a resend request and considering the request as lost - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Threshold after which resend requests are initiated - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Time to wait (in milliseconds) between detecting a missing packet and sending a resend request - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Socket buffer size in kilobytes - Applies to: GigE.
Socket buffer size in kilobytes. Only available if the socket driver is used.
Visibility: Guru
The Basler Product Documentation may provide more information.
|
inherited |
Number of frames lost because there were no buffers in the queue - Applies to: GigE.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
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: BCON, GigE and USB.
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 Basler Product Documentation may provide more information.
|
inherited |
Number of failed packets - Applies to: GigE.
Number of failed packets, i.e., the number of packets whose status is not 'success'.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Last grabbed block ID - Applies to: BCON and USB.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Status code of the last failed buffer - Applies to: BCON and USB.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Status code of the last failed buffer - Applies to: BCON and USB.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of corrupt or lost frames between successfully grabbed images - Applies to: BCON and USB.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of out-of-memory errors - Applies to: USB.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of packets requested by packet resend commands - Applies to: GigE.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of emitted packet resend commands sent - Applies to: GigE.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of stream resynchronizations - Applies to: USB.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
GigE cameras: Number of frames received Other cameras: Number of buffers processed - Applies to: BCON, GigE and USB.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of packets received - Applies to: GigE.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Indicates the current status of the stream grabber - Applies to: GigE.
Visibility: Guru
The Basler Product Documentation may provide more information.
|
inherited |
Minimum number of buffers to announce to enable selected buffer handling mode - Applies to: CoaXPress.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of announced (known) buffers on this stream - Applies to: CoaXPress.
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 Basler Product Documentation may provide more information.
|
inherited |
Alignment size in bytes of the buffers passed to DSAnnounceBuffer - Applies to: CoaXPress.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Sets the buffer handling mode of this data stream - Applies to: CoaXPress.
Visibility: Beginner
The Basler Product Documentation may provide more information.
|
inherited |
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 Basler Product Documentation may provide more information.
|
inherited |
Number of delivered frames since last acquisition start - Applies to: CoaXPress.
Number of delivered frames since last acquisition start. It isn't reset until the stream is closed.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Device-wide unique ID of the data stream - Applies to: CoaXPress.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of buffers in the input buffer pool plus the buffers currently being filled - Applies to: CoaXPress.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Indicates whether the acquisition engine is started or not - Applies to: CoaXPress.
Indicates whether the acquisition engine is started or not. This is independent of the acquisition status of the remote device.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of lost frames due to queue underrun - Applies to: CoaXPress.
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 Basler Product Documentation may provide more information.
|
inherited |
Number of buffers in the output buffer queue - Applies to: CoaXPress.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Number of frames started in the acquisition engine - Applies to: CoaXPress.
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 Basler Product Documentation may provide more information.
|
inherited |
Sets the transport layer of the data stream - Applies to: CoaXPress.
Visibility: Expert
The Basler Product Documentation may provide more information.
|
inherited |
Priority of the thread that handles USB requests from the stream interface - Applies to: USB.
Visibility: Guru
The Basler Product Documentation may provide more information.
|
inherited |
Sets how stream data is transferred within the network - Applies to: GigE.
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 Basler Product Documentation may provide more information.
|
inherited |
Sets the driver type to be used by the stream grabber - Applies to: GigE.
Visibility: Beginner
The Basler Product Documentation may provide more information.
|
inherited |
Indicates whether the socket driver is currently available - Applies to: GigE.
Visibility: Guru
The Basler Product Documentation may provide more information.
|
inherited |
Indicates whether the pylon GigE Vision Filter Driver is currently available - Applies to: GigE.
Visibility: Guru
The Basler Product Documentation may provide more information.
|
inherited |
Indicates whether the pylon GigE Vision Performance Driver is currently available - Applies to: GigE.
Visibility: Guru
The Basler Product Documentation may provide more information.
|
inherited |
Width of the image ROI on the host side - Applies to: BCON.
Width of the image ROI on the host side. This parameter is linked with the Width camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
Visibility: Expert
The Basler Product Documentation may provide more information.