Namespaces
	Utilities
	Provides commonly used methods.

Classes
struct	IVxAlarmInput
	Represents a physical alarm input. More...

struct	IVxBookmark
	Represents a point in time of interest with reference to a particular data source. More...

struct	IVxClip
	Represents a contiguous duration of stored media originating from a single data source. More...

struct	IVxConfiguration
	Represents the configuration of a device. More...

struct	IVxDataInterface
	Represents a data interface for a data source. Clients can retrieve data from the data source using the protocol specified by this interface. More...

struct	IVxDataObject
	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. More...

struct	IVxDataSession
	Represents a data session that is being transmitted by a data source, via a data interface, to a client. More...

struct	IVxDataSource
	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. More...

struct	IVxDataStorage
	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. More...

struct	IVxDevice
	Represents a particular physical device in the system. More...

struct	IVxDeviceAssignment
	Represents a device assignment on a data storage. More...

struct	IVxDrawing
	Represents a diagrammatic representation of an area. A drawing may contain any number of markers to represent points of interest within the area. More...

struct	IVxDriver
	Represents a device communication driver. More...

struct	IVxEvent
	Represents an instance of a particular situation that has occurred. More...

struct	IVxExport
	Represents an exported data set that is archived within the system. More...

struct	IVxExportClip
	Represents an individual range of media data belonging to an export. This data shall be exported when the export is triggered. More...

struct	IVxLicense
	Represents license information for the resource that owns this resource. More...

struct	IVxLicenseFeature
	Represents device functionality that is enabled with a valid license. More...

struct	IVxManualRecording
	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...

struct	IVxMarker
	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. More...

struct	IVxMonitor
	Represents a display for view data (typically video). More...

struct	IVxMonitorCell
	Represents a single viewport, hosted on a monitor, that can play media from a data source. More...

struct	IVxNotification
	Represents a particular notification configuration for a situation. More...

struct	IVxPattern
	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...

struct	IVxPreset
	Represents a predefined point that a PTZ device can PTZ to when triggered. More...

struct	IVxPrivilege
	Represents a specific permission that is given to a role. More...

struct	IVxPtzController
	Represents a controller for a device that has pan, tilt, and/or zoom functionality. More...

struct	IVxPtzLock
	Represents a lock for a PTZ controller. More...

struct	IVxQuickLog
	Represents a set of system logs that can be compiled together and packaged for download. More...

struct	IVxQuickReport
	Represents a quick system health report. More...

struct	IVxRelayOutput
	Represents a physical relay output. More...

struct	IVxResourceLock
	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...

struct	IVxResourceRel
	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...

struct	IVxRole
	Represents a collection of permissions which can be assigned to a user. More...

struct	IVxSchedule
	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...

struct	IVxScheduleTrigger
	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...

struct	IVxSituation
	Represents a particular situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected. More...

struct	IVxSystem
	Represents a VideoXpert system and allows the user to manage the system and devices. More...

struct	IVxTag
	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...

struct	IVxUser
	Represents information about a system user. More...

struct	IVxUserInfo
	Represents general information about a user. More...

struct	VxAckState
	Values that represent the current acknowledgement state of an event. More...

struct	VxAlarmState
	Values that represent the state of an alarm input. More...

struct	VxAuthInfo
	Represents the information needed to authenticate with a VideoXpert system. More...

struct	VxCellLayout
	Values that represent possible monitor layouts. More...

struct	VxCollection
	Represents a collection of resources. More...

struct	VxCollectionFilter
	Represents a filter to be used when creating a VxCollection. More...

struct	VxCollectionFilterItem
	Values that represent collection filter types. More...

struct	VxConfigStatus
	Values that represent the current cluster configuration status. More...

struct	VxDataSourceType
	Values that represent the particular type of a data source. More...

struct	VxDataStorageType
	Values that represent hardware type of a data storage. More...

struct	VxDeviceSearchStatus
	Values that represent the current status of an `AutoAddDevices` search. More...

struct	VxDeviceState
	Values that represent the operational state of a device. More...

struct	VxDeviceStatus
	Values that represent the current status of a device. More...

struct	VxDeviceType
	Values that represent device types. More...

struct	VxExportFormat
	Values that represent the format of exported data. More...

struct	VxExportStatus
	Values that represent status of an export. More...

struct	VxFocusDirection
	Values that represent focus directions. More...

struct	VxInternalEvent
	Represents an internal event generated by the VxSDK. More...

struct	VxInternalEventType
	Values that represent event types sent from the VxSDK. More...

struct	VxIrisDirection
	Values that represent iris directions. More...

struct	VxKvObject
	Represents a key/value pair object. More...

struct	VxLogCreationStatus
	Values that represent status of creating a quick log. More...

struct	VxLoginInfo
	Represents the information needed to log in to a VideoXpert system. More...

struct	VxLogLevel
	Values that represent logging severity levels. More...

struct	VxNewBookmark
	Represents a new bookmark to be created. More...

struct	VxNewDataObject
	Represents a new data object to be created. More...

struct	VxNewDevice
	Represents a new device to be created. More...

struct	VxNewDeviceAssignment
	Represents a new device assignment to be created. More...

struct	VxNewDrawing
	Represents a new drawing to be created. More...

struct	VxNewEvent
	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. More...

struct	VxNewExport
	Represents a new export to be created. More...

struct	VxNewExportClip
	Represents a clip that will be exported as part of a new export. More...

struct	VxNewManualRecording
	Represents a request for a new manual recording to be generated. More...

struct	VxNewMarker
	Represents a new marker to be created. More...

struct	VxNewMonitor
	Represents a new monitor to be created. More...

struct	VxNewNotification
	Represents a new notification configuration for a situation. More...

struct	VxNewPrivilege
	Represents a new privilege to be created. More...

struct	VxNewQuickReport
	Represents a new quick report. More...

struct	VxNewSchedule
	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. More...

struct	VxNewScheduleTrigger
	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. More...

struct	VxNewSituation
	Represents a new situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected. More...

struct	VxNewTag
	Represents a new tag to be created. More...

struct	VxNewUser
	Represents a new user to be created. More...

struct	VxPermissionId
	Values that represent a permission type. More...

struct	VxPhoneNumber
	Represents a telephone number for a user. More...

struct	VxPhoneType
	Values that represent the type of a phone number. More...

struct	VxPtzLimits
	Represents the value limits for a PTZ controller. More...

struct	VxRecordingFramerate
	Values that represent the video framerate level. More...

struct	VxRecordingType
	Values that represent the type of trigger that caused the recording. More...

struct	VxRecurrenceType
	Values that represent the interval at which triggers repeat. More...

struct	VxRelayState
	Values that represent the state of a relay output. More...

struct	VxRenderType
	Values that represent the stream rendering types. More...

struct	VxReportContent
	Values that represent types of content for quick reports. More...

struct	VxReportCreationStatus
	Values that represent status of creating a quick report. More...

struct	VxResourceType
	Values that represent a type of resource. More...

struct	VxResult
	Values that represent the result of calls to the VideoXpert system. More...

struct	VxRetentionPriority
	Values that represent how long the recording device should attempt to retain the clip. More...

struct	VxScheduleAction
	Values that represent schedule recording actions. More...

struct	VxSituationType
	Values that represent the available situation types for triggering a schedule. More...

struct	VxSnapshotFilter
	Represents a snapshot filter to be used when taking a snapshot. More...

struct	VxSnapshotFilterItem
	Values that represent snapshot filter types. More...

struct	VxStreamFormat
	Values that represent media stream encoding formats. More...

struct	VxStreamProtocol
	Values that represent stream protocols. More...

struct	VxSystemLicenseType
	Values that represent the types of system licenses. More...

struct	VxZoomDirection
	Values that represent zoom directions. More...

Typedefs
typedef void(*	VxEventCallback) (IVxEvent *)

typedef void(*	VxInternalEventCallback) (VxInternalEvent *)

Functions
EXTERN_C VXAPI VxResult::Value	VxSystemLogin (const VxLoginInfo &loginInfo, IVxSystem *&system)
	Logs in to the VideoXpert system. More...

EXTERN_C VXAPI VxResult::Value	IsSupportedSystem (const char *ipAddress, int port, bool &isSupported)
	Checks whether the system at the specified IP address is supported by this SDK. More...

EXTERN_C VXAPI VxResult::Value	VxSetLogLevel (VxLogLevel::Value logLevel)
	Sets the minimum severity level of messages to log. More...

EXTERN_C VXAPI VxResult::Value	VxSetLogPath (const char *logPath)
	Sets the output path for log files. More...

Typedef Documentation

typedef void(* VxSdk::VxEventCallback) (IVxEvent *)

Definition at line 164 of file IVxEvent.h.

typedef void(* VxSdk::VxInternalEventCallback) (VxInternalEvent *)

Definition at line 69 of file VxInternalEvent.h.

Function Documentation

EXTERN_C VXAPI VxResult::Value VxSdk::IsSupportedSystem	(	const char *	ipAddress,
		int	port,
		bool &	isSupported
	)

Checks whether the system at the specified IP address is supported by this SDK.

Parameters

ipAddress	The IP address of the system we want to check.
port	The port of the system we want to check.
isSupported	`true` if system is supported, otherwise `false`.

Returns: The Result of the request.

EXTERN_C VXAPI VxResult::Value VxSdk::VxSetLogLevel ( VxLogLevel::Value logLevel )

Sets the minimum severity level of messages to log.

Parameters

logLevel The logging severity level.

Returns: The Result of setting the configuration.

EXTERN_C VXAPI VxResult::Value VxSdk::VxSetLogPath ( const char * logPath )

Sets the output path for log files.

Parameters

logPath The directory to store the generated log files.

Returns: The Result of setting the configuration.

EXTERN_C VXAPI VxResult::Value VxSdk::VxSystemLogin	(	const VxLoginInfo &	loginInfo,
		IVxSystem *&	system
	)

Logs in to the VideoXpert system.

Parameters

loginInfo	The information to connect and log in with.
system	`nullptr` if login fails, else the new IVxSystem.

Returns: The Result of the login.

Namespaces

Classes

Typedefs

Functions

Typedef Documentation

Function Documentation