Detailed Description
The Central Alarm Management System (CAMS) facilitates interactions with notifications stored at the Server.
Notifications are generated as a consequence of server-side rule matching and have a state associated with them. The state may be changed by a client and all other listening clients who are listed as recipients for this notification will receive the state change notification.
CAMS notifications are stored along with their state at the Server. An EdgeVis SDK application can retrieve the existing notifications from the server at any time via the EdgeVisDecoderSDK::CamsNotificationManager. New notifications are received via the EdgeVisDecoderSDK::IServerEventListener interface.
The EdgeVisDecoderSDK::CamsNotificationManager also allows changing the state of notifications stored at the server. The state change can be requested for a single notification or a bulk update on a range of notifications. When a notification changes state all recipients are notified of the update via the EdgeVisDecoderSDK::IServerEventListener interface.
CAMS notifications originate in response to Encoder events matching rules defined at the Server. CAMS rules may be defined for an encoder via the Server web UI for the encoder under the Alarm rules option. The source Encoder events are included with the notification information.
Each system users has a set of notification preferences, Email, SMS phone number and Mobile push notifications. These can be access via the EdgeVisDecoderSDK::UserNotificationPreferences class.
Sample applications
Full sample applications are available demonstrating the capabilities of the SDK
Classes | |
| class | EdgeVisDecoderSDK::CamsBulkNotification |
| A CamsBulkNotification object contains CAMS state change information for multiple CAMS notifications. More... | |
| class | EdgeVisDecoderSDK::CamsGetNotificationsResult |
| Contains the notifications retrieved in response to querying the Server for existing CAMS notifications. More... | |
| class | EdgeVisDecoderSDK::CamsNotification |
| A CamsNotification object contains all of the information associated with a CAMS notification either received at the time of generation from the server via the IServerEventListener interface or retrieved from the CamsNotificationManager via the GetNotifications method. More... | |
| class | EdgeVisDecoderSDK::CamsNotificationAttachment |
| Contains information on attachments such as images for a CAMS notification. More... | |
| class | EdgeVisDecoderSDK::CamsAttachment |
| A CamsAttachment object typically contains an image associated with a CamsNotification object. More... | |
| class | EdgeVisDecoderSDK::CamsNotificationEventDesc |
| Contains information on a source event for a CAMS notification. More... | |
| class | EdgeVisDecoderSDK::CamsNotificationEventParamDesc |
| Contains a summary of the event parameter information that forms part of a CAMS notification. More... | |
| class | EdgeVisDecoderSDK::CamsNotificationManager |
| The CamsNotificationManager facilitates interactions with CAMS notifications stored at the server. More... | |
| class | EdgeVisDecoderSDK::CamsNotificationStateDesc |
| Indicates the total number of CAMS notifications at the server in the given CAMS state. More... | |
| class | EdgeVisDecoderSDK::EmailNotificationDetails |
| User settings can be configure on the server for notifications. More... | |
| class | EdgeVisDecoderSDK::IServerEventListener |
| The interface for receiving CAMS notification events from the Server. More... | |
| class | EdgeVisDecoderSDK::OnvifEvent |
| Contains information relating to Onvif Events. More... | |
| class | EdgeVisDecoderSDK::PhoneNotificationDetails |
| User settings can be configure on the server for notifications. More... | |
| class | EdgeVisDecoderSDK::PushNotificationDetails |
| User settings can be configure on the server for notifications. More... | |
| class | EdgeVisDecoderSDK::UserNotificationPreferences |
| A class representing the current user's CAMS notification preferences. More... | |
Typedefs | |
| typedef enum ECamsNotificationState | ECamsNotificationState |
| CAMS notification state types. | |
Enumerations |