Back to Aurora Vision Library website

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

GigEVision_GetStreamingStatistics


Header: Genicam.h
Namespace: avl
Module: Genicam

Retrieves basic statistics of video streaming out of a GigEVision device.

Syntax

C++
C#
 
void avl::GigEVision_GetStreamingStatistics
(
	GigEHandle inDeviceHandle,
	bool inReset,
	GigEVision_StreamingStatistics& outStatistics
)

Parameters

Name Type Default Description
Input value inDeviceHandle GigEHandle Handle of an opened device that is streaming video.
Input value inReset bool True to reset internal device statistics after read.
Output value outStatistics GigEVision_StreamingStatistics&

Description

This function is intended to help with diagnosing video streaming and network transfer issues, and it allows to read basic streaming statistic counters from the acquisition engine.

Exceptions

This function will throw an exception in the following situations:

  • Device handle is invalid.