Class List

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

[detail level 123]

►NVxSdk
CIVxAlarmInput	Represents a physical alarm input.
CIVxBookmark	Represents a point in time of interest with reference to a particular data source.
CIVxClip	Represents a contiguous duration of stored media originating from a single data source.
►CIVxConfiguration	Represents the configuration of a device.
CCluster	Represents cluster configuration attributes. This representation shall be identical within a cluster, regardless of the node it was retrieved from.
CNode	Represents an individual host machine (a "node") within a cluster.
CStorage	Represents a VxStorage-specific configuration.
CTime	Represents the time configuration.
CIVxDataInterface	Represents a data interface for a data source. Clients can retrieve data from the data source using the protocol specified by this interface.
CIVxDataObject	Represents 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.
CIVxDataSession	Represents a data session that is being transmitted by a data source, via a data interface, to a client.
CIVxDataSource	Represents a data producer in the system hosted by a device. Each data source provides a list of data interfaces, which provide a particular protocol used to transmit and control the data produced by this data source.
CIVxDataStorage	Represents a data storage provider in the system (e.g. NSM5200 storage pool or VideoXpert Storage) hosted by a system device. The data storage can be directed to store media produced by a device by assigning the device to it.
CIVxDevice	Represents a particular physical device in the system.
CIVxDeviceAssignment	Represents a device assignment on a data storage.
CIVxDrawing	Represents a diagrammatic representation of an area. A drawing may contain any number of markers to represent points of interest within the area.
CIVxDriver	Represents a device communication driver.
CIVxEvent	Represents an instance of a particular situation that has occurred.
CIVxExport	Represents an exported data set that is archived within the system.
CIVxExportClip	Represents an individual range of media data belonging to an export. This data shall be exported when the export is triggered.
CIVxLicense	Represents license information for the resource that owns this resource.
CIVxLicenseFeature	Represents device functionality that is enabled with a valid license.
CIVxManualRecording	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.
CIVxMarker	Represents the location of a resource on a drawing. A marker is associated with exactly one drawing, though a drawing may have many markers. A marker may be associated with one resource, though a resource may have many markers.
CIVxMonitor	Represents a display for view data (typically video).
CIVxMonitorCell	Represents a single viewport, hosted on a monitor, that can play media from a data source.
CIVxNotification	Represents a particular notification configuration for a situation.
CIVxPattern	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.
CIVxPreset	Represents a predefined point that a PTZ device can PTZ to when triggered.
CIVxPrivilege	Represents a specific permission that is given to a role.
CIVxPtzController	Represents a controller for a device that has pan, tilt, and/or zoom functionality.
CIVxPtzLock	Represents a lock for a PTZ controller.
CIVxQuickLog	Represents a set of system logs that can be compiled together and packaged for download.
CIVxQuickReport	Represents a quick system health report.
CIVxRelayOutput	Represents a physical relay output.
CIVxResourceLock	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.
CIVxResourceRel	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.
CIVxRole	Represents a collection of permissions which can be assigned to a user.
CIVxSchedule	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.
CIVxScheduleTrigger	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.
CIVxSituation	Represents a particular situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected.
CIVxSystem	Represents a VideoXpert system and allows the user to manage the system and devices.
CIVxTag	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.
CIVxUser	Represents information about a system user.
CIVxUserInfo	Represents general information about a user.
CVxAckState	Values that represent the current acknowledgement state of an event.
CVxAlarmState	Values that represent the state of an alarm input.
CVxAuthInfo	Represents the information needed to authenticate with a VideoXpert system.
CVxCellLayout	Values that represent possible monitor layouts.
CVxCollection	Represents a collection of resources.
CVxCollectionFilter	Represents a filter to be used when creating a VxCollection.
CVxCollectionFilterItem	Values that represent collection filter types.
CVxConfigStatus	Values that represent the current cluster configuration status.
CVxDataSourceType	Values that represent the particular type of a data source.
CVxDataStorageType	Values that represent hardware type of a data storage.
CVxDeviceSearchStatus	Values that represent the current status of an AutoAddDevices search.
CVxDeviceState	Values that represent the operational state of a device.
CVxDeviceStatus	Values that represent the current status of a device.
CVxDeviceType	Values that represent device types.
CVxExportFormat	Values that represent the format of exported data.
CVxExportStatus	Values that represent status of an export.
CVxFocusDirection	Values that represent focus directions.
CVxInternalEvent	Represents an internal event generated by the VxSDK.
CVxInternalEventType	Values that represent event types sent from the VxSDK.
CVxIrisDirection	Values that represent iris directions.
CVxKvObject	Represents a key/value pair object.
CVxLogCreationStatus	Values that represent status of creating a quick log.
CVxLoginInfo	Represents the information needed to log in to a VideoXpert system.
CVxLogLevel	Values that represent logging severity levels.
CVxNewBookmark	Represents a new bookmark to be created.
CVxNewDataObject	Represents a new data object to be created.
CVxNewDevice	Represents a new device to be created.
CVxNewDeviceAssignment	Represents a new device assignment to be created.
CVxNewDrawing	Represents a new drawing to be created.
CVxNewEvent	Represents a request for a new event to be generated. The event will be generated based upon the event data, its situation configuration, and will receive a unique identifier.
CVxNewExport	Represents a new export to be created.
CVxNewExportClip	Represents a clip that will be exported as part of a new export.
CVxNewManualRecording	Represents a request for a new manual recording to be generated.
CVxNewMarker	Represents a new marker to be created.
CVxNewMonitor	Represents a new monitor to be created.
CVxNewNotification	Represents a new notification configuration for a situation.
CVxNewPrivilege	Represents a new privilege to be created.
CVxNewQuickReport	Represents a new quick report.
CVxNewSchedule	Represents a new schedule to be created. 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.
CVxNewScheduleTrigger	Represents a new schedule trigger to be created. 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.
CVxNewSituation	Represents a new situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected.
CVxNewTag	Represents a new tag to be created.
CVxNewUser	Represents a new user to be created.
CVxPermissionId	Values that represent a permission type.
CVxPhoneNumber	Represents a telephone number for a user.
CVxPhoneType	Values that represent the type of a phone number.
CVxPtzLimits	Represents the value limits for a PTZ controller.
CVxRecordingFramerate	Values that represent the video framerate level.
CVxRecordingType	Values that represent the type of trigger that caused the recording.
CVxRecurrenceType	Values that represent the interval at which triggers repeat.
CVxRelayState	Values that represent the state of a relay output.
CVxRenderType	Values that represent the stream rendering types.
CVxReportContent	Values that represent types of content for quick reports.
CVxReportCreationStatus	Values that represent status of creating a quick report.
CVxResourceType	Values that represent a type of resource.
CVxResult	Values that represent the result of calls to the VideoXpert system.
CVxRetentionPriority	Values that represent how long the recording device should attempt to retain the clip.
CVxScheduleAction	Values that represent schedule recording actions.
CVxSituationType	Values that represent the available situation types for triggering a schedule.
CVxSnapshotFilter	Represents a snapshot filter to be used when taking a snapshot.
CVxSnapshotFilterItem	Values that represent snapshot filter types.
CVxStreamFormat	Values that represent media stream encoding formats.
CVxStreamProtocol	Values that represent stream protocols.
CVxSystemLicenseType	Values that represent the types of system licenses.
CVxZoomDirection	Values that represent zoom directions.