EdgeVisDecoderSDK::CamsNotificationEventDesc Class Reference
Detailed Description
Contains information on a source event for a CAMS notification.
Availability
Available in version 6.7.0 of Decoder SDK. Requires a server version greater than 6.5
#include <CamsNotificationEventDesc.h>
Public Member Functions | |
| DB_EDGEVIS_SDK int64_t | GetId () |
| Retrieve the ID for this event. More... | |
| DB_EDGEVIS_SDK int64_t | GetTime () |
| Gets the timestamp of the source event. More... | |
| DB_EDGEVIS_SDK std::wstring | GetEventType () |
| Gets the type of event. More... | |
| DB_EDGEVIS_SDK std::wstring | GetSource () |
| Returns the source of the event, typically the encoder name. More... | |
| DB_EDGEVIS_SDK std::vector< CamsNotificationEventParamDesc > | GetEventParameters () |
| Returns the list of parameters associated with this event. More... | |
| DB_EDGEVIS_SDK std::wstring | GetDisplayString () |
| Returns a display string for the event. More... | |
| DB_EDGEVIS_SDK bool | GetOnvifEvent (OnvifEvent &onvif_event) |
| Convert this notification event to an ONVIF event. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::CamsNotificationEventDesc::GetId | ( | ) |
Retrieve the ID for this event.
- Returns
- The ID of the source event.
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::CamsNotificationEventDesc::GetTime | ( | ) |
Gets the timestamp of the source event.
- Returns
- Timestamp in milliseconds since the epoch.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsNotificationEventDesc::GetEventType | ( | ) |
Gets the type of event.
- Returns
- The event type, see EncoderStatusInfo for the range of event types to expect. Along with the event type, there may be 1 or more paramaters depending on the type of event.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsNotificationEventDesc::GetSource | ( | ) |
Returns the source of the event, typically the encoder name.
- Returns
- The source of the event.
| DB_EDGEVIS_SDK std::vector<CamsNotificationEventParamDesc> EdgeVisDecoderSDK::CamsNotificationEventDesc::GetEventParameters | ( | ) |
Returns the list of parameters associated with this event.
- Returns
- The list of CamsNotificationEventParamDesc object that describe the parameters for this event.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CamsNotificationEventDesc::GetDisplayString | ( | ) |
Returns a display string for the event.
This can be used to display the details of the event to the user.
- Returns
- A display string of the event
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::CamsNotificationEventDesc::GetOnvifEvent | ( | OnvifEvent & | onvif_event | ) |
Convert this notification event to an ONVIF event.
- Note
- onvif_event must have a valid implementation
- Returns
- true if the event was successfully converted to a supported ONVIF event
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/CamsNotificationEventDesc.h