Class extracting string-based information out of PvStream statistics. More...

Public Member Functions
	PvStreamInfo (PvStream *aStream)
	Constructor. More...

	~PvStreamInfo ()
	Destructor.

PvString	GetStatistics (uint32_t aDisplayFrameRate)
	Returns statistics string. More...

PvString	GetErrors ()
	Returns errors string. More...

PvString	GetWarnings (bool aPipelineReallocated)
	Returns warnings string. More...

Detailed Description

Class extracting string-based information out of PvStream statistics.

This class is used by Pleora applications like eBUS Player to provide information on the stream statistics, errors and warnings.

While not a core component of the SDK this utility class can be reused in your own application if needed.

Constructor & Destructor Documentation

PvStreamInfo::PvStreamInfo ( PvStream * aStream )

Constructor.

Parameters

[in] aStream Pointer to the PvStream object to use to build information strings.

PvString PvStreamInfo::GetErrors ( )

Returns errors string.

PvString PvStreamInfo::GetStatistics ( uint32_t aDisplayFrameRate )

Returns statistics string.

Parameters

[in] aDisplayFrameRate The current display frame rate. Will be appended to the string.

Returns: Formatted statistics string, which includes images received, received frames per second, bitrate received, display frames per second

PvString PvStreamInfo::GetWarnings ( bool aPipelineReallocated )

Returns warnings string.

Parameters

[in] aPipelineReallocated Set to true to add information that the pipeline was reallocated.

Returns

Formatted warnings string, which can include:

buffers reallocated. Indicates that the buffers are not large enough to store the incoming image. If your application uses PvPipeline for streaming, this warning also indicates that the buffers have been automatically resized to ensure they are large enough to fit subsequent images. If your application uses PvPipeline, you can safely ignore this message.
resends. The GigE Vision device has received requests from the eBUS Universal Pro for Ethernet driver to resend packets. This indicates that at least one packet was lost.
missing block IDs. Indicates that there are missing blocks (images) in the stream.
pipeline dropped images. Indicates that a received block (image) was dropped in the pipeline and is no longer available for retrieval. This can happen when buffers are not retrieved fast enough by your application.
device dropped images. Indicates that the device has dropped blocks (images) and cannot transmit all of the images received from the sensor.
partial lines missing, full lines missing. Indicates that frames are ending early (FVAL goes invalid before the full number of lines) or lines are ending early (LVAL goes invalid before the full number of pixels). For detailed information about why these warnings are reported, and for information about resolving them, see the Stream Control Application Note, available at www.pleora.com/support-center.

The documentation for this class was generated from the following files: