Skip to content

Class SpinnakerNET::ManagedTransportLayerStream

ClassList > SpinnakerNET > ManagedTransportLayerStream

Part of the Managed QuickSpin API to provide access to camera information without having to first initialize the camera.

  • #include <ManagedTransportLayerStream.h>

Public Attributes

Type Name
property SpinnakerNET::GenApi::Integer StreamAnnounceBufferMinimum
property SpinnakerNET::GenApi::Integer StreamAnnouncedBufferCount
property SpinnakerNET::GenApi::Integer StreamBlockTransferSize
property SpinnakerNET::GenApi::Integer StreamBufferAlignment
property SpinnakerNET::GenApi::Integer StreamBufferCountManual
property SpinnakerNET::GenApi::Integer StreamBufferCountMax
property SpinnakerNET::GenApi::Enumeration StreamBufferCountMode
property SpinnakerNET::GenApi::Integer StreamBufferCountResult
property SpinnakerNET::GenApi::Enumeration StreamBufferHandlingMode
property SpinnakerNET::GenApi::BoolNode StreamCRCCheckEnable
property SpinnakerNET::GenApi::Integer StreamChunkCountMaximum
property SpinnakerNET::GenApi::Integer StreamDeliveredFrameCount
property SpinnakerNET::GenApi::Integer StreamDroppedFrameCount
property SpinnakerNET::GenApi::Integer StreamFrameProcessingTimeLast
property SpinnakerNET::GenApi::Integer StreamFrameProcessingTimeMax
property SpinnakerNET::GenApi::Integer StreamFrameProcessingTimeMin
property SpinnakerNET::GenApi::Integer StreamFrameReceptionTimeLast
property SpinnakerNET::GenApi::Integer StreamFrameReceptionTimeMax
property SpinnakerNET::GenApi::Integer StreamFrameReceptionTimeMin
property SpinnakerNET::GenApi::StringNode StreamID
property SpinnakerNET::GenApi::Integer StreamIncompleteFrameCount
property SpinnakerNET::GenApi::Integer StreamIncompleteFramePacketsMissingThresholdOverrunCount
property SpinnakerNET::GenApi::Integer StreamIncompleteFramePacketsMissingUnavailableCount
property SpinnakerNET::GenApi::Integer StreamIncompleteFramePayloadProcessingFailedCount
property SpinnakerNET::GenApi::Integer StreamIncompleteFramePayloadTypeNotSupportedCount
property SpinnakerNET::GenApi::Integer StreamIncompleteFrameResendRequestQueueOverrunCount
property SpinnakerNET::GenApi::Integer StreamIncompleteFrameResendRequestsThresholdOverrunCount
property SpinnakerNET::GenApi::Integer StreamIncompleteFrameTimeoutCount
property SpinnakerNET::GenApi::Integer StreamIncompleteFrameTransferQueueOverrunCount
property SpinnakerNET::GenApi::Integer StreamInputBufferCount
property SpinnakerNET::GenApi::BoolNode StreamIsGrabbing
property SpinnakerNET::GenApi::BoolNode StreamLogMessagesEnable
property SpinnakerNET::GenApi::Integer StreamLostFrameCount
property SpinnakerNET::GenApi::Integer StreamLostFrameReceptionQueueOverrunCount
property SpinnakerNET::GenApi::Integer StreamLostFrameReceptionStorageOverrunCount
property SpinnakerNET::GenApi::Integer StreamLostFrameTrashedCount
property SpinnakerNET::GenApi::Integer StreamLostFrameUserMessageQueueOverrunCount
property SpinnakerNET::GenApi::Integer StreamMissedPacketCount
property SpinnakerNET::GenApi::Enumeration StreamMode
property SpinnakerNET::GenApi::Integer StreamOutputBufferCount
property SpinnakerNET::GenApi::BoolNode StreamPacketResendEnable
property SpinnakerNET::GenApi::Integer StreamPacketResendMaxRequests
property SpinnakerNET::GenApi::Integer StreamPacketResendReceivedPacketCount
property SpinnakerNET::GenApi::Integer StreamPacketResendRequestCount
property SpinnakerNET::GenApi::Integer StreamPacketResendRequestTimeoutCount
property SpinnakerNET::GenApi::Integer StreamPacketResendRequestedPacketCount
property SpinnakerNET::GenApi::Integer StreamPacketResendTimeout
property SpinnakerNET::GenApi::Integer StreamPacketsDuplicatedCount
property SpinnakerNET::GenApi::Integer StreamPacketsNotYetAvailableCount
property SpinnakerNET::GenApi::Integer StreamPacketsPerFrameCount
property SpinnakerNET::GenApi::Integer StreamPacketsRejectedCount
property SpinnakerNET::GenApi::Integer StreamPacketsTemporarilyUnavailableCount
property SpinnakerNET::GenApi::Integer StreamPacketsTimeoutCount
property SpinnakerNET::GenApi::Integer StreamPacketsUnavailableCount
property SpinnakerNET::GenApi::Integer StreamReceivedFrameCount
property SpinnakerNET::GenApi::Integer StreamReceivedPacketCount
property SpinnakerNET::GenApi::Command StreamResetCounters
property SpinnakerNET::GenApi::Integer StreamStartedFrameCount
property SpinnakerNET::GenApi::Enumeration StreamType

Public Functions

Type Name
ManagedTransportLayerStream (SpinnakerNET::GenApi::NodeMap^ pNodeMapTLDevice)
virtual ~ManagedTransportLayerStream ()

Public Attributes Documentation

variable StreamAnnounceBufferMinimum

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamAnnounceBufferMinimum;

Description: Minimal number of buffers to announce to enable selected buffer handling mode. Visibility: Expert


variable StreamAnnouncedBufferCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamBlockTransferSize;

Description: Controls the image breakup size that should be used on this stream. Visibility: Expert


variable StreamBufferAlignment

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamBufferAlignment;

Description: Alignment size in bytes of the buffer passed to DSAnnounceBuffer. Visibility: Expert


variable StreamBufferCountManual

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamBufferCountManual;

Description: Controls the number of buffers to be used on this stream upon acquisition start when in manual mode. Visibility: Expert


variable StreamBufferCountMax

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Enumeration SpinnakerNET::ManagedTransportLayerStream::StreamBufferCountMode;

Description: Controls access to setting the number of buffers used for the stream. Visibility: Expert


variable StreamBufferCountResult

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Enumeration SpinnakerNET::ManagedTransportLayerStream::StreamBufferHandlingMode;

Description: Available buffer handling modes of this data stream. Visibility: Beginner


variable StreamCRCCheckEnable

virtual property SpinnakerNET::GenApi::BoolNode SpinnakerNET::ManagedTransportLayerStream::StreamCRCCheckEnable;

Description: Enables or disables CRC checks on received images. Visibility: Expert


variable StreamChunkCountMaximum

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamChunkCountMaximum;

Description: Maximum number of chunks to be expected in a buffer. Visibility: Expert


variable StreamDeliveredFrameCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamDeliveredFrameCount;

Description: Number of delivered frames since last acquisition start. It is not reset until the stream is closed. Visibility: Expert


variable StreamDroppedFrameCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamFrameProcessingTimeLast;

Description: Time for processing all packets for last block. Visibility: Guru


variable StreamFrameProcessingTimeMax

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamFrameProcessingTimeMax;

Description: Maximum time for processing all packets for all blocks. Visibility: Guru


variable StreamFrameProcessingTimeMin

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamFrameProcessingTimeMin;

Description: Minimum time for processing all packets for all blocks. Visibility: Guru


variable StreamFrameReceptionTimeLast

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamFrameReceptionTimeLast;

Description: Time for receiving all packets for last block. Visibility: Guru


variable StreamFrameReceptionTimeMax

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamFrameReceptionTimeMax;

Description: Maximum time for receiving all packets for all blocks. Visibility: Guru


variable StreamFrameReceptionTimeMin

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamFrameReceptionTimeMin;

Description: Minimum time for receiving all packets for all blocks. Visibility: Guru


variable StreamID

virtual property SpinnakerNET::GenApi::StringNode SpinnakerNET::ManagedTransportLayerStream::StreamID;

Description: Device unique ID for the data stream, e.g. a GUID. Visibility: Expert


variable StreamIncompleteFrameCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamIncompleteFrameCount;

Description: Displays number of images with missing packet. Visibility: Expert


variable StreamIncompleteFramePacketsMissingThresholdOverrunCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamIncompleteFramePacketsMissingThresholdOverrunCount;

Description: Number of frames incomplete due to number of missing packets threshold reached. Visibility: Guru


variable StreamIncompleteFramePacketsMissingUnavailableCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamIncompleteFramePacketsMissingUnavailableCount;

Description: Number of frames incomplete due to missing packets that are no longer available on the streaming device. Visibility: Guru


variable StreamIncompleteFramePayloadProcessingFailedCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamIncompleteFramePayloadProcessingFailedCount;

Description: Number of frames incomplete due to packet payload processing failed. Visibility: Guru


variable StreamIncompleteFramePayloadTypeNotSupportedCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamIncompleteFramePayloadTypeNotSupportedCount;

Description: Number of frames incomplete due to packet payload type not supported. Visibility: Guru


variable StreamIncompleteFrameResendRequestQueueOverrunCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamIncompleteFrameResendRequestsThresholdOverrunCount;

Description: Number of frames incomplete due to resend requests threshold reached. Visibility: Guru


variable StreamIncompleteFrameTimeoutCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamIncompleteFrameTimeoutCount;

Description: Number of frames incomplete due to timeout expired before all packets for a frame have been received. Visibility: Guru


variable StreamIncompleteFrameTransferQueueOverrunCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamIncompleteFrameTransferQueueOverrunCount;

Description: Number of frames incomplete due to insufficient resource on the streaming device. Visibility: Guru


variable StreamInputBufferCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamInputBufferCount;

Description: Number of buffers in the input buffer pool plus the buffers(s) currently being filled. Visibility: Expert


variable StreamIsGrabbing

virtual property SpinnakerNET::GenApi::BoolNode SpinnakerNET::ManagedTransportLayerStream::StreamIsGrabbing;

Description: Flag indicating whether the acquisition engine is started or not. Visibility: Expert


variable StreamLogMessagesEnable

virtual property SpinnakerNET::GenApi::BoolNode SpinnakerNET::ManagedTransportLayerStream::StreamLogMessagesEnable;

Description: Sets the enable state for logging messages for the stream information. Visibility: Guru


variable StreamLostFrameCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamLostFrameTrashedCount;

Description: Number of frames dropped due to buffer underrun. Visibility: Guru


variable StreamLostFrameUserMessageQueueOverrunCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamMissedPacketCount;

Description: Displays number of packets missed by this stream. Visibility: Expert


variable StreamMode

virtual property SpinnakerNET::GenApi::Enumeration SpinnakerNET::ManagedTransportLayerStream::StreamMode;

Description: Stream mode of the device. Visibility: Expert


variable StreamOutputBufferCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamOutputBufferCount;

Description: Number of buffers in the output buffer queue. Visibility: Expert


variable StreamPacketResendEnable

virtual property SpinnakerNET::GenApi::BoolNode SpinnakerNET::ManagedTransportLayerStream::StreamPacketResendEnable;

Description: Enables or disables the packet resend mechanism. Visibility: Expert


variable StreamPacketResendMaxRequests

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketResendMaxRequests;

Description: Maximum number of resend requests per image. Each resend request consists of a span of consecutive packet IDs. Visibility: Expert


variable StreamPacketResendReceivedPacketCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketResendReceivedPacketCount;

Description: Displays number of retransmitted packets received on this stream. Visibility: Expert


variable StreamPacketResendRequestCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketResendRequestCount;

Description: Displays number of packet resend requests transmitted to the camera. Visibility: Expert


variable StreamPacketResendRequestTimeoutCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketResendRequestTimeoutCount;

Description: Number of resend requests not fully fulfilled before the resend request timeout expired. Visibility: Expert


variable StreamPacketResendRequestedPacketCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketResendRequestedPacketCount;

Description: Displays number of packets requested to be retransmitted on this stream. Visibility: Expert


variable StreamPacketResendTimeout

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketsDuplicatedCount;

Description: Number of duplicate packets received from the streaming device. Visibility: Guru


variable StreamPacketsNotYetAvailableCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketsNotYetAvailableCount;

Description: Number of packets not yet available on the streaming device. Visibility: Guru


variable StreamPacketsPerFrameCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketsPerFrameCount;

Description: Number of packets per frame. Visibility: Beginner


variable StreamPacketsRejectedCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketsRejectedCount;

Description: Number of packets rejected after detecting error in their content. Visibility: Guru


variable StreamPacketsTemporarilyUnavailableCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketsTemporarilyUnavailableCount;

Description: Number of packets temporarily unavailable on the streaming device. Visibility: Guru


variable StreamPacketsTimeoutCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketsTimeoutCount;

Description: Number of packets not received before the inter-packet timeout expired. Visibility: Guru


variable StreamPacketsUnavailableCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamPacketsUnavailableCount;

Description: Number of missing packets no more available on the streaming device. Visibility: Guru


variable StreamReceivedFrameCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamReceivedFrameCount;

Description: Number of successful GVSP data blocks received. Only valid while stream is active. Visibility: Expert


variable StreamReceivedPacketCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::StreamReceivedPacketCount;

Description: Displays number of packets received on this stream. Visibility: Expert


variable StreamResetCounters

virtual property SpinnakerNET::GenApi::Command SpinnakerNET::ManagedTransportLayerStream::StreamResetCounters;

Description: Resets the stream information counters. Visibility: Beginner


variable StreamStartedFrameCount

virtual property SpinnakerNET::GenApi::Integer SpinnakerNET::ManagedTransportLayerStream::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

virtual property SpinnakerNET::GenApi::Enumeration SpinnakerNET::ManagedTransportLayerStream::StreamType;

Description: Stream type of the device. Visibility: Expert


Public Functions Documentation

function ManagedTransportLayerStream

inline SpinnakerNET::ManagedTransportLayerStream::ManagedTransportLayerStream (
    SpinnakerNET::GenApi::NodeMap ^ pNodeMapTLDevice
) 

function ~ManagedTransportLayerStream

inline virtual SpinnakerNET::ManagedTransportLayerStream::~ManagedTransportLayerStream () 


The documentation for this class was generated from the following file /workspace/src/SpinnakerNET/ManagedTransportLayerStream.h