Options available for the EnvironmentManager.Instance.EnvironmentOptions dictionary. More...

Static Public Attributes
const string	ApplicationDataFilePath = "ApplicationDataFilePath"
	Key for entry in the EnvironmentOptions specifying the absolute path to the location where plugins can store data locally.

const string	CompanyNameFolder = "CompanyNameFolder"
	Identify if product has been OEM'ed to another company. Used for building ProgramData\"CompanyNameFolder"\MIPSDK\ log files.

const string	ConfigurationChangeCheckInterval = "ConfigurationChangeCheckInterval"
	In seconds.

const string	ConnectionCheckTimeout = "ConnectionCheckTimeout"
	Timeout in seconds for connections to Identity Provider (IDP).

const string	DualItemHierarchy = "DualItemHierarchy"
	Key in EnvironmentOptions - reserved for internal use.

const string	HardwareDecodingMode = "HardwareDecodingMode"
	Specify if hardware decoding can be used.

const string	LogPrefix = "LogPrefix"
	Used by standalone application to name what it's log file should start with.

const string	Manufacturer = "Manufacturer"
	Key identifying VMS Manufacturer information in EnvironmentManager.EnvironmentOptions

const string	MulticastErrorRate = "MULTICASTERRORRATE"
	When added to EnvironmentManager.Instance.EnvironmentOptions, the value indicates when to switch from using multicast to unicast. Default is "0.25".

const string	MulticastLog = "MULTICASTLOG"
	When added to EnvironmentManager.Instance.EnvironmentOptions, multicast activity is logged on debug level.

const string	OptionHardwareDecodingModeAuto = "Auto"
	Value used on EnvironmentOptions, where key is HardwareDecodingMode.

const string	OptionHardwareDecodingModeAutoNvidia = "AutoNvidia"
	Value used on EnvironmentOptions, where key is HardwareDecodingMode.

const string	OptionHardwareDecodingModeOff = "Off"
	Value used on EnvironmentOptions, where key is HardwareDecodingMode.

const string	OptionHardwareDecodingModeOnlyIntel = "OnlyIntel"
	Value used on EnvironmentOptions, where key is HardwareDecodingMode.

const string	OptionHardwareDecodingModeOnlyNvidia = "OnlyNvidia"
	Value used on EnvironmentOptions, where key is HardwareDecodingMode.

const string	OptionNo = "No"
	Value used on EnvironmentOptions.

const string	OptionYes = "Yes"
	Value used on EnvironmentOptions.

const string	PlayerDiagnosticLevel = "PlayerDiagnosticLevel"
	Set this value to number between "0" and "3", to display developer information on top of ImageViewerCOntrol.

const string	PtzReverseTiltForContinuesMoves = "PtzReverseTiltForContinuesMoves"
	This property controls if the continues move commands will have the tilt value multiplied with -1. Values can be "True", "False" - or not filled.

const string	RestApiCallerId = "RestApiCallerId"
	For Internal Use Only.

const string	ShortProductName = "ShortProductName"
	Key for entry in the EnvironmentOptions specifying the product name in a short form.

const string	SoftwareDecodingThreads = "SoftwareDecodingThreads"
	Defines the number of threads to be used while decoding. The value is formatted as: "4,1" - defining that 4 threads is to be used when just one stream is active, while 1 thread is used if more streams are active.

const string	ToolkitFork = "ToolkitFork"
	Key in EnvironmentOptions. Used by the standalone MIP Environment to define if live streams should be shared among multiple users, e.g. JPEGLiveSource, BitmapLiveSource - when possible. Default is "Yes".

const string	UseActiveX = "UseActiveX"
	Deprecated. Defines if the ImageViewer ActiveX should be used, or the hardware accellerated implementation should be used.

const string	UseControlForMessaging = "UseControlForMessaging"
	Key in EnvironmentOptions. Used by standalone MIP Environment to identify is sending and posting messages should be carried out on the top level user control. Default is "Yes".

const string	UsePing = "UsePing"
	Key in EnvironmentOptions. Used by standalone MIP Environment to identify is server identification should use Ping. For application connecting over the internet, this should be changed to a "No". Default is "Yes" from MIPSDK 4.0.

const string	UseRestApiCaching = "UseRestApiCaching"
	Used by the stand-alone MIP Environment to determine whether to use caching of the configuration. The default is "Yes".

const string	ViewControlSupportChangeLayout = "ViewControlSupportChangeLayout"
	Value used on EnvironmentOptions to indicate, that ViewControl supports change of layout.

Detailed Description

Options available for the EnvironmentManager.Instance.EnvironmentOptions dictionary.

Member Data Documentation

◆ ApplicationDataFilePath

const string VideoOS.Platform.EnvironmentOptions.ApplicationDataFilePath = "ApplicationDataFilePath"

static

Key for entry in the EnvironmentOptions specifying the absolute path to the location where plugins can store data locally.

Only supported in Smart Client, Management Client and Event Server environments.

◆ CompanyNameFolder

const string VideoOS.Platform.EnvironmentOptions.CompanyNameFolder = "CompanyNameFolder"

static

Identify if product has been OEM'ed to another company. Used for building ProgramData\"CompanyNameFolder"\MIPSDK\ log files.

◆ ConfigurationChangeCheckInterval

const string VideoOS.Platform.EnvironmentOptions.ConfigurationChangeCheckInterval = "ConfigurationChangeCheckInterval"

static

In seconds.

◆ ConnectionCheckTimeout

const string VideoOS.Platform.EnvironmentOptions.ConnectionCheckTimeout = "ConnectionCheckTimeout"

static

Timeout in seconds for connections to Identity Provider (IDP).

Used by plug-in and standalone MIP Environments to get well known information provided by IDP. Used by standalone MIP Environment when checking connection to sites the user has access to.

Default value is "5".

◆ DualItemHierarchy

const string VideoOS.Platform.EnvironmentOptions.DualItemHierarchy = "DualItemHierarchy"

static

Key in EnvironmentOptions - reserved for internal use.

◆ HardwareDecodingMode

const string VideoOS.Platform.EnvironmentOptions.HardwareDecodingMode = "HardwareDecodingMode"

static

Specify if hardware decoding can be used.

Available options are:
"Auto" - The media toolkit selects the best way to decode, can be either using GPU or software.
"Off" - Do not utilize any hardware for decoding.

◆ LogPrefix

const string VideoOS.Platform.EnvironmentOptions.LogPrefix = "LogPrefix"

static

Used by standalone application to name what it's log file should start with.

Default is "MIP"

◆ Manufacturer

const string VideoOS.Platform.EnvironmentOptions.Manufacturer = "Manufacturer"

static

Key identifying VMS Manufacturer information in EnvironmentManager.EnvironmentOptions

◆ MulticastErrorRate

const string VideoOS.Platform.EnvironmentOptions.MulticastErrorRate = "MULTICASTERRORRATE"

static

When added to EnvironmentManager.Instance.EnvironmentOptions, the value indicates when to switch from using multicast to unicast. Default is "0.25".

It represent the rate of errors compared to all frames, e.g. 0.25 signifies that when 25% of the frame are in error, swap to unicast.

Only supported in standalone environment.

◆ MulticastLog

const string VideoOS.Platform.EnvironmentOptions.MulticastLog = "MULTICASTLOG"

static

When added to EnvironmentManager.Instance.EnvironmentOptions, multicast activity is logged on debug level.

Only supported in standalone environment.