Inheritance diagram for ServerCommandService:

Classes
class	AlertOccurrence
	Represents an entry in a list of alerts. More...

class	AlertTypeGroupInfo

class	AlertTypeInfo

class	ApplicationSecurityInfo

class	AudioMessageInfo

class	Bookmark
	A bookmark. More...

class	BookmarkReference
	A bookmark reference. More...

class	BookmarkSettingInfo

class	CameraGroupInfo

class	CameraInfo

class	CameraSecurityInfo

class	CapabilityInfo

class	Change

class	ChangeType

class	ClientProfile
	A Client Profile. More...

class	ClientProfileSetting
	A Client Profile Setting. More...

class	ConfigurationInfo
	Represents configuration information for a server. More...

class	CustomSetting
	Contains custom setting information and data. More...

class	CustomSettingData
	Contains custom setting data. More...

class	CustomSettingInfo
	Contains custom setting information. More...

class	DeviceInfo

class	DeviceMappingInfo

class	EventTypeGroupInfo

class	EventTypeInfo

class	FaultDevice
	Error state of device while processing marked or restricted media. More...

class	GroupInfo

class	HardwareInfo

class	HemisphereInfo

class	ImmerVisionInfo

class	InputGroupInfo

class	InputInfo

class	InputSecurityInfo

class	IpixInfo

class	KeyValue
	A Key/Value pair that consists of two strings. More...

class	LicenseInfo

class	LoginInfo
	Login information returned by a login call. More...

class	MarkedData
	Marked Data. More...

class	MarkedDataReference
	Marked data reference. More...

class	MarkedDataResult
	Result of processing marked data. More...

class	MatrixMonitorInfo

class	MetadataDeviceInfo

class	MetadataDeviceSecurityInfo

class	MicrophoneGroupInfo

class	MicrophoneInfo

class	MicrophoneSecurityInfo

class	OutputGroupInfo

class	OutputInfo

class	OutputSecurityInfo

class	PanoramicLensInfo

class	PositionInfo

class	PresetInfo

class	ProductInfo

class	PtzInfo

class	PtzSecurityInfo

class	RecorderInfo

class	RestrictedMedia
	Class representing a playback media restriction (also known as a video restriction). More...

class	RestrictedMediaLive
	Class representing a live media restriction (also known as a video restriction). More...

class	RestrictedMediaLiveResult
	Class representing the result of creating, querying, updating or deleting live media restrictions (also known as video restrictions). More...

class	RestrictedMediaResult
	Class representing the result of creating, querying, updating or deleting media restrictions (also known as video restrictions). More...

class	RetentionOption

class	RetentionSettingInfo

class	ServerOption

class	SmartClientSecurityInfo

class	SmartClientVersion

class	SpeakerGroupInfo

class	SpeakerInfo

class	SpeakerSecurityInfo

class	StreamInfo

class	SystemEventTypeInfo

class	SystemLicenseInfo

class	TimeDuration
	Represents a timespan (.NET TimeSpan does apparently not work automatically with soap serialization) More...

class	UpgradeInfo

class	UserInfo

class	ViewGroup
	Contains ViewGroup information and data. More...

class	ViewGroupData
	Contains ViewGroup data. More...

class	ViewGroupInfo
	Contains ViewGroup information. More...

class	WarningDevice
	Warning for a device while processing marked or restricted media. More...

Public Types
enum	AuthorizationActionType { None = 0 , LogOn = 1 }

enum	EventSource { Undefined , Device , External , Hardware , Recorder , Server , System , Timer }

enum	MediaDeviceType { Camera , Microphone , Speaker }

enum	RestrictedMediaResultStatus { Undefined , Success , Failed , PartlySuccess , RestrictedMediaNotFound , FeatureNotLicensed , RecorderNotFound , ManagementServerUnavailable , Unauthorized }
	Enum representing the result of a media restriction operation. More...

enum	ResultStatus { Undefined , Success , Failed , PartlySuccess , MarkedDataNotFound , FeatureNotLicensed , RecorderNotFound , ManagementServerUnavailable , Unauthorized }

enum	RetentionOptionType { Unused = 0 , Days , Weeks , Months , Years , UserDefined , Indefinite }

enum	SetCustomSettingResultType { UnspecifiedError , Success , ModifiedError }
	Represents the set custom setting result. More...

enum	SetViewGroupDataResultType { UnspecifiedError , Success , ReadOnlyError , ModifiedError }
	Represents the set ViewGroup data result. More...

enum	SortOrderOption { Header , Description , StartTime , TagTime , EndTime , CreateTime , RetentionExpireTime , UserName , Size }

enum	ViewGroupType { Normal = 0 }
	Represents the ViewGroup type. More...

Public Member Functions
AlertOccurrence[]	AlertsGetAroundWithSpan (string token, Guid[] alertIds, DateTime centerTime, TimeDuration maxTimeBefore, int maxCountBefore, TimeDuration maxTimeAfter, int maxCountAfter)

string	Authorize (string userDomainName, AuthorizationActionType type)
	Creates an cookie for authorized user.

Bookmark	BookmarkCreate (string token, Guid deviceId, DateTime timeBegin, DateTime timeTrigged, DateTime timeEnd, string reference, string header, string description)
	Creates a new bookmark.

void	BookmarkDelete (string token, Guid bookmarkId)
	Delete a bookmark.

Bookmark	BookmarkGet (string token, Guid bookmarkId)
	Retreive a bookmark.

BookmarkReference	BookmarkGetNewReference (string token, Guid deviceId, bool live)
	Creates a new reference id string. For now none of the parameters are used, might be use in future schemes. The bookmark and id is not stored before calling BookmarkCreate. This reference id is not to be confused with the bookmark id (unique id as guid).

Bookmark[]	BookmarkSearchFromBookmark (string token, Guid fromBookmarkId, TimeDuration timeLimit, int countLimit, MediaDeviceType[] deviceTypes, Guid[] optDeviceIds, string[] optUsers, string optSearchStr)
	Search out bookmarks from time of given bookmark with different filtering options. This function is used for paging search results.

Bookmark[]	BookmarkSearchTime (string token, DateTime time, TimeDuration timeLimit, int countLimit, MediaDeviceType[] deviceTypes, Guid[] optDeviceIds, string[] optUsers, string optSearchStr)
	Search out bookmarks from time with different filtering options.

Bookmark	BookmarkUpdate (string token, Guid bookmarkId, Guid deviceId, DateTime timeBegin, DateTime timeTrigged, DateTime timeEnd, string reference, string header, string description)
	Updates a bookmark.

SmartClientVersion	CheckSmartClientVersion (int major, int minor, string revision)

Guid	CreatePreset (string token, Guid deviceId, string name)
	Create a new preset.

void	DeletePreset (string token, Guid id, Guid deviceId)
	Deletes a specific preset.

void	EventTrigger (string token, Guid eventId)
	This command will trigger a user-defined event on an XProtect VMS.

void	EventTriggerWithMetadata (string token, Guid eventId, KeyValue[] metadata)
	This command will trigger a defined event on a VMS. This command is similar to the EventTrigger, except that this command include references to device ids (usually camera Guids), that are used as parameters for issuing the event. The format of the KeyValue pair is two strings, where the key contains a simple name, and the Value contains a XML definition.

ClientProfile	GetClientProfile (string token, bool withSetting)

ConfigurationInfo	GetConfiguration (string token)

HardwareInfo[]	GetConfigurationHardware (string token, Guid[] hardwareIds)

RecorderInfo[]	GetConfigurationRecorders (string token, Guid[] recorderIds)

CustomSetting	GetCustomSettingDataGlobal (string token, Guid customSettingId)

CustomSetting	GetCustomSettingDataUser (string token, Guid customSettingId)

PresetInfo[]	GetPresets (string token, Guid deviceId)
	Retrieve all presets.

ProductInfo	GetProductInfo ()
	Returns the basic product information for the VMS. Note: Check product support matrix for what products can support this command.

string	GetServerVersion ()

SmartClientVersion	GetSmartClientVersion ()

SystemLicenseInfo	GetSystemLicenseInfo ()

UserInfo	GetUserInfo (string token)
	Returns the UserInfo for an already logged on session.

int	GetVersion ()

ViewGroup	GetViewGroupData (string token, Guid viewGroupId)

ViewGroupInfo[]	GetViewGroups (string token)

System.Collections.DictionaryEntry[]	GetVmoServicesList ()

LoginInfo	Login (Guid instanceId, string currentToken)
	Login to a Milestone VMS.

void	Logout (Guid instanceId, string currentToken)

MarkedDataResult	MarkedDataCreate (string token, Guid markedDataId, System.Guid[] deviceIds, System.DateTime timeStart, System.DateTime timeTag, System.DateTime timeEnd, string reference, string header, string description, int markedDataType, bool useRetention, DateTime retentionExpire, RetentionOption retentionOption)
	Creates a new bookmark.

MarkedDataResult[]	MarkedDataDelete (string token, Guid[] markedDataIds)
	Delete a marked data.

MarkedData	MarkedDataGet (string token, Guid markedDataId)
	Retreive a marked data.

MarkedDataReference	MarkedDataGetNewReference (string token, Guid[] deviceIds, bool live)
	Creates a new reference id string. For now none of the parameters are used, might be use in future schemes. The marked data and id is not stored before calling MarkedDataCreate. This reference id is not to be confused with the marked data id (unique id as guid).

MarkedData[]	MarkedDataSearch (string token, System.Guid[] deviceIds, string searchText, string[] users, System.DateTime createdFromTime, System.DateTime createdToTime, System.DateTime markedDataFromTime, System.DateTime markedDataToTime, System.DateTime tagTimeFromTime, System.DateTime tagTimeToTime, System.DateTime retentionExpireFrom, System.DateTime retentionExpireTo, int pageIndex, int pageSize, SortOrderOption sortOrder, bool sortAscending)
	Search out marked data with different filtering options. This function is used for paging search results.

MarkedDataResult	MarkedDataUpdate (string token, Guid markedDataId, System.Guid[] deviceIds, System.DateTime timeStart, System.DateTime timeTag, System.DateTime timeEnd, string reference, string header, string description, int markedDataType, bool useRetention, DateTime retentionExpire, RetentionOption retentionOption)
	Updates a marked data.

void	MatrixMonitorActivateCamera (string token, Guid matrixMonitorId, Guid deviceId)
	DEPRECATED! Activates (displays) a camera on a Matrix Monitor.

void	MatrixMonitorActivateScript (string token, Guid matrixMonitorId, string script)
	DEPRECATED!

void	OrderPresets (string token, Guid deviceId, Guid[] ids)
	Attempt to order the presets given, doing a "best effort" ordering.

Change[]	QueryChanges (string token, DateTime changesFrom)
	Can be called to be notified when failover happens.

RecorderInfo	QueryRecorderInfo (string token, Guid recorderId)
	Provides the basic information about a recorder. Can be used to re-new the recorder URL after failover.

void	RegisterIntegration (string token, string instanceId, System.Guid integrationId, string integrationVersion, string integrationName, string manufacturerName)
	Method for registering an integration for the sole purpose of getting an overview of integration usage.

RestrictedMediaResult	RestrictedMediaCreate (Guid id, Guid[] deviceIds, string header, string description, DateTime timeStart, DateTime timeEnd)
	Creates a media restriction (also known as a video restriction) for a list of cameras and a time interval where special permissions are needed for users to be able to playback recordings.

RestrictedMediaResult	RestrictedMediaDelete (Guid restrictedMediaId)
	Updates an existing media restriction (also known as a video restriction).

RestrictedMediaLiveResult	RestrictedMediaLiveDelete (Guid[] deviceIds)
	Deletes live media restrictions for the specified devices - thereby removing both restrictions for viewing live and for playing back recorded data for the devices. (No playback media restriction will be created as it is when calling RestrictedMediaLiveModeExit(Guid, Guid[], string, string, DateTime, DateTime).

RestrictedMediaLiveResult	RestrictedMediaLiveModeEnter (Guid[] deviceIds, DateTime timeStart)
	Enters 'restricted live mode' for a list of devices by creating a RestrictedMediaLive instance for each of the specified devices. While in live mode a user will need special permissions in order to view live from the device or to playback recordings made while the camera was in restricted live mode.

RestrictedMediaResult	RestrictedMediaLiveModeExit (Guid id, Guid[] deviceIds, string header, string description, DateTime timeStart, DateTime timeEnd)
	Exits 'restricted live mode' for a list of devices and a the same time creates a playback media restriction for the cameras specified. The playback restriction created by this is similar to a restriction created by calling RestrictedMediaCreate(Guid, Guid[], string, string, DateTime, DateTime).

RestrictedMediaLive[]	RestrictedMediaLiveQueryAll ()
	Queries a list of all existing live media restrictions (also known as video restrictions).

RestrictedMediaLiveResult	RestrictedMediaLiveUpdate (Guid[] deviceIds, DateTime timeStart)
	Updates the start time for a number of live restrictions, thereby either extending or reducing the time interval for which recorded data is restricted.

RestrictedMedia[]	RestrictedMediaQueryAll ()
	Queries a list of all existing media restrictions (also known as video restrictions).

RestrictedMediaResult	RestrictedMediaUpdate (Guid id, Guid[] deviceIdsToAdd, Guid[] deviceIdsToRemove, string header, string description, DateTime timeStart, DateTime timeEnd)
	Updates an existing media restriction (also known as a video restriction).

	ServerCommandService ()

SetCustomSettingResultType	SetCustomSettingDataGlobal (string token, Guid customSettingId, CustomSettingData customSettingData, bool forceOverride)

SetCustomSettingResultType	SetCustomSettingDataUser (string token, Guid customSettingId, CustomSettingData customSettingData, bool forceOverride)

SetViewGroupDataResultType	SetViewGroupData (string token, Guid viewGroupId, ViewGroupData viewGroupdata)

void	UpdatePresetName (string token, Guid id, Guid deviceId, string newName)
	Updates the name of a specific preset.

void	UpdatePresetPosition (string token, Guid id, Guid deviceId)
	Updated the position to current camera postion on a specific preset.

Member Enumeration Documentation

◆ AuthorizationActionType

enum ServerCommandService.AuthorizationActionType

Enumerator
None
LogOn

◆ EventSource

enum ServerCommandService.EventSource

Enumerator
Undefined
Device
External
Hardware
Recorder
Server
System
Timer

◆ MediaDeviceType

enum ServerCommandService.MediaDeviceType

Enumerator
Camera
Microphone
Speaker

◆ RestrictedMediaResultStatus

enum ServerCommandService.RestrictedMediaResultStatus

Enum representing the result of a media restriction operation.

Enumerator
Undefined	Result is undefined (should not happen).
Success	The operation succeeded.
Failed	The operation failed.
PartlySuccess	The operation succeeded for some devices and failed for others.
RestrictedMediaNotFound	An update or delete failed because the specified restriction id does not exist.
FeatureNotLicensed	The operation failed because the functionality is not included in the currently used license.
RecorderNotFound	Not used.
ManagementServerUnavailable	Not used.
Unauthorized	The user did not have permission to do the requested change.

◆ ResultStatus

enum ServerCommandService.ResultStatus

Enumerator
Undefined
Success
Failed
PartlySuccess
MarkedDataNotFound
FeatureNotLicensed
RecorderNotFound
ManagementServerUnavailable
Unauthorized

◆ RetentionOptionType

enum ServerCommandService.RetentionOptionType

Enumerator
Unused
Days
Weeks
Months
Years
UserDefined
Indefinite

◆ SetCustomSettingResultType

enum ServerCommandService.SetCustomSettingResultType

Represents the set custom setting result.

Enumerator
UnspecifiedError	Unspecified error. custom setting data has not been set.
Success	The custom setting data was successfully set.
ModifiedError	Set custom setting data failed because it has been modified by another user.

◆ SetViewGroupDataResultType

enum ServerCommandService.SetViewGroupDataResultType

Represents the set ViewGroup data result.

Enumerator
UnspecifiedError	Unspecified error. ViewGroup data has not been set.
Success	The ViewGroup data was successfully set.
ReadOnlyError	Set ViewGroup data failed because it is read only.
ModifiedError	Set ViewGroup data failed because it has been modified by another user.

◆ SortOrderOption

enum ServerCommandService.SortOrderOption

Enumerator
Header
Description
StartTime
TagTime
EndTime
CreateTime
RetentionExpireTime
UserName
Size

◆ ViewGroupType

enum ServerCommandService.ViewGroupType

Represents the ViewGroup type.

Enumerator
Normal	A normal viewgroup.

Constructor & Destructor Documentation

◆ ServerCommandService()

ServerCommandService.ServerCommandService ( )

inline

Member Function Documentation

◆ AlertsGetAroundWithSpan()

AlertOccurrence[] ServerCommandService.AlertsGetAroundWithSpan	(	string	token,
		Guid[]	alertIds,
		DateTime	centerTime,
		TimeDuration	maxTimeBefore,
		int	maxCountBefore,
		TimeDuration	maxTimeAfter,
		int	maxCountAfter )

inline

◆ Authorize()

string ServerCommandService.Authorize	(	string	userDomainName,
		AuthorizationActionType	type )

inline

Creates an cookie for authorized user.

Parameters

userDomainName	name of the user that needs to be authorized
type	type of authorization

Returns: authorization id

◆ BookmarkCreate()

Bookmark ServerCommandService.BookmarkCreate	(	string	token,
		Guid	deviceId,
		DateTime	timeBegin,
		DateTime	timeTrigged,
		DateTime	timeEnd,
		string	reference,
		string	header,
		string	description )

inline

Creates a new bookmark.

Parameters

token	Security token
deviceId	Device id
timeTrigged	The time of the bookmark
timeBefore	the time duration before timeTriggered that a clip is started
timeAfter	the time duration after timeTriggered that a clip stops
reference	The reference obtained from BookmarkGetNewReferenceXxxx functions
header	Header text
description	Description

◆ BookmarkDelete()

void ServerCommandService.BookmarkDelete	(	string	token,
		Guid	bookmarkId )

inline

Delete a bookmark.

Parameters

token	Security token
bookmarkId	Bookmark id

◆ BookmarkGet()

Bookmark ServerCommandService.BookmarkGet	(	string	token,
		Guid	bookmarkId )

inline

Retreive a bookmark.

Parameters

token	Security token
bookmarkId	Bookmark id

Returns: The bookmark

◆ BookmarkGetNewReference()

BookmarkReference ServerCommandService.BookmarkGetNewReference	(	string	token,
		Guid	deviceId,
		bool	live )

inline

Creates a new reference id string. For now none of the parameters are used, might be use in future schemes. The bookmark and id is not stored before calling BookmarkCreate. This reference id is not to be confused with the bookmark id (unique id as guid).

Parameters

token	Security token
deviceId	Device id
clientTime	The time on the client

Returns: A new reference id

◆ BookmarkSearchFromBookmark()

Bookmark[] ServerCommandService.BookmarkSearchFromBookmark	(	string	token,
		Guid	fromBookmarkId,
		TimeDuration	timeLimit,
		int	countLimit,
		MediaDeviceType[]	deviceTypes,
		Guid[]	optDeviceIds,
		string[]	optUsers,
		string	optSearchStr )

inline

Search out bookmarks from time of given bookmark with different filtering options. This function is used for paging search results.

Parameters

token	Security token
fromBookmarkId	Bookmark to get the time from
timeLimit	The time duration to look in. Negative value means backwards in time
countLimit	Max response count
deviceTypes	Types of media devices to look for
optDeviceIds	If stated, limits the search to the devices given
optUsers	If stated, limits the search to the users given
optSearchStr	If stated, limits the search to items with the text in reference, header or description

Returns

◆ BookmarkSearchTime()

Bookmark[] ServerCommandService.BookmarkSearchTime	(	string	token,
		DateTime	time,
		TimeDuration	timeLimit,
		int	countLimit,
		MediaDeviceType[]	deviceTypes,
		Guid[]	optDeviceIds,
		string[]	optUsers,
		string	optSearchStr )

inline

Search out bookmarks from time with different filtering options.

Parameters

token	Security token
time	The time
timeLimit	The time duration to look in. Negative value means backwards in time
countLimit	Max response count
deviceTypes	Types of media devices to look for
optDeviceIds	If stated, limits the search to the devices given
optUsers	If stated, limits the search to the users given
optSearchStr	If stated, limits the search to items with the text in reference, header or description

Returns

◆ BookmarkUpdate()

Bookmark ServerCommandService.BookmarkUpdate	(	string	token,
		Guid	bookmarkId,
		Guid	deviceId,
		DateTime	timeBegin,
		DateTime	timeTrigged,
		DateTime	timeEnd,
		string	reference,
		string	header,
		string	description )

inline

Updates a bookmark.

Parameters

token	Security token
bookmarkId	Bookmark id
timeTrigged	The time of the bookmark
timeBefore	The time duration before timeTriggered that a clip is started
timeAfter	The time duration after timeTriggered that a clip stops
reference	The reference obtained from BookmarkGetNewReferenceXxxx functions
header	Header text
description	Description

◆ CheckSmartClientVersion()

SmartClientVersion ServerCommandService.CheckSmartClientVersion	(	int	major,
		int	minor,
		string	revision )

inline

◆ CreatePreset()

Guid ServerCommandService.CreatePreset	(	string	token,
		Guid	deviceId,
		string	name )

inline

Create a new preset.

Parameters

token	Security token
deviceId	The deviceId to create on
name	The name of the preset

Returns: The identifier of the new preset

◆ DeletePreset()

void ServerCommandService.DeletePreset	(	string	token,
		Guid	id,
		Guid	deviceId )

inline

Deletes a specific preset.

Parameters

token	Security token
id	The identifier of the preset to delete
deviceId	The deviceId containing the preset to delete

◆ EventTrigger()

void ServerCommandService.EventTrigger	(	string	token,
		Guid	eventId )

inline

This command will trigger a user-defined event on an XProtect VMS.

Parameters

eventId	The Guid identifying the event
token	A valid token from a login

◆ EventTriggerWithMetadata()

void ServerCommandService.EventTriggerWithMetadata	(	string	token,
		Guid	eventId,
		KeyValue[]	metadata )

inline

This command will trigger a defined event on a VMS. This command is similar to the EventTrigger, except that this command include references to device ids (usually camera Guids), that are used as parameters for issuing the event.
The format of the KeyValue pair is two strings, where the key contains a simple name, and the Value contains a XML definition.

Supported key-values:
Key: TargetDevices
Value: XML node with two inner nodes. See sample below:

<targetDevices>
  <deviceIds>
     <deviceId>device1-GUID</deviceId>
     <deviceId>device2-GUID</deviceId>
  </deviceIds>
  <deviceGroupIds>
     <deviceGroupId>deviceGroup1-GUID</deviceGroupId>
     <deviceGroupId>deviceGroup2-GUID</deviceGroupId>
  </deviceGroupIds>
</targetDevices>

The defined device and group ids are used in the rule execution where the rule states "the devices from the metadata".
XProtect has three built-in commands for StartRecording, StopRecording and RequestPlayAudioGuid (playing audio clips).

The three built-in commands have these event ids:
StartRecording: Guid("85867627-B287-4439-9E55-A63701E1715B")
StopRecording : Guid("77B1E70D-BA8D-4bb8-9EE8-43B09746D82A")
RequestPlayAudioGuid : Guid("7605F8B0-7F5F-4432-B223-0BB2DC3F1F5C")

When the StartRecording has been issued, make sure the StopRecording event is also fired at some later point.
In case of using the method for triggering an audio clip, the "metadata" parameter must contain an additional key-value pair named "AudioMessage" with the GUID of the audio clip as value.

Parameters

token
eventId
metadata

◆ GetClientProfile()

ClientProfile ServerCommandService.GetClientProfile	(	string	token,
		bool	withSetting )

inline

◆ GetConfiguration()

ConfigurationInfo ServerCommandService.GetConfiguration ( string token )

inline

◆ GetConfigurationHardware()

HardwareInfo[] ServerCommandService.GetConfigurationHardware	(	string	token,
		Guid[]	hardwareIds )

inline

◆ GetConfigurationRecorders()

RecorderInfo[] ServerCommandService.GetConfigurationRecorders	(	string	token,
		Guid[]	recorderIds )

inline

◆ GetCustomSettingDataGlobal()

CustomSetting ServerCommandService.GetCustomSettingDataGlobal	(	string	token,
		Guid	customSettingId )

inline

◆ GetCustomSettingDataUser()

CustomSetting ServerCommandService.GetCustomSettingDataUser	(	string	token,
		Guid	customSettingId )

inline

◆ GetPresets()

PresetInfo[] ServerCommandService.GetPresets	(	string	token,
		Guid	deviceId )

inline

Retrieve all presets.

Parameters

token	Security token
deviceId	The deviceId to retrieve

Returns: A list of presets

◆ GetProductInfo()

ProductInfo ServerCommandService.GetProductInfo ( )

inline

Returns the basic product information for the VMS.
Note: Check product support matrix for what products can support this command.

Returns

◆ GetServerVersion()

string ServerCommandService.GetServerVersion ( )

inline

◆ GetSmartClientVersion()

SmartClientVersion ServerCommandService.GetSmartClientVersion ( )

inline

◆ GetSystemLicenseInfo()

SystemLicenseInfo ServerCommandService.GetSystemLicenseInfo ( )

inline

◆ GetUserInfo()

UserInfo ServerCommandService.GetUserInfo ( string token )

inline

Returns the UserInfo for an already logged on session.

Parameters

token

Returns

◆ GetVersion()

int ServerCommandService.GetVersion ( )

inline

◆ GetViewGroupData()

ViewGroup ServerCommandService.GetViewGroupData	(	string	token,
		Guid	viewGroupId )

inline

◆ GetViewGroups()

ViewGroupInfo[] ServerCommandService.GetViewGroups ( string token )

inline

◆ GetVmoServicesList()

System.Collections.DictionaryEntry[] ServerCommandService.GetVmoServicesList ( )

inline

◆ Login()

LoginInfo ServerCommandService.Login	(	Guid	instanceId,
		string	currentToken )

inline

Login to a Milestone VMS.

Parameters

instanceId
currentToken	The current token if login is called to relogin. Set to empty string on first login.

Returns: A new set of login information

◆ Logout()

void ServerCommandService.Logout	(	Guid	instanceId,
		string	currentToken )

inline

◆ MarkedDataCreate()

MarkedDataResult ServerCommandService.MarkedDataCreate	(	string	token,
		Guid	markedDataId,
		System.Guid[]	deviceIds,
		System.DateTime	timeStart,
		System.DateTime	timeTag,
		System.DateTime	timeEnd,
		string	reference,
		string	header,
		string	description,
		int	markedDataType,
		bool	useRetention,
		DateTime	retentionExpire,
		RetentionOption	retentionOption )

inline

Creates a new bookmark.

Parameters

token	Security token
markedDataId	The marked data identifier.
deviceIds	Device ids
timeStart	The time of the marked data
timeTag	the time duration before timeTag that a clip is started
timeEnd	the time duration after timeTag that a clip stops
reference	The reference obtained from MarkedDataGetNewReferenceXxxx functions
header	Header text
description	Description
markedDataType	The type of marked data
useRetention	Should the data be protected
retentionExpire	When should the protection expire
retentionOption	The retention options

Returns

◆ MarkedDataDelete()

MarkedDataResult[] ServerCommandService.MarkedDataDelete	(	string	token,
		Guid[]	markedDataIds )

inline

Delete a marked data.

Parameters

token	Security token
markedDataIds	Marked data ids to delete

◆ MarkedDataGet()

MarkedData ServerCommandService.MarkedDataGet	(	string	token,
		Guid	markedDataId )

inline

Retreive a marked data.

Parameters

token	Security token
markedDataId	Marked data id

Returns: The marked data

◆ MarkedDataGetNewReference()

MarkedDataReference ServerCommandService.MarkedDataGetNewReference	(	string	token,
		Guid[]	deviceIds,
		bool	live )

inline

Creates a new reference id string. For now none of the parameters are used, might be use in future schemes. The marked data and id is not stored before calling MarkedDataCreate. This reference id is not to be confused with the marked data id (unique id as guid).

Parameters

token	Security token
deviceIds	Device ids
live	Fire events

Returns: A new reference id

◆ MarkedDataSearch()

MarkedData[] ServerCommandService.MarkedDataSearch	(	string	token,
		System.Guid[]	deviceIds,
		string	searchText,
		string[]	users,
		System.DateTime	createdFromTime,
		System.DateTime	createdToTime,
		System.DateTime	markedDataFromTime,
		System.DateTime	markedDataToTime,
		System.DateTime	tagTimeFromTime,
		System.DateTime	tagTimeToTime,
		System.DateTime	retentionExpireFrom,
		System.DateTime	retentionExpireTo,
		int	pageIndex,
		int	pageSize,
		SortOrderOption	sortOrder,
		bool	sortAscending )

inline

Search out marked data with different filtering options. This function is used for paging search results.

Parameters

token	Security token
deviceIds	The device ids.
searchText	The search text.
users	The users.
createdFromTime	The created from time.
createdToTime	The created to time.
markedDataFromTime	The marked data from time.
markedDataToTime	The marked data to time.
tagTimeFromTime	The tag time from time.
tagTimeToTime	The tag time to time.
retentionExpireFrom	The retention expire from.
retentionExpireTo	The retention expire to.
pageIndex	Index of the page.
pageSize	Size of the page.
sortOrder	The sort order.
sortAscending	if set to `true` sort ascending.

Returns

◆ MarkedDataUpdate()

MarkedDataResult ServerCommandService.MarkedDataUpdate	(	string	token,
		Guid	markedDataId,
		System.Guid[]	deviceIds,
		System.DateTime	timeStart,
		System.DateTime	timeTag,
		System.DateTime	timeEnd,
		string	reference,
		string	header,
		string	description,
		int	markedDataType,
		bool	useRetention,
		DateTime	retentionExpire,
		RetentionOption	retentionOption )

inline

Updates a marked data.

Parameters

token	Security token
markedDataId	The marked data identifier.
deviceIds	Device ids
timeStart	The time of the marked data
timeTag	the time duration before timeTag that a clip is started
timeEnd	the time duration after timeTag that a clip stops
reference	The reference obtained from MarkedDataGetNewReferenceXxxx functions
header	Header text
description	Description
markedDataType	The type of marked data
useRetention	Should the data be protected
retentionExpire	When should the protection expire
retentionOption	The retention options

Returns

◆ MatrixMonitorActivateCamera()

void ServerCommandService.MatrixMonitorActivateCamera	(	string	token,
		Guid	matrixMonitorId,
		Guid	deviceId )

inline

DEPRECATED! Activates (displays) a camera on a Matrix Monitor.

Parameters

matrixMonitorId	Id of the Matrix Monitor that the camera shall be activated on.
deviceId	Id of the camera.

◆ MatrixMonitorActivateScript()

void ServerCommandService.MatrixMonitorActivateScript	(	string	token,
		Guid	matrixMonitorId,
		string	script )

inline

DEPRECATED!

Parameters

token
matrixMonitorId
script

◆ OrderPresets()

void ServerCommandService.OrderPresets	(	string	token,
		Guid	deviceId,
		Guid[]	ids )

inline

Attempt to order the presets given, doing a "best effort" ordering.

If ids containspresets that no longer exists they ar ignored
Presets that exist on the server but are not in the array will be put last in the order

Parameters

token	Security token
deviceId	The deviceId to order on
ids	An array of ids to order

◆ QueryChanges()

Change[] ServerCommandService.QueryChanges	(	string	token,
		DateTime	changesFrom )

inline

Can be called to be notified when failover happens.

Supported by Corporate and Expert product.

Could be called every 5 or 10 seconds to be able to react in a timely manor.

The result will contain the Id (Guid) of the recorder that failed over to another server. Use the QueryRecorderInfo method to get the new URL for that server.

Parameters

token
changesFrom

Returns

◆ QueryRecorderInfo()

RecorderInfo ServerCommandService.QueryRecorderInfo	(	string	token,
		Guid	recorderId )

inline

Provides the basic information about a recorder. Can be used to re-new the recorder URL after failover.

Notice that the Arrays of cameras etc are not filled.

Parameters

token
recorderId

Returns

◆ RegisterIntegration()

void ServerCommandService.RegisterIntegration	(	string	token,
		string	instanceId,
		System.Guid	integrationId,
		string	integrationVersion,
		string	integrationName,
		string	manufacturerName )

inline

Method for registering an integration for the sole purpose of getting an overview of integration usage.

Parameters

token	Security token
instanceId	Identifier uniquely identifying the calling instance. Typically each ID should refer to a specific machine running an integration.
integrationId	Unique identifier representing the integration. Should be hardcoded the integrating application.
integrationVersion	Version of the calling application.
integrationName	Name of the calling appliation.
manufacturerName	Name of the manufacturer of the calling application.

◆ RestrictedMediaCreate()

RestrictedMediaResult ServerCommandService.RestrictedMediaCreate	(	Guid	id,
		Guid[]	deviceIds,
		string	header,
		string	description,
		DateTime	timeStart,
		DateTime	timeEnd )

Creates a media restriction (also known as a video restriction) for a list of cameras and a time interval where special permissions are needed for users to be able to playback recordings.

Parameters

id	The id that the new playback restriction will be created with.
deviceIds	A list of ids of devices that will be covered by the media restriction.
header	The header of the playback restriction.
description	The description of the playback restriction.
timeStart	The start time of the time interval for which playback is restricted.
timeEnd	The end time of the time interval for which playback is restricted.

Returns: A RestrictedMediaResult instance containing the result of the create.

◆ RestrictedMediaDelete()

RestrictedMediaResult ServerCommandService.RestrictedMediaDelete ( Guid restrictedMediaId )

Updates an existing media restriction (also known as a video restriction).

Parameters

restrictedMediaId The id of the media restriction to delete.

Returns: A RestrictedMediaResult instance containing the result of the delete.

◆ RestrictedMediaLiveDelete()

RestrictedMediaLiveResult ServerCommandService.RestrictedMediaLiveDelete ( Guid[] deviceIds )

Deletes live media restrictions for the specified devices - thereby removing both restrictions for viewing live and for playing back recorded data for the devices. (No playback media restriction will be created as it is when calling RestrictedMediaLiveModeExit(Guid, Guid[], string, string, DateTime, DateTime).

Parameters

deviceIds A list of ids of devices for which to delete the live restriction.

Returns: A RestrictedMediaLiveResult instance containing the result of the delete live restriction call.

◆ RestrictedMediaLiveModeEnter()

RestrictedMediaLiveResult ServerCommandService.RestrictedMediaLiveModeEnter	(	Guid[]	deviceIds,
		DateTime	timeStart )

Enters 'restricted live mode' for a list of devices by creating a RestrictedMediaLive instance for each of the specified devices. While in live mode a user will need special permissions in order to view live from the device or to playback recordings made while the camera was in restricted live mode.

Parameters

deviceIds	A list of ids of devices that will be covered by the media restriction.
timeStart	The start time of the time interval for which playback is restricted.

Returns: A RestrictedMediaLiveResult instance containing the result of the enter live mode call.

◆ RestrictedMediaLiveModeExit()

RestrictedMediaResult ServerCommandService.RestrictedMediaLiveModeExit	(	Guid	id,
		Guid[]	deviceIds,
		string	header,
		string	description,
		DateTime	timeStart,
		DateTime	timeEnd )

Exits 'restricted live mode' for a list of devices and a the same time creates a playback media restriction for the cameras specified. The playback restriction created by this is similar to a restriction created by calling RestrictedMediaCreate(Guid, Guid[], string, string, DateTime, DateTime).

Parameters

id	The id that the playback restriction will be created with.
deviceIds	A list of ids of devices that will be covered by the media restriction.
header	The header of the playback restriction.
description	The description of the playback restriction.
timeStart	The start time of the time interval for which playback is restricted.
timeEnd	The end time of the time interval for which playback is restricted.

Returns

A RestrictedMediaResult instance containing the result of the exit live mode (create).

A RestrictedMediaLiveResult instance containing the result of the exit live mode call.

◆ RestrictedMediaLiveQueryAll()

RestrictedMediaLive[] ServerCommandService.RestrictedMediaLiveQueryAll ( )

Queries a list of all existing live media restrictions (also known as video restrictions).

Returns: A list of existing live media restrictions.

◆ RestrictedMediaLiveUpdate()

RestrictedMediaLiveResult ServerCommandService.RestrictedMediaLiveUpdate	(	Guid[]	deviceIds,
		DateTime	timeStart )

Updates the start time for a number of live restrictions, thereby either extending or reducing the time interval for which recorded data is restricted.

Parameters

deviceIds	A list of ids of devices for which to change the start time of the live restriction.
timeStart	The new start time of the live restriction.

Returns: A RestrictedMediaLiveResult instance containing the result of the update live call.

◆ RestrictedMediaQueryAll()

RestrictedMedia[] ServerCommandService.RestrictedMediaQueryAll ( )

Queries a list of all existing media restrictions (also known as video restrictions).

Returns: A list of existing media restrictions.

◆ RestrictedMediaUpdate()

RestrictedMediaResult ServerCommandService.RestrictedMediaUpdate	(	Guid	id,
		Guid[]	deviceIdsToAdd,
		Guid[]	deviceIdsToRemove,
		string	header,
		string	description,
		DateTime	timeStart,
		DateTime	timeEnd )

Updates an existing media restriction (also known as a video restriction).

Parameters

id	The id of the playback restriction to update.
deviceIdsToAdd	A list of ids of devices to add to the restriction.
deviceIdsToRemove	A list of ids of devices to remove from the restriction.
header	The header of the playback restriction.
description	The description of the playback restriction.
timeStart	The start time of the time interval for which playback is restricted.
timeEnd	The end time of the time interval for which playback is restricted.

Returns: A RestrictedMediaResult instance containing the result of the update.

◆ SetCustomSettingDataGlobal()

SetCustomSettingResultType ServerCommandService.SetCustomSettingDataGlobal	(	string	token,
		Guid	customSettingId,
		CustomSettingData	customSettingData,
		bool	forceOverride )

inline

◆ SetCustomSettingDataUser()

SetCustomSettingResultType ServerCommandService.SetCustomSettingDataUser	(	string	token,
		Guid	customSettingId,
		CustomSettingData	customSettingData,
		bool	forceOverride )

inline

◆ SetViewGroupData()

SetViewGroupDataResultType ServerCommandService.SetViewGroupData	(	string	token,
		Guid	viewGroupId,
		ViewGroupData	viewGroupdata )

inline

◆ UpdatePresetName()

void ServerCommandService.UpdatePresetName	(	string	token,
		Guid	id,
		Guid	deviceId,
		string	newName )

inline

Updates the name of a specific preset.

Parameters

token	Security token
id	The identifier of the preset to update
deviceId	The deviceId containing the preset to update.
newName	The new name of the preset

◆ UpdatePresetPosition()

void ServerCommandService.UpdatePresetPosition	(	string	token,
		Guid	id,
		Guid	deviceId )

inline

Updated the position to current camera postion on a specific preset.

Parameters

token	Security token
id	The identifier of the preset to update
deviceId	The deviceId containing the preset to update.

Classes

Public Types

Public Member Functions

Member Enumeration Documentation

◆ AuthorizationActionType

◆ EventSource

◆ MediaDeviceType

◆ RestrictedMediaResultStatus

◆ ResultStatus

◆ RetentionOptionType

◆ SetCustomSettingResultType

◆ SetViewGroupDataResultType

◆ SortOrderOption

◆ ViewGroupType

Constructor & Destructor Documentation

◆ ServerCommandService()

Member Function Documentation

◆ AlertsGetAroundWithSpan()

◆ Authorize()

◆ BookmarkCreate()

◆ BookmarkDelete()

◆ BookmarkGet()

◆ BookmarkGetNewReference()

◆ BookmarkSearchFromBookmark()

◆ BookmarkSearchTime()

◆ BookmarkUpdate()

◆ CheckSmartClientVersion()

◆ CreatePreset()

◆ DeletePreset()

◆ EventTrigger()

◆ EventTriggerWithMetadata()

◆ GetClientProfile()

◆ GetConfiguration()

◆ GetConfigurationHardware()

◆ GetConfigurationRecorders()

◆ GetCustomSettingDataGlobal()

◆ GetCustomSettingDataUser()

◆ GetPresets()

◆ GetProductInfo()

◆ GetServerVersion()

◆ GetSmartClientVersion()

◆ GetSystemLicenseInfo()

◆ GetUserInfo()

◆ GetVersion()

◆ GetViewGroupData()

◆ GetViewGroups()

◆ GetVmoServicesList()

◆ Login()

◆ Logout()

◆ MarkedDataCreate()

◆ MarkedDataDelete()

◆ MarkedDataGet()

◆ MarkedDataGetNewReference()

◆ MarkedDataSearch()

◆ MarkedDataUpdate()

◆ MatrixMonitorActivateCamera()

◆ MatrixMonitorActivateScript()

◆ OrderPresets()

◆ QueryChanges()

◆ QueryRecorderInfo()

◆ RegisterIntegration()

◆ RestrictedMediaCreate()

◆ RestrictedMediaDelete()

◆ RestrictedMediaLiveDelete()

◆ RestrictedMediaLiveModeEnter()

◆ RestrictedMediaLiveModeExit()

◆ RestrictedMediaLiveQueryAll()

◆ RestrictedMediaLiveUpdate()

◆ RestrictedMediaQueryAll()

◆ RestrictedMediaUpdate()

◆ SetCustomSettingDataGlobal()

◆ SetCustomSettingDataUser()

◆ SetViewGroupData()

◆ UpdatePresetName()

◆ UpdatePresetPosition()