Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

▼NCPPCli
CAlarmInput	The AlarmInput class represents a physical alarm input.
CBookmark	The Bookmark class represents a point in time of interest with reference to a particular data source.
CClip	The Clip class represents a contiguous duration of stored media originating from a single DataSource.
▼CConfiguration	The Configuration class represents a device configuration.
CCluster	The Cluster class represents cluster configuration attributes. This representation shall be identical within a cluster, regardless of the node it was retrieved from.
CNode	The Node class represents an individual host machine (a "node") within a cluster.
CStorage	The Configuration class represents a VxStorage-specific configuration.
CTime	The Time class represents a time configuration.
CDataInterface	The DataInterface class represents an interface to a data source.
CDataObject	The DataObject class represents an object that contains a custom serialized data object submitted by a client and stored on the server. The data is completely opaque to the server and other types of clients.
CDataSession	The DataSession class represents a data session that is being transmitted by a data source, via a data interface, to a client.
CDataSource	The DataSource class represents a data producer in the system hosted by a device. Each DataSource provides a list of DataInterface, each of which provides a particular protocol used to transmit and control the data produced by this DataSource.
CDataStorage	The DataStorage class represents a data storage provider in the system (e.g. an NSM5200 storage pool or a VxRecorder) hosted by a system device. The DataStorage can be directed to store media produced by a device by assigning the device to it.
CDevice	The Device class represents a particular physical device in the system.
CDeviceAssignment	The DeviceAssignment class represents a device assignment.
CDrawing	The Drawing class represents a diagrammatic representation of an area. A drawing may contain any number of markers to represent points of interest within the area.
CDriver	The Driver class represents a device communication driver.
CEvent	The Event class represents an instance of a particular situation that has occurred.
CExport	The Export class represents an exported data set that is archived within the system.
CExportClip	The ExportClip class represents an individual range of media data belonging to an Export. This data shall be exported when the Export is triggered.
CInternalEvent	The InternalEvent class represents an internal event generated by the VxSDK.
CLicense	The License class represents license information for the resource that owns this resource.
CLicenseFeature	The LicenseFeature class represents device functionality that is enabled with a valid license.
CLogLevel	The LogLevel class is a helper class that contains the logging severity Values enum.
CManualRecording	The ManualRecording class represents an instance of an active manual recording (the action, not the recorded clip). Each manual recording will cause its specified data source to be manually recorded by all data storages that the data source is assigned to. Only one manual recording per user per data source is allowed. A clip created via the application of a manual recording will have an event value of manual.
CMarker	The Marker class represents the location of a resource on a drawing.
CMediaControl	The MediaControl class creates a controller object that provides the ability to create and control video streams.
CMediaEvent	The MediaEvent class represents an event that has been sent from a stream.
CMonitor	The Monitor class represents a display for view data (typically video).
CMonitorCell	The MonitorCell class represents a single viewport, hosted on a monitor, that can play media from a data source.
CNewBookmark	The NewBookmark class represents a new bookmark.
CNewDataObject	The NewDataObject class represents a new data object.
CNewDevice	The NewDevice class represents a new device.
CNewDeviceAssignment	The NewDeviceAssignment class represents a new device assignment.
CNewEvent	The NewEvent class represents a request for a new event to be generated. The event will be generated based upon the NewEvent data, its Situation configuration, and will receive a unique identifier.
CNewExport	The NewExport class represents a new export.
CNewExportClip	The NewExportClip class represents a new export clip.
CNewManualRecording	The NewManualRecording class represents a request for a new manual recording to be generated.
CNewMarker	The NewMarker class represents a new Marker.
CNewMonitor	The NewMonitor class represents a new monitor to be created on the system.
CNewNotification	The NewNotification class represents a new notification.
CNewPrivilege	The NewTag class represents a new privilege.
CNewQuickReport	The NewQuickReport class represents a new quick report.
CNewSchedule	The NewSchedule class represents a new schedule.
CNewScheduleTrigger	The NewScheduleTrigger class represents a new schedule trigger configuration that specifies a time range and an optional event that together act as a trigger to activate a schedule.
CNewSituation	The NewSituation class represents a new situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected.
CNewTag	The NewTag class represents a new tag.
CNewUser	The NewUser class represents a new user.
CNotification	The Notification class represents a particular notification configuration for a situation.
CPattern	The Pattern class represents a predefined sequence of movement that a PTZ device can perform when triggered. A running pattern will be halted upon any other PTZ request.
CPreset	The Preset class represents a predefined point that a PTZ device can PTZ to when triggered.
CPrivilege	The Privilege class represents a specific permission that is given to a role.
CPtzController	The PtzController class can be created for a device that has pan, tilt, and/or zoom functionality.
CPtzLimits	The PtzLimits class represents the value limits for a ptz controller.
CPtzLock	The PtzLock class represents a lock for a ptz controller.
CQuickLog	The QuickLog class represents a quick system health log.
CQuickReport	The QuickReport class represents a quick system health report.
CRelayOutput	The RelayOutput class represents a physical relay output.
CResourceLock	The ResourceLock class represents a lock upon a resource. A resource that has been locked shall permit only the owner of the lock access to modify the resource.
CResourceRel	The ResourceRel class represents a related resource; that is, a resource that is related in some way to a parent resource. This related resource may be linked to its parent resource for some effect.
CResults	The Results class is a helper class that contains the Results enum.
CRole	The Role class represents a collection of permissions which can be assigned to a user.
CSchedule	The Schedule class represents a recording schedule. A schedule is a group of 0 or more resources associated with a set of time and/or event based schedule triggers that, when any are active, cause the scheduled action to be performed.
CScheduleTrigger	The Situation class represents a schedule trigger. A schedule trigger is a time range and an optional event that together act as a trigger to activate a schedule and cause it to perform its configured action.
CSituation	The Situation class represents a particular situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected.
CSnapshotFilter	The SnapshotFilter class represents a filter that can be used when generating snapshots.
CTag	The Tag class represents a non-hierarchical identifier typically associated with one or more resources (i.e. device or data source). A tag helps to describe a resource and allows it to be found more efficiently.
CUser	The User class represents information about a system user.
CUserInfo	The UserInfo class represents general information about a user.
CUtils	Provides commonly used methods.
CVxGlobal	Provides global VxSDK methods.
CVXSystem	The VXSystem class represents a VideoXpert system. It is the entry point of the VideoXpert SDK and allows the user to manage the system and devices.