Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
| ►NEdgeVisDecoderSDK | The EdgeVis Decoder SDK namespace |
| CAnalyticsActorInfo | Encoders equipped with SafeZone 2D analytics will return an actor when an object is detected |
| CAnalyticsConfig | Defines the analytics configuration to use for a video input |
| CAnalyticsData | Encoders equipped with SafeZone 2D analytics will return analytics data when an object is detected |
| CAnalyticsInfo | Defines the type of analytics that the encoder will use and the configuration for each video input that will use these analytics |
| CAnalyticsRegion | Defines a region within the video frame within which the analytics will be applied |
| CAnalyticsRegionVertex | Defines a vertex within the video frame |
| CAnalyticsStream | The AnalyticsStream is used to receive ONVIF M Analytics XML from a camera connected to an encoder |
| CArchiveBookmark | Contains the details of an Archive bookmark |
| CArchiveExporterService | The ArchiveExporter Service handles listing files from a remote archive device connected to an Encoder and allows the files to be downloaded |
| CArchiveFile | A simple container class for information about a file on a remote archive device connected to an Encoder |
| CArchiveFiles | A collection of ArchiveFiles |
| CArchiveService | The Archive Service provides access to the edge archive on an Encoder |
| CAudioData | AudioData is delivered for every frame of audio decoded from a media stream |
| CCamera | A Camera interface represents a camera connected to an Encoder |
| CCameraInfo | The CameraInfo interface contains the settings for a Camera connected to one of the Encoder's camera inputs |
| CCameraPositionData | If the encoder has camera position data it will return this information as part of the stream data |
| CCamsAttachment | A CamsAttachment object typically contains an image associated with a CamsNotification object |
| CCamsBulkNotification | A CamsBulkNotification object contains CAMS state change information for multiple CAMS notifications |
| CCamsGetNotificationsResult | Contains the notifications retrieved in response to querying the Server for existing CAMS notifications |
| CCamsNotification | 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 |
| CCamsNotificationAttachment | Contains information on attachments such as images for a CAMS notification |
| CCamsNotificationEventDesc | Contains information on a source event for a CAMS notification |
| CCamsNotificationEventParamDesc | Contains a summary of the event parameter information that forms part of a CAMS notification |
| CCamsNotificationManager | The CamsNotificationManager facilitates interactions with CAMS notifications stored at the server |
| CCamsNotificationStateDesc | Indicates the total number of CAMS notifications at the server in the given CAMS state |
| CClientSecurityPolicy | Describes the client security policy set at the server |
| CCommandData | A command received by the dewclaw library |
| CCredentials | Holds the server credentials for the user logging in |
| CDeepSleepManager | A DeepSleepManager interface is used to manage and facilitate the Deep Sleep feature on an Encoder |
| CDevice | A Device represents a physical device that may provide one or more Encoder instances |
| CEdgeVisDecoderSDKVersion | Defines the build and version information for this Decoder SDK library |
| CEmailNotificationDetails | User settings can be configure on the server for notifications |
| CEncoder | An Encoder interface represents an Encoder that is managed by the server |
| CEncoderCapabilties | The EncoderCapabilities class exposes information on the capabilties of the hardware and firmware of a particular encoder |
| CEncoderConfig | The EncoderConfig interface contains the Encoder's global configuration settings |
| CEncoderInfo | Contains information relating to the Encoder |
| CEncoderMetaData | An Event received from the Encoder by the decoder library |
| CEncoderProfile | The EncoderProfile interface contains Encoder connection profile settings |
| CEncoderSettings | The EncoderSettings interface provides access to an Encoder's configuration, connection profile and camera settings |
| CEncoderSettingsChangeInfo | Describes the Encoder settings that have been changed |
| CEncoderStatusInfo | The EncoderStatusInfo holds information about Encoder status events |
| CEncoderUpdateInfo | Holds information about the Encoder updates such as an Encoders location |
| CEventData | An Event received from the Encoder by the decoder library |
| CFrameConfig | This is the base class for the FrameConfig objects |
| CFullResService | Access to the Full Resolution capability on encoders that support it |
| CGOPData | The GOP Data class represents a downloaded element from the edge archive of a supported encoder |
| CGOPDataBlock | The GOP Data Block class represents an individual element of a GOPData buffer |
| CGOPDownloadService | The GOP Download Service handles the download of GOPs (Group of Pictures) from the edge archive of supported encoders |
| CGPSData | If the encoder has live GPS data it will return location information as part of the stream data |
| CH264Frame | An H264Frame object provides H.264 (Annex B) data from the MediaStream to the applicaiton |
| CH264FrameConfig | This is the derived class for the H264FrameConfig objects |
| CIAsset | An Asset is a tangible asset on the system such as an Encoder or a Server |
| CIEncoderListener | The interface for the Encoder asset |
| CIEncoderSettingsListener | The interface to provide callbacks on Encoder settings changes |
| CIFullResListener | The interface for the Full resolution service callbacks |
| CIGOPDownloadListener | The interface for the GOP download service callbacks |
| CIndexedSCTData | An Indexed SCT Data block |
| CISecureConnectProxyServiceListener | The interface for the secure connect service |
| CIServerEventListener | The interface for receiving CAMS notification events from the Server |
| CIServerListener | The interface for the Server |
| CIServiceListener | Defines an interface for a class that listens for incoming state changes from a service |
| CISettings | Definition of the ISettings interface class |
| CIStreamListener | Defines an interface for a class that listens for incoming data from a Stream |
| CJPEGFrame | A JPEGFrame is designed for transforming YCbCr colour space frames into an in memory JPEG frame buffer |
| CJPEGFrameConfig | This is the derived class for the JPEGFrameConfig objects |
| CMediaStream | A MediaStream is a Stream class that provides additional methods and properties specific to the Media Stream |
| CMFALoginResponse | Holds the result of a time based one time passcode (OTP) login attempt |
| COnvifEvent | Contains information relating to Onvif Events |
| COnvifMetadata | Provides analytics data in ONVIF XML format: https://www.onvif.org/specs/srv/analytics/ONVIF-VideoAnalytics-Service-Spec-v210.pdf |
| CPassThruData | 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 |
| CPassThruStream | This object sends data to a port on an Encoder |
| CPasswordResetInfo | Describes the details required for resetting a users password |
| CPhoneNotificationDetails | User settings can be configure on the server for notifications |
| CPTZStream | The PTZStream is used to send movement commands to a PTZ camera |
| CPushNotificationDetails | User settings can be configure on the server for notifications |
| CRGBFrame | An RGBFrame is designed for transforming YCbCr colour space frames into RGB colour space frames |
| CSecureConnectProxyService | Creates a secure connect service to the remote encoder |
| CSensorInfo | A class representing an RDC sensor attached to the encoder |
| CServer | A Server interface is used to make a connection to an EdgeVis server |
| CServerInfo | Holds the current status of the server |
| CService | Definition of the Service abstract class |
| CSettingsModifier | The settings modifier is used to change the settings on an Encoder |
| CSnapshotFrame | A SnapshotFrame is an extension of YCbCrFrame |
| CStream | The Stream interface represent a service that is available on an Encoder |
| CStreamData | This is the base class for the StreamData objects |
| CTimeline | This contains lists of days, hours and minutes that the archive holds footage for |
| CUserNotificationPreferences | A class representing the current user's CAMS notification preferences |
| CVideoData | Extends the StreamData class and is a base class for all types of video data provided by the MediaStream |
| CVideoFrameLayout | VideoFrameLayout decribes the content of the frame from a given Encoder input |
| CVideoFrameLayoutComponent | VideoFrameLayoutComponent decribes either all or part of a VideoFrameLayout |
| CVPTZData | Class describing the are currently being sent as VPTZ |
| CYCbCrFrame | An YCbCrFrame is delivered for every frame of video decoded from a media stream |
| ►NEdgeVisSDKCore | |
| CAreaOfInterestConfig | Defines the area of interest configuration to use for a video input |
| CBandwidthConfig | Defines the bandwidth configuration to use for an encoder |
| CConnectionProfile | Availability |
| CIridiumConfig | Defines the Iridium configuration in use for an encoder |
| CSecureConnectEndpointConfig | Availability |
| CServerAddresses | This stores server addresses that the SDK should use to connect to |
| CStreamConfig | Class to allow for configuring the streaming characteristics of an Encoder |
| CAnalyticsActorInfo | Describes an analytics actor data object being received |
| CAnalyticsActorPoint | Describes an analytics actor points |
| CAudioProfileInfo | The audio profile info as used in the EncoderProfile object |
| CBandwidthProfileInfo | The Bandwidth profile info as used in the EncoderProfile object |
| CFeatureInfo | Describes the availability of an Encoder feature |
| CFilterInfo | Defines Encoder video filter settings |
| CLocalWifiDownloadInfo | Defines Encoder local Wifi download settings |
| CPTZCustomCommand | Content for PTZ Custom command |
| CPTZPresetInfo | Defines a PTZ Preset |
| CPTZTourInfo | Content of the PTZ Tour |
| CSecureConnectProxyStatus | Contains status information of the SecureConnect connection |
| CVideoProfileInfo | The video profile info as used in the EncoderProfile object |