Interface to the PylonGigE Stream Grabber parameters. More...
#include <pylon/gige/_GigEStreamParams.h>
Public Attributes | |
Root - Interface to the GigE specific stream parameters. | |
GenApi::IEnumerationT < TypeEnums > & | Type |
Selects the driver type to be used. More... | |
GenApi::IInteger & | MaxNumBuffer |
The maximum number of buffers that can be used simultaneously. More... | |
GenApi::IInteger & | MaxBufferSize |
The maximum buffer size in bytes that can be registered. More... | |
GenApi::IBoolean & | EnableResend |
Enables or disables the packet resend mechanism. More... | |
GenApi::IInteger & | PacketTimeout |
Timeout period in milliseconds between two packets within one frame. More... | |
GenApi::IBoolean & | AutoPacketSize |
Enables or disables probing of a working large packet size before grabbing. More... | |
GenApi::IInteger & | ReceiveWindowSize |
Size of the sliding receive window in number of frames. More... | |
GenApi::IInteger & | ResendRequestThreshold |
Resend threshold as percentage of receive window. More... | |
GenApi::IInteger & | ResendRequestBatching |
Additional resend batching as percentage of threshold. More... | |
GenApi::IInteger & | ResendTimeout |
Time in milliseconds to wait until a resend request is issued. More... | |
GenApi::IInteger & | ResendRequestResponseTimeout |
Timeout in milliseconds for missing resend responses. More... | |
GenApi::IInteger & | MaximumNumberResendRequests |
Maximum number of resend requests per packet. More... | |
GenApi::IInteger & | FrameRetention |
Maximum time in milliseconds to receive all packets of an individual frame. More... | |
GenApi::IBoolean & | ReceiveThreadPriorityOverride |
If enabled, the user can set a custom priority of the receive thread. More... | |
GenApi::IInteger & | ReceiveThreadPriority |
The realtime receive thread priority. More... | |
GenApi::IInteger & | SocketBufferSize |
The socket buffer size in KB. More... | |
Debug - Shows information for debugging purposes. | |
GenApi::IEnumerationT < StatusEnums > & | Status |
Shows the current stream grabber status. More... | |
GenApi::IEnumerationT < AccessModeEnums > & | AccessMode |
Camera access mode. More... | |
GenApi::IInteger & | TypeIsWindowsIntelPerformanceDriverAvailable |
Specifies whether the Pylon GigE Vision Performance Driver for Intel network controllers is currently available. More... | |
GenApi::IInteger & | TypeIsWindowsFilterDriverAvailable |
Specifies whether the Pylon GigE Vision Streaming Filter Driver is currently available. More... | |
GenApi::IInteger & | TypeIsSocketDriverAvailable |
Specifies whether the socket driver is currently available. More... | |
Statistic - Statistical data. | |
GenApi::IInteger & | Statistic_Total_Buffer_Count |
Counts the number of received frames. More... | |
GenApi::IInteger & | Statistic_Failed_Buffer_Count |
Counts the number of buffers with at least one failed packet (status != success). More... | |
GenApi::IInteger & | Statistic_Buffer_Underrun_Count |
Counts the number of frames lost because there were no buffers queued to the driver. More... | |
GenApi::IInteger & | Statistic_Total_Packet_Count |
Counts the number of received packets. More... | |
GenApi::IInteger & | Statistic_Failed_Packet_Count |
Counts the number of failed packets (status != success). More... | |
GenApi::IInteger & | Statistic_Resend_Request_Count |
Counts the number of emitted PACKETRESEND commands. More... | |
GenApi::IInteger & | Statistic_Resend_Packet_Count |
Counts the number of packets requested by PACKETRESEND commands. More... | |
IPConfig - Configuration of the stream destination. | |
GenApi::IEnumerationT < TransmissionTypeEnums > & | TransmissionType |
Controls whether the stream data is sent to a single device or to multiple devices. More... | |
GenApi::IString & | DestinationAddr |
Specifies the destination IP address. More... | |
GenApi::IInteger & | DestinationPort |
Specifies the destination port number (0 = auto select). More... | |
Interface to the PylonGigE Stream Grabber parameters.
GenApi::IEnumerationT<AccessModeEnums >& Basler_GigEStreamParams::CGigEStreamParams_Params::AccessMode |
Camera access mode.
Visibility = Guru
GenApi::IBoolean& Basler_GigEStreamParams::CGigEStreamParams_Params::AutoPacketSize |
Enables or disables probing of a working large packet size before grabbing.
Enables or disables probing of a working large packet size before grabbing. Using large packets reduces the overhead for transferring images but whether a large packet can be transported depends on the used network hardware and its configuration.
Visibility = Guru
GenApi::IString& Basler_GigEStreamParams::CGigEStreamParams_Params::DestinationAddr |
Specifies the destination IP address.
The camera will sent all stream data to this IP address. For more details see 'TransmissionType' feature.
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::DestinationPort |
Specifies the destination port number (0 = auto select).
The camera will sent all stream data to this port.
Port configuration:
Visibility = Expert
GenApi::IBoolean& Basler_GigEStreamParams::CGigEStreamParams_Params::EnableResend |
Enables or disables the packet resend mechanism.
An image frame consists of n numbers of packets. Each packet has a header consisting of a 24-bit packet ID. This packet ID increases with each packet sent, and makes it possible for the receiving end to know if a particular packet has been lost during the transfer. If 'ResendPacketMechanism' is enabled, and the receiving end notices a lost packet, it will request the other side (e.g. the camera) to send the lost packet again. If enabled, the 'ResendPacketMechanism' can cause delays in the timing because the sending end will resend the lost packet. If disabled, image data packet(s) can get lost which results in an incomplete received frame. You have to weigh the disadvantages and advantages for your special application to decide whether to enable or disable this command.
Default setting: Enabled
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::FrameRetention |
Maximum time in milliseconds to receive all packets of an individual frame.
An image frame consists of n numbers of packets. The 'FrameRetention' always starts from the point in time the receiving end notices that a packet has been received for a particular frame. If the transmission of packets of a frame is not completed within the 'FrameRetention' time, the corresponding frame is delivered with status 'Failed'.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::MaxBufferSize |
The maximum buffer size in bytes that can be registered.
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::MaximumNumberResendRequests |
Maximum number of resend requests per packet.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::MaxNumBuffer |
The maximum number of buffers that can be used simultaneously.
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::PacketTimeout |
Timeout period in milliseconds between two packets within one frame.
An image frame consists of n numbers of packets. The packet timeout counting is (re)started each time a packet is received. If the timeout expires (e.g. no packet was received during the last 'PacketTimeout' period), the 'Resend Packet Mechanism' is started. For information, see the 'EnableResend' feature.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::ReceiveThreadPriority |
The realtime receive thread priority.
This value sets the absolute thread priority of the receive thread.
Visibility = Guru
GenApi::IBoolean& Basler_GigEStreamParams::CGigEStreamParams_Params::ReceiveThreadPriorityOverride |
If enabled, the user can set a custom priority of the receive thread.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::ReceiveWindowSize |
Size of the sliding receive window in number of frames.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::ResendRequestBatching |
Additional resend batching as percentage of threshold.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::ResendRequestResponseTimeout |
Timeout in milliseconds for missing resend responses.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::ResendRequestThreshold |
Resend threshold as percentage of receive window.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::ResendTimeout |
Time in milliseconds to wait until a resend request is issued.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::SocketBufferSize |
The socket buffer size in KB.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::Statistic_Buffer_Underrun_Count |
Counts the number of frames lost because there were no buffers queued to the driver.
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::Statistic_Failed_Buffer_Count |
Counts the number of buffers with at least one failed packet (status != success).
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::Statistic_Failed_Packet_Count |
Counts the number of failed packets (status != success).
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::Statistic_Resend_Packet_Count |
Counts the number of packets requested by PACKETRESEND commands.
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::Statistic_Resend_Request_Count |
Counts the number of emitted PACKETRESEND commands.
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::Statistic_Total_Buffer_Count |
Counts the number of received frames.
Visibility = Expert
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::Statistic_Total_Packet_Count |
Counts the number of received packets.
Visibility = Expert
GenApi::IEnumerationT<StatusEnums >& Basler_GigEStreamParams::CGigEStreamParams_Params::Status |
Shows the current stream grabber status.
Visibility = Guru
GenApi::IEnumerationT<TransmissionTypeEnums >& Basler_GigEStreamParams::CGigEStreamParams_Params::TransmissionType |
Controls whether the stream data is sent to a single device or to multiple devices.
Visibility = Expert
GenApi::IEnumerationT<TypeEnums >& Basler_GigEStreamParams::CGigEStreamParams_Params::Type |
Selects the driver type to be used.
Visibility = Beginner
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::TypeIsSocketDriverAvailable |
Specifies whether the socket driver is currently available.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::TypeIsWindowsFilterDriverAvailable |
Specifies whether the Pylon GigE Vision Streaming Filter Driver is currently available.
Visibility = Guru
GenApi::IInteger& Basler_GigEStreamParams::CGigEStreamParams_Params::TypeIsWindowsIntelPerformanceDriverAvailable |
Specifies whether the Pylon GigE Vision Performance Driver for Intel network controllers is currently available.
Visibility = Guru