Class PvStreamInfo
Class extracting string-based information out of PvStream statistics.
Implements
Inherited Members
Namespace: eBUSDotNetReceive
Assembly: eBUSDotNetReceive.dll
Syntax
public class PvStreamInfo : IDisposable
Remarks
This class is used by Pleora applications like eBUSPlayer 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.
Constructors
View SourcePvStreamInfo(PvStream)
Creates a PvStreamInfo for the specified stream.
Declaration
public PvStreamInfo(PvStream aStream)
Parameters
| Type | Name | Description |
|---|---|---|
| PvStream | aStream | The stream to gather information from. |
Fields
View SourceswigCMemOwn
Declaration
protected bool swigCMemOwn
Field Value
| Type | Description |
|---|---|
| bool |
Methods
View SourceDispose()
Dispose.
Declaration
public void Dispose()
Dispose(bool)
Declaration
protected virtual void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing |
~PvStreamInfo()
Destructor.
Declaration
protected ~PvStreamInfo()
GetErrors()
Gets a string containing error information from the stream.
Declaration
public string GetErrors()
Returns
| Type | Description |
|---|---|
| string | A string containing error details. |
GetStatistics(uint)
Gets stream statistics as a formatted string.
Declaration
public string GetStatistics(uint aDisplayFrameRate)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | aDisplayFrameRate | The display frame rate to include in statistics. |
Returns
| Type | Description |
|---|---|
| string | A string containing stream statistics. |
GetWarnings(bool)
Gets a string containing warning information from the stream.
Declaration
public string GetWarnings(bool aPipelineReallocated)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | aPipelineReallocated | Whether the pipeline was reallocated. |
Returns
| Type | Description |
|---|---|
| string | A string containing warning details. |