CPPCli Namespace Reference

Classes
class	AlarmInput
	The AlarmInput class represents a physical alarm input. More...
class	Bookmark
	The Bookmark class represents a point in time of interest with reference to a particular data source. More...
class	Clip
	The Clip class represents a contiguous duration of stored media originating from a single DataSource. More...
class	Configuration
	The Configuration class represents a device configuration. More...
class	DataInterface
	The DataInterface class represents an interface to a data source. More...
class	DataObject
	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. More...
class	DataSession
	The DataSession class represents a data session that is being transmitted by a data source, via a data interface, to a client. More...
class	DataSource
	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. More...
class	DataStorage
	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. More...
class	Device
	The Device class represents a particular physical device in the system. More...
class	DeviceAssignment
	The DeviceAssignment class represents a device assignment. More...
class	Drawing
	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. More...
class	Driver
	The Driver class represents a device communication driver. More...
class	Event
	The Event class represents an instance of a particular situation that has occurred. More...
class	Export
	The Export class represents an exported data set that is archived within the system. More...
class	ExportClip
	The ExportClip class represents an individual range of media data belonging to an Export. This data shall be exported when the Export is triggered. More...
class	InternalEvent
	The InternalEvent class represents an internal event generated by the VxSDK. More...
class	License
	The License class represents license information for the resource that owns this resource. More...
class	LicenseFeature
	The LicenseFeature class represents device functionality that is enabled with a valid license. More...
class	LogLevel
	The LogLevel class is a helper class that contains the logging severity Values enum. More...
class	ManualRecording
	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. More...
class	Marker
	The Marker class represents the location of a resource on a drawing. More...
class	MediaControl
	The MediaControl class creates a controller object that provides the ability to create and control video streams. More...
class	MediaEvent
	The MediaEvent class represents an event that has been sent from a stream. More...
class	Monitor
	The Monitor class represents a display for view data (typically video). More...
class	MonitorCell
	The MonitorCell class represents a single viewport, hosted on a monitor, that can play media from a data source. More...
class	NewBookmark
	The NewBookmark class represents a new bookmark. More...
class	NewDataObject
	The NewDataObject class represents a new data object. More...
class	NewDevice
	The NewDevice class represents a new device. More...
class	NewDeviceAssignment
	The NewDeviceAssignment class represents a new device assignment. More...
class	NewEvent
	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. More...
class	NewExport
	The NewExport class represents a new export. More...
class	NewExportClip
	The NewExportClip class represents a new export clip. More...
class	NewManualRecording
	The NewManualRecording class represents a request for a new manual recording to be generated. More...
class	NewMarker
	The NewMarker class represents a new Marker. More...
class	NewMonitor
	The NewMonitor class represents a new monitor to be created on the system. More...
class	NewNotification
	The NewNotification class represents a new notification. More...
class	NewPrivilege
	The NewTag class represents a new privilege. More...
class	NewQuickReport
	The NewQuickReport class represents a new quick report. More...
class	NewSchedule
	The NewSchedule class represents a new schedule. More...
class	NewScheduleTrigger
	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. More...
class	NewSituation
	The NewSituation class represents a new situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected. More...
class	NewTag
	The NewTag class represents a new tag. More...
class	NewUser
	The NewUser class represents a new user. More...
class	Notification
	The Notification class represents a particular notification configuration for a situation. More...
class	Pattern
	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. More...
class	Preset
	The Preset class represents a predefined point that a PTZ device can PTZ to when triggered. More...
class	Privilege
	The Privilege class represents a specific permission that is given to a role. More...
class	PtzController
	The PtzController class can be created for a device that has pan, tilt, and/or zoom functionality. More...
class	PtzLimits
	The PtzLimits class represents the value limits for a ptz controller. More...
class	PtzLock
	The PtzLock class represents a lock for a ptz controller. More...
class	QuickLog
	The QuickLog class represents a quick system health log. More...
class	QuickReport
	The QuickReport class represents a quick system health report. More...
class	RelayOutput
	The RelayOutput class represents a physical relay output. More...
class	ResourceLock
	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. More...
class	ResourceRel
	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. More...
class	Results
	The Results class is a helper class that contains the Results enum. More...
class	Role
	The Role class represents a collection of permissions which can be assigned to a user. More...
class	Schedule
	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. More...
class	ScheduleTrigger
	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. More...
class	Situation
	The Situation class represents a particular situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected. More...
class	SnapshotFilter
	The SnapshotFilter class represents a filter that can be used when generating snapshots. More...
class	Tag
	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. More...
class	User
	The User class represents information about a system user. More...
class	UserInfo
	The UserInfo class represents general information about a user. More...
class	Utils
	Provides commonly used methods. More...
class	VxGlobal
	Provides global VxSDK methods. More...
class	VXSystem
	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. More...