Class Spinnaker::TransportLayerStream¶
ClassList > Spinnaker > TransportLayerStream
Part of the QuickSpin API to provide access to camera information without having to first initialize the camera.
#include <TransportLayerStream.h>
Public Attributes¶
Public Functions¶
| Type | Name |
|---|---|
| TransportLayerStream (GenApi::INodeMap * nodeMapTLDevice) |
|
| ~TransportLayerStream () |
Protected Functions¶
| Type | Name |
|---|---|
| TransportLayerStream () |
Public Attributes Documentation¶
variable StreamAnnounceBufferMinimum¶
Description: Minimal number of buffers to announce to enable selected buffer handling mode. Visibility: Expert
variable StreamAnnouncedBufferCount¶
Description: 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
variable StreamBlockTransferSize¶
Description: Controls the image breakup size that should be used on this stream. Visibility: Expert
variable StreamBufferAlignment¶
Description: Alignment size in bytes of the buffer passed to DSAnnounceBuffer. Visibility: Expert
variable StreamBufferCountManual¶
Description: Controls the number of buffers to be used on this stream upon acquisition start when in manual mode. Visibility: Expert
variable StreamBufferCountMax¶
Description: Controls the maximum number of buffers that should be used on this stream. This value is calculated based on the available system memory. Visibility: Expert
variable StreamBufferCountMode¶
GenApi::IEnumerationT<StreamBufferCountModeEnum>& Spinnaker::TransportLayerStream::StreamBufferCountMode;
Description: Controls access to setting the number of buffers used for the stream. Visibility: Expert
variable StreamBufferCountResult¶
Description: Displays the number of buffers to be used on this stream upon acquisition start. Recalculated on acquisition start if in auto mode. Visibility: Expert
variable StreamBufferHandlingMode¶
GenApi::IEnumerationT<StreamBufferHandlingModeEnum>& Spinnaker::TransportLayerStream::StreamBufferHandlingMode;
Description: Available buffer handling modes of this data stream. Visibility: Beginner
variable StreamCRCCheckEnable¶
Description: Enables or disables CRC checks on received images. Visibility: Expert
variable StreamChunkCountMaximum¶
Description: Maximum number of chunks to be expected in a buffer. Visibility: Expert
variable StreamDeliveredFrameCount¶
Description: Number of delivered frames since last acquisition start. It is not reset until the stream is closed. Visibility: Expert
variable StreamDroppedFrameCount¶
Description: Number of frames dropped from the output buffer queue before being processed by the application. This count usually indicates buffer starvation. To reduce dropped frame count, improve the application's image processing speed, release the buffer (image->Release()) as soon as it is not needed, or add more buffers before streaming. This number is initialized with zero when stream is opened and incremented when old data is dropped. It is reset when the stream is closed. Visibility: Expert
variable StreamFrameProcessingTimeLast¶
Description: Time for processing all packets for last block. Visibility: Guru
variable StreamFrameProcessingTimeMax¶
Description: Maximum time for processing all packets for all blocks. Visibility: Guru
variable StreamFrameProcessingTimeMin¶
Description: Minimum time for processing all packets for all blocks. Visibility: Guru
variable StreamFrameReceptionTimeLast¶
Description: Time for receiving all packets for last block. Visibility: Guru
variable StreamFrameReceptionTimeMax¶
Description: Maximum time for receiving all packets for all blocks. Visibility: Guru
variable StreamFrameReceptionTimeMin¶
Description: Minimum time for receiving all packets for all blocks. Visibility: Guru
variable StreamID¶
Description: Device unique ID for the data stream, e.g. a GUID. Visibility: Expert
variable StreamIncompleteFrameCount¶
Description: Displays number of images with missing packet. Visibility: Expert
variable StreamIncompleteFramePacketsMissingThresholdOverrunCount¶
GenApi::IInteger& Spinnaker::TransportLayerStream::StreamIncompleteFramePacketsMissingThresholdOverrunCount;
Description: Number of frames incomplete due to number of missing packets threshold reached. Visibility: Guru
variable StreamIncompleteFramePacketsMissingUnavailableCount¶
GenApi::IInteger& Spinnaker::TransportLayerStream::StreamIncompleteFramePacketsMissingUnavailableCount;
Description: Number of frames incomplete due to missing packets that are no longer available on the streaming device. Visibility: Guru
variable StreamIncompleteFramePayloadProcessingFailedCount¶
GenApi::IInteger& Spinnaker::TransportLayerStream::StreamIncompleteFramePayloadProcessingFailedCount;
Description: Number of frames incomplete due to packet payload processing failed. Visibility: Guru
variable StreamIncompleteFramePayloadTypeNotSupportedCount¶
GenApi::IInteger& Spinnaker::TransportLayerStream::StreamIncompleteFramePayloadTypeNotSupportedCount;
Description: Number of frames incomplete due to packet payload type not supported. Visibility: Guru
variable StreamIncompleteFrameResendRequestQueueOverrunCount¶
GenApi::IInteger& Spinnaker::TransportLayerStream::StreamIncompleteFrameResendRequestQueueOverrunCount;
Description: Number of frames incomplete due to insufficient space in the resend request queue for storing new resend requests following missing packets detection. Visibility: Guru
variable StreamIncompleteFrameResendRequestsThresholdOverrunCount¶
GenApi::IInteger& Spinnaker::TransportLayerStream::StreamIncompleteFrameResendRequestsThresholdOverrunCount;
Description: Number of frames incomplete due to resend requests threshold reached. Visibility: Guru
variable StreamIncompleteFrameTimeoutCount¶
Description: Number of frames incomplete due to timeout expired before all packets for a frame have been received. Visibility: Guru
variable StreamIncompleteFrameTransferQueueOverrunCount¶
Description: Number of frames incomplete due to insufficient resource on the streaming device. Visibility: Guru
variable StreamInputBufferCount¶
Description: Number of buffers in the input buffer pool plus the buffers(s) currently being filled. Visibility: Expert
variable StreamIsGrabbing¶
Description: Flag indicating whether the acquisition engine is started or not. Visibility: Expert
variable StreamLogMessagesEnable¶
Description: Sets the enable state for logging messages for the stream information. Visibility: Guru
variable StreamLostFrameCount¶
Description: Number of times new data could not be acquired and was lost because there was no free buffer in the input buffer pool, or the frame data was never received fully due to data lost. This count usually indicates buffer starvation as well as some other underlying issues causing data lost in transit from the imaging device to the host. To reduce lost frame count, improve the application's image processing speed, release the buffer (image->Release()) as soon as it is not needed, improve the data connection, or use buffer handling modes such as Oldest First Overwrite or Newest First. This number is initialized with zero when the stream is opened and incremented when new data is lost. It is reset when the stream is closed. Visibility: Expert
variable StreamLostFrameReceptionQueueOverrunCount¶
Description: Number of frames dropped due to insufficient space in the reception queue for storing an incoming frame from the streaming device. Visibility: Guru
variable StreamLostFrameReceptionStorageOverrunCount¶
Description: Number of frames dropped due to insufficient space in the reception storage for storing the incoming packets from the streaming device. Visibility: Guru
variable StreamLostFrameTrashedCount¶
Description: Number of frames dropped due to buffer underrun. Visibility: Guru
variable StreamLostFrameUserMessageQueueOverrunCount¶
Description: Number of frames dropped due to insufficient space in the user message queue for storing an outgoing event for the user application. Visibility: Guru
variable StreamMissedPacketCount¶
Description: Displays number of packets missed by this stream. Visibility: Expert
variable StreamMode¶
Description: Stream mode of the device. Visibility: Expert
variable StreamOutputBufferCount¶
Description: Number of buffers in the output buffer queue. Visibility: Expert
variable StreamPacketResendEnable¶
Description: Enables or disables the packet resend mechanism. Visibility: Expert
variable StreamPacketResendMaxRequests¶
Description: Maximum number of resend requests per image. Each resend request consists of a span of consecutive packet IDs. Visibility: Expert
variable StreamPacketResendReceivedPacketCount¶
Description: Displays number of retransmitted packets received on this stream. Visibility: Expert
variable StreamPacketResendRequestCount¶
Description: Displays number of packet resend requests transmitted to the camera. Visibility: Expert
variable StreamPacketResendRequestTimeoutCount¶
Description: Number of resend requests not fully fulfilled before the resend request timeout expired. Visibility: Expert
variable StreamPacketResendRequestedPacketCount¶
Description: Displays number of packets requested to be retransmitted on this stream. Visibility: Expert
variable StreamPacketResendTimeout¶
Description: Time in milliseconds to wait after the image trailer is received and before the image is completed by the driver. Visibility: Expert
variable StreamPacketsDuplicatedCount¶
Description: Number of duplicate packets received from the streaming device. Visibility: Guru
variable StreamPacketsNotYetAvailableCount¶
Description: Number of packets not yet available on the streaming device. Visibility: Guru
variable StreamPacketsPerFrameCount¶
Description: Number of packets per frame. Visibility: Beginner
variable StreamPacketsRejectedCount¶
Description: Number of packets rejected after detecting error in their content. Visibility: Guru
variable StreamPacketsTemporarilyUnavailableCount¶
Description: Number of packets temporarily unavailable on the streaming device. Visibility: Guru
variable StreamPacketsTimeoutCount¶
Description: Number of packets not received before the inter-packet timeout expired. Visibility: Guru
variable StreamPacketsUnavailableCount¶
Description: Number of missing packets no more available on the streaming device. Visibility: Guru
variable StreamReceivedFrameCount¶
Description: Number of successful GVSP data blocks received. Only valid while stream is active. Visibility: Expert
variable StreamReceivedPacketCount¶
Description: Displays number of packets received on this stream. Visibility: Expert
variable StreamResetCounters¶
Description: Resets the stream information counters. Visibility: Beginner
variable StreamStartedFrameCount¶
Description: Number of frames started in the acquisition engine. This number is incremented every time in case of a new buffer is started and then to be filled (data written to) regardless even if the buffer is later delivered to the user or discarded for any reason. This number is initialized with 0 at at the time of the stream is opened. It is not reset until the stream is closed. Visibility: Expert
variable StreamType¶
Description: Stream type of the device. Visibility: Expert
Public Functions Documentation¶
function TransportLayerStream [1/3]¶
function ~TransportLayerStream¶
Protected Functions Documentation¶
function TransportLayerStream [2/3]¶
The documentation for this class was generated from the following file C:/workspace/include/TransportLayerStream.h