EdgeVisDecoderSDK::AnalyticsStream Class Reference
Detailed Description
The AnalyticsStream is used to receive ONVIF M Analytics XML from a camera connected to an encoder.
It can also provide ONVIF M XML from Digital Barriers edge analytics.
The AnalyticsStream can be used independently of the MediaStream, allowing for monitoring of analytics without the need to decode the video stream.
Availability
Available in version 8.7 of Decoder SDK. Requires a server version greater than 8.7 and an encoder version greater than 8.7
#include <AnalyticsStream.h>
Public Member Functions | |
| DB_EDGEVIS_SDK bool | IsConnected () const override |
| Checks if the analytics stream is currently connected. More... | |
 Public Member Functions inherited from EdgeVisDecoderSDK::Stream | |
| DB_EDGEVIS_SDK StreamType | Type () const |
| Gets the stream type. More... | |
| DB_EDGEVIS_SDK std::wstring | Name () const |
| Gets the stream's name. More... | |
| virtual DB_EDGEVIS_SDK OpResult | SetTransport (TransportType trans) |
| This is underlying transport type. More... | |
| virtual DB_EDGEVIS_SDK TransportType | GetTransport () |
| Gets the stream's transport. More... | |
| DB_EDGEVIS_SDK Encoder | GetEncoder () const |
| Gets the Encoder object that the Stream is on. More... | |
| DB_EDGEVIS_SDK OpResult | Open () |
| Opens the stream. More... | |
| DB_EDGEVIS_SDK void | Close () |
| Closes this stream. More... | |
| DB_EDGEVIS_SDK void | RegisterListener (IStreamListener *listener) |
| Registers the specified listener to be notified when stream data is received. More... | |
| DB_EDGEVIS_SDK void | UnregisterListener (IStreamListener *listener) |
| Removes the specified listener from the set of listeners to be notified about incoming stream data. More... | |
| DB_EDGEVIS_SDK int64_t | GetTotalBytesSent () |
| Returns the current total number of bytes sent on this stream. More... | |
| DB_EDGEVIS_SDK int64_t | GetTotalBytesReceived () |
| Returns the current total number of bytes received on this stream. More... | |
| DB_EDGEVIS_SDK void | ResetDataUsageStats () |
| Resets the count of the total number of bytes sent and received for this stream. | |
| DB_EDGEVIS_SDK int64_t | GetStreamUseDuration () const |
| Get the duration in milliseconds that the stream has been open. More... | |
| DB_EDGEVIS_SDK int64_t | GetLastStreamUseDuration () const |
| Get the duration in milliseconds that the stream was open on last use. More... | |
| DB_EDGEVIS_SDK void | SetEnableAnalyticsSync (bool enable) |
| Enables or disables synchronization of analytics metadata with audio and video Enabled by default, to disable set to false. More... | |
| DB_EDGEVIS_SDK bool | GetEnableAnalyticsSync () const |
| Returns true if Analytics Sync is enabled. More... | |
Member Function Documentation
|
overridevirtual |
Checks if the analytics stream is currently connected.
- Returns
- true if connected, false if not
Reimplemented from EdgeVisDecoderSDK::Stream.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/AnalyticsStream.h