Inheritance diagram for VideoOS.Platform.ConfigurationItems.Hardware:

Public Member Functions
ChangePasswordHardwareServerTask	ChangePasswordHardware ()
	Change hardware password.

ServerTask	ChangePasswordHardware (String password)
	Change hardware password Please consider using secure version taking SecureString instead.

ServerTask	ChangePasswordHardware (System.Security.SecureString password)
	Change hardware password.

ServerTask	ChangePasswordHardware (System.Security.SecureString password, bool updatePasswordOnDevice)
	Change hardware password.

	Hardware (FQID fqid)
	Construct the class from a MIP FQID - note that not all configuration items have a corresponding FQID.

	Hardware (ServerId serverId, ConfigurationItem hardware)
	Construct the class from serverId of the Management Server that owns the configuration, and the already returned ConfigurationItem.

	Hardware (ServerId serverId, string path)
	Construct the class from serverId of the Management Server that owns the configuration, and the path of the item.

MoveHardwareServerTask	MoveHardware ()
	Move hardware.

ServerTask	MoveHardware (String destinationRecordingServer)
	Move hardware.

ServerTask	ReadPasswordHardware ()
	Read hardware password.

ReplaceHardwareServerTask	ReplaceHardware ()
	Replace hardware.

ServerTask	ReplaceHardware (String address, int port, bool useHttps, int httpsPort, String userName, System.Security.SecureString password, String driver, String customDriverData, bool allowDeletingDisabledDevices)
	Replace hardware.

UpdateFirmwareHardwareServerTask	UpdateFirmwareHardware ()
	Update firmware.

ServerTask	UpdateFirmwareHardware (String storageId)
	Update firmware.

UpdateHardwareServerTask	UpdateHardware ()
	Update hardware - detection step.

UpdateHardwareServerTask	UpdateHardware (long sessionDataId)
	Update hardware. When sessionDataId is zero - performs a detection, otherwise the sessionDataId is set to the value returned in detection step - and will apply the detected changes.

Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationItem
void	ClearChildrenCache ()
	Clear the internal cache of children. Can be used to force a new set of children to be fetched from the server at next access.

ServerTask	ExecuteMethod (string methodId)
	Execute the provided method. The method id must be one of the defined values in the Methods property.

void	FillChildren (string[] itemTypes)
	Fill all children and grand-children - as long as the itemtype is contained in itemType parameter.

void	FillChildren (string[] itemTypes, ItemFilter[] itemFilters)
	Fill all children and grand-children - as long as the itemtype is contained in itemType parameter and filters match. If multiple filters are defined for same itemtype, all must match for the item to be included ('and' operation). If no filter is defined for an ItemType, then all items of that type is filled.

void	Save ()
	Will save all updated values to server.

ValidateResult	ValidateItem ()
	Validate the current content.

Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem
string	GetProperty (string key)
	Return a property value as string, if key is not found the return value will be null.

ICollection< string >	GetPropertyKeys ()
	Get a collection of all available property keys.

List< ValueTypeInfo >	GetValueTypeInfoList (string propertyKey)
	Get defined ValueTypeInfo for a given property. If no ValueTypeInfo is available, an empty list is returned.

void	SetProperty (string key, string content)
	Sets the value of a property (all is string format here)

override string	ToString ()
	Display the 'DisplayName' is the default ToString()

Properties
string	Address `[get, set]`
	Address. The base address of the hardware. If the property HttpsEnabled exists in the general settings of this hardware and has the value Yes, the address should be modified to use HTTPS and the port defined in the property named HttpsPort under general settings.

CameraFolder	CameraFolder `[get]`
	Return the single folder item of the given ItemType.

CustomPropertiesFolder	CustomPropertiesFolder `[get]`
	Return the single folder item of the given ItemType.

bool	Enabled `[get, set]`
	Indicate if this item is active in the VMS system, e.g. enabled.

HardwareDeviceEventFolder	HardwareDeviceEventFolder `[get]`
	Return the single folder item of the given ItemType.

String	HardwareDriverPath `[get]`
	Path. Contains the path/ID of the device driver used for the hardware. Driver can be looked up under the recording server.

HardwareDriverSettingsFolder	HardwareDriverSettingsFolder `[get]`
	Return the single folder item of the given ItemType.

HardwarePtzSettingsFolder	HardwarePtzSettingsFolder `[get]`
	Return the single folder item of the given ItemType.

string	Id `[get]`
	ID.

InputEventFolder	InputEventFolder `[get]`
	Return the single folder item of the given ItemType.

DateTime	LastModified `[get]`
	Last modified.

MetadataFolder	MetadataFolder `[get]`
	Return the single folder item of the given ItemType.

MicrophoneFolder	MicrophoneFolder `[get]`
	Return the single folder item of the given ItemType.

string	Model `[get]`
	Model.

OutputFolder	OutputFolder `[get]`
	Return the single folder item of the given ItemType.

DateTime	PasswordLastModified `[get]`
	Password last changed.

SpeakerFolder	SpeakerFolder `[get]`
	Return the single folder item of the given ItemType.

string	UserName `[get, set]`
	User name.

Properties inherited from VideoOS.Platform.ConfigurationItems.IConfigurationItem
Guid	Guid `[get]`
	Returns the id property or part of the path, when available. When no id is available this will be Guid.Empty. This is relevant for some items of ItemCategory.ChildItem where no property with key = "Id" exists and path does not contains a guid.

Collection< string >	Methods `[get]`
	The available methods for this class.

Properties inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem
string	Description `[get, set]`
	Description.

virtual string	DisplayName `[get]`
	Name of this ConfigurationItem in user readable format. Usually the same as property with key = "Name".

string	ItemCategory `[get]`
	Return the item category for this item. This can be used to understand how multiple items are fetched and saved together. Only ItemCategory == 'Item' can be saved.

string	Name `[get, set]`
	Name.

string	ParentItemPath `[get]`
	Get hold of the next real parent path, e.g. skip any 'Folder' type parent.

string	ParentPath `[get]`
	The path for the parent of this ConfigurationItem.

string	Path `[get]`
	The identification of this item.

ServerId	ServerId `[get, set]`
	Contains the ServerId of the Management Server holding this item.

Detailed Description

Constructor & Destructor Documentation

◆ Hardware() [1/3]

VideoOS.Platform.ConfigurationItems.Hardware.Hardware	(	ServerId	serverId,
		ConfigurationItem	hardware )

inline

Construct the class from serverId of the Management Server that owns the configuration, and the already returned ConfigurationItem.

Parameters

serverId	Identify the Management Server that owns the configuration
hardware	The ConfigurationItem returned from elsewhere

Exceptions

ArgumentMIPException When LoginSettings not found for serverId

◆ Hardware() [2/3]

VideoOS.Platform.ConfigurationItems.Hardware.Hardware	(	ServerId	serverId,
		string	path )

inline

Construct the class from serverId of the Management Server that owns the configuration, and the path of the item.

This construction will contact the server and read the specified item.

Parameters

serverId	Identify the Management Server that owns the configuration
path	The path of a specific item

Exceptions

MIPException Represents a number of possible exceptions. Possible exceptions can be found via the inherited exceptions - like PathNotFoundMIPException

◆ Hardware() [3/3]

VideoOS.Platform.ConfigurationItems.Hardware.Hardware ( FQID fqid )

inline

Construct the class from a MIP FQID - note that not all configuration items have a corresponding FQID.

This construction will contact the server and read the specified item.

Parameters

fqid	Identify the MIP item

Exceptions

MIPException Represents a number of possible exceptions. Possible exceptions can be found via the inherited exceptions - like PathNotFoundMIPException

Member Function Documentation

◆ ChangePasswordHardware() [1/4]

ChangePasswordHardwareServerTask VideoOS.Platform.ConfigurationItems.Hardware.ChangePasswordHardware ( )

inline

Change hardware password.

◆ ChangePasswordHardware() [2/4]

ServerTask VideoOS.Platform.ConfigurationItems.Hardware.ChangePasswordHardware ( String password )

inline

Change hardware password
Please consider using secure version taking SecureString instead.

Parameters

password Password

◆ ChangePasswordHardware() [3/4]

ServerTask VideoOS.Platform.ConfigurationItems.Hardware.ChangePasswordHardware ( System.Security.SecureString password )

inline

Change hardware password.

Parameters

password Password

◆ ChangePasswordHardware() [4/4]

ServerTask VideoOS.Platform.ConfigurationItems.Hardware.ChangePasswordHardware	(	System.Security.SecureString	password,
		bool	updatePasswordOnDevice )

inline

Change hardware password.

Parameters

password	Password
updatePasswordOnDevice	Update password also on device. If checked the password will be changed in the system and on the hardware device itself

◆ MoveHardware() [1/2]

MoveHardwareServerTask VideoOS.Platform.ConfigurationItems.Hardware.MoveHardware ( )

inline

Move hardware.

◆ MoveHardware() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.Hardware.MoveHardware ( String destinationRecordingServer )

inline

Move hardware.

Parameters

destinationRecordingServer Destination recording server. The recording server that the hardware device is moved to.

◆ ReadPasswordHardware()

ServerTask VideoOS.Platform.ConfigurationItems.Hardware.ReadPasswordHardware ( )

inline

Read hardware password.

◆ ReplaceHardware() [1/2]

ReplaceHardwareServerTask VideoOS.Platform.ConfigurationItems.Hardware.ReplaceHardware ( )

inline

Replace hardware.

◆ ReplaceHardware() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.Hardware.ReplaceHardware	(	String	address,
		int	port,
		bool	useHttps,
		int	httpsPort,
		String	userName,
		System.Security.SecureString	password,
		String	driver,
		String	customDriverData,
		bool	allowDeletingDisabledDevices )

inline

Replace hardware.

Parameters

address	Address. The IP address or host name of the new hardware.
port	Port. The network port to use for communicating with the new hardware
useHttps	Use HTTPS. Communication with the new hardware must use HTTPS
httpsPort	HTTPS port. Port to use for HTTPS communication with the new hardware
userName	User name. User name to use with the new hardware
password	Password. Password to use with the new hardware
driver	Driver. Driver number of the driver to use with the new hardware
customDriverData	Custom driver data. Custom driver data passed to the driver when obtaining information about the new hardware. Not supported for most drivers, so in most cases just leave it empty
allowDeletingDisabledDevices	Allow deleting disabled devices. Is the replace hardware task allowed to delete disabled devices if needed during the replace hardware operation

◆ UpdateFirmwareHardware() [1/2]

UpdateFirmwareHardwareServerTask VideoOS.Platform.ConfigurationItems.Hardware.UpdateFirmwareHardware ( )

inline

Update firmware.

◆ UpdateFirmwareHardware() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.Hardware.UpdateFirmwareHardware ( String storageId )

inline

Update firmware.

Parameters

storageId Storage ID. The storage ID of the uploaded file

◆ UpdateHardware() [1/2]

UpdateHardwareServerTask VideoOS.Platform.ConfigurationItems.Hardware.UpdateHardware ( )

inline

Update hardware - detection step.

◆ UpdateHardware() [2/2]

UpdateHardwareServerTask VideoOS.Platform.ConfigurationItems.Hardware.UpdateHardware ( long sessionDataId )

inline

Update hardware. When sessionDataId is zero - performs a detection, otherwise the sessionDataId is set to the value returned in detection step - and will apply the detected changes.

Property Documentation

◆ Address

string VideoOS.Platform.ConfigurationItems.Hardware.Address

getset

Address. The base address of the hardware. If the property HttpsEnabled exists in the general settings of this hardware and has the value Yes, the address should be modified to use HTTPS and the port defined in the property named HttpsPort under general settings.

◆ CameraFolder

CameraFolder VideoOS.Platform.ConfigurationItems.Hardware.CameraFolder

get

Return the single folder item of the given ItemType.

◆ CustomPropertiesFolder

CustomPropertiesFolder VideoOS.Platform.ConfigurationItems.Hardware.CustomPropertiesFolder

get

Return the single folder item of the given ItemType.

◆ Enabled

bool VideoOS.Platform.ConfigurationItems.Hardware.Enabled

getset

Indicate if this item is active in the VMS system, e.g. enabled.

◆ HardwareDeviceEventFolder

HardwareDeviceEventFolder VideoOS.Platform.ConfigurationItems.Hardware.HardwareDeviceEventFolder

get

Return the single folder item of the given ItemType.

◆ HardwareDriverPath

String VideoOS.Platform.ConfigurationItems.Hardware.HardwareDriverPath

get

Path. Contains the path/ID of the device driver used for the hardware. Driver can be looked up under the recording server.

◆ HardwareDriverSettingsFolder

HardwareDriverSettingsFolder VideoOS.Platform.ConfigurationItems.Hardware.HardwareDriverSettingsFolder

get

Return the single folder item of the given ItemType.

◆ HardwarePtzSettingsFolder

HardwarePtzSettingsFolder VideoOS.Platform.ConfigurationItems.Hardware.HardwarePtzSettingsFolder

get

Return the single folder item of the given ItemType.

◆ Id

string VideoOS.Platform.ConfigurationItems.Hardware.Id

get

ID.

◆ InputEventFolder

InputEventFolder VideoOS.Platform.ConfigurationItems.Hardware.InputEventFolder

get

Return the single folder item of the given ItemType.

◆ LastModified

DateTime VideoOS.Platform.ConfigurationItems.Hardware.LastModified

get

Last modified.

◆ MetadataFolder

MetadataFolder VideoOS.Platform.ConfigurationItems.Hardware.MetadataFolder

get

Return the single folder item of the given ItemType.

◆ MicrophoneFolder

MicrophoneFolder VideoOS.Platform.ConfigurationItems.Hardware.MicrophoneFolder

get

Return the single folder item of the given ItemType.

◆ Model

string VideoOS.Platform.ConfigurationItems.Hardware.Model

get

Model.

◆ OutputFolder

OutputFolder VideoOS.Platform.ConfigurationItems.Hardware.OutputFolder

get

Return the single folder item of the given ItemType.

◆ PasswordLastModified

DateTime VideoOS.Platform.ConfigurationItems.Hardware.PasswordLastModified

get

Password last changed.

◆ SpeakerFolder

SpeakerFolder VideoOS.Platform.ConfigurationItems.Hardware.SpeakerFolder

get

Return the single folder item of the given ItemType.

◆ UserName

string VideoOS.Platform.ConfigurationItems.Hardware.UserName

getset

User name.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Hardware() [1/3]

◆ Hardware() [2/3]

◆ Hardware() [3/3]

Member Function Documentation

◆ ChangePasswordHardware() [1/4]

◆ ChangePasswordHardware() [2/4]

◆ ChangePasswordHardware() [3/4]

◆ ChangePasswordHardware() [4/4]

◆ MoveHardware() [1/2]

◆ MoveHardware() [2/2]

◆ ReadPasswordHardware()

◆ ReplaceHardware() [1/2]

◆ ReplaceHardware() [2/2]

◆ UpdateFirmwareHardware() [1/2]

◆ UpdateFirmwareHardware() [2/2]

◆ UpdateHardware() [1/2]

◆ UpdateHardware() [2/2]

Property Documentation

◆ Address

◆ CameraFolder

◆ CustomPropertiesFolder

◆ Enabled

◆ HardwareDeviceEventFolder

◆ HardwareDriverPath

◆ HardwareDriverSettingsFolder

◆ HardwarePtzSettingsFolder

◆ Id

◆ InputEventFolder

◆ LastModified

◆ MetadataFolder

◆ MicrophoneFolder

◆ Model

◆ OutputFolder

◆ PasswordLastModified

◆ SpeakerFolder

◆ UserName