Inheritance diagram for VideoOS.Platform.ConfigurationItems.RecordingServer:

Public Member Functions
AddHardwareServerTask	AddHardware ()
	Add new hardware.

ServerTask	AddHardware (ChildTaskDetail hardwareScanResult, String customData=null)
	Add new hardware using the ChildTaskDetail returned by one of the hardware scan methods.

ServerTask	AddHardware (String hardwareAddress, String hardwareDriverPath, String userName, String password)
	Add new hardware Please consider using secure version taking SecureString instead.

ServerTask	AddHardware (String hardwareAddress, String hardwareDriverPath, String userName, System.Security.SecureString password)
	Add new hardware.

ServerTask	AddHardware (String hardwareAddress, String hardwareDriverPath, String userName, System.Security.SecureString password, String customData)
	Add new hardware.

CreateDirectoryOnRecorderServerTask	CreateDirectoryOnRecorder ()
	Create directory on recorder.

ServerTask	CreateDirectoryOnRecorder (String newDirectoryFullName)
	Create directory on recorder.

ClassCollectionServerTask	GetOtherDevicesWithMediaOnRecorder ()
	Get devices with media on recording server.

HardwareScanServerTask	HardwareScan ()
	Detect hardware driver.

ServerTask	HardwareScan (String hardwareAddress, String hardwareDriverIds, String userName, String password, bool useDefaultCredentials)
	Detect hardware driver Please consider using secure version taking SecureString instead.

ClassCollectionServerTask	HardwareScan (String hardwareAddress, String hardwareDriverIds, String userName, System.Security.SecureString password, bool useDefaultCredentials)
	Detect hardware driver.

HardwareScanExpressServerTask	HardwareScanExpress ()
	Detect hardware.

ServerTask	HardwareScanExpress (String primaryUserName, String primaryPassword, String secondaryUserName, String secondaryPassword, String tertiaryUserName, String tertiaryPassword, bool useDefaultCredentials)
	Detect hardware.

ClassCollectionServerTask	HardwareScanExpress (String primaryUserName, String primaryPassword, String secondaryUserName, String secondaryPassword, String tertiaryUserName, String tertiaryPassword, bool useDefaultCredentials, bool useSecurePort)
	Detect hardware.

ClassCollectionServerTask	LoadTasks ()
	Load the tasks existing on the server.

ReadDirectoriesOnRecorderServerTask	ReadDirectoriesOnRecorder ()
	Read directories on recorder.

ServerTask	ReadDirectoriesOnRecorder (String currentDirectory)
	Read directories on recorder.

ServerTask	ReadDrivesOnRecorder ()
	Read drives on recorder.

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

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

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

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	ActiveWebServerUri `[get]`
	Active Public Web server URI . Currently active public web server address.

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

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

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

string	HostName `[get]`
	Host name. Host name of the recording server (deprecated, use 'Web Server Uri')

string	Id `[get]`
	ID.

DateTime	LastModified `[get]`
	Last modified.

string	MulticastServerAddress `[get, set]`
	Multicast server address.

int	PortNumber `[get]`
	Port number. Port number of the recording server (deprecated, use 'Web Server Uri')

bool	PublicAccessEnabled `[get, set]`
	Public address enabled. Enable or disable the public address.

string	PublicWebserverHostName `[get, set]`
	Public recording server address.

int	PublicWebserverPort `[get, set]`
	Public recording server port.

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

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

bool	ShutdownOnStorageFailure `[get, set]`
	Shutdown on storage failure.

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

int	SynchronizationTime `[get, set]`
	Synchronization time. Defines when the configuration is synchronized with the hardware. Define when to start the synchronization by entering a number of minutes after midnight (local time of recording server). The default value is -1, which means no synchronization.

string	TimeZoneName `[get]`
	Time zone.

string	Version `[get]`
	Version.

string	WebServerUri `[get]`
	Web Server Uri. Web Server Uri of the recording server.

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

◆ RecordingServer() [1/3]

VideoOS.Platform.ConfigurationItems.RecordingServer.RecordingServer	(	ServerId	serverId,
		ConfigurationItem	recordingServer )

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
recordingServer	The ConfigurationItem returned from elsewhere

Exceptions

ArgumentMIPException When LoginSettings not found for serverId

◆ RecordingServer() [2/3]

VideoOS.Platform.ConfigurationItems.RecordingServer.RecordingServer	(	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

◆ RecordingServer() [3/3]

VideoOS.Platform.ConfigurationItems.RecordingServer.RecordingServer ( 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

◆ AddHardware() [1/5]

AddHardwareServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.AddHardware ( )

inline

Add new hardware.

◆ AddHardware() [2/5]

ServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.AddHardware	(	ChildTaskDetail	hardwareScanResult,
		String	customData = null )

inline

Add new hardware using the ChildTaskDetail returned by one of the hardware scan methods.

Parameters

hardwareScanResult	Address
customData	Custom data - can be left empty

◆ AddHardware() [3/5]

ServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.AddHardware	(	String	hardwareAddress,
		String	hardwareDriverPath,
		String	userName,
		String	password )

inline

Add new hardware
Please consider using secure version taking SecureString instead.

Parameters

hardwareAddress	Address
hardwareDriverPath	Hardware driver
userName	User name
password	Password

◆ AddHardware() [4/5]

ServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.AddHardware	(	String	hardwareAddress,
		String	hardwareDriverPath,
		String	userName,
		System.Security.SecureString	password )

inline

Add new hardware.

Parameters

hardwareAddress	Address
hardwareDriverPath	Hardware driver
userName	User name
password	Password

◆ AddHardware() [5/5]

ServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.AddHardware	(	String	hardwareAddress,
		String	hardwareDriverPath,
		String	userName,
		System.Security.SecureString	password,
		String	customData )

inline

Add new hardware.

Parameters

hardwareAddress	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.
hardwareDriverPath	Hardware driver. Contains the path/ID of the device driver used for the hardware. Driver can be looked up under the recording server.
userName	User name. User name for the hardware
password	Password. Password for hardware
customData	Custom data. Data to be passed on to driver during add hardware process

◆ CreateDirectoryOnRecorder() [1/2]

CreateDirectoryOnRecorderServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.CreateDirectoryOnRecorder ( )

inline

Create directory on recorder.

◆ CreateDirectoryOnRecorder() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.CreateDirectoryOnRecorder ( String newDirectoryFullName )

inline

Create directory on recorder.

Parameters

newDirectoryFullName Full path of new directory. Full path including name of directory to create on the recorder

◆ GetOtherDevicesWithMediaOnRecorder()

ClassCollectionServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.GetOtherDevicesWithMediaOnRecorder ( )

inline

Get devices with media on recording server.

◆ HardwareScan() [1/3]

HardwareScanServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.HardwareScan ( )

inline

Detect hardware driver.

◆ HardwareScan() [2/3]

ServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.HardwareScan	(	String	hardwareAddress,
		String	hardwareDriverIds,
		String	userName,
		String	password,
		bool	useDefaultCredentials )

inline

Detect hardware driver
Please consider using secure version taking SecureString instead.

Parameters

hardwareAddress	Address
hardwareDriverIds	Hardware driver IDs
userName	User name
password	Password
useDefaultCredentials	Use default credentials

◆ HardwareScan() [3/3]

ClassCollectionServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.HardwareScan	(	String	hardwareAddress,
		String	hardwareDriverIds,
		String	userName,
		System.Security.SecureString	password,
		bool	useDefaultCredentials )

inline

Detect hardware driver.

Parameters

hardwareAddress	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.
hardwareDriverIds	Hardware driver IDs. Hardware driver IDs separated by ';'. Example: "48;13;25". Specify an empty string to include all drivers.
userName	User name. User name for the hardware
password	Password. Password for hardware
useDefaultCredentials	Use default credentials. Specify if you want to use the default hardware credentials or use another one.

◆ HardwareScanExpress() [1/3]

HardwareScanExpressServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.HardwareScanExpress ( )

inline

Detect hardware.

◆ HardwareScanExpress() [2/3]

ServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.HardwareScanExpress	(	String	primaryUserName,
		String	primaryPassword,
		String	secondaryUserName,
		String	secondaryPassword,
		String	tertiaryUserName,
		String	tertiaryPassword,
		bool	useDefaultCredentials )

inline

Detect hardware.

Parameters

primaryUserName	User name
primaryPassword	Password
secondaryUserName	User name
secondaryPassword	Password
tertiaryUserName	User name
tertiaryPassword	Password
useDefaultCredentials	Use default credentials

◆ HardwareScanExpress() [3/3]

ClassCollectionServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.HardwareScanExpress	(	String	primaryUserName,
		String	primaryPassword,
		String	secondaryUserName,
		String	secondaryPassword,
		String	tertiaryUserName,
		String	tertiaryPassword,
		bool	useDefaultCredentials,
		bool	useSecurePort )

inline

Detect hardware.

Parameters

primaryUserName	User name. User name for the hardware
primaryPassword	Password. Password for hardware
secondaryUserName	User name. User name for the hardware
secondaryPassword	Password. Password for hardware
tertiaryUserName	User name. User name for the hardware
tertiaryPassword	Password. Password for hardware
useDefaultCredentials	Use default credentials. Specify if you want to use the default hardware credentials or use another one.
useSecurePort	Use HTTPS. Specify if you want to use the HTTPS protocol to connect to the hardware.

◆ LoadTasks()

ClassCollectionServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.LoadTasks ( )

inline

Load the tasks existing on the server.

◆ ReadDirectoriesOnRecorder() [1/2]

ReadDirectoriesOnRecorderServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.ReadDirectoriesOnRecorder ( )

inline

Read directories on recorder.

◆ ReadDirectoriesOnRecorder() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.ReadDirectoriesOnRecorder ( String currentDirectory )

inline

Read directories on recorder.

Parameters

currentDirectory Current directory. Current directory on the recorder

◆ ReadDrivesOnRecorder()

ServerTask VideoOS.Platform.ConfigurationItems.RecordingServer.ReadDrivesOnRecorder ( )

inline

Read drives on recorder.

Property Documentation

◆ ActiveWebServerUri

string VideoOS.Platform.ConfigurationItems.RecordingServer.ActiveWebServerUri

get

Active Public Web server URI . Currently active public web server address.

◆ Enabled

bool VideoOS.Platform.ConfigurationItems.RecordingServer.Enabled

getset

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

◆ HardwareDriverFolder

HardwareDriverFolder VideoOS.Platform.ConfigurationItems.RecordingServer.HardwareDriverFolder

get

Return the single folder item of the given ItemType.

◆ HardwareFolder

HardwareFolder VideoOS.Platform.ConfigurationItems.RecordingServer.HardwareFolder

get

Return the single folder item of the given ItemType.

◆ HostName

string VideoOS.Platform.ConfigurationItems.RecordingServer.HostName

get

Host name. Host name of the recording server (deprecated, use 'Web Server Uri')

◆ Id

string VideoOS.Platform.ConfigurationItems.RecordingServer.Id

get

ID.

◆ LastModified

DateTime VideoOS.Platform.ConfigurationItems.RecordingServer.LastModified

get

Last modified.

◆ MulticastServerAddress

string VideoOS.Platform.ConfigurationItems.RecordingServer.MulticastServerAddress

getset

Multicast server address.

◆ PortNumber

int VideoOS.Platform.ConfigurationItems.RecordingServer.PortNumber

get

Port number. Port number of the recording server (deprecated, use 'Web Server Uri')

◆ PublicAccessEnabled

bool VideoOS.Platform.ConfigurationItems.RecordingServer.PublicAccessEnabled

getset

Public address enabled. Enable or disable the public address.

◆ PublicWebserverHostName

string VideoOS.Platform.ConfigurationItems.RecordingServer.PublicWebserverHostName

getset

Public recording server address.

◆ PublicWebserverPort

int VideoOS.Platform.ConfigurationItems.RecordingServer.PublicWebserverPort

getset

Public recording server port.

◆ RecordingServerFailoverFolder

RecordingServerFailoverFolder VideoOS.Platform.ConfigurationItems.RecordingServer.RecordingServerFailoverFolder

get

Return the single folder item of the given ItemType.

◆ RecordingServerMulticastFolder

RecordingServerMulticastFolder VideoOS.Platform.ConfigurationItems.RecordingServer.RecordingServerMulticastFolder

get

Return the single folder item of the given ItemType.

◆ ShutdownOnStorageFailure

bool VideoOS.Platform.ConfigurationItems.RecordingServer.ShutdownOnStorageFailure

getset

Shutdown on storage failure.

◆ StorageFolder

StorageFolder VideoOS.Platform.ConfigurationItems.RecordingServer.StorageFolder

get

Return the single folder item of the given ItemType.

◆ SynchronizationTime

int VideoOS.Platform.ConfigurationItems.RecordingServer.SynchronizationTime

getset

Synchronization time. Defines when the configuration is synchronized with the hardware. Define when to start the synchronization by entering a number of minutes after midnight (local time of recording server). The default value is -1, which means no synchronization.

◆ TimeZoneName

string VideoOS.Platform.ConfigurationItems.RecordingServer.TimeZoneName

get

Time zone.

◆ Version

string VideoOS.Platform.ConfigurationItems.RecordingServer.Version

get

Version.

◆ WebServerUri

string VideoOS.Platform.ConfigurationItems.RecordingServer.WebServerUri

get

Web Server Uri. Web Server Uri of the recording server.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RecordingServer() [1/3]

◆ RecordingServer() [2/3]

◆ RecordingServer() [3/3]

Member Function Documentation

◆ AddHardware() [1/5]

◆ AddHardware() [2/5]

◆ AddHardware() [3/5]

◆ AddHardware() [4/5]

◆ AddHardware() [5/5]

◆ CreateDirectoryOnRecorder() [1/2]

◆ CreateDirectoryOnRecorder() [2/2]

◆ GetOtherDevicesWithMediaOnRecorder()

◆ HardwareScan() [1/3]

◆ HardwareScan() [2/3]

◆ HardwareScan() [3/3]

◆ HardwareScanExpress() [1/3]

◆ HardwareScanExpress() [2/3]

◆ HardwareScanExpress() [3/3]

◆ LoadTasks()

◆ ReadDirectoriesOnRecorder() [1/2]

◆ ReadDirectoriesOnRecorder() [2/2]

◆ ReadDrivesOnRecorder()

Property Documentation

◆ ActiveWebServerUri

◆ Enabled

◆ HardwareDriverFolder

◆ HardwareFolder

◆ HostName

◆ Id

◆ LastModified

◆ MulticastServerAddress

◆ PortNumber

◆ PublicAccessEnabled

◆ PublicWebserverHostName

◆ PublicWebserverPort

◆ RecordingServerFailoverFolder

◆ RecordingServerMulticastFolder

◆ ShutdownOnStorageFailure

◆ StorageFolder

◆ SynchronizationTime

◆ TimeZoneName

◆ Version

◆ WebServerUri