Classes
class	AccessControlSystem

class	AccessControlSystemFolder

class	AccessControlUnit

class	AccessControlUnitFolder

class	ActivateLicenseServerTask
	Activate License. More...

class	AddAlarmDefinitionServerTask
	Add alarm definition. More...

class	AddAnalyticsEventServerTask
	Add analytics event. More...

class	AddAppointmentServerTask
	Add appointment. More...

class	AddArchiveStorageServerTask
	Add archive. More...

class	AddBasicOwnerInfoServerTask
	Add basic owner information. More...

class	AddBasicUserServerTask
	Add new basic user. More...

class	AddClientProfileServerTask
	Add client profile. More...

class	AddDetectedDeviceCredentialServerTask
	Add new credentials to the auto-detect configuration. More...

class	AddDeviceGroupMemberServerTask
	Add device. More...

class	AddDeviceGroupServerTask
	Create new group. More...

class	AddEvidenceLockProfileServerTask
	Add evidence lock profile. More...

class	AddFailoverGroupServerTask
	Add failover group. More...

class	AddGenericEventDataSourceServerTask
	Add generic event data source. More...

class	AddGenericEventServerTask
	Add generic event. More...

class	AddGisMapLocationServerTask
	Add GIS map location. More...

class	AddHardwareServerTask
	Add new hardware. More...

class	AddLayoutServerTask
	Add layout. More...

class	AddLoginProviderServerTask
	Add external IDP. More...

class	AddMailNotificationProfileServerTask
	Add mail notification profile. More...

class	AddMatrixServerTask
	Add Matrix. More...

class	AddMIPItemServerTask
	Add MIPItem task. More...

class	AddMonitorServerTask
	Add new monitor. More...

class	AddPatrollingEntryServerTask
	Add patrolling entry. More...

class	AddPatrollingProfileServerTask
	Add patrolling profile. More...

class	AddPtzPresetServerTask
	Add PTZ preset. More...

class	AddRecurringAppointmentServerTask
	Add recurring appointment. More...

class	AddRegisteredClaimServerTask
	Add registered claim. More...

class	AddRoleClaimServerTask
	Add role claim. More...

class	AddRoleMemberServerTask
	Add new user or group to role. More...

class	AddRoleServerTask
	Add new role. More...

class	AddSaveSearchServerTask
	Server task for adding a search. More...

class	AddStateGroupServerTask
	Add state group. More...

class	AddStorageServerTask
	Add storage. More...

class	AddTimeProfileServerTask
	Add time profile. More...

class	AddUserDefinedEventServerTask
	Add user-defined event. More...

class	AddVideoWallPresetServerTask
	Add video wall preset. More...

class	AddVideoWallServerTask
	Add new video wall. More...

class	AddViewGroupServerTask
	Add new View Group. More...

class	AddViewServerTask
	Add View. More...

class	AlarmDefinition

class	AlarmDefinitionFolder

class	AnalyticsEvent

class	AnalyticsEventFolder

class	ApplyCamerasAndLayoutServerTask
	Apply cameras and layout. More...

class	ApplyCamerasServerTask
	Apply cameras. More...

class	ApplyLayoutServerTask
	Apply layout. More...

class	ApplyMonitorStateServerTask
	Apply monitor state. More...

class	ApplyTextAndLayoutServerTask
	Apply text and layout. More...

class	ApplyViewItemsXmlServerTask
	Apply view items XML. More...

class	ArchiveScheduleChildItem

class	ArchiveStorage

class	ArchiveStorageFolder

class	AutoDetectConfiguration

class	AutoDetectConfigurationFolder

class	BasicOwnerInformation

class	BasicOwnerInformationFolder

class	BasicUser

class	BasicUserFolder

class	Camera

class	CameraFolder

class	CameraGroup

class	CameraGroupFolder

class	ChangeDeviceRecordingStorageServerTask
	Change storage for device. More...

class	ChangeEncryptionMethodServerTask
	Change encryption method. More...

class	ChangeLicenseServerTask
	Change to a new license. More...

class	ChangeOverallSecurityPermissionsServerTask
	Edit overall security permissions. More...

class	ChangePasswordBasicUserServerTask
	Change basic user password. More...

class	ChangePasswordHardwareServerTask
	Change hardware password. More...

class	ChangePasswordStorageEncryptionServerTask
	Change encryption password for recording storage. More...

class	ChangeSecurityPermissionsServerTask
	Edit permissions. More...

class	ChildTaskDetail
	Class for accessing the details of a task result. More...

class	ClaimChildItem

class	ClaimFolder

class	ClassCollectionServerTask
	A serverTask (result) that also Contains a collection of classes, as a result of the executed task on the server. More...

class	ClientLogOnSupportedServerTask
	Client application login supported. More...

class	ClientProfile

class	ClientProfileAccessControlChildItem

class	ClientProfileAdvancedChildItem

class	ClientProfileAlarmManagerChildItem

class	ClientProfileExportChildItem

class	ClientProfileFolder

class	ClientProfileGeneralChildItem

class	ClientProfileGisMapChildItem

class	ClientProfileLiveChildItem

class	ClientProfilePlaybackChildItem

class	ClientProfileSetupChildItem

class	ClientProfileTimelineChildItem

class	ClientProfileViewLayoutsChildItem

class	ClientSettings

class	ClientSettingsFolder

class	Compressor

class	CompressorFolder

class	ConfigurationApiProperties
	Contains the properties provided by a ConfigurationItem. More...

class	ConfigurationService
	Class used to call methods on the ConfigurationAPI. More...

class	CopyRoleServerTask
	Copy role. More...

class	CreateDirectoryOnRecorderServerTask
	Create directory on recorder. More...

class	CustomProperties

class	CustomPropertiesFolder

class	CustomSettingGlobal

class	CustomSettingUser

class	DefaultPtzPresetServerTask
	Set default PTZ preset. More...

class	DeleteHardwareServerTask
	Delete hardware. More...

class	DetectedDeviceCredentials

class	DetectedDeviceCredentialsFolder

class	DeviceDriverSettings

class	DeviceDriverSettingsChildItem

class	DeviceDriverSettingsFolder

class	DisableEncryptionServerTask
	Disable encryption on recording storage. More...

class	EnableEncryptionServerTask
	Enable encryption on recording storage. More...

class	EventType

class	EventTypeFolder

class	EventTypeGroup

class	EventTypeGroupFolder

class	EvidenceLockProfile

class	EvidenceLockProfileFolder

class	Factory
	Contains a set of methods for creating paths and conversions. More...

class	FailoverGroup

class	FailoverGroupFolder

class	FailoverRecorder

class	FailoverRecorderFolder

class	FindSaveSearches
	A find save search configuration item. More...

class	FindSaveSearchesServerTask
	Server tasks for finding save searches based on filters. More...

class	FisheyeLens

class	FisheyeLensFolder

class	GenericEvent

class	GenericEventDataSource

class	GenericEventDataSourceFolder

class	GenericEventFolder

class	GetDevicePresetsServerTask
	Get presets from camera. More...

class	GetInternalUnitPathServerTask
	Get internal unit path. More...

class	GetSaveSearchServerTask
	Server task for getting a search. More...

class	GisMapLocation

class	GisMapLocationFolder

class	Hardware

class	HardwareDeviceEvent

class	HardwareDeviceEventChildItem

class	HardwareDeviceEventFolder

class	HardwareDriver

class	HardwareDriverFolder

class	HardwareDriverSettings

class	HardwareDriverSettingsChildItem

class	HardwareDriverSettingsFolder

class	HardwareFolder

class	HardwarePtzDeviceSettingChildItem

class	HardwarePtzSettings

class	HardwarePtzSettingsFolder

class	HardwareScanExpressServerTask
	Detect hardware. More...

class	HardwareScanServerTask
	Detect hardware driver. More...

class	IConfigurationChildItem
	Contains fields relevant for a ConfiguratonItem with category = "ChildItem". More...

class	IConfigurationItem
	Contains a wrapped instance of a ConfigurationItem. More...

interface	IMIPItem
	Interface for the MIPItem typed Configuration API. More...

class	InputEvent

class	InputEventFolder

class	InputEventGroup

class	InputEventGroupFolder

class	Layout

class	LayoutFolder

class	LayoutGroup

class	LayoutGroupFolder

class	LicenseDetailChildItem

class	LicenseDetailFolder

class	LicenseFeatureChildItem

class	LicenseInformation

class	LicenseInformationFolder

class	LicenseInstalledProductChildItem

class	LicenseInstalledProductFolder

class	LicenseOverviewAllChildItem

class	LicenseOverviewAllFolder

class	LoginProvider

class	LoginProviderFolder

class	LprMatchList

class	LprMatchListFolder

class	MailNotificationProfile

class	MailNotificationProfileFolder

class	ManagementServer

class	Matrix

class	MatrixCommandServerTask
	Matrix command. More...

class	MatrixFolder

class	Metadata

class	MetadataFolder

class	MetadataGroup

class	MetadataGroupFolder

class	MethodIdAddLprMatchListServerTask
	Add LPR match list. More...

class	MethodIdAddOrEditRegistrationNumbersInfoServerTask
	Add or edit data for registration numbers. More...

class	MethodIdDeleteRegistrationNumbersServerTask
	Delete registration numbers. More...

class	MethodIdGetCustomFieldsForRegistrationNumberResult
	The strongly typed result for LprMatchList.MethodIdGetCustomFieldsForRegistrationNumberWithResult(string) More...

class	MethodIdGetCustomFieldsForRegistrationNumberServerTask
	Get custom fields. More...

class	MethodIdGetRegistrationNumbersInfoResult
	The strongly typed result for LprMatchList.MethodIdGetRegistrationNumbersInfoWithResult More...

class	MethodIdRemoveLprMatchListServerTask
	Remove LPR match list. More...

class	Microphone

class	MicrophoneFolder

class	MicrophoneGroup

class	MicrophoneGroupFolder

class	MIPItem

class	MIPItemFolder

class	MIPKind

class	MIPKindFolder

class	MIPOptionProperties
	Contains settings used on the Management Clients option menu. More...

class	Monitor

class	MonitorFolder

class	MonitorPreset

class	MonitorPresetFolder

class	MotionDetection

class	MotionDetectionFolder

class	MoveArchiveStorageServerTask
	Move archive. More...

class	MoveFailoverGroupServerTask
	Move failover server. More...

class	MoveHardwareServerTask
	Move hardware. More...

class	MoveRecordingStorageServerTask
	Move storage. More...

class	Output

class	OutputFolder

class	OutputGroup

class	OutputGroupFolder

class	PatrollingEntryChildItem

class	PatrollingProfile

class	PatrollingProfileFolder

class	PrivacyMask

class	PrivacyMaskFolder

class	PrivacyProtection

class	PrivacyProtectionFolder

class	PTZChildItem

class	PtzPreset

class	PtzPresetFolder

class	PTZSessionTimeoutChildItem

class	QueryUsersWithAccessServerTask
	Query users with access to given object. More...

class	ReadDirectoriesOnRecorderServerTask
	Read directories on recorder. More...

class	RecordingServer

class	RecordingServerFailover

class	RecordingServerFailoverFolder

class	RecordingServerFolder

class	RecordingServerMulticast

class	RecordingServerMulticastFolder

class	RegisteredClaim

class	RegisteredClaimFolder

class	RemoveAlarmDefinitionServerTask
	Remove alarm definition. More...

class	RemoveAnalyticsEventServerTask
	Remove analytics event. More...

class	RemoveAppointmentServerTask
	Remove appointment. More...

class	RemoveArchiveStorageServerTask
	Remove archive. More...

class	RemoveBasicOwnerInfoServerTask
	Remove basic owner tag. More...

class	RemoveBasicUserServerTask
	Remove basic user. More...

class	RemoveCamerasServerTask
	Remove cameras. More...

class	RemoveClientProfileServerTask
	Remove client profile. More...

class	RemoveDetectedDeviceCredentialServerTask
	Remove the selected credential from the auto-detect configuration. More...

class	RemoveDeviceGroupMemberServerTask
	Remove device. More...

class	RemoveDeviceGroupServerTask
	Delete group. More...

class	RemoveEvidenceLockProfileServerTask
	Remove evidence lock profile. More...

class	RemoveFailoverGroupServerTask
	Remove failover group. More...

class	RemoveGenericEventDataSourceServerTask
	Remove generic event data source. More...

class	RemoveGenericEventServerTask
	Remove generic event. More...

class	RemoveGisMapLocationServerTask
	Remove GIS map location. More...

class	RemoveLayoutServerTask
	Remove layout. More...

class	RemoveLoginProviderServerTask
	Remove external IDP. More...

class	RemoveMailNotificationProfileServerTask
	Remove mail notification profile. More...

class	RemoveMatrixServerTask
	Remove Matrix. More...

class	RemoveMIPItemServerTask
	Remove MIPItem. More...

class	RemoveMonitorServerTask
	Remove monitor. More...

class	RemovePatrollingEntryServerTask
	Remove patrolling entry. More...

class	RemovePatrollingProfileServerTask
	Remove patrolling profile. More...

class	RemovePtzPresetServerTask
	Remove PTZ preset. More...

class	RemoveRecordingServerServerTask
	Remove recording server. More...

class	RemoveRecurringAppointmentServerTask
	Remove recurring appointment. More...

class	RemoveRegisteredClaimServerTask
	Remove registered claim. More...

class	RemoveRoleClaimServerTask
	Remove role claim. More...

class	RemoveRoleMemberServerTask
	Remove role member. More...

class	RemoveRoleServerTask
	Remove role. More...

class	RemoveStateGroupServerTask
	Remove state group. More...

class	RemoveStorageServerTask
	Remove storage. More...

class	RemoveStreamServerTask
	Remove stream. More...

class	RemoveTimeProfileServerTask
	Remove time profile. More...

class	RemoveUserDefinedEventServerTask
	Remove user-defined event. More...

class	RemoveVideoWallPresetServerTask
	Remove video wall preset. More...

class	RemoveVideoWallServerTask
	Remove video wall. More...

class	RemoveViewGroupServerTask
	Remove a View Group. More...

class	RemoveViewServerTask
	Remove View. More...

class	ReplaceHardwareServerTask
	Replace hardware. More...

class	RetrieveEdgeStorageServerTask
	Retrieve recordings from edge storage. More...

class	Role

class	RoleFolder

class	SaveSearches
	A single saved search. More...

class	SaveSearchesFolder
	A overall folder where all save searches methods are present. More...

class	ServerTask
	Represent a task that is running on the server. More...

class	ServerTaskResult
	Abstract wrapper for the ServerTask, allowing to init strongly typed properties for the result. More...

class	SetClientProfileServerTask
	Set client profile on role. More...

class	SetClientTimeProfileServerTask
	Set client login time profile. More...

class	SetFramerateReductionArchiveStorageServerTask
	Enable/disable frame rate reduction on archive. More...

class	Site

class	SiteAddressChildItem

class	SiteAddressFolder

class	SiteFolder

class	Speaker

class	SpeakerFolder

class	SpeakerGroup

class	SpeakerGroupFolder

class	StateGroup

class	StateGroupFolder

class	Storage

class	StorageFolder

class	StorageInformation

class	StreamChildItem

class	StreamDefinition

class	StreamFolder

class	StreamUsageChildItem

class	SystemAddressChildItem

class	SystemAddressFolder

class	TaskDetail
	Class containing the current state of a task, or task result when progress is 100. In some cases this class will contain a collection of children with further information. More...

class	TimeProfile

class	TimeProfileAppointmentRecurChildItem

class	TimeProfileAppointmentRootChildItem

class	TimeProfileFolder

class	ToolOptionAviGeneration

class	ToolOptionBookmark

class	ToolOptionCustomerDashbord

class	ToolOptionFolder

class	ToolOptionMailServer

class	ToolOptionNetwork

class	ToolOptionPrivacySetting

class	ToolOptionRecordingServer

class	ToolOptionServerLog

class	TruncateStorageOnOtherRecordingServerServerTask
	Delete all recordings for device on another recording server. More...

class	UpdateFirmwareHardwareServerTask
	Update firmware. More...

class	UpdateHardwareDetail
	Contains the details for each device/item on the hardware, about what has changed. More...

class	UpdateHardwareServerTask
	Contains the result from a Hardware.UpdateHardware() call. More...

class	UpdateLicenseServerTask
	Update license. More...

class	UpdateSaveSearchServerTask
	Server task for updating a search. More...

class	UploadFileChunkServerTask
	Upload file chunk. More...

class	User

class	UserDefinedEvent

class	UserDefinedEventFolder

class	UserFolder

class	Utility

class	ValidateStorageEncryptionPasswordServerTask
	Validate encryption password on recording storage. More...

class	ValueTypeInformation
	This class assist in defining what values are valid for a given property. More...

class	VideoWall

class	VideoWallFolder

class	VideoWallPreset

class	VideoWallPresetFolder

class	View

class	ViewFolder

class	ViewGroup

class	ViewGroupFolder

class	ViewItem

class	ViewItemChildItem

Enumerations
enum	StateEnum { Success , Error , InProgress , Idle , Completed }
	Defines the different valies for the ServerTask.State property. More...

Enumeration Type Documentation

◆ StateEnum

enum VideoOS.Platform.ConfigurationItems.StateEnum

Defines the different valies for the ServerTask.State property.

Enumerator
Success	The task has completed with success.
Error	The task has completed with error, check the errorCode and errorState for explanation.
InProgress	The task is in progress, check the Progress property for how far it is.
Idle	The task is queued up on the server, awaiting free resources.
Completed	The task has completed.

Classes

Enumerations

Enumeration Type Documentation

◆ StateEnum