 |
|
Spinnaker SDK C++ |
| 4.2.0.21 |
|
| |
|
Spinnaker SDK C++ |
| 4.2.0.21 |
|
|
Part of the QuickSpin API to provide access to camera information without having to first initialize the camera. More...
#include <TransportLayerStream.h>
Public Member Functions | |
| TransportLayerStream (GenApi::INodeMap *nodeMapTLDevice) | |
| ~TransportLayerStream () | |
Public Attributes | |
| GenApi::IString & | StreamID |
| Description: Device unique ID for the data stream, e.g. | |
| GenApi::IEnumerationT< StreamTypeEnum > & | StreamType |
| Description: Stream type of the device. | |
| GenApi::IEnumerationT< StreamModeEnum > & | StreamMode |
| Description: Stream mode of the device. | |
| GenApi::IInteger & | StreamBufferCountManual |
| Description: Controls the number of buffers to be used on this stream upon acquisition start when in manual mode. | |
| GenApi::IInteger & | StreamBufferCountResult |
| Description: Displays the number of buffers to be used on this stream upon acquisition start. | |
| GenApi::IInteger & | StreamBufferCountMax |
| Description: Controls the maximum number of buffers that should be used on this stream. | |
| GenApi::IEnumerationT< StreamBufferCountModeEnum > & | StreamBufferCountMode |
| Description: Controls access to setting the number of buffers used for the stream. | |
| GenApi::IEnumerationT< StreamBufferHandlingModeEnum > & | StreamBufferHandlingMode |
| Description: Available buffer handling modes of this data stream: Visibility: Beginner. | |
| GenApi::IInteger & | StreamAnnounceBufferMinimum |
| Description: Minimal number of buffers to announce to enable selected buffer handling mode. | |
| GenApi::IInteger & | StreamAnnouncedBufferCount |
| Description: Number of announced (known) buffers on this stream. | |
| GenApi::IInteger & | StreamStartedFrameCount |
| Description: Number of frames started in the acquisition engine. | |
| GenApi::IInteger & | StreamDeliveredFrameCount |
| Description: Number of delivered frames since last acquisition start. | |
| GenApi::IInteger & | StreamReceivedFrameCount |
| Description: Number of successful GVSP data blocks received. | |
| GenApi::IInteger & | StreamIncompleteFrameCount |
| Description: Displays number of images with missing packet. | |
| GenApi::IInteger & | 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. | |
| GenApi::IInteger & | StreamDroppedFrameCount |
| Description: Number of frames dropped from the output buffer queue before being processed by the application. | |
| GenApi::IInteger & | StreamInputBufferCount |
| Description: Number of buffers in the input buffer pool plus the buffers(s) currently being filled. | |
| GenApi::IInteger & | StreamOutputBufferCount |
| Description: Number of buffers in the output buffer queue. | |
| GenApi::IBoolean & | StreamIsGrabbing |
| Description: Flag indicating whether the acquisition engine is started or not. | |
| GenApi::IInteger & | StreamChunkCountMaximum |
| Description: Maximum number of chunks to be expected in a buffer. | |
| GenApi::IInteger & | StreamBufferAlignment |
| Description: Alignment size in bytes of the buffer passed to DSAnnounceBuffer. | |
| GenApi::IBoolean & | StreamCRCCheckEnable |
| Description: Enables or disables CRC checks on received images. | |
| GenApi::IInteger & | StreamReceivedPacketCount |
| Description: Displays number of packets received on this stream. | |
| GenApi::IInteger & | StreamMissedPacketCount |
| Description: Displays number of packets missed by this stream. | |
| GenApi::IBoolean & | StreamPacketResendEnable |
| Description: Enables or disables the packet resend mechanism. | |
| GenApi::IInteger & | StreamPacketResendTimeout |
| Description: Time in milliseconds to wait after the image trailer is received and before the image is completed by the driver. | |
| GenApi::IInteger & | StreamPacketResendMaxRequests |
| Description: Maximum number of resend requests per image. | |
| GenApi::IInteger & | StreamPacketResendRequestCount |
| Description: Displays number of packet resend requests transmitted to the camera. | |
| GenApi::IInteger & | StreamPacketResendRequestTimeoutCount |
| Description: Number of resend requests not fully fulfilled before the resend request timeout expired. | |
| GenApi::IInteger & | StreamPacketResendRequestedPacketCount |
| Description: Displays number of packets requested to be retransmitted on this stream. | |
| GenApi::IInteger & | StreamPacketResendReceivedPacketCount |
| Description: Displays number of retransmitted packets received on this stream. | |
| GenApi::IInteger & | StreamPacketsDuplicatedCount |
| Description: Number of duplicate packets received from the streaming device. | |
| GenApi::IInteger & | StreamPacketsTimeoutCount |
| Description: Number of packets not received before the inter-packet timeout expired. | |
| GenApi::IInteger & | StreamPacketsNotYetAvailableCount |
| Description: Number of packets not yet available on the streaming device. | |
| GenApi::IInteger & | StreamPacketsTemporarilyUnavailableCount |
| Description: Number of packets temporarily unavailable on the streaming device. | |
| GenApi::IInteger & | StreamPacketsPerFrameCount |
| Description: Number of packets per frame. | |
| GenApi::IInteger & | StreamPacketsUnavailableCount |
| Description: Number of missing packets no more available on the streaming device. | |
| GenApi::IInteger & | StreamBlocksReceptionTimeLast |
| Description: Time for receiving all packets for last block Visibility: Expert. | |
| GenApi::IInteger & | StreamBlocksReceptionTimeMin |
| Description: Minimum time for receiving all packets for all blocks Visibility: Expert. | |
| GenApi::IInteger & | StreamBlocksReceptionTimeMax |
| Description: Maximum time for receiving all packets for all blocks Visibility: Expert. | |
| GenApi::IInteger & | StreamBlocksProcessingTimeLast |
| Description: Time for processing all packets for last block Visibility: Expert. | |
| GenApi::IInteger & | StreamBlocksProcessingTimeMin |
| Description: Minimum time for processing all packets for all blocks Visibility: Expert. | |
| GenApi::IInteger & | StreamBlocksProcessingTimeMax |
| Description: Maximum time for processing all packets for all blocks Visibility: Expert. | |
| GenApi::IInteger & | StreamBlockTransferSize |
| Description: Controls the image breakup size that should be used on this stream. | |
Protected Member Functions | |
| TransportLayerStream () | |
Friends | |
| class | CameraBase |
| class | ICameraBase |
| class | CameraInternal |
Part of the QuickSpin API to provide access to camera information without having to first initialize the camera.
| TransportLayerStream | ( | GenApi::INodeMap * | nodeMapTLDevice | ) |
| ~TransportLayerStream | ( | ) |
|
protected |
|
friend |
|
friend |
|
friend |
| GenApi::IInteger& StreamAnnounceBufferMinimum |
Description: Minimal number of buffers to announce to enable selected buffer handling mode.
Visibility: Expert
| GenApi::IInteger& 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
| GenApi::IInteger& StreamBlocksProcessingTimeLast |
Description: Time for processing all packets for last block Visibility: Expert.
| GenApi::IInteger& StreamBlocksProcessingTimeMax |
Description: Maximum time for processing all packets for all blocks Visibility: Expert.
| GenApi::IInteger& StreamBlocksProcessingTimeMin |
Description: Minimum time for processing all packets for all blocks Visibility: Expert.
| GenApi::IInteger& StreamBlocksReceptionTimeLast |
Description: Time for receiving all packets for last block Visibility: Expert.
| GenApi::IInteger& StreamBlocksReceptionTimeMax |
Description: Maximum time for receiving all packets for all blocks Visibility: Expert.
| GenApi::IInteger& StreamBlocksReceptionTimeMin |
Description: Minimum time for receiving all packets for all blocks Visibility: Expert.
| GenApi::IInteger& StreamBlockTransferSize |
Description: Controls the image breakup size that should be used on this stream.
Visibility: Expert
| GenApi::IInteger& StreamBufferAlignment |
Description: Alignment size in bytes of the buffer passed to DSAnnounceBuffer.
Visibility: Expert
| GenApi::IInteger& StreamBufferCountManual |
Description: Controls the number of buffers to be used on this stream upon acquisition start when in manual mode.
Visibility: Expert
| GenApi::IInteger& 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
| GenApi::IEnumerationT<StreamBufferCountModeEnum>& StreamBufferCountMode |
Description: Controls access to setting the number of buffers used for the stream.
Visibility: Expert
| GenApi::IInteger& 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
| GenApi::IEnumerationT<StreamBufferHandlingModeEnum>& StreamBufferHandlingMode |
Description: Available buffer handling modes of this data stream: Visibility: Beginner.
| GenApi::IInteger& StreamChunkCountMaximum |
Description: Maximum number of chunks to be expected in a buffer.
Visibility: Expert
| GenApi::IBoolean& StreamCRCCheckEnable |
Description: Enables or disables CRC checks on received images.
Visibility: Expert
| GenApi::IInteger& StreamDeliveredFrameCount |
Description: Number of delivered frames since last acquisition start.
It is not reset until the stream is closed. Visibility: Expert
| GenApi::IInteger& 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
| GenApi::IString& StreamID |
Description: Device unique ID for the data stream, e.g.
a GUID. Visibility: Expert
| GenApi::IInteger& StreamIncompleteFrameCount |
Description: Displays number of images with missing packet.
Visibility: Expert
| GenApi::IInteger& StreamInputBufferCount |
Description: Number of buffers in the input buffer pool plus the buffers(s) currently being filled.
Visibility: Expert
| GenApi::IBoolean& StreamIsGrabbing |
Description: Flag indicating whether the acquisition engine is started or not.
Visibility: Expert
| GenApi::IInteger& 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
| GenApi::IInteger& StreamMissedPacketCount |
Description: Displays number of packets missed by this stream.
Visibility: Expert
| GenApi::IInteger& StreamOutputBufferCount |
Description: Number of buffers in the output buffer queue.
Visibility: Expert
| GenApi::IBoolean& StreamPacketResendEnable |
Description: Enables or disables the packet resend mechanism.
Visibility: Expert
| GenApi::IInteger& StreamPacketResendMaxRequests |
Description: Maximum number of resend requests per image.
Each resend request consists of a span of consecutive packet IDs. Visibility: Expert
| GenApi::IInteger& StreamPacketResendReceivedPacketCount |
Description: Displays number of retransmitted packets received on this stream.
Visibility: Expert
| GenApi::IInteger& StreamPacketResendRequestCount |
Description: Displays number of packet resend requests transmitted to the camera.
Visibility: Expert
| GenApi::IInteger& StreamPacketResendRequestedPacketCount |
Description: Displays number of packets requested to be retransmitted on this stream.
Visibility: Expert
| GenApi::IInteger& StreamPacketResendRequestTimeoutCount |
Description: Number of resend requests not fully fulfilled before the resend request timeout expired.
Visibility: Expert
| GenApi::IInteger& StreamPacketResendTimeout |
Description: Time in milliseconds to wait after the image trailer is received and before the image is completed by the driver.
Visibility: Expert
| GenApi::IInteger& StreamPacketsDuplicatedCount |
Description: Number of duplicate packets received from the streaming device.
Visibility: Beginner
| GenApi::IInteger& StreamPacketsNotYetAvailableCount |
Description: Number of packets not yet available on the streaming device.
Visibility: Beginner
| GenApi::IInteger& StreamPacketsPerFrameCount |
| GenApi::IInteger& StreamPacketsTemporarilyUnavailableCount |
Description: Number of packets temporarily unavailable on the streaming device.
Visibility: Beginner
| GenApi::IInteger& StreamPacketsTimeoutCount |
Description: Number of packets not received before the inter-packet timeout expired.
Visibility: Expert
| GenApi::IInteger& StreamPacketsUnavailableCount |
Description: Number of missing packets no more available on the streaming device.
Visibility: Beginner
| GenApi::IInteger& StreamReceivedFrameCount |
Description: Number of successful GVSP data blocks received.
Only valid while stream is active. Visibility: Expert
| GenApi::IInteger& StreamReceivedPacketCount |
Description: Displays number of packets received on this stream.
Visibility: Expert
| GenApi::IInteger& 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
| GenApi::IEnumerationT<StreamTypeEnum>& StreamType |