EdgeVisDecoderSDK Namespace Reference
Detailed Description
The EdgeVis Decoder SDK namespace.
Classes | |
| class | AnalyticsActorInfo |
| Encoders equipped with SafeZone 2D analytics will return an actor when an object is detected. More... | |
| class | AnalyticsConfig |
| Defines the analytics configuration to use for a video input. More... | |
| class | AnalyticsData |
| Encoders equipped with SafeZone 2D analytics will return analytics data when an object is detected. More... | |
| class | AnalyticsInfo |
| Defines the type of analytics that the encoder will use and the configuration for each video input that will use these analytics. More... | |
| class | AnalyticsRegion |
| Defines a region within the video frame within which the analytics will be applied. More... | |
| class | AnalyticsRegionVertex |
| Defines a vertex within the video frame. More... | |
| class | AnalyticsStream |
| The AnalyticsStream is used to receive ONVIF M Analytics XML from a camera connected to an encoder. More... | |
| class | ArchiveBookmark |
| Contains the details of an Archive bookmark. More... | |
| class | ArchiveExporterService |
| The ArchiveExporter Service handles listing files from a remote archive device connected to an Encoder and allows the files to be downloaded. More... | |
| class | ArchiveFile |
| A simple container class for information about a file on a remote archive device connected to an Encoder. More... | |
| class | ArchiveFiles |
| A collection of ArchiveFiles. More... | |
| class | ArchiveService |
| The Archive Service provides access to the edge archive on an Encoder. More... | |
| class | AudioData |
| AudioData is delivered for every frame of audio decoded from a media stream. More... | |
| class | Camera |
| A Camera interface represents a camera connected to an Encoder. More... | |
| class | CameraInfo |
| The CameraInfo interface contains the settings for a Camera connected to one of the Encoder's camera inputs. More... | |
| class | CameraPositionData |
| If the encoder has camera position data it will return this information as part of the stream data. More... | |
| class | CamsAttachment |
| A CamsAttachment object typically contains an image associated with a CamsNotification object. More... | |
| class | CamsBulkNotification |
| A CamsBulkNotification object contains CAMS state change information for multiple CAMS notifications. More... | |
| class | CamsGetNotificationsResult |
| Contains the notifications retrieved in response to querying the Server for existing CAMS notifications. More... | |
| class | 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 | CamsNotificationAttachment |
| Contains information on attachments such as images for a CAMS notification. More... | |
| class | CamsNotificationEventDesc |
| Contains information on a source event for a CAMS notification. More... | |
| class | CamsNotificationEventParamDesc |
| Contains a summary of the event parameter information that forms part of a CAMS notification. More... | |
| class | CamsNotificationManager |
| The CamsNotificationManager facilitates interactions with CAMS notifications stored at the server. More... | |
| class | CamsNotificationStateDesc |
| Indicates the total number of CAMS notifications at the server in the given CAMS state. More... | |
| class | ClientSecurityPolicy |
| Describes the client security policy set at the server. More... | |
| class | CommandData |
| A command received by the dewclaw library. More... | |
| class | Credentials |
| Holds the server credentials for the user logging in. More... | |
| class | DeepSleepManager |
| A DeepSleepManager interface is used to manage and facilitate the Deep Sleep feature on an Encoder. More... | |
| class | Device |
| A Device represents a physical device that may provide one or more Encoder instances. More... | |
| class | EdgeVisDecoderSDKVersion |
| Defines the build and version information for this Decoder SDK library. More... | |
| class | EmailNotificationDetails |
| User settings can be configure on the server for notifications. More... | |
| class | Encoder |
| An Encoder interface represents an Encoder that is managed by the server. More... | |
| class | EncoderCapabilties |
| The EncoderCapabilities class exposes information on the capabilties of the hardware and firmware of a particular encoder. More... | |
| class | EncoderConfig |
| The EncoderConfig interface contains the Encoder's global configuration settings. More... | |
| struct | EncoderInfo |
| Contains information relating to the Encoder. More... | |
| class | EncoderMetaData |
| An Event received from the Encoder by the decoder library. More... | |
| class | EncoderProfile |
| The EncoderProfile interface contains Encoder connection profile settings. More... | |
| class | EncoderSettings |
| The EncoderSettings interface provides access to an Encoder's configuration, connection profile and camera settings. More... | |
| class | EncoderSettingsChangeInfo |
| Describes the Encoder settings that have been changed. More... | |
| class | EncoderStatusInfo |
| The EncoderStatusInfo holds information about Encoder status events. More... | |
| class | EncoderUpdateInfo |
| Holds information about the Encoder updates such as an Encoders location. More... | |
| class | EventData |
| An Event received from the Encoder by the decoder library. More... | |
| class | FrameConfig |
| This is the base class for the FrameConfig objects. More... | |
| class | FullResService |
| Access to the Full Resolution capability on encoders that support it. More... | |
| class | GOPData |
| The GOP Data class represents a downloaded element from the edge archive of a supported encoder. More... | |
| class | GOPDataBlock |
| The GOP Data Block class represents an individual element of a GOPData buffer. More... | |
| class | GOPDownloadService |
| The GOP Download Service handles the download of GOPs (Group of Pictures) from the edge archive of supported encoders. More... | |
| class | GPSData |
| If the encoder has live GPS data it will return location information as part of the stream data. More... | |
| class | H264Frame |
| An H264Frame object provides H.264 (Annex B) data from the MediaStream to the applicaiton. More... | |
| class | H264FrameConfig |
| This is the derived class for the H264FrameConfig objects. More... | |
| class | IAsset |
| An Asset is a tangible asset on the system such as an Encoder or a Server. More... | |
| class | IEncoderListener |
| The interface for the Encoder asset. More... | |
| class | IEncoderSettingsListener |
| The interface to provide callbacks on Encoder settings changes. More... | |
| class | IFullResListener |
| The interface for the Full resolution service callbacks. More... | |
| class | IGOPDownloadListener |
| The interface for the GOP download service callbacks. More... | |
| class | IndexedSCTData |
| An Indexed SCT Data block. More... | |
| class | ISecureConnectProxyServiceListener |
| The interface for the secure connect service. More... | |
| class | IServerEventListener |
| The interface for receiving CAMS notification events from the Server. More... | |
| class | IServerListener |
| The interface for the Server. More... | |
| class | IServiceListener |
| Defines an interface for a class that listens for incoming state changes from a service. More... | |
| class | ISettings |
| Definition of the ISettings interface class. More... | |
| class | IStreamListener |
| Defines an interface for a class that listens for incoming data from a Stream. More... | |
| class | JPEGFrame |
| A JPEGFrame is designed for transforming YCbCr colour space frames into an in memory JPEG frame buffer. More... | |
| class | JPEGFrameConfig |
| This is the derived class for the JPEGFrameConfig objects. More... | |
| class | MediaStream |
| A MediaStream is a Stream class that provides additional methods and properties specific to the Media Stream. More... | |
| class | MFALoginResponse |
| Holds the result of a time based one time passcode (OTP) login attempt. More... | |
| class | OnvifEvent |
| Contains information relating to Onvif Events. More... | |
| class | OnvifMetadata |
| Provides analytics data in ONVIF XML format: https://www.onvif.org/specs/srv/analytics/ONVIF-VideoAnalytics-Service-Spec-v210.pdf. More... | |
| class | PassThruData |
| This is data that has been received at a port on the remote Encoder device and then sent back via the PassThruStream or broadcast to all viewers of the MediaStream. More... | |
| class | PassThruStream |
| This object sends data to a port on an Encoder. More... | |
| class | PasswordResetInfo |
| Describes the details required for resetting a users password. More... | |
| class | PhoneNotificationDetails |
| User settings can be configure on the server for notifications. More... | |
| class | PTZStream |
| The PTZStream is used to send movement commands to a PTZ camera. More... | |
| class | PushNotificationDetails |
| User settings can be configure on the server for notifications. More... | |
| class | RGBFrame |
| An RGBFrame is designed for transforming YCbCr colour space frames into RGB colour space frames. More... | |
| class | SecureConnectProxyService |
| Creates a secure connect service to the remote encoder. More... | |
| class | SensorInfo |
| A class representing an RDC sensor attached to the encoder. More... | |
| class | Server |
| A Server interface is used to make a connection to an EdgeVis server. More... | |
| class | ServerInfo |
| Holds the current status of the server. More... | |
| class | Service |
| Definition of the Service abstract class. More... | |
| class | SettingsModifier |
| The settings modifier is used to change the settings on an Encoder. More... | |
| class | SnapshotFrame |
| A SnapshotFrame is an extension of YCbCrFrame. More... | |
| class | Stream |
| The Stream interface represent a service that is available on an Encoder. More... | |
| class | StreamData |
| This is the base class for the StreamData objects. More... | |
| class | Timeline |
| This contains lists of days, hours and minutes that the archive holds footage for. More... | |
| class | UserNotificationPreferences |
| A class representing the current user's CAMS notification preferences. More... | |
| class | VideoData |
| The VideoData class extends the StreamData class and is a base class for all types of video data provided by the MediaStream. More... | |
| class | VideoFrameLayout |
| VideoFrameLayout decribes the content of the frame from a given Encoder input. More... | |
| class | VideoFrameLayoutComponent |
| VideoFrameLayoutComponent decribes either all or part of a VideoFrameLayout. More... | |
| class | VPTZData |
| Class describing the are currently being sent as VPTZ. More... | |
| class | YCbCrFrame |
| An YCbCrFrame is delivered for every frame of video decoded from a media stream. More... | |
Typedefs | |
| typedef enum EdgeVisDecoderSDK::IndexedPacketType | IndexedPacketType |
| Contains the type of IndexedSCTData | |
| typedef enum EdgeVisDecoderSDK::StreamType | StreamType |
| Defines the type of stream. | |
Enumerations |