Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » GigE Vision » GigEVision_GetStreamingStatistics

GigEVision_GetStreamingStatistics


Retrieves basic statistics of video streaming out of GigEVision device.

Name Type Description
inAddress GevAddress GigE Vision Device identifying address (IP, MAC or Serial Number)
inReset Bool True to reset internal device statistics after read.
outReceivedFrames Integer Number of received valid frames that were put into the input queue.
outLostFrames Integer Number of all frames that the device should have sent but were not retrieved by the application.
outDroppedFrames Integer Number of received valid frames that were lost because of input queue overflow.
outDamagedFrames Integer Number of frames that were partially received but were discarded because of data damage.
outCurrentQueueSize Integer Number of frames currently held in the input queue.
outResendRequests Integer Number of times the device was requested to resend some parts of lost frames.
outLostPackets Integer Number of network packets that were expected but not retrieved.
outReconnections Integer Number of times the connection with the device was lost and automatically reestablished.
outLastPacketError String Last network packet related error logged by the stream receiver.
outLastFrameError String Last frame reconstruction related error logged by the stream receiver.

Description

This filter is intended for retrieving the video streaming statistics and diagnosing video streaming problems related to GigE Vision® compliant video transmitter. It is usually used beside other GigEVision filters, especially GigEVision_GrabImage or GigEVision_GrabImage_WithTimeout performing actual video streaming, and only for diagnostic purpose.

Device address (inAddress port) is a textual definition of either IP, MAC or serial number. Use Device Manager (click "..." button in filter properties) to select appropriate address of connected device. For information on address type meaning and selecting device address see Device manager section in user manual.

This filter will interpret the value of inAddress port only during the first iteration of its parent Task, when the connection to the device is established. During the next iterations the filter will use previously established connection and subsequent changes in the device address will be ignored.

On every execution this filter will return following statistics on its outputs:

  • outReceivedFrames - Number of all frames that were internally received from the device without any errors, and that were put into the image input queue. Those frames are intended for processing by the application through GigEVision_GrabImage and equivalent filters. It is possible that not all of those frames were processed by the application.
  • outLostFrames - Number of all frames that should have been generated by the device (based on frames counter) but were not, for any reason, processed by the application through the GigEVision_GrabImage or equivalent filter. This is an estimated value and on serious transport problems may be different than actual lost frames count. This counter includes dropped frames, damaged frames, and other frames that were fully lost (not received even partially).
  • outDroppedFrames - Number of frames that were internally received from the device without any errors, and that were put into the image input queue, but were not consumed by the application on time using the GigEVision_GrabImage or equivalent filter and was discarded because of the input queue overflow. Large values of this statistic and its constant continuous growth means that the application is not keeping up with processing frames generated by the device and may indicate application performance issues or too large camera framerate. Occasional short growths of this statistic may indicate periodic performance problems in the application and (when loosing of frames is not acceptable) may indicate the need to increase capacity of the input queue.
  • outDamagedFrames - Number of all frames that were internally received from the device but were incomplete (some data were lost on transport layer) or were otherwise damaged (some data was corrupted or not recognized), and was discarded without putting them into the images input queue. Large values of this statistic may indicate network problems, network infrastructure performance problems, local system network stack performance problems, or use of unsupported or invalid format of stream payload by the device.
  • outCurrentQueueSize - Number of valid frames that at the time of this filter execution was stored in the frames input queue and waiting for retrieving through the GigEVision_GrabImage or equivalent filter. This value can be changing rapidly due too the race condition between filter execution time and internal receiving of new frames from the device.
  • outResendRequests - Number of times transport layer detected missing network packets and requested the device to retransmit some parts of incomplete frames. This takes place only when the device is supporting packets retransmission. When retransmission is successful the frames are not damaged despite increment in this statistic. When retransmission is not successful the packets are lost and the outLostPackets and outDamagedFrames statistics will be incremented according to resulting damage. Large value of this statistic may indicate network communication issues, network infrastructure performance issues or local system network stack performance issues. Very small periodic increments of this statistic are usually acceptable.
  • outLostPackets - Estimated number of network packets that were expected but were not received or received with significant delay to other packets. Packets can be lost due to network communication issues, network infrastructure performance issues or local system network stack performance issues. When the device is supporting packets retransmission and the packets were successfully retransmitted this statistic is not incremented. As a result of lost network packets one or more frames can be damaged or left incomplete and the outDamagedFrames statistic will be incremented.
  • outReconnections - Number of times the network connection with the device was broken and successfully restored. Restoring network connection usually results in resetting of the device stream state, resetting of some other statistics and lost of unspecified amount of frames. In properly working system network connection should never be lost. Often reconnections may indicate very serious network communication issues, serious local system performance issues (like stalling of whole system) or technical problems with the device.

Setting the inReset input to True results in resetting of all statistics back to zero (filter outputs will be set to the last value of statistics before their reset).

Complexity Level

This filter is available on Expert Complexity Level.

Disabled in Lite Edition

This filter is disabled in Lite Edition. It is available only in full, Adaptive Vision Studio Professional version.

See Also

  • Application Notes - set of documents about connecting devices or establishing communication with Adaptive Vision Studio.