▼NVideoOS | |
▼NConfigurationApi | |
►NClientService | |
CArgumentExceptionFault | |
CArgumentNullExceptionFault | |
CConfigurationItem | |
CConfigurationServiceClient | |
CEnablePropertyInfo | |
CErrorResult | |
CIConfigurationService | |
CIConfigurationServiceChannel | |
CItemFilter | Describes how to match items for Query and FillChildren methods |
CLicenseExceptionFault | |
CMethodInfo | |
CNotSupportedExceptionFault | |
CPathNotFoundExceptionFault | |
CProperty | |
CPropertyFilter | Contains criteria for filtering ConfigurationItems during Query and FillChildren oprations |
CQueryItems | Assist with querying for ConfigurationItems on a given server |
CServerExceptionFault | |
CUnauthorizedAccessFault | |
CValidateResult | |
CValueTypeInfo | |
▼NPlatform | |
►NAdmin | |
CAddUserControl | UserControl to be used when adding a new Item in the Management Client |
CAdminImageViewerControl | An ImageViewer UserControl for displaying live video in the XProtect Management Client It is intended for assisting the user in configuring specifics that relates to the image of a camera, e.g. lines to cross in an analytics trip wire setup. |
CAssociatedProperties | Contains a cache of properties to be configured by the TabUserControl |
CContextMenuItem | Defines one context menu entry, to be used in the Administration clients. This class is constructed and defined in the ItemManager that owns a given type of Item, as identified by it's Kind |
CDetailedUserControl | This class is used in the Management Client and Administrator to provide multiple pages or tabs of configuration pages. This class is generated by the MIP Plugin and returned to the administrators in the ItemManager.GenerateDetailUserControlList() method |
►CItemManager | This class is created once for all Items of a specific Kind and is responsible for getting and saving configuration for all Items of that Kind This class is also responsible for creating, filling and saving UserControl and relevant fields changed by the user in the administrators. Normally there will be one ItemManager for each ItemNode. If the Items being managed are stored on another server, then this class can utilize the Init() and Close() methods to setup sessions to the remote server in anticipation of calls to GetItems(). EventServer and Items on MAP This class is also involved in defining ContextMenu on the SmartClient MAP, because the plug-in executing in the Event Server, are providing the Smart Client MAP ViewItem with all relevant plug-ins and their definitions. As the Event Server uses authorization for Items, the ItemNode needs to define the SecurityActions relevant for the items being managed by the ItemManager. A minimum of two SecurityActions must always be defined for the Items to be available in the Smart Client. Item Selection in the Administrators Selection of an Item can happen via mouse click on the TreeView. The user action will result in the following sequences of events: a) ItemManager is accessed through the ItemNode b) The GenerateUserControl() is called to allow ItemManager to create the User Control, setup the ConfigurationChangedByUserEvent, and return the UserControl to the caller. c) The caller will add the UserControl to its relevant panel and set userControl.Dock = DockStyle.Fill to fill available area. d) Existing configuration is fetched by calling the ItemManager.GetItem(FQID) e) The ItemManager.FillUserControl(item) method is called to let the ItemManager populate the UserControl. When de-selecting an item, the ItemManager.FillUserControl(null) is called to let the ItemManager clear the UserControl. The parent UserControl will also have Enabled=false; set shortly after this call. Note: A ItemManager.ClearUserControl() is now defined - this is used when no items are selected to let the implementation clear all fields and disable the entire form. Item edit and update After an Item is selected or created, the system needs to know if any updates have been done by the administrator. Ensure the ConfigurationChangedByUserHandler is called whenever the administrator changes something on the UI. This will allow the administration application to enable Save and Apply buttons as appropriate. When the administrator presses a Save or Apply button, the ValidateAndSaveUserControl is called to let the ItemManager and the underlying UserControl validate the entered values. If fields are valid the method returns true. TreeView name change On the TreeView itself, it is possible to press F2 and edit the name directly. In this case the updated name is passed to the ItemManager via the SetItemName(name) method. The ItemManager should save the new name immediately. |
CItemSummaryHeader | A structure which describes a column header in a summary pane |
CItemNode | An ItemNode contains all relevant information for a configuring and maintaining a specific kind of item. It has ItemKind, name and a reference to an ItemManager. The ItemManager assist in managing individual items and the UI controls to be used for this task. This class is constructed and used in all Environments, either to manage Items, or to get lists of them via GetItems(...) or GetItem(...) methods |
CItemNodeUserControl | User control to display status panel for a configuration item, e.g. Connections on a server |
CMapAlarmContextMenu | Define a ContextMenu line to be displayed on the map when right clicking |
CSecurityAction | Contains definition of a specific security action. An Action could be "MANAGE" or "VIEW". The DisplayName should be the translated version to be used on UI |
CTabPlugin | Defines a plugin to be placed on the tab control of a built-in object |
CTabUserControl | UserControl used to manage configuration associated to e.g. a camera or hardware |
CToolsOptionsDialogPlugin | A class specifying an OptionsDialog plug-in to the Administrator program. Each of the OptionsDialogPlugin’s will have a separate tab in the tools-options dialog. The plug-in should initialize the UI as part of the class construction. The UserControl will be docked to fill the tab page. When the SaveChanges method is called, the plug-in can use the base method ‘SaveProperties’ to save the configuration, if all configuration fields are saved in the Property dictionary |
CToolsOptionsDialogUserControl | This UserControl is created by the PluginDefinition and placed in a new separate tab in the administrator's tools-options dialog. The UserControl will be added to the owning tab parent UserControl and docking set to Fill |
CVideoInfoArgs | Specific EventArgs class to contain the information coming with each frame received |
►NBackground | |
CBackgroundPlugin | A background plugin will be started during application start and be running until the user logs off or application terminates. The Environment will call the methods Init() and Close() when the user login and logout, so the background task can flush any cached information. Don't read the plugin configuration in the Init() method, as it is not guaranteed to be ready at this time. Instead listen for the message with MessageId == Server.ConfigurationChangedIndication and load the configuration once this is received. It will be sent once configuration is ready and also no later than 60 seconds after configuration has been changed by the administrator. The base class implementation of the LoadProperties can get a set of configuration, e.g. the configuration saved by the Options Dialog in the Smart Client or a configuration set saved in one of the administrators. Identification of which configuration to get is done via the GUID. The SaveProperties method can be used if updating of configuration is relevant. The configuration is stored on the server the application is logged into, and should be refreshed when the ApplicationLoggedOn method is called. Configuration can be user private or shared with all users. Notice: For a plugin to be loaded and executed in the Event Server, at least one BackgroundPlugin MUST be defined |
CEventServerControl | This class only exist in the EventServer MIP Environment |
►NClient | |
►NExport | |
CItemExtensions | Extension methods providing easy access to export related properties on view item items provided in the ViewItems property of ExportParameters instance provided to ExportManager |
►NHid | |
CConnectResult | NOTE: BETA. Might change in future release. Type representing the result of a call to HidInstance.ConnectAsync |
CHidAxisInput | NOTE: BETA. Might change in future release. Class representing HID axis input (joystick axis, mouse wheel, etc.) |
CHidAxisValueChangedEventArgs | NOTE: BETA. Might change in future release. Event arguments for an axis value change |
CHidBoolConfigurationProperty | NOTE: BETA. Might change in future release. Boolean configuration property for a HidInstance.
|
CHidButtonInput | NOTE: BETA. Might change in future release. Class representing HID button (joystick button, keyboard key, etc.) |
CHidButtonValueChangedEventArgs | NOTE: BETA. Might change in future release. Event arguments for a button value change |
CHidButtonValueParameters | NOTE: BETA. Might change in future release. Class representing a button pressed value with optional dynamic parameters. This class can be used to set the ValueParameters of the HidButtonInput to signal that a button has been pressed with a dynamic parameter string. The dynamic parameter is prepared by the plug-in and can, for example, represent the key sequence typed into a key pad before pressing the command button |
CHidConfigurationProperty | NOTE: BETA. Might change in future release. Abstract base class for a HID configuration property. Configuration properties are used when creating/connecting to a HidInstance |
CHidEnumConfigurationProperty | NOTE: BETA. Might change in future release. Enumeration configuration property for a HidInstance.
|
CHidInput | NOTE: BETA. Might change in future release. Base class for a Human Interface Device (HID) input. Class has unique ID, user-friendly Name and default ActionId. The HID input element can be associated with an action, that will be executed by the environment when the input value changes |
CHidInstance | NOTE: BETA. Might change in future release. A Human Interface Device (HID) plugin is very similar to the BackgroundPlugin with few members added to service human interface devices (keyboards, joysticks, trackballs, etc.). For more information, refer into the BackgroundPlugin documentation |
CHidIntConfigurationProperty | NOTE: BETA. Might change in future release. Integer configuration property for a HidInstance.
|
CHidPlugin | NOTE: BETA. Might change in future release. Human Interface Device (HID) plugin base class. Inherit from this class to create a new HID plugin. HID instances created by the plugin are exposed as joysticks in the Environment |
CHidSliderInput | NOTE: BETA. Might change in future release. Class representing HID slider input (zoom, speaker volume slider, etc.) |
CHidSliderValueChangedEventArgs | NOTE: BETA. Might change in future release. Event arguments for a slider value change |
CHidStringConfigurationProperty | NOTE: BETA. Might change in future release. String configuration property for a HidInstance.
|
CHidValueChangedEventArgs | NOTE: BETA. Might change in future release. Base class for HID input notifications |
CActiveElementsOverlayRenderParameters | Defines how WPF UIElements are placed on top of video. Used by ImageViewerAddOn.ActiveElementsOverlay methods |
►CAudioPlayer | It supports playing live and recorded audio from an XProtect server or from an export in XProtect format. Supported in Smart Client and standalone environments. |
CAudioMeterValueEventArgs | Current audio meter value for the audio stream |
CAudioPlayerControl | This class is deprecated. Windows Forms controls are no longer supported. Use AudioPlayer instead. This class is available in the Smart Client and the .Net Library. It supports playing live and recorded audio from an XProtect server or from an export in XProtect format. A simple implementation just need these lines for initialization: |
CBitmapSource | |
CCameraViewControlItem | Use this class to represent a camera view item that should be part of the ViewControl |
CClientAction | Defines a client action that can be activated by the operator of the Smart Client. In the Smart Client, client actions can be assigned to keyboard shortcuts, joystick buttons and dragged to camera view items as overlay buttons |
CClientActionGroup | Defines a client action group. Groups support hierarchies |
CConfigurationItemBase | Abstract base class for specialized configuration item classes |
CConnectionState | Current state information for a session |
CConnectResponseEventArgs | The argument filled on the ConnectResponse event. |
CConnectResponseEventEventArgs | The argument filled on the ConnectResponseEvent. |
CCustomViewControlItem | Use this class to represent any view item that should be part of the ViewControl |
CDataViewControlItem | Use this class to represent a data based view item that should be part of the ViewControl |
CExportManager | This class contains information and methods used when the user exports something in the Smart Client. The ExportManager needs to copy all relevant data to the defined folder, so when it starts in Offline mode the plug-in can get hold of all relevant data. The plug-ins configuration is automatically included in the exported material. See the PluginDefinition.GenerateExportManager(...) for how the Smart Client creates your implementation of this class |
CExportParameters | Contains all relevant parameters selected by the user or environment used for an export. The class is build by the Environment |
CGisMapViewControlItem | Use this class to represent a Gis map view item that should be part of the ViewControl |
CImageDisplayedEventArgs | For each image being displayed that argument is filled with the Image time, and passed to this class via the ImageDisplayedEvent |
CImageOrPaintInfoChangedEventArgs | The argument filled on the ImageOrPaintInfoChanged event. |
CImageViewerAddOn | This class is created and send as a parameter on the ClientControl.NewImageViewerControlEvent event The fields and properties on this class is mostly in a 'listen' mode, as another ImageViewerControl will control the actual video as usually. This class can then be used for applying overlay in the form of analytics graphics or text. By registering on the StartLive and StopLive events, the CloseEvent and the PropertyChanged event, a plug-in can ensure to follow the modes and states that may change in the underlaying ImageViewerControl. Note: If using a background thread to retrieve and format overlays, a Invoke is required before calling UserControl related methods like SetOverlay and ClearOverlay |
CImageViewerControl | This class is deprecated. Windows Forms controls are no longer supported. Use ImageViewerWpfControl instead. This class is available in the Smart Client and the .Net Library. It embeds and manages one ImageViewerControl with the following key functions: |
CImageViewerWpfControl | This class is available in the Smart Client and the .Net Library. Supported from Smart Client 2017 R3 It embeds and manages one ImageViewerWpfControl with the following key functions: |
CIndependentPlaybackModeEventArgs | Implements the class that contains the EventArgs for independent playback mode changed events |
CLiveStreamInformationEventArgs | The argument filled on the LiveStreamInformationEvent. |
CLiveStreamInformationReceivedEventArgs | The argument filled on the LiveStreamInformationReceived event. |
CLoginPlugin | A class specifying an Login plug-in. Login plugin are called during the smart client login process. It can choose to be called as part of the normal login flow of the smart client and/or after the normal login flow. In the latter case the plugin can define a user interface to be shown in the login dialog |
CLoginUserControl | Base class for the usercontrol returned by LoginPlugin.GenerateCustomLoginUserControl(). The user control is displayed in the Smart Client login dialog after the normal Smart Client login flow. Note that it is important that the usercontrols does not block the Smart Client UI thread and thus all work must be done on a separate thread |
CMapViewControlItem | Use this class to represent a map view item that should be part of the ViewControl |
COptionsDialogPlugin | This class is deprecated. Windows Forms controls are no longer supported. Use SettingsPanelPlugin instead. A class specifying an Application options plug-in. Each of the OptionsDialogPlugin’s will have a tab in the Application options of Settings panel with the Name defined. When the Name is selected, the CreateUserControl method is called to create the UserControl for this plug-in. The plug-in should initialize the UI as part of the class construction. The UserControl contains the entire right hand side of the panel, and will be resized to current available size. When the SaveChanges method is called, the plug-in can use the base method ‘SaveProperties’ to save the configuration, if all configuration fields are saved in the Property dictionary. |
COptionsDialogUserControl | This class is deprecated. Windows Forms controls are no longer supported. Use SettingsPanelPlugin instead. This UserControl is created by the PluginDefinition and placed on the Smart Client's options dialog when the user selects the options icon. The UserControl will be added to the owning parent UserControl and docking set to Fill |
CPassRequestEventArgs | |
►CPlaybackController | Build-in controller containing playback information and events, e.g. current play time, goto, prev, next etc |
CBrowseTimeInfo | Use by application to inform the PlaybackController about previous and next time stamps. The PlaybackController uses these to navigate when the device with this deviceId is selected, and a 'Next' or 'Previous' is requested (via UI or command) |
CPlaybackModeEventArgs | Implements the class that contains the event args for playback mode changed events |
CPlaybackSpeedEventArgs | Implements the class that contains the EventArgs for playback speed changed events |
CProgressChangedEventArgs | Is used when playback is in a loop. This EventArgs is fired to show how far the current loop is progressing. The Progress is between 0.0 and 1.0 |
CTimeEventArgs | Implements the class that contains the event args for various time related events |
CPlaybackControllerBase | The PlaybackControllerBase is used internally by the MIP Environment for controlling timing and commands around playback. It is identified by a FQID |
CPlaybackUserControl | This class is deprecated. Windows Forms controls are no longer supported. Use PlaybackWpfUserControl instead. A virtual class for actual usercontrols implemented in each environment. Current implementations exists for Smart Client, .Net Components and Management Client / Administrator |
CPlaybackUserControlMini | This class is deprecated. Windows Forms controls are no longer supported. Use PlaybackWpfUserControl instead and use PlaybackWpfUserControl.ShowTallUserControl to control the size. An implementation of the PlaybackUserControl |
CPlaybackWpfUserControl | Interaction logic for PlaybackWpfControl.xaml |
CPlaybackWpfUserControlInternal | Internal use only. Use PlaybackWpfUserControl instead |
CPropertiesUserControl | This class is deprecated. Windows Forms controls are no longer supported. Use PropertiesWpfUserControl instead. This UserControl contains the visible part of the Property panel during Setup mode. If no properties is required by this ViewItemPlugin, the GeneratePropertiesUserControl() method on the ViewItemManager can return a value of null. When changing properties the ViewItemManager should continuously be updated with the changes to ensure correct saving of the changes. As the user click on different ViewItem, the displayed property UserControl will be disposed, and a new one created for the newly selected ViewItem |
CPropertiesWpfUserControl | This UserControl contains the visible part of the Property panel during Setup mode. If no properties is required by this ViewItemPlugin, the GeneratePropertiesWpfUserControl() method on the ViewItemManager can return a value of null. When changing properties the ViewItemManager should continuously be updated with the changes to ensure correct saving of the changes. As the user click on different ViewItem, the displayed property UserControl will be disposed, and a new one created for the newly selected ViewItem |
CPropertiesWpfUserControlWinFormsWrapper | |
CPropertyClass | Abstract class incapsulating a key-value based property list. |
CRawSource | This class wraps RawVideoSource and RawLiveSource, handling buffering video, synchronizing with the given PlaybackController and ensuring a uniform return of frames whether live or playback |
CRecordedImageReceivedEventArgs | For each recorded image being displayed that argument is filled with the Image time, and passed to this class via the RecordedImageReceivedEvent |
CSettingsPanelPlugin | Represents a plug-in that can be integrated into the Settings panel. |
CShapesOverlayRenderParameters | Defines how WPF shapes is placed on top of video. Used by ImageViewerControl.ShapesOverlay methods |
CSidePanelPlaceDefinition | Defines a side panel placement. Used in SidePanelPlugin.SidePanelPlaceDefinitions |
CSidePanelPlugin | The SidePanelPlugin defines a plug-in that resides in the live or playback side panel in the Smart Client. Is it only created once during startup/login and never disposed |
CSidePanelUserControl | This class is deprecated. Windows Forms controls are no longer supported. Use SidePanelWpfUserControl instead. For new plugins it is recommended to implement SidePanelWpfUserControl instead. The UserControl to be displayed in a side panel in the Smart Client. Generated by a plug-ins SidePanelPlugin. The width of the SidePanel is approximately 280 pixels wide. It is suggested to set the Anchor for wide fields to Left, Top, Right. Please note that SidePanels are being created and disposed when the user navigates from one workspace to another, and the Init() and Close() methods will therefor be called many times during a Smart Client session. If your plugin need to perform CPU heavy operations during the Init() call, or get access to a remote server - consider to develop a BackgroundPlugin to maintain the remote session or any resources that may make sense to keep created. The height of this UserControl can be as large as you think makes sense. Consider setting the AutoScaleMode = None, as the height may not include all your inner Controls otherwise |
CSidePanelWpfUserControl | The WPF UserControl to be displayed in a side panel in the Smart Client. Generated by a plug-ins SidePanelPlugin. The width of the SidePanel is approximately 280 pixels wide. Please note that SidePanels are being created and disposed when the user navigates from one workspace to another, and the Init() and Close() methods will therefor be called many times during a Smart Client session. If your plugin need to perform CPU heavy operations during the Init() call, or get access to a remote server - consider to develop a BackgroundPlugin to maintain the remote session or any resources that may make sense to keep created. The height of this UserControl can be as large as you think makes sense |
CSidePanelWpfUserControlWinFormsWrapper | |
CTheme | Contains a set of Colors to describe the current selected Theme. The ThemeType can be used for further selecting matching icons or buttons. For simply applying these colors to your UserControl, use the ClientControl.Instance.RegisterUIControlForAutoTheming( userControl ), where the userControl should be the main part of your ViewItem. The titlebar can afterwards be updated depending on the selection state with the 4 properties starting with the letters 'ViewItem'. Notice that side panels, property panel and option configuration panels are automatically themed |
CTimeEventArgs | |
CTimelineDataArea | Class representing one interval to be marked on the timeline. If this is used with a TimelineSequenceSource of type TimelineSequenceSource.TimelineSequenceSourceType.Marker only the begin time of the interval is used |
CTimelineSequencesEventArgs | EventArgs class to be used with the TimelineSequenceSource.SequencesRetrieved event |
CTimelineSequenceSource | Implement derived class capable of delivering information about when data is available for a source and return instances in the TimelineSequenceSources property of the ViewItemManager |
CTimelineSourceQueryResult | Class for holding timeline data from a source for one interval |
CTimeLineUserControl | This class is deprecated. Windows Forms controls are no longer supported. Use PlaybackWpfUserControl instead. This call is intended for internal use together with the PlaybackUserControl implementations |
CToolbarPluginWpfUserControl | The WPF UserControl to be displayed when the user activates a toolbar plugin instance. |
CVideoControl | VideoControl is an easy to use UI component for showing a camera view in MIP plugin UI. The control creates a view of cameras having the same functionality as a normal view in the Smart Client. This means that features like live mode, playback mode, playback synchronization, camera selection, camera maximization, PTZ, independent playback, camera toolbar, timeline etc. is handled automatically by the control |
CViewAndLayoutItem | The ViewAndLayoutItem represent a specific view with all its content for a View in the Smart Client. This class is a ConfigItem, where child to be configured can be added and removed. The child in this context are individual View Items, either the built-in ones like Camera View Item or any of the ones provided in a MIP Plug-in. The FQID of this item can be used for some of the Messages, e.g. MultiWindowCommand with its MultiWindowCommandData.View field for selecting a view on a specific Window. For accessing the Groups, View groups and View Layouts, the ClientControl provides access through the methods GetViewGroupItems, GetSmartWallItems and CreateTemporaryGroupItem. |
CViewControl | ViewControl is an easy to use UI component for showing a collection of viewitems in a MIP plugin UI |
CViewControlItem | Base class for all ViewControlItems |
CViewControlItemArgs | Event argument for SelectedItemChanged |
CViewControlItemDataArgs | Event argument for ItemPropertiesChanged |
CViewGroup | The content of a ViewGroup: Data and Info |
CViewGroupData | The XML content of a ViewGroup |
CViewGroupInfo | Contains the header information for a Smart Client view group. |
CViewItemManager | The ViewItemManager contains the configuration for the ViewItem. When the class is initiated it will automatically recreate relevant ViewItem configuration saved in the properties collection from earlier. Also, when the ViewLayout is saved the ViewItemManager will supply current configuration to the SmartClient to be saved on the server. This class is only relevant when executing in the Smart Client |
CViewItemPlugin | Class defining one Smart Client ViewItem. The ViewItemPlugin is only constructed one time. For each ViewItem defined on any view layout, a call to GenerateViewItemManager is performed to create a ViewItemManager. This instance of the ViewItemManager is then responsible for the configuration in relation to one viewitem. The ViewItemManager will again generate ViewItemUserControl and PropertiesUserControl as appropriate for this viewitem. e.g. if a given ViewLayout is shown once, then only one ViewItemUserControl is generated, and only one PropertiesUserControl is generated when selected in setup mode. Now, if multiple floating windows are opened with SAME ViewLayout, and thereby same configuration of a ViewItem's, then multiple ViewItemUserControl's may be requested via the same ViewItemManager. The properties part of the class is used to build the tree node in the Smart Client |
CViewItemToolbarPlaceDefinition | Defines view item toolbar placement information. Used in ViewItemToolbarPlugin.ViewItemToolbarPlaceDefinition |
CViewItemToolbarPlugin | The ViewItemToolbarPlugin defines a plug-in that resides in the view item toolbar in the Smart Client |
CViewItemToolbarPluginInstance | Represents an actual view item toolbar plugin instance. An instance of this class will be created for each toolbar plugin that is added to the Smart Client UI |
CViewItemUserControl | This class is deprecated. Windows Forms controls are no longer supported. Use ViewItemWpfUserControl instead. The ViewItemUserControl is instantiated for every position it is created on the current visible view. When a user select another View or ViewLayout, this class will be disposed. No permanent settings can be saved in this class. The Init() method is called when the class is initiated and handle has been created for the UserControl. Please perform resource initialization in this method. If Message communication is performed, register the MessageReceivers during the Init() method and UnRegister the receivers during the Close() method. The Close() method can be used to Dispose resources in a controlled manor. Mouse events not used by this control, should be passed on to the Smart Client by issuing the following methods: FireClickEvent() for single click FireDoubleClickEvent() for double click The single click will be interpreted by the Smart Client as a selection of the item, and the double click will be interpreted to expand the current viewitem to fill the entire View |
CViewItemWpfUserControl | The ViewItemWpfUserControl is the WPF version of the ViewItemUserControl. It is instantiated for every position it is created on the current visible view. When a user select another View or ViewLayout, this class will be disposed. No permanent settings can be saved in this class. The Init() method is called when the class is initiated and handle has been created for the UserControl. Please perform resource initialization in this method. If Message communication is performed, register the MessageReceivers during the Init() method and UnRegister the receivers during the Close() method. The Close() method can be used to Dispose resources in a controlled manor. Mouse events not used by this control, should be passed on to the Smart Client by issuing the following methods: FireClickEvent() for single click FireDoubleClickEvent() for double click The single click will be interpreted by the Smart Client as a selection of the item, and the double click will be interpreted to expand the current viewitem to fill the entire View |
CViewItemWpfUserControlWinFormsWrapper | |
CViewLayout | The Layout represent a specific Smart Client view layout without content. This class is provided by the PluginDefinition |
CWindowInformation | This class provide information of the currently executing window. It is accessed from the ViewItemUserControl.WindowInformation |
CWorkSpaceNotification | Class defining a works space notification |
CWorkSpacePlugin | The abstract base class a MIP plugin can implement for having a WorkSpace tab available in the Smart Client |
CWorkSpaceToolbarPlaceDefinition | Defines work space toolbar placement information. Used in WorkSpaceToolbarPlugin.WorkSpaceToolbarPlaceDefinition |
CWorkSpaceToolbarPlugin | The WorkSpaceToolbarPlugin defines a plug-in that resides in the work space toolbar in the Smart Client |
CWorkSpaceToolbarPluginGroup | Represents a workspace toolbar plug-in group. Used for grouping workspace toolbar plug-ins. If there are no plug-ins or sub groups under a group, then the group won't be shown |
CWorkSpaceToolbarPluginInstance | Represents an actual work space toolbar plug-in instance. An instance of this class will be created for each toolbar plug-in that is added to the Smart Client UI |
►NConfigurationItems | |
CAccessControlSystem | |
CAccessControlSystemFolder | |
CAccessControlUnit | |
CAccessControlUnitFolder | |
CActivateLicenseServerTask | Activate License |
CAddAlarmDefinitionServerTask | Add alarm definition |
CAddAnalyticsEventServerTask | Add analytics event |
CAddAppointmentServerTask | Add appointment |
CAddArchiveStorageServerTask | Add archive |
CAddBasicOwnerInfoServerTask | Add basic owner information |
CAddBasicUserServerTask | Add new basic user |
CAddClientProfileServerTask | Add client profile |
CAddDetectedDeviceCredentialServerTask | Add new credentials to the auto-detect configuration |
CAddDeviceGroupMemberServerTask | Add device |
CAddDeviceGroupServerTask | Create new group |
CAddEvidenceLockProfileServerTask | Add evidence lock profile |
CAddFailoverGroupServerTask | Add failover group |
CAddGenericEventDataSourceServerTask | Add generic event data source |
CAddGenericEventServerTask | Add generic event |
CAddGisMapLocationServerTask | Add GIS map location |
CAddHardwareServerTask | Add new hardware |
CAddLayoutServerTask | Add layout |
CAddLoginProviderServerTask | Add external IDP |
CAddMailNotificationProfileServerTask | Add mail notification profile |
CAddMatrixServerTask | Add Matrix |
CAddMIPItemServerTask | Add MIPItem task |
CAddMonitorServerTask | Add new monitor |
CAddPatrollingEntryServerTask | Add patrolling entry |
CAddPatrollingProfileServerTask | Add patrolling profile |
CAddPtzPresetServerTask | Add PTZ preset |
CAddRecurringAppointmentServerTask | Add recurring appointment |
CAddRegisteredClaimServerTask | Add registered claim |
CAddRoleClaimServerTask | Add role claim |
CAddRoleMemberServerTask | Add new user or group to role |
CAddRoleServerTask | Add new role |
CAddSaveSearchServerTask | Server task for adding a search |
CAddStateGroupServerTask | Add state group |
CAddStorageServerTask | Add storage |
CAddTimeProfileServerTask | Add time profile |
CAddUserDefinedEventServerTask | Add user-defined event |
CAddVideoWallPresetServerTask | Add video wall preset |
CAddVideoWallServerTask | Add new video wall |
CAddViewGroupServerTask | Add new View Group |
CAddViewServerTask | Add View |
CAlarmDefinition | |
CAlarmDefinitionFolder | |
CAnalyticsEvent | |
CAnalyticsEventFolder | |
CApplyCamerasAndLayoutServerTask | Apply cameras and layout |
CApplyCamerasServerTask | Apply cameras |
CApplyLayoutServerTask | Apply layout |
CApplyMonitorStateServerTask | Apply monitor state |
CApplyTextAndLayoutServerTask | Apply text and layout |
CApplyViewItemsXmlServerTask | Apply view items XML |
CArchiveScheduleChildItem | |
CArchiveStorage | |
CArchiveStorageFolder | |
CAutoDetectConfiguration | |
CAutoDetectConfigurationFolder | |
CBasicOwnerInformation | |
CBasicOwnerInformationFolder | |
CBasicUser | |
CBasicUserFolder | |
CCamera | |
CCameraFolder | |
CCameraGroup | |
CCameraGroupFolder | |
CChangeDeviceRecordingStorageServerTask | Change storage for device |
CChangeEncryptionMethodServerTask | Change encryption method |
CChangeLicenseServerTask | Change to a new license |
CChangeOverallSecurityPermissionsServerTask | Edit overall security permissions |
CChangePasswordBasicUserServerTask | Change basic user password |
CChangePasswordHardwareServerTask | Change hardware password |
CChangePasswordStorageEncryptionServerTask | Change encryption password for recording storage |
CChangeSecurityPermissionsServerTask | Edit permissions |
CChildTaskDetail | Class for accessing the details of a task result |
CClaimChildItem | |
CClaimFolder | |
CClassCollectionServerTask | A serverTask (result) that also Contains a collection of classes, as a result of the executed task on the server |
CClientLogOnSupportedServerTask | Client application login supported |
CClientProfile | |
CClientProfileAccessControlChildItem | |
CClientProfileAdvancedChildItem | |
CClientProfileAlarmManagerChildItem | |
CClientProfileExportChildItem | |
CClientProfileFolder | |
CClientProfileGeneralChildItem | |
CClientProfileGisMapChildItem | |
CClientProfileLiveChildItem | |
CClientProfilePlaybackChildItem | |
CClientProfileSetupChildItem | |
CClientProfileTimelineChildItem | |
CClientProfileViewLayoutsChildItem | |
CClientSettings | |
CClientSettingsFolder | |
CCompressor | |
CCompressorFolder | |
CConfigurationApiProperties | Contains the properties provided by a ConfigurationItem |
CConfigurationService | Class used to call methods on the ConfigurationAPI |
CCopyRoleServerTask | Copy role |
CCreateDirectoryOnRecorderServerTask | Create directory on recorder |
CCustomProperties | |
CCustomPropertiesFolder | |
CCustomSettingGlobal | |
CCustomSettingUser | |
CDefaultPtzPresetServerTask | Set default PTZ preset |
CDeleteHardwareServerTask | Delete hardware |
CDetectedDeviceCredentials | |
CDetectedDeviceCredentialsFolder | |
CDeviceDriverSettings | |
CDeviceDriverSettingsChildItem | |
CDeviceDriverSettingsFolder | |
CDisableEncryptionServerTask | Disable encryption on recording storage |
CEnableEncryptionServerTask | Enable encryption on recording storage |
CEventType | |
CEventTypeFolder | |
CEventTypeGroup | |
CEventTypeGroupFolder | |
CEvidenceLockProfile | |
CEvidenceLockProfileFolder | |
CFactory | Contains a set of methods for creating paths and conversions |
CFailoverGroup | |
CFailoverGroupFolder | |
CFailoverRecorder | |
CFailoverRecorderFolder | |
CFindSaveSearches | A find save search configuration item |
CFindSaveSearchesServerTask | Server tasks for finding save searches based on filters |
CFisheyeLens | |
CFisheyeLensFolder | |
CGenericEvent | |
CGenericEventDataSource | |
CGenericEventDataSourceFolder | |
CGenericEventFolder | |
CGetDevicePresetsServerTask | Get presets from camera |
CGetInternalUnitPathServerTask | Get internal unit path |
CGetSaveSearchServerTask | Server task for getting a search |
CGisMapLocation | |
CGisMapLocationFolder | |
CHardware | |
CHardwareDeviceEvent | |
CHardwareDeviceEventChildItem | |
CHardwareDeviceEventFolder | |
CHardwareDriver | |
CHardwareDriverFolder | |
CHardwareDriverSettings | |
CHardwareDriverSettingsChildItem | |
CHardwareDriverSettingsFolder | |
CHardwareFolder | |
CHardwarePtzDeviceSettingChildItem | |
CHardwarePtzSettings | |
CHardwarePtzSettingsFolder | |
CHardwareScanExpressServerTask | Detect hardware |
CHardwareScanServerTask | Detect hardware driver |
CIConfigurationChildItem | Contains fields relevant for a ConfiguratonItem with category = "ChildItem" |
CIConfigurationItem | Contains a wrapped instance of a ConfigurationItem |
CIMIPItem | Interface for the MIPItem typed Configuration API |
CInputEvent | |
CInputEventFolder | |
CInputEventGroup | |
CInputEventGroupFolder | |
CLayout | |
CLayoutFolder | |
CLayoutGroup | |
CLayoutGroupFolder | |
CLicenseDetailChildItem | |
CLicenseDetailFolder | |
CLicenseFeatureChildItem | |
CLicenseInformation | |
CLicenseInformationFolder | |
CLicenseInstalledProductChildItem | |
CLicenseInstalledProductFolder | |
CLicenseOverviewAllChildItem | |
CLicenseOverviewAllFolder | |
CLoginProvider | |
CLoginProviderFolder | |
CLprMatchList | |
CLprMatchListFolder | |
CMailNotificationProfile | |
CMailNotificationProfileFolder | |
CManagementServer | |
CMatrix | |
CMatrixCommandServerTask | Matrix command |
CMatrixFolder | |
CMetadata | |
CMetadataFolder | |
CMetadataGroup | |
CMetadataGroupFolder | |
CMethodIdAddLprMatchListServerTask | Add LPR match list |
CMethodIdAddOrEditRegistrationNumbersInfoServerTask | Add or edit data for registration numbers |
CMethodIdDeleteRegistrationNumbersServerTask | Delete registration numbers |
CMethodIdGetCustomFieldsForRegistrationNumberResult | The strongly typed result for LprMatchList.MethodIdGetCustomFieldsForRegistrationNumberWithResult(string) |
CMethodIdGetCustomFieldsForRegistrationNumberServerTask | Get custom fields |
CMethodIdGetRegistrationNumbersInfoResult | The strongly typed result for LprMatchList.MethodIdGetRegistrationNumbersInfoWithResult |
CMethodIdRemoveLprMatchListServerTask | Remove LPR match list |
CMicrophone | |
CMicrophoneFolder | |
CMicrophoneGroup | |
CMicrophoneGroupFolder | |
CMIPItem | |
CMIPItemFolder | |
CMIPKind | |
CMIPKindFolder | |
CMIPOptionProperties | Contains settings used on the Management Clients option menu |
CMonitor | |
CMonitorFolder | |
CMonitorPreset | |
CMonitorPresetFolder | |
CMotionDetection | |
CMotionDetectionFolder | |
CMoveArchiveStorageServerTask | Move archive |
CMoveFailoverGroupServerTask | Move failover server |
CMoveHardwareServerTask | Move hardware |
CMoveRecordingStorageServerTask | Move storage |
COutput | |
COutputFolder | |
COutputGroup | |
COutputGroupFolder | |
CPatrollingEntryChildItem | |
CPatrollingProfile | |
CPatrollingProfileFolder | |
CPrivacyMask | |
CPrivacyMaskFolder | |
CPrivacyProtection | |
CPrivacyProtectionFolder | |
CPTZChildItem | |
CPtzPreset | |
CPtzPresetFolder | |
CPTZSessionTimeoutChildItem | |
CQueryUsersWithAccessServerTask | Query users with access to given object |
CReadDirectoriesOnRecorderServerTask | Read directories on recorder |
CRecordingServer | |
CRecordingServerFailover | |
CRecordingServerFailoverFolder | |
CRecordingServerFolder | |
CRecordingServerMulticast | |
CRecordingServerMulticastFolder | |
CRegisteredClaim | |
CRegisteredClaimFolder | |
CRemoveAlarmDefinitionServerTask | Remove alarm definition |
CRemoveAnalyticsEventServerTask | Remove analytics event |
CRemoveAppointmentServerTask | Remove appointment |
CRemoveArchiveStorageServerTask | Remove archive |
CRemoveBasicOwnerInfoServerTask | Remove basic owner tag |
CRemoveBasicUserServerTask | Remove basic user |
CRemoveCamerasServerTask | Remove cameras |
CRemoveClientProfileServerTask | Remove client profile |
CRemoveDetectedDeviceCredentialServerTask | Remove the selected credential from the auto-detect configuration |
CRemoveDeviceGroupMemberServerTask | Remove device |
CRemoveDeviceGroupServerTask | Delete group |
CRemoveEvidenceLockProfileServerTask | Remove evidence lock profile |
CRemoveFailoverGroupServerTask | Remove failover group |
CRemoveGenericEventDataSourceServerTask | Remove generic event data source |
CRemoveGenericEventServerTask | Remove generic event |
CRemoveGisMapLocationServerTask | Remove GIS map location |
CRemoveLayoutServerTask | Remove layout |
CRemoveLoginProviderServerTask | Remove external IDP |
CRemoveMailNotificationProfileServerTask | Remove mail notification profile |
CRemoveMatrixServerTask | Remove Matrix |
CRemoveMIPItemServerTask | Remove MIPItem |
CRemoveMonitorServerTask | Remove monitor |
CRemovePatrollingEntryServerTask | Remove patrolling entry |
CRemovePatrollingProfileServerTask | Remove patrolling profile |
CRemovePtzPresetServerTask | Remove PTZ preset |
CRemoveRecordingServerServerTask | Remove recording server |
CRemoveRecurringAppointmentServerTask | Remove recurring appointment |
CRemoveRegisteredClaimServerTask | Remove registered claim |
CRemoveRoleClaimServerTask | Remove role claim |
CRemoveRoleMemberServerTask | Remove role member |
CRemoveRoleServerTask | Remove role |
CRemoveStateGroupServerTask | Remove state group |
CRemoveStorageServerTask | Remove storage |
CRemoveStreamServerTask | Remove stream |
CRemoveTimeProfileServerTask | Remove time profile |
CRemoveUserDefinedEventServerTask | Remove user-defined event |
CRemoveVideoWallPresetServerTask | Remove video wall preset |
CRemoveVideoWallServerTask | Remove video wall |
CRemoveViewGroupServerTask | Remove a View Group |
CRemoveViewServerTask | Remove View |
CReplaceHardwareServerTask | Replace hardware |
CRetrieveEdgeStorageServerTask | Retrieve recordings from edge storage |
CRole | |
CRoleFolder | |
CSaveSearches | A single saved search |
CSaveSearchesFolder | A overall folder where all save searches methods are present |
CServerTask | Represent a task that is running on the server |
CServerTaskResult | Abstract wrapper for the ServerTask, allowing to init strongly typed properties for the result |
CSetClientProfileServerTask | Set client profile on role |
CSetClientTimeProfileServerTask | Set client login time profile |
CSetFramerateReductionArchiveStorageServerTask | Enable/disable frame rate reduction on archive |
CSite | |
CSiteAddressChildItem | |
CSiteAddressFolder | |
CSiteFolder | |
CSpeaker | |
CSpeakerFolder | |
CSpeakerGroup | |
CSpeakerGroupFolder | |
CStateGroup | |
CStateGroupFolder | |
CStorage | |
CStorageFolder | |
CStorageInformation | |
CStreamChildItem | |
CStreamDefinition | |
CStreamFolder | |
CStreamUsageChildItem | |
CSystemAddressChildItem | |
CSystemAddressFolder | |
CTaskDetail | 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 |
CTimeProfile | |
CTimeProfileAppointmentRecurChildItem | |
CTimeProfileAppointmentRootChildItem | |
CTimeProfileFolder | |
CToolOptionAviGeneration | |
CToolOptionBookmark | |
CToolOptionCustomerDashbord | |
CToolOptionFolder | |
CToolOptionMailServer | |
CToolOptionNetwork | |
CToolOptionPrivacySetting | |
CToolOptionRecordingServer | |
CToolOptionServerLog | |
CTruncateStorageOnOtherRecordingServerServerTask | Delete all recordings for device on another recording server |
CUpdateFirmwareHardwareServerTask | Update firmware |
CUpdateHardwareDetail | Contains the details for each device/item on the hardware, about what has changed |
CUpdateHardwareServerTask | Contains the result from a Hardware.UpdateHardware() call |
CUpdateLicenseServerTask | Update license |
CUpdateSaveSearchServerTask | Server task for updating a search |
CUploadFileChunkServerTask | Upload file chunk |
CUser | |
CUserDefinedEvent | |
CUserDefinedEventFolder | |
CUserFolder | |
CValidateStorageEncryptionPasswordServerTask | Validate encryption password on recording storage |
CValueTypeInformation | This class assist in defining what values are valid for a given property |
CVideoWall | |
CVideoWallFolder | |
CVideoWallPreset | |
CVideoWallPresetFolder | |
CView | |
CViewFolder | |
CViewGroup | |
CViewGroupFolder | |
CViewItemChildItem | |
►NData | |
►NHardwareDeviceDefinitions | |
CDeviceDefinition | Base class responsible for describing the parameters for a single device |
CMicrophoneDeviceDefinition | This class is responsible for describing the parameters for a single microphone device |
CPcmMicrophoneDeviceDefinition | This class is responsible for describing the parameters for a single microphone device (when using PCM format) |
►NMediaDataHelpers | |
CAudioMediaDataQueue | Class implementing PCM audio buffers queue and transforming push of byte[] to pull of MediaData |
CAudioRecorderToMediaData | Class providing data conversion from IAudioRecorder to MediaData |
CMediaDataQueue | Class implementing media data buffers queue |
CMediaDataQueueException | Generic exception for AudioMediaDataQueue class |
CMediaDataQueueOverflowException | Exception in AudioMediaDataQueue class which occurs on buffer overflow |
CAccessControlEvent | The AccessControlEvent class is used for events generated with access control plugins |
CAlarm | The representation of a Milestone alarm |
CAlarmUpdateKey | This class specifies the available keys when doing an alarm update |
CAlertConverter | Allows for conversion from legacy MAD format to MAD format version 2.5 |
CAlertData | This is simply a reference to the EventData structure, that is used to return the result |
CAlertDataSource | Alerts are no longer supported |
CAnalyticsEvent | An implementation of the BaseEvent with more relevant information when an Analytics oriented event has occurred |
CAnalyticsObject | The representation of an analytics object |
CAnalyticsObjectList | A list of analytics objects |
CAsyncResultEventArgs | The result of a Async operation |
CAudioStreamPlayer | Streams PCM data from an input stream to the OutgoingSpeakerController |
CAVIExporter | This class will use environment specific implementation to export either one video stream with zero or more audio streams, or multiple video streams, to an AVI file |
CBaseEvent | The BaseEvent, containing information common for all Milestone events. Notice that several overriden classes exists that may be more useful in a given situation, e.g. AnalyticsEvent or EventData |
CBitmapData | Contains the Bitmap information |
CBitmapDataResult | The result type received when using the ThumbnailQueue to fetch a thumbnail. The type has properties to indicate if an error occurred, and the actual data (if no error occurred) |
CBitmapVideoSource | BitmapVideoSource gets video image formatted as Bitmaps. This class is NOT thread safe, and all calls to these methods MUST be coming from same thread. When getting images from the server, it should be considered that the Get() method can take some time and is not ideal to execute on a UI thread. Only supported in Smart Client and standalone environments |
CBookmark | The Bookmark class represents a bookmark instance |
CBookmarkReference | The result of getting a new bookmark reference. This class is returned as a result for the BookmarkGetNewReference method |
►CBookmarkService | Provides access to the bookmark service of the ServerCommandService. Note that this service is only available on the high-end XProtect Corporate products. For the products where it is not supported, each method entry is ignored and a single message is logged in the MIP log. The methods of this service is invoked through the singleton reference 'Instance'. E.g. A new bookmark may be created using the statement: Bookmark bookmark1 = BookmarkService.Instance.BookmarkCreate(cameraFqid, timeBegin, timeTrigger, timeEnd, reference, header, description); The 'Bookmark' class contains all the information related to the new bookmark, especially the BookmarkFQID property, which holds the unique identification of the new bookmark. Existing bookmarks may be queried by BookmarkSearchTime or BookmarkSearchFromBookmark. BookmarkSearchTime searches for bookmarks within a specific time interval. BookmarkSearchFromBookmark begins the search from the time right after a specific existing bookmark. The search may take several seconds. Therefore it may be relevant to use the asynchronous equivalents BookmarkSearchTimeAsync and BookmarkSearchFromBookmarkAsync in stead. A known bookmark may be quieried by means of the BookmarkGet method |
CBookmarkSearchCompletedEventArgs | Carries the result of an asynchronous search request. The 'Result' property contains the result. The 'AsyncState' property provides the asyncstate argument provided with the call of the async request. The 'Exception' property contains exception information if one has occured The 'Cancelled' property returns true if the async request was cancelled |
CBoundingBox | The representation of a bounding box, describing a rectangle in normalized coordinates within the scene |
CCameraDeviceDefinition | This class is responsible for describing the parameters for a single camera device |
CDataCapability | This class is responsible for describing the parameters for a data capability, which takes integer values |
CDataSource | An abstract class to be used for implementation of a DataSource. Within the MIP Environment there are currently these built-in implementations: AlertDataSource - to get access to video alerts SequenceDataSource - to get access to recorded video related sequence information StreamDataSource - to get the configured streams on a camera MetadataSource - to get the configured metadata stream information on a metadata item If a plug-in can provide list of data related to a specific Item, implementation of this class can be used. Construction can be performed in two ways: Call the GetDataSource() on the owning Item Construct the correct class based on the Item at hand |
►CDataType | Represents a type of Data being provided by a DataSource |
CJPEGTypeGuids | Reserved for future use |
CSequenceTypeGuids | Build-in DataType Ids for camera Items |
CTimeLineInformationTypeGuids | |
CDBExporter | Class to perform a database export from a VMS server to a local disk |
►CDirectSpeakerController | The DirectSpeakerController sends an audio stream directly to an outgoing speaker. The audio data is transported "as is", without adjusting parameters like |
CActiveOutgoingSpeakersChangedEventArgs | Implements the class that contains the event args for the ActiveOutgoingSpeakersChangedEventArgs |
COutgoingAudioTransmitLockEventArgs | Implements the class that contains the event args for the GetOutgoingAudioTransmitLockEventArgs |
CDirectSpeakerControllerExt | Extension to DirectSpeakerController The DirectSpeakerControllerExt sends an audio stream directly to an outgoing speaker. The audio data is transported "as is", without adjusting parameters. Added error code and device id properties |
CEnumCapability | This class is responsible for describing the parameters for an enum capability, which can only take discrete predefined values |
CEnumCapabilityValue | This class is responsible for describing one of the allowed values for an enum capability. Each value is selectable in the drop-down list for the enum capability |
CEventData | The EventData contains a complete set of information for a specific event. It is used for some DataSources as well as for EventServer integration |
CEventGroup | This class is used to group EventTypes |
CEventHeader | The representation of an event header containing information common for all Milestone events. When using this class for creation of events or alarms, please be aware that Message is to be considered the type of the event/alarm and thus should not be unique for each event/alarm, but rather common between all events/alarms of the same type. |
CEventHeaderTypes | Contains the built-in types used in the EventHeader.Type on the BaseEvent class. Partners are welcome to use their own types. These types can be used to filter message reception of type level, instead of receiving all messages, when using the MessageCommunication classes. VideoOS.Platform.Messaging.CommunicationIdFilter constructor for more on usage |
CEventSequence | Contain image and video reference |
CEventSource | The source of the event. This can represent e.g. a camera, a microphone, a user-defined event, etc |
CEventType | This class is used to define Event Types which an VideoOS.Platform.Admin.ItemManager can deliver to the Event Server using the method GetKnownEventTypes(CultureInfo culture). Event Types are used in defining the events, which can trigger alarms |
CFaultDevice | Error state of processed marked data |
CFreeFormBaseEvent | The FreeFormBaseEvent is used to store events with arbitrary JSON data. FreeFormBaseEvent is for internal use only. Do not use |
CGenericData | Contains the Generic Data as bytes |
CGenericVideoSource | BaseVideoSource in abstract class for video and audio sources |
CHardwareDefinition | This class represents a piece of hardware that can added to a runnig system using the MIP driver |
►CIAudioRecorder | This class is a base class for audio recorder implementations. In the .Net Library there is one implementation, for recording audio from a PC attached microphone |
CAudioDataEventArgs | Implements the class that contains the event arguments for the AudioDataEventArgs |
CICancelableRequest | Defines a cancelable thumbnail queue request |
CIDirectSpeakerController | Interface of DirectSpeakerController sends an audio stream directly to an outgoing speaker |
CIDirectSpeakerControllerExt | |
CIExporter | The common interface used by DBExporter and AVIExporter |
CIInternalCommandServiceImplementer | Interface for communication with InternalCommandService. Used by instances of BaseVideoSource |
CIPcmAudioData | Contains the specific data for audio data |
CItemRequestQueue | Queue that is used to make multiple item related server requests in a controlled manor. Using this queue in the right way will throttle the server requests to ensure that resources are not exhausted. Currently item of type camera, microphone, speaker metadata is supported |
CIThumbnailQueueDiagnostics | Diagnostics for the ThumbnailQueue providing a snapshot of the current state of the queue |
CJPEGData | Contains the JPEG as bytes |
CJPEGVideoSource | JPEGVideoSource gets recorded video image formatted as JPEGs. Please note that all calls to the methods in this class MUST be coming from the same thread! When getting images from the server, it should be considered that the Get() method can take some time and is not ideal to execute on a UI thread. Only supported in Smart Client and standalone environments |
CMediaData | Contains one piece of media information. For video it will be one frame, for audio it will be for a short period |
CMediaProviderChannel | This MediaProvider provides an interface for sending video frames to a Milestone XProtect Recording Server. The specific MIPMediaProvider driver has to be configured to point at this executing application and port, as defined in this class. |
CMediaProviderService | The MediaProviderService will open for TCP socket and listen for connections. New MediaProvider's need to be created for each channel that will be available for video later on |
CMediaProviderSession | Contains the properties that a given session is using. When used on the initial SessionOpening method, it will contain the values as requested by the server side. The application can then modify the values to what is relevant for the given application and session. This class is created by the MediaProviderService when a new HTTP request has been received that want to receive a new stream. Note that multiple MediaProviderSession classes can exist on the same MediaProvider when multiple servers are connecting to the same channel |
CMetadataDeviceCapability | This class is responsible for describing a capability for a metadata device. A capability describes a single setting that will appear on the settings tab for the device |
CMetadataDeviceDefintion | This class is responsible for describing the parameters used by a single metadata device on a piece of hardware |
CMetadataHardwareDefinition | This class represents the overall |
CMetadataPlaybackData | This class is responsible for containing the information about a single "frame" of recorded metadata |
CMetadataPlaybackSource | MetadataPlaybackSource gets metadata in raw mode. This means that the Generic Byte Header as well as the content is available. When getting metadata from the server, it should be considered that the Get() method can take some time and is not ideal to execute on a UI thread. Only supported in Smart Client and standalone environments |
CMetadataProviderChannel | This MetadataProviderChannel provides an interface for sending metadata to a Milestone XProtect Recording Server |
CMetadataQueue | Metadata queue (singleton) used for fetching metadata XML in a controlled and optimized manner. Queue characteristics can be controlled in the app.config of the client application, otherwise default values are used. The following app settings can be configured in the app.config file to control the queue: |
CMetadataQueueResult | The result type received when using the MetadataQueue to fetch a metadata. The type has properties to indicate if an error occurred, and the actual data (if no error occurred) |
CMetadataSource | This class is responsible for giving information about the data in a metadata device. Specifically, it allows a client to retrieve information about the types of metadata that the device can deliver |
CMetadataSupplier | This class automatically provides metadata when available, both in live and playback |
CMetadataSupplierErrorEventArgs | Instances of this class will be returned when MetadataSupplier.ErrorEvent is triggered |
CMetadataSupplierEventArgs | Instances of this class will be included when MetadataSupplier.NewMetadataEvent is triggered |
CMetadataSupplierMetadataInvalidatedEventArgs | Instances of this class will be returned when MetadataSupplier.MetadataInvalidatedEvent is triggered |
CMetadataTypeDefinition | This class is responsible for handling the parameters that define the type of metadata a metadata device delivers when using the MIP driver. The display name (or its translation) will be used as the headline on the settings tab for the device in the Management Client. All capabilities in this type will then appear as children in the setting tab |
CMKVExporter | This class will use Environment specific implementation to export one video stream and zero or multiple audio streams to an MKV file (Matroska) |
CObjectMotion | The representation of an objects tracked motion through the scene |
►COutgoingSpeakerController | The OutgoingSpeakerController sends an audio stream to a speaker. The audio stream can come from a pc-microphone or a file |
COutgoingAudioMeterEventArgs | Implements the class that contains the event args for the OutgoingAudioMeterEventArgs |
CPcmAudioData | PCM data |
CPcmAudioDataList | List of PCM audio datas |
CPcmAudioSource | Class providing Pcm audio data for playback When getting audio from the server, it should be considered that the Get() method can take some time and is not ideal to execute on a UI thread |
CPointList | A list of points |
CPolygonList | A list of polygons |
CProperty | The Property class is used for events generated with access control plugins. The AccessControlEvent class references this class |
CRawVideoSource | RawVideoSource gets video image in raw mode, e.g. GenericByteHeaders with encoded content. When getting images from the server, it should be considered that the Get() method can take some time and is not ideal to execute on a UI thread. Note: Is only implemented in the Smart Client and in the MIP SDK for component integration. |
CRawVideoSourceData | Contains the raw GenericByteData content, used by RawVideoSource during playback of raw frames |
CRawVideoSourceDataList | Contains a list of raw GenericByteData content, used by RawVideoSource during playback of raw frames |
CReference | The representation of a reference to another entity in the system - e.g. another alarm or device |
CReferenceList | A list of references |
CRestrictedMedia | The RestrictedMedia class represents a restricted media instance |
CRestrictedMediaLive | This RestrictedMediaLive class represents a restricted media live instance |
CRestrictedMediaLiveResult | Result of processed restricted media live |
CRestrictedMediaResult | Result of processed restricted media |
CRestrictedMediaService | |
CRule | The representation of a rule, which triggered the event |
CRuleList | A list of rules |
CSequenceAviExportElement | Class for defining each element of an AVI sequence export |
CSequenceData | Contains the actual sequence data for one sequence, e.g. start and end DateTime |
CSequenceDataSource | The SequenceDataSource can assist with getting sequence information for a camera or metadata device. The GetData methods returns a list of SequenceData containing the DateTime information for the type of sequence requested. The GetTypes() method will return the possible and supported types for this class. E.g. the DataType.SequenceTypeGuids.RecordingSequence for Recorded sequences. |
CSmartClientProfileSetting | Data class for a Smart Client Profile setting |
CSnapshot | The representation of a snapshot associated with the event with time offset relative to the event timestamp |
CSnapshotList | A list of snapshots |
CSourceDataOnBitmapDataProxy | Proxy between ISourceData and BitmapData |
CSourceDataOnJpegDataProxy | Proxy between ISourceData and JPEGData |
CSourceDataOnRawDataProxy | Proxy between ISourceData and RawVideoSourceData |
CStateGroup | This class is used to define a state group, referenced by EventType |
CStreamDataSource | The StreamDataSource provides information of what streams are available on a given Item. This data source is only valid for camera items (Kind.Camera) when running in the .Net Library Environment. (Version MIPSDK 3.6 or later) |
CTColor | The representation of an ARGB color |
CThumbnailQueue | Thumbnail queue (singleton) used for fetching thumbnail images from cameras in a controlled and optimized manner. Queue characteristics can be controlled in the app.config of the client application, otherwise default values are used. The following app settings can be configured in the app.config file to control the queue: |
CTPoint | The representation of a point described by a set of normalized coordinates |
CTPolygon | The representation of a polygon describing a set of normalized coordiantes and color |
CVendor | Information about the analytics vendor including any custom data |
CVideoSource | Gives access to recorded video |
CVideoSourceDataOnBitmapDataProxy | Proxy between IVideoSourceData and BitmapData |
CVideoSourceDataOnJpegDataProxy | Proxy between ISourceData and JPEGData |
CWarningDevice | Warning state of processed restricted media |
CWAVExporter | This class will use environment specific implementation to export one or mixture of multiple audio streams to an WAV file. You can do sound mixing with combination of speaker output and microphone input for instance. To export multiple audio streams, you need to set the AudioList property then call the StartExport(DateTime, DateTime) method |
►NEventsAndState | |
CEventsAndStateSession | Provides access to the Events and State |
CEventTypes | Specifies a collection of event type ID's or Any (representing any event type) to be used in a SubscriptionRule |
CIEventReceiver | EventReceiver Implement this interface to be able to receive events and state. |
CIEventsAndStateSession | Get events and state from the VMS |
CInternalSpecifier | Specifies either a collection of ids or a match for any ID |
CResourceTypes | Specifies a collection of resource type ID's or Any (representing any resource type) to be used in a SubscriptionRule |
CSourceIds | Specifies a collection of source ID's or Any (representing any source ID) to be used in a SubscriptionRule |
CSubscriptionRule | Specifier for a subscription |
►NEventsData | |
CAccessControlData | Data of an access control event |
CAnalyticsBoundingBox | The representation of a bounding box, describing a rectangle in normalized coordinates within the scene |
CAnalyticsColor | The representation of an ARGB color |
CAnalyticsData | Data of an analytics event or alarm (including the snapshots) |
CAnalyticsDataWithoutSnapshots | Data of an analytics event |
CAnalyticsMotion | The representation of an object's tracked motion through the scene |
CAnalyticsObject | Represents an analytics object |
CAnalyticsPoint | The representation of a point described by a set of normalized coordinates |
CAnalyticsPolygon | The representation of a polygon describing a set of normalized coordinates and color |
CAnalyticsRule | The representation of the rule, which triggered the event |
CAnalyticsSnapshot | The representation of a snapshot associated with the event with time offset relative to the event timestamp |
CAnalyticsVendor | Information about the analytics vendor including any custom data |
CChangedEventDataActions | Possible values of the IEventChangedData<T>.Action |
CMipItemPositionChangedEventData | The data of a MIP Item Position Changed free-form event in the RESTful Events API |
CMipItemPositionChangedEventDataPositionInfo | Defines the position |
CSmartWallChangedEventDataRelatedItem | A configuration item that is affected |
CSmartWallEventChangedData | Data included in the Data field for VideoWallChanged event |
CSystemConfigurationChangedEventData | The data of a System Configuration Changed free-form event in the RESTful Events API |
CSystemConfigurationChangedEventDataRelatedItem | A configuration item that is affected |
►NJsonHandling | |
CBooleanElement | Contains one json element of boolean type |
CDoubleElement | Contains one json element with a double value |
CElementList | ElementList is a class used to contain the json elements sent in Post, Put and Patch messages. These values will later be used to update the values of items stored in the database |
CIElement | Interface used to describe one json element. Specific classes for each json formatted type implements this interface |
CIntElement | Contains one json element of integer type |
CJsonBuilder | A class for basic Json handling. This class handles construction of json objects in string format |
CJsonObject | Handling JSON formated fields. This class constructior will use the JsonReader to pass the json string and construct IElement objects of all sub fields |
CJsonReader | Converts JSON string into an ElementList |
CJsonUtilities | Class for assisting in handling Json strings |
CNullElement | Element that only contains a null value - could be related to both an Int or a String |
CStringElement | Contains one json element of string type, the string is enclused in double quotes, and need to be json escaped for special characters |
CToken | Contains a single json token with field name, the value in either Text or BoolValue |
CTokenException | Exception throws when the json parser finds an invalid token |
►NLicense | |
CConcurrentLicenseManager | NOTE: This class has been discontinued and should no longer be used |
CConcurrentLicenseUsed | |
CCryptoHelper | Can encrypt and decrypt data |
CILicenseService | For internal use only |
CLicenseInformation | This class is used for both license requests and license responses. It contains the information flowing from a plugin to and from the license server. |
CLicenseItem | Contains information for one single reserved licensed item. This class can be used to ear-mark the specific items to have a valid license, or are in trial mode. The items that are added above the licensed max and therefore are extra items in trial mode. The plug-in will decided how may items can be added above the licensed count, and for how long they can be in this mode before an activation is required. |
CLicenseManager | The LicenseManager assist the plugins in managing licenses for a plugin or stand alone application. |
CLicenseResponse | This class is used for license responses and inherits LicenseInformation. When a license response it obtained as a LicenseInformation, it can be cast to a an instance of this class to access additional license response properties |
COemResourceManager | Used internally for extranting OEM resources. Only used for light weight OEM solutions |
CReservedLicenseManager | This class is used for handling licenses to be reserved for specific items. All the items to have a licensed reserved for them need to have a LicenseItem saved in the LicenseInformation. The LicenseItem contains the id of the item to have a license, and the current state of the license. The state can be that it is a normal license, an item in trial mode and a trial end date. The main difference between this class and the ConcurrentLicenseManager, is that the ConcurrentLicenseManager assist with checking for concurrent use of the licenses |
CResolvedLicenseCount | Container for various license count information |
CSystemLicense | Contains information about the general license for the installed XProtect product |
CUnknownCompressionTypeException | |
►NLive | |
CBaseLiveContentEventArgs | The content of the eventArgs fired on the LiveContentEvent (base class for every one of them) |
CBaseLiveSource | T is the type of the content data (LiveSourceContent or LiveSourceRawContent) |
CBitmapLiveSource | This class is responsible for delivering live bitmap images from a camera. Only supported in Smart Client and standalone environments |
CJPEGLiveSource | This class is responsible for delivering live JPEG images from a camera. Only supported in Smart Client and standalone environments |
CLiveContentEventArgs | The content of the eventArgs fired on the LiveContentEvent |
CLiveContentPcmEventArgs | The content of the eventArgs fired on the LiveContentEvent |
CLiveContentRawEventArgs | The content of the eventArgs fired on the LiveContentEvent |
CLiveSource | An abstract class to be used for implementation of a LiveSources. Within the MIP Environment there are currently these built-in implementations: JPEGLiveSource BitmapLiveSource RawLiveSource |
CLiveSourceBitmapContent | This class is received in the event args for LiveVideo coming out of the multi media toolkit |
CLiveSourceContent | This class is used for receiving live content |
CLiveSourcePcmContent | This class is received in the event args for LiveVideo coming out of the multi media toolkit, used by the PcmLiveSource class |
CLiveSourceRawContent | This class is received in the event args for LiveVideo coming out of the multi media toolkit, use by the RawVideoSource class |
CLiveSourceStatus | Contains the LiveStatus information. It is transmitted as XML in between live video stream and contains changes relating to a given camera |
CLiveSourceTimeout | Class used to report a timeout from the toolkit |
CLiveStatusEventArgs | The content of the eventArgs fired on the LiveStatusEvent |
CMetadataLiveContent | This class contains the data delivered by a live metadata stream. All fields are immutable after construction |
CMetadataLiveSource | This class is responsible for delivering live metadata from a device. Only supported in Smart Client and standalone environments |
CPcmLiveSource | Class for retrieving pcm live audio (decoded to fixed number of channels, bits per pixel and sample frequency) |
CRawLiveSource | Provides raw video frames, including GenericByteHeader, for further analysis and decoding |
CVideoLiveSource | |
►NLog | |
CGroup | Contains constants defining the different type of logs |
CLogClient | This class is used for storing log messages in the server side logs. Currently only supported in standalone and Management Client environment |
CLogMessage | Contains one log message |
CLogMessageDictionary | Represent a set of log messages that a MIP plugin would like to define in the log system. Used when using the LogClient to register messages for later use |
CPermissionState | Used when performing audit logging - specify result of an permission check |
CSeverity | Contains constants definining the severity levels available |
CStatus | Contains constants defining if a message also should be considered to change a state |
►NLogin | |
CAuthenticationType | Defines the authentication types used in MIP |
CLoginServerProductInfo | Contains information about the server that is logged on to. |
CLoginSettings | LoginSettings contain a Token of login for one server. It needs to be renewed once in a while |
CLoginSettingsCache | Contains the cache of all LoginSettings currently in use by the Environment |
CUtil | A utility class to build user CredentialCache and NetworkCredential |
►NMessaging | |
CAddToExportCommandData | This class is used with the MessageId.SmartClient.AddToExportCommand message |
CAnalyticsMessageData | Contains a definition of one analytics event |
CAnyFilter | This MessageFilter will match any messages |
CApplicationControlCommandData | A set of const strings to defined available values for the ApplicationControlCommand message |
CChangedAlarmData | This class is contained on the Server.ChangedAlarmIndication. The content identifies what changes has been made. When changes only involved a single alarm, the ChangeHint is ChangeHintSingleAlarm and the AlarmId can be used to get the alarm again. When changes involves a number of alarms on a specific source, the ChangeHint is ChangeHistMassUpdateForSource, and the SourceId can be used to run though alarms for that source and check the changes |
CChangedAlarmHistoriesData | This class is contained on the Server.ChangedAlarmHistoryIndication. The content identifies the changes made to alarm history. E.g. changing state or changing assignee on an alarm. |
CChangedAlarmHistoryData | This class contains a single AlarmUpdateActivity, and is part of ChangedAlarmUpdateActivitiesData. See class AlarmUpdateKey for possible AlarmUpdateKeys |
CClearIndicatorCommandData | This class contains the commands to control clearing the red, yellow indicators on top of the Camera images |
CCommunicationIdFilter | The CommunicationIdFilter is used to identify what messages to subscribe to, on another machine. It is used in the Messaging.MessageCommunication class. |
CConnectionStateChangedEventArgs | Identifies the server wre the connection state has changed |
CConnectionStateEventArgs | Is send on the ConnectionStateChangedEvent |
CDriverCommandData | Use with MessageId = DriverCommand. |
CDriverResponseData | The response coming back from sending a message with MessageId = DriverCommand |
CEndPointIdentityData | Contains the FQID and the username used for login at that EndPoint identified by the EndPointFQID. This class is used in conjunction with the WhoAreOnlineResponse and NewEndPointIndication messages |
CExternalMessage | A ExternalMessage contains information send from a sender to one or multiple receivers. It is identified by a String, the well known messages created and send by the MIP Environment are defined in class VideoOS.Platform.Messaging.MessageId. The fields may be filled out or not filled out depending on the MessageId. The MessageId is the identification of the message, a plugin can use any MessageId they choose for additional communication. The field Reason - is a string containing why this message has been send, could be the name of a rule, a black list, or simply a user action. The RelatedFQID is used for some Messages – see documentation for each MessageId. The Data field is simply an object relevant to the specific MessageId |
CIMessageClient | Messages (through WebSockets) is a BETA API. Future releases might break backwards compatibility of the API and the clients |
CIMessageReceiverArgs | Interface holding received message parameters like topic and data |
CIsDirectInputHIDHandledByPlugInRequestData | This class is used to identify a DirectInput device found by the DirectInput HID plugin. The class represents the Data object of the MessageId.SmartClient.IsDirectInputHIDHandledByPlugInRequest message |
CItemState | Defines the current state a given Item has. This class is used in conjunction with the ProvideCurrentStateResponse message. |
CKindFilter | The KindFilter can filter on Messages. This class will match the message.RelatedFQID to the Guid parameter on the constructor and return true if there is a match |
CLensCommandData | A set of const strings to defined available values for the LensCommand message |
CMapRequestData | Class filled when sending a GetMapRequest |
CMapResponseData | Is part of the Message.Data field for a GetMapResponse message |
CMapResponseDataInstance | Short identification of a map |
CMessage | A Message contains information send from a sender to one or multiple receivers. It is identified by a String, the well known messages created and send by the MIP Environment are defined in class VideoOS.Platform.Messaging.MessageId. The fields may be filled out or not filled out depending on the MessageId. The MessageId is the identification of the message, a plugin can use any MessageId they choose of additional communication. The field Reason - is a string containing why this message has been send, could be the name of a rule, a black list, or simply a user action. The RelatedFQID is used for some Messages – see documentation for each MessageId. The Data field is simply an object relevant to the specific MessageId |
CMessageClientManager | Messages (through WebSockets) is a BETA API. Future releases might break backwards compatibility of the API and the clients |
CMessageCommunication | Communication between EventServer and all other MIP Environments can be done via this class. Each starting application or service will have one EndPoint ( Unique for each execution ), and a EndPointType. The EventServer is defined as a EndPointType.Server and all other MIP Environments are in this context a EndPointType.Client. Any MIP plug-in can get a list of all currently executing MIP Environments and store their EndPointFQID for communication purpose. For each EndPoint is is possible to get hold of the EndPointIdentityData class to identify the login user name for a given EndPoint. See the WhoAreOnlineRequest and WhoAreOnlineResponse MessageId's for more on this. This class is created through the MessageCommunicationManager static class |
CMessageCommunicationManager | The MessageCommunicationManager holds MessageCommunication classes for each EventServer it has connection to. The EventServers are identified by the ServerId.Id of their owning Management Server |
CMessageFilter | This class is the base class for classes that can assist in filtering messages. The MessageIdFilter matches on the MessageId itself. The AnyFilter is an always-true filter – most useful for debugging. A plugin can create own filters as appropriate for matching and filtering on specific combination the available fields |
►CMessageId | The MessageId class contains the definitions of all the system defined messages |
CControl | This class is a collection of static strings for controlling camera or triggering events. |
CLPR | This class is a collection of static strings for subscribing to LPR match lists related events. |
CServer | This class is a collection of static strings for server communications. The event and alarm messages will be sent to the EventServer and others represent communication to the logon server. |
CSmartClient | This class is a collection of static strings mostly for use when executing in the Smart Client The 4 playback message Id's can also be used for a ImageViewerControl running in the .Net Library |
CSystem | This class is a collection of static strings used for messages relevant on a system level |
CMessageIdAndRelatedKindFilter | The MessageIdFilter will match on the provided MessageId and kind. Only messages send with a specific messageId and where the message.RelatedFQID matches the given kind will be passed through the filter. The matching string for the messageId may contain a '' as the last character to allow for multiple matches, e.g. 'Control.PTZ' will match almost all PTZ operations going on. This filter is especially useful for the MessageId.Server.ConfigurationChangedIndication message |
CMessageIdFilter | The MessageIdFilter will match on the MessageId itself. Only messages send with a specific messageId will be passed through the filter. The matching string may contain a '' as the last character to allow for multiple matches, e.g. 'Control.PTZ' will match almost all PTZ operations going on |
CMessageIdListFilter | This class will match the messageId of a message with a list of messageId's, if a match exists for one of these, the message is passed through the filter. The '*' character cannot be used for this class |
CMoveCommand | The commands available for the SetSelectedViewItemData message |
CMultiWindowCommand | A set of const strings to defined available values for the MultiWindowCommandData structure Please note this class has same name as a command, but should be used in the MultiWindowCommandData.MultiWindowCommand field |
CMultiWindowCommandData | The data structure filled when sending the MultiWindowCommand message. |
CMyKeyValue | KeyValue to be used for serialization |
CMyRectangle | Defines a version of rectangle that can be serialized |
CPlaybackCommandData | A class specifying how to start PlayBack. Used by the PlaybackCommand for instructing the Smart Client, and by the PlaybackIndication when the Smart Client informs of user or other program commands |
CPlaybackControllerFilter | This class can be used to filter messages coming from playbackcontrollers. By using this filter, only messages from the defined playbackcontroller will be received |
CPlaybackControllerReceiverFilter | Used internally to match for receiver == playbackController |
CPlaybackData | Contains the possible values to be filled in the PlaybackCommandData.Command field. This class is send as Data in messages with MessagesIds SmartClient.PlaybackCommand and SmartClient.PlaybackIndication |
CPlaybackPlayModeData | Class of strings specifying the playback modes |
CPlaybackTimeInformationData | A class holding information about the currently received data to display. This class is sent to the PlaybackController to keep it updated with available data and possible skipping of gaps. |
CPTZAUXCommandData | A struct specifying the AUX specifics for the PTZAUXCommand message, used in the message's Data field |
CPTZCenterCommandData | Defines a rectangle in witch to center and zoom. |
CPTZGetAbsoluteRequestData | A struct defining the PTZ values returned by the PTZGetAbsoluteRequest message. The values for Pan an Tilt are between -1..1 The value for Zoom are in interval 0..1, where 0=full zoom out; 1=full zoom in; |
CPTZMoveAbsoluteCommandData | A struct specifying the PTZ and speed of a PTZMoveAbsoluteCommand message, used in the message's Data field |
CPTZMoveCommandData | A struct specifying the PTZ Move command of a PTZMoveCommand message, used in the message's Data field |
CPTZMoveStartCommandData | A struct specifying the PTZ and speed of a PTZMoveStartCommand message, used in the message's Data field |
CPTZMoveStartCommandData2 | A struct specifying the PTZ and speed of a PTZMoveStartCommand message, used in the message's Data field |
CPTZRectangleCommandData | Defines a rectangle to be displayed. All values are in pixels |
CRecorderErrorIndicationData | Describes in detail the error |
CSetCameraInViewCommandData | This structure is used when sending the SetCameraInViewCommand to tell the Smart Client what camera to insert in what position on current displayed view |
CSetSelectedViewItemData | This class is used by the SetSelectedViewItemCommand message id. It describes what view item should be selected within the currently selected window |
CShowCamerasInFloatingWindowData | Defines the state of a floating window and the cameras it contains. Fill this class when sending a message with id SmartClient.ShowCamerasInFloatingWindowCommand |
CSmartClientMessageData | Contains a single message to be displayed in the message area of the Smart Client. This class is used to display new messages in the message area of the Smart Client, as well as changing or removing existing messages. Fill this class when sending a message with id SmartClient.SmartClientMessageCommand |
CSmartClientTextToastData | Specialization of SmartClientToastData that represents a text toast message. A text toast message contains an icon, primary text, secondary text and a count text. All are optional but it is recommended that at least a primary text is always provided |
CSmartClientToastData | Abstract base class for the available toast message types. Use the specialized implementations to fill in information about the toast message to display |
CSmartMapGetPositionRequestData | This class is used with the MessageId.SmartClient.SmartMapGetPositionRequest message |
CSmartMapGoToAreaCommandData | This class is used with the MessageId.SmartClient.SmartMapGoToAreaCommand message |
CSmartMapGoToLocationCommandData | This class is used with the MessageId.SmartClient.SmartMapGoToLocationCommand message |
CSmartMapGoToPositionCommandData | This class is used with the MessageId.SmartClient.SmartMapGoToPositionCommand message |
CSmartMapNavigateToCameraData | This class is used with the MessageId.SmartClient.SmartMapNavigateToCamera message |
CSmartMapNavigateToDeviceData | This class is used with the MessageId.SmartClient.SmartMapNavigateToDevice message |
CSmartMapPositionData | This class is used with the MessageId.SmartClient.SmartMapPositionChangedIndication or MessageId.SmartClient.SmartMapGetPositionRequest message |
CSmartMapSelectItemCommandData | This class is used with the MessageId.SmartClient.SmartMapSelectItemCommand message |
CSystemConfigurationChangedDetails | Class defines one change, used by SystemConfigurationChangedDetailsIndicationData |
CSystemConfigurationChangedDetailsIndicationData | This class is coming with the MessageId.System.SystemConfigurationChangedDetailsIndication message |
CTalkToSpeakerData | The class send as data when sending a command to start or stop the 'talk' button. The command TalkToSpeakerCommand with this Data is implemented in the Smart Client |
CVideoWallApplyXmlCommandData | Contains information for what to change on a video wall. The listed devices (cameras) are removed from the monitor |
CVideoWallIndicationData | Contains description of a change on a video wall |
CVideoWallRemoveCamerasCommandData | Contains information for what to change on a video wall |
CVideoWallSetCamerasCommandData | Contains information for what to change on a video wall |
CVideoWallSetLayoutAndCamerasCommandData | Contains information for what to change on a video wall |
CVideoWallSetLayoutCommandData | Contains information for what to change on a video wall |
CVideoWallShowTextCommandData | Contains information for what to change on the Video Wall |
CViewItemControlCommandData | A set of const strings to defined available values for the ViewItemControlCommand message |
CViewItemInformation | Contains description of one ViewItem. The class is used by the VideoWallIndicationData class to inform about VideoWall View changes |
CWindowFilter | This class can be used to filter messages, so only relevant messages from a window is received |
CWindowStateChangedIndicationData | A set of const strings to define available values for the WindowStateChangedIndication message |
►NMetadata | |
CAppearance | This class is responsible for representing an ONVIF XML appearance |
CBehaviour | This class is responsible for representing an ONVIF XML behavior for objects |
CClassCandidate | This class is responsible for representing an ONVIF XML class candidate used for conveying information on the type of object inside a bounding box |
CDisplayColor | This class is responsible for containing information on the color used to draw metadata objects |
CDisplayText | This class is responsible for representing text than can be embedded as part of metadata. This text can then be presented to the users in some form |
CFrame | This class is responsible for representing a Frame in ONVIF XML |
CMetadataContent | This class is responsible for containing metadata received from the VMS system |
CMetadataDeserializer | This class is responsible for deserializing metadata stored in the ONVIF metadata format |
CMetadataSerializer | This class is responsible for serializing metadata to the ONVIF XML metadata format |
CMetadataStream | This class is responsible for representing a Frame in ONVIF XML |
CNavigationalData | This class is responsible for holding navigational metadata |
COnvifClass | This class is responsible for representing an ONVIF XML class |
COnvifObject | This class is responsible for representing an ONVIF XML object |
CRectangle | This class is responsible for representing an ONVIF XML rectangle |
CShape | This class is responsible for representing an ONVIF XML shape |
CTransformation | This class is responsible for representing an ONVIF XML transformation |
CVector | This class is responsible for representing a two-dimensional vector in ONVIF XML |
CVideoAnalytics | This class is responsible for representing a VideoAnalytics in ONVIF XML |
►NOAuth | |
CIMipTokenCache | IMipTokenCache interface |
►NProperties | |
CStrings | A strongly-typed resource class, for looking up localized strings, etc |
►NProxy | |
►NAlarm | |
CAlarmCommandTokenClient | The alarm command token client is a WCF client used against XProtect Enterprice to handle alarms. VideoOS.Platform.Proxy.AlarmClient.IAlarmClient for a description of the available methods. Use VideoOS.Platform.Proxy.AlarmClient.AlarmClientManager whenever possible, to make sure the correct AlarmCommand version is constructed |
CAlarmFilter | The Alarm Filter is used to filter alarm lines. Alarm filter has conditions to filter by and order in which to return the alarm list. Ordering priority is done by position in the array. First position in the array has highest priority. The filter should use '[]' to wrap up special characters, otherwise special characters are treated as wildcard characters and will be removed from the database |
CAlarmHistory | Alarm history contains data reflecting a alarm change. The history contains the data fields that was changed, the time of the change and the user how did the change. The changes made to an alarm is normally done on alarm updates, and the data fields in the alarm histry object reflects this |
CAlarmLine | The alarm line is a subset of the alarm. The fields contained in the alarm line are also the fields which are searchable using the alarm filter VideoOS.Platform.Proxy.Alarm.AlarmFilter |
CAlarmSearchCriteria | |
CAlarmServiceFault | The alarm service fault is thrown when a alarm action either is rejected or fails for some reason |
CAlarmUpdate | Alarm history update contains data reflecting a alarm change. The update contains the data key and value that was changed, the time of the change and the user how did the change. The changes made to an alarm is normally done on alarm updates |
CAlarmUpdateData | The alarm line is a subset of the alarm. The fields contained in the alarm line are also the fields which are searchable using the alarm filter VideoOS.Platform.Proxy.Alarm.AlarmFilter |
CCondition | The condition is used in the alarm filter to define the filter constains. Note: The value has to match the target object type |
CEventFilter | The Event Filter is used to filter event lines. Event filter has conditions to filter by and order in which to return the event list. Ordering priority is done by position in the array. First position in the array has highest priority. The filter should use '[]' to wrap up special characters, otherwise special characters are treated as wildcard characters and will be removed from the database |
CEventLine | The event line is a subset of the event. The fields contained in the event line are also the fields which are searchable using the event filter VideoOS.Platform.Proxy.Alarm.EventFilter |
CEventUpdateData | The event line is a subset of the alarm. The fields contained in the event line are also the fields which are searchable using the alarm filter VideoOS.Platform.Proxy.Alarm.AlarmFilter |
CIAlarmCommandToken | |
CIAlarmCommandTokenChannel | |
CNameNumberPairValue | |
COrderBy | Order by is used when defining a order of the filter result |
CStatistic | This class contains a alarm statistic. The statistic has a type VideoOS.Platform.Proxy.Alarm.StatisticType, a number which categorize the specific type and a value. An example could be a statistic containing StatisticType.State number = 4 has value = 100. which means that there is 100 alarms of state = 4 |
►NAlarmClient | |
CAlarmClientManager | The alarm client manager can be used in order to handle alarm client VideoOS.Platform.Proxy.AlarmClient.IAlarmClient. The alarm client manager will create a alarm client to use when handling alarms. The client is created based on a server id which is the server to get the alarms from. In order to receive alarms from the server it must have a Event Server running. The alarm client manager will keep track of created clients and handle caching of the clients |
CIAlarmClient | The alarm client is used to handle alarm specific actions. The client can be used to both add and get alarms. Updates of already existing alarms can be done primarily updating the alarm management field such as alarm state and and owner. The alarm history can also be received which is the collection of all the changes made to a specific alarm |
►NBookmarkApi | |
CBookmarkApiClient | |
CBookmarkDataModel | |
CIBookmarkApiClient | |
CNewBookmarkReferenceDataModel | |
CPatchBookmarkDataModel | |
CPathDataModel | |
CRelationsDataModel | |
►NConfigApi | |
CConfigurationApiManager | Class containing proxy classes for towards all servers this usercontext is working with |
CConfigurationItemPath | Class that represents a path in the configuration API |
CIConfigurationClientDecorator | |
CValidateResultException | Thrown when the server validation found an error. The ValidateResult contains a set of found issues |
►NEvidenceLockApi | |
CEvidenceLockApiClient | |
CEvidenceLockDataModel | |
CIEvidenceLockApiClient | |
CNewEvidenceLockReferenceDataModel | |
CPatchEvidenceLockDataModel | |
CPathDataModel | |
CRelationsDataModel | |
CRetentionOptionDataModel | |
►NRestApi | |
►NConfigApiRelated | |
CIRestSerializer | |
CResourceNotFoundException | |
CApiCounters | A set of counters related to the use of the RestAPI |
CDetailRest | |
CErrorRest | |
CIRestApiClient | |
CIServiceRegistrationClient | Defining the interface for the rest implementaion of the registration service |
CRestApiBase | A base class used by rest clients. |
CRestApiClient | Internal for now |
CServiceInformation | The information stored for each service |
CServiceInformationEndpoint | Contains details for each available endpoint |
CServiceRegistrationClient | This is a rest api implementation for managing the registered services, used by integrations |
CWellKnownInformation | Class to assist with getting and interpreting the well known information provided by the IDP |
►NSecurityApi | |
CEffectivePermissionsModel | Contains the effective permissions for all the objects within a security namespace, the caller has access to |
CISecurityApiClient | |
CObjectPermissionsModel | Contains permission bits for one objectId |
CSecurityAction | Defines a security action, also called permission |
CSecurityApiClient | Handles getting and caching security permissions |
CSecurityNamespaceModel | Contains the definition of one security namespace |
►NResources | |
CStrings | A strongly-typed resource class, for looking up localized strings, etc |
►NRuleAction | |
CActionDefinition | Definition of an action |
CActionElement | Selectable element in the action |
CActionManager | Manager for plug-ins to specify and execute actions |
►NSearch | |
►NErrors | |
CCustomSearchError | Custom search error for showing a message or a complete exception |
CDeviceSearchError | Search error for when there is an error searching on a specific device |
CInvalidFilterSearchError | Search error for when an filter value is not valid |
CNoItemsSupportedSearchError | Search error for when none of the items supplied is supported by the search agent |
CSearchError | Abstract base class for all search errors |
CServerNotAvailableSearchError | Search error for when a server is not available to complete the search |
CUnauthorizedDeviceAccessSearchError | Search error for when the user does not have rights to access a device |
CUnknownSearchError | Search error where an unknown error occued |
►NFilterCategories | |
COtherSearchFilterCategory | Filter category for a non-standard category |
CPersonSearchFilterCategory | Standard filter category for the "Person" group |
CVehicleSearchFilterCategory | Standard filter category for the "Vehicle" group |
►NFilterConfigurations | |
CCheckBoxFilterConfiguration | Configuration for a check box edit control |
CFilterConfigurationBase | Base class for all search filter configuration types. These types are used as input to the user control resolver when creating a SearchFilterEditControl |
CListSelectionFilterConfiguration | Configuration for a (e.g. checkbox-) list-selection edit control |
CRangeSliderFilterConfiguration | Configuration for a range slider edit control |
CRegionSelectionFilterConfiguration | Configuration for a region selection edit control |
CSliderFilterConfiguration | Configuration for a slider edit control |
CTextBoxFilterConfiguration | Configuration for a text box edit control |
►NFilterValues | |
►NStandard | |
CPersonAgeFilterValue | Filter value representing an age span for a person |
CPersonGenderFilterValue | Filter value representing genders of a person |
CVehicleColorFilterValue | Filter value representing colors of a vehicle |
CVehicleLicensePlateFilterValue | Filter value representing the license plate of a vehicle |
CBoolFilterValue | Search filter value representing a boolean |
CDoubleFilterValue | Search filter value representing a double |
CDoubleRangeFilterValue | Search filter value representing a range (of doubles) selection |
CFilterValueBase | Filter value abstraction which must be the base class for all search filter values. The sub-classes must be serializable to allow storing/retrieving filter values to/from disk |
CRegionSelection | Regions selection for a single camera item |
CRegionSelectionFilterValue | Search filter value representing region selections for a collection of cameras |
CSelectionFilterValue | Search filter value representing a selection of entries |
CStringFilterValue | Search filter value representing a string |
►NResults | |
CBoundingShape | Abstract base class for all supported bounding shapes. Do not create custom implementation of the class but instead always use the built-in implementations that are available in the framework |
CEllipseBoundingShape | Class defining a elliptical bounding shape |
CPolygonBoundingShape | Class defining a polygonic bounding shape |
CRectangleBoundingShape | Class defining a rectangular bounding shape |
CResultProperty | Search result property. Property has Title and typed value (for example, DateTimeValue). Value always contains string representation of the type value. There only one typed value is not empty/null |
CSearchResultUserControlTypes | Contains the ids for built in search results for the built in visual representation of search results |
►NSearchFilters | |
CColorSearchFilter | Search filter used for Color search. It is built on top of a ListSelectionFilterConfiguration with some specialization for handling colors. Currently used to implement StandardSearchFilters.Color from VehicleSearchFilterCategory |
CActivateResult | Result of the SearchToolbarPluginInstance.Activate method |
CSearchAgentPlugin | Defines the search agent plugin interface. Inherit this class to create an implementation of a specific type of search agent |
CSearchCriteria | Data class containing all search criteria data (i.e. values of selected SearchFilters) which is to be used in the SearchDefinition it belongs to |
CSearchCriteriaChangedEventArgs | Event args used when the SearchCriteria changes |
CSearchDefinition | Represents an independent search definition |
CSearchDoneEventArgs | Event arguments used when a Search.SearchDefinition has finished its search |
CSearchErrorEventArgs | Event args attached to the ISearchManager.ErrorOccurred-event |
CSearchFilter | Represents a single searchable filter |
CSearchFilterCategory | Represents a single searchable category containing all the filters associated with that category |
CSearchFilterEditControl | Represents a user control used to set the values for a given FilterValueBase. Implementations of this class are responsible for constructing the UI allowing the user to create/modify the value(s) of the associated FilterValueBase |
CSearchInput | Data class representing the input to the SearchDefinition.Search(VideoOS.Platform.Search.SearchInput,System.Threading.CancellationToken) method |
CSearchManager | A single-entry point for performing searches across the VMS system. The search manager will expose all available searches supplied by loaded search agent plugins. A search can be started across multiple search agents and run simultaneously by the search manager. |
CSearchResultData | Represents a single search result. A search performed on a Search.SearchDefinition instance may yield many instances of derivatives of this class |
CSearchResultDataMetadataObjects | Class representing a set of metadata objects that is associated with a SearchResultData |
CSearchResultReadyEventArgs | Event arguments used when a partial search result is ready from the SearchManager |
CSearchResultUserControl | User control used to visualize a given SearchResultData |
CSearchScope | Search scope used when starting a search. Includes a timespan and list of items in which to limit the search |
CSearchToolbarPlugin | The SearchToolbarPlugin defines a plugin that resides in the action/preview area of the Search tab in Smart Client |
CSearchToolbarPluginInstance | Instance of a SearchToolbarPlugin. An instance is needed for every place in the UI where the toolbar action is shown |
CSearchUserControlResolver | Singleton used to resolve/instantiate user controls for search results and/or search filters |
CSearchUserControlsPlugin | Defines the search user controls plugin interface. Inherit this class to create custom UI controls to visualize SearchResultData and/or FilterConfigurationBase instances |
►NUI | |
►NControls | |
►NTables | |
►NInternal | |
►NColumnTemplates | |
CCellActions | For internal use only |
CCellIcon | For internal use only |
CCellMark | For internal use only |
CCellTemplate | For internal use only |
CCellText | For internal use only |
CCellTimestamp | For internal use only |
CHeaderMark | For internal use only |
CVideoOSActionActivate | Action that can be selected |
CVideoOSActionBase | Base class for all action types |
CVideoOSActionGroup | A group of actions. Not an action in itself (i.e. cannot be selected/toggled) but contains a collection of actions |
CVideoOSActionHold | Action that can be held by the user |
CVideoOSActionListBase | Base class for all action list controls |
CVideoOSActionListHorizontalExtraSmall | VideoOSActionListHorizontalExtraSmall control |
CVideoOSActionListHorizontalMedium | VideoOSActionListHorizontalMedium control |
CVideoOSActionListHorizontalSmall | VideoOSActionListHorizontalSmall control |
CVideoOSActionSelect | Action that can be toggled on/off |
CVideoOSActionSeparator | A separator action. Not an action as such (i.e. cannot be selected/toggled) but is visualized as a "separation" (e.g. a separator) |
CVideoOSAlert | Class representing alert information that can be added to various user controls. Typically visualized in the UI by a badge shown in the user controls |
CVideoOSBadgeBase | Base class for badges |
CVideoOSBadgeExtraSmall | VideoOSBadgeExtraSmall control |
CVideoOSButtonAccentBase | Base class for all acccent button controls |
CVideoOSButtonAccentExtraSmall | VideoOSButtonAccentExtraSmall control |
CVideoOSButtonAccentLarge | VideoOSButtonAccentLarge control |
CVideoOSButtonAccentMedium | VideoOSButtonAccentMedium control |
CVideoOSButtonAccentSmall | VideoOSButtonAccentSmall control |
CVideoOSButtonBase | Base class for all buttons |
CVideoOSButtonHyperlinkBase | VideoOSButtonHyperlinkBase control |
CVideoOSButtonHyperlinkMedium | VideoOSButtonHyperlinkMedium control |
CVideoOSButtonHyperlinkSmall | VideoOSButtonHyperlinkSmall control |
CVideoOSButtonPrimaryBase | Base class for all primary button controls |
CVideoOSButtonPrimaryLarge | VideoOSButtonPrimaryLarge control |
CVideoOSButtonPrimaryMedium | VideoOSButtonPrimaryMedium control |
CVideoOSButtonPrimarySmall | VideoOSButtonPrimarySmall control |
CVideoOSButtonSecondaryBase | Base class for all secondary button controls |
CVideoOSButtonSecondaryLarge | VideoOSButtonSecondaryLarge control |
CVideoOSButtonSecondaryMedium | VideoOSButtonSecondaryMedium control |
CVideoOSButtonSecondarySmall | VideoOSButtonSecondarySmall control |
CVideoOSButtonTertiaryBase | Base class for all tertiary button controls |
CVideoOSButtonTertiaryLarge | VideoOSButtonTertiaryLarge control |
CVideoOSButtonTertiaryMedium | VideoOSButtonTertiaryMedium control |
CVideoOSButtonTertiarySmall | VideoOSButtonTertiarySmall control |
CVideoOSButtonTextBase | Base class for all text buttons |
CVideoOSButtonTextMedium | VideoOSButtonTextMedium control |
CVideoOSButtonTextSmall | VideoOSButtonTextSmall control |
CVideoOSButtonTransparentBase | Base class for all Transparent button controls |
CVideoOSButtonTransparentExtraSmall | VideoOSButtonTransparentExtraSmall control |
CVideoOSButtonTransparentLarge | VideoOSButtonTransparentLarge control |
CVideoOSButtonTransparentMedium | VideoOSButtonTransparentMedium control |
CVideoOSButtonTransparentSmall | VideoOSButtonTransparentSmall control |
CVideoOSCalendar | VideoOSCalendar control |
CVideoOSCheckBoxBase | Base class for all check box controls |
CVideoOSCheckBoxLarge | VideoOSCheckBoxLarge control |
CVideoOSCheckBoxMedium | VideoOSCheckBoxMedium control |
CVideoOSCheckBoxSmall | VideoOSCheckBoxSmall control |
►CVideoOSContextMenuBase | Base class for all context menu controls Note: Context menus derived from VideoOSContextMenuBase only supports VideoOSContextMenuItem and Separator as menu items |
CItemDragInitiatedEventArgs | Event args containing information about the item associated with a item drag operation |
CVideoOSContextMenuItem | Class representing a menu item displayed in context menus derived from VideoOSContextMenuBase. Note that the properties MenuItem.Icon and HeaderedItemsControl.Header that VideoOSContextMenuItem inherits from MenuItem is not supported. The properties IconSource and Data should be used instead |
CVideoOSContextMenuLarge | VideoOSContextMenuLarge control. Note that VideoOSContextMenuLarge only supports VideoOSContextMenuItem and Separator as menu items |
CVideoOSContextMenuSmall | VideoOSContextMenuSmall control. Note that VideoOSContextMenuSmall only supports VideoOSContextMenuItem and Separator as menu items |
CVideoOSDialog | VideoOSDialog control |
CVideoOSDialogActionBase | Base class for all dialog actions |
CVideoOSDialogActionButtonBase | Base class for all button based dialog actions |
CVideoOSDialogActionButtonPrimary | VideoOSDialogActionButtonPrimary dialog action |
CVideoOSDialogActionButtonSecondary | VideoOSDialogActionButtonSecondary dialog action |
CVideoOSDialogActionButtonTertiary | VideoOSDialogActionButtonTertiary dialog action |
CVideoOSDialogActionButtonText | VideoOSDialogActionButtonText dialog action |
CVideoOSDialogActionButtonTransparent | VideoOSDialogActionButtonTransparent dialog action |
CVideoOSDialogActionCheckBox | VideoOSDialogActionCheckBox dialog action |
CVideoOSDropDownBase | Base class for all drop down implementations |
CVideoOSDropDownBorderedBase | Base class for all bordered drop down implementations |
CVideoOSDropDownBorderlessBase | Base class for all borderless drop down implementations |
CVideoOSDropDownBorderlessContentForegroundExtension | Markup extension used to retrieve the content foreground for borderless drop downs. This can be used to "follow" the color of the "chevron" on other controls in the custom content (i.e. DataTemplate). When used in drop downs with a border, or in the drop down list (of any drop down type), it falls back to the default foreground color for the theme |
CVideoOSDropDownBorderlessMedium | VideoOSDropDownBorderlessMedium control |
CVideoOSDropDownBorderlessSmall | VideoOSDropDownBorderlessSmall control |
CVideoOSDropDownItem | Data class representing a drop down item to be used with VideoOSDropDownBase implementations |
CVideoOSDropDownLarge | VideoOSDropDownLarge control |
CVideoOSDropDownMedium | VideoOSDropDownMedium control |
CVideoOSDropDownSmall | VideoOSDropDownSmall control |
CVideoOSDynamicResourceExtension | Markup extension used to retrieve theme-aware resources. See VideoOSResourceKeys for available resource keys |
CVideoOSIcon | VideoOSIcon control |
CVideoOSIconBitmapSource | Icon source type where the icon is set as an BitmapSource |
CVideoOSIconBuiltInSource | Icon source type displaying built in icons |
CVideoOSIconBuiltInSourceExtension | Markup extension to make it easier to use built-in icons in XAML |
CVideoOSIconMultiPathPathInfo | Contains path information that can be added to the VideoOSIconMultiPathSource.Paths collection of VideoOSIconMultiPathSource |
CVideoOSIconMultiPathSource | Icon source type where the icon is set as collection of VideoOSIconMultiPathPathInfo each identifying a Path that is used to build the icon |
CVideoOSIconPathSource | Icon source type where the icon is set as a System.Windows.Shapes.Path |
CVideoOSIconResourceSource | Icon source type where the icon is set as a resource name |
CVideoOSIconSourceBase | Base class for icon source types |
CVideoOSIconUriSource | Icon source type where the icon is set as an Uri |
CVideoOSInlineMessageBase | Base class for all inline messages |
CVideoOSInlineMessageMedium | VideoOSInlineMessageMedium control |
CVideoOSInlineMessageSmall | VideoOSInlineMessageSmall control |
CVideoOSInputControlBase | Base class for all input control controls |
CVideoOSInputControlMedium | VideoOSInputControlMedium control |
CVideoOSInputControlSmall | VideoOSInputControlSmall control |
CVideoOSInternalDynamicResourceExtension | For internal use only |
CVideoOSMenuButtonAccentExtraSmall | VideoOSMenuButtonAccentExtraSmall control |
CVideoOSMenuButtonAccentLarge | VideoOSMenuButtonAccentLarge control |
CVideoOSMenuButtonAccentMedium | VideoOSMenuButtonAccentMedium control |
CVideoOSMenuButtonAccentSmall | VideoOSMenuButtonAccentSmall control |
CVideoOSMenuButtonBase | Base class for all menu button controls |
CVideoOSMenuButtonPrimaryLarge | VideoOSMenuButtonPrimaryLarge control |
CVideoOSMenuButtonPrimaryMedium | VideoOSMenuButtonPrimaryMedium control |
CVideoOSMenuButtonPrimarySmall | VideoOSMenuButtonPrimarySmall control |
CVideoOSMenuButtonSecondaryLarge | VideoOSMenuButtonSecondaryLarge control |
CVideoOSMenuButtonSecondaryMedium | VideoOSMenuButtonSecondaryMedium control |
CVideoOSMenuButtonSecondarySmall | VideoOSMenuButtonSecondarySmall control |
CVideoOSMenuButtonTertiaryLarge | VideoOSMenuButtonTertiaryLarge control |
CVideoOSMenuButtonTertiaryMedium | VideoOSMenuButtonTertiaryMedium control |
CVideoOSMenuButtonTertiarySmall | VideoOSMenuButtonTertiarySmall control |
CVideoOSMenuButtonTextMedium | VideoOSMenuButtonTextMedium control |
CVideoOSMenuButtonTextSmall | VideoOSMenuButtonTextSmall control |
CVideoOSMenuButtonTransparentExtraSmall | VideoOSMenuButtonTransparentExtraSmall control |
CVideoOSMenuButtonTransparentLarge | VideoOSMenuButtonTransparentLarge control |
CVideoOSMenuButtonTransparentMedium | VideoOSMenuButtonTransparentMedium control |
CVideoOSMenuButtonTransparentSmall | VideoOSMenuButtonTransparentSmall control |
CVideoOSMessageBarBase | Base class for all message bars |
CVideoOSMessageBarLarge | VideoOSMessageBarLarge control |
CVideoOSMessageBarMedium | VideoOSMessageBarMedium control |
CVideoOSMessageBarSmall | VideoOSMessageBarSmall control |
►CVideoOSMessageBox | Utility class used to display a standard message box to the user |
COptions | Options class allowing a caller to override the defaults (eg. buttons text and appearances) |
CResult | Class containing the message box result |
CVideoOSPanel | VideoOSPanel control |
CVideoOSPasswordBoxBase | Base class for all password box controls |
CVideoOSPasswordBoxLarge | VideoOSPasswordBoxLarge control |
CVideoOSPasswordBoxMedium | VideoOSPasswordBoxMedium control |
CVideoOSPasswordBoxSmall | VideoOSPasswordBoxSmall control |
CVideoOSPopover | VideoOSPopover control |
CVideoOSProgressBar | VideoOSProgressBar control |
CVideoOSProgressSpinner | VideoOSProgressSpinner control |
CVideoOSRadioButtonBase | Base class for all radio button controls |
CVideoOSRadioButtonMedium | VideoOSRadioButtonMedium control |
CVideoOSRadioButtonSmall | VideoOSRadioButtonSmall control |
CVideoOSScrollViewer | VideoOSScrollViewer control |
CVideoOSSliderBase | Base class for all slider control |
CVideoOSSliderHorizontal | VideoOSSliderHorizontal control |
CVideoOSStaticResourceExtension | Markup extension used to retrieve static (non-themed) resources. See VideoOSResourceKeys for available resource keys |
CVideoOSStyleFocusVisualStyle | Static class containing attached properties used to apply a focus visual style matching the current theme |
►CVideoOSTabControlBase | Base class for all tab controls |
CItemDragInitiatedEventArgs | Event args containing information about the item associated with a item drag operation |
CVideoOSTabControlItemBase | Data class representing a tab item to be used with a VideoOSTabControlBase implementation |
CVideoOSTabControlPrimaryBase | Base class for all primary tab controls |
CVideoOSTabControlPrimaryHorizontalBase | Base class for all primary horizontal tab controls |
CVideoOSTabControlPrimaryHorizontalLarge | VideoOSTabControlPrimaryHorizontalLarge control |
CVideoOSTabControlPrimaryItem | Data class representing a tab item to be used with a VideoOSTabControlPrimaryBase implementation |
CVideoOSTable | VideoOSTable control |
CVideoOSTableActionsColumn | Table column type where the row cells consist of a list of actions |
CVideoOSTableColumnBase | Base class for all column types supported by VideoOSTable |
CVideoOSTableIconAndTextColumn | Table column type where the row cells consist of an icon and a text |
CVideoOSTableMarkColumn | Table column type where the row cells allows the row to be marked. The marked items is available in the VideoOSTable.MarkedItems collection |
CVideoOSTableTemplateColumn | Table column type where the row cells consist of custom data and the visualization can be controlled by a DataTemplate set on the CellTemplate property |
CVideoOSTableTextColumn | Table column type where the row cells consist of a text |
CVideoOSTableTimestampColumn | Table column type where the row cells consist of a timestamp |
CVideoOSTextBlockBase | Base class for all text blocks. By default, a tooltip containing the value of the TextBlock.Text property is automatically shown if the text is truncated. This feature can be disabled by setting the FrameworkElement.ToolTip property to null |
CVideoOSTextBlockBodyExtraSmall | VideoOSTextBlockBodyExtraSmall control |
CVideoOSTextBlockBodyMedium | VideoOSTextBlockBodyMedium control |
CVideoOSTextBlockBodySmall | VideoOSTextBlockBodySmall control |
CVideoOSTextBlockEmptyState | VideoOSTextBlockEmptyState control |
CVideoOSTextBlockH1 | VideoOSTextBlockH1 control |
CVideoOSTextBlockH2 | VideoOSTextBlockH2 control |
CVideoOSTextBlockH3 | VideoOSTextBlockH3 control |
CVideoOSTextBlockInteractiveExtraSmall | VideoOSTextBlockInteractiveExtraSmall control |
CVideoOSTextBlockInteractiveMedium | VideoOSTextBlockInteractiveMedium control |
CVideoOSTextBlockInteractiveSmall | VideoOSTextBlockInteractiveSmall control |
CVideoOSTextBlockLabel | VideoOSTextBlockLabel control |
CVideoOSTextBlockTitle | VideoOSTextBlockTitle control |
CVideoOSTextBoxBase | Base class for all text box controls |
CVideoOSTextBoxLarge | VideoOSTextBoxLarge control |
CVideoOSTextBoxMedium | VideoOSTextBoxMedium control |
CVideoOSTextBoxSmall | VideoOSTextBoxSmall control |
CVideoOSTheming | Exposes utility method to apply a specific theme on a particular branch of the visual tree |
CVideoOSToggleButtonBase | Base class for all ToggleButton controls |
CVideoOSToggleButtonIconBase | Base class adding icon support to toggle buttons |
CVideoOSToggleButtonIconExtraSmall | VideoOSToggleButtonIconExtraSmall control |
CVideoOSToggleButtonIconMedium | VideoOSToggleButtonIconMedium control |
CVideoOSToggleButtonIconSmall | VideoOSToggleButtonIconSmall control |
CVideoOSToggleButtonSwitchBase | Base class for all switch toggle buttons |
CVideoOSToggleButtonSwitchMedium | VideoOSToggleButtonSwitchMedium control |
CVideoOSToggleButtonSwitchSmall | VideoOSToggleButtonSwitchSmall control |
CVideoOSTreeView | VideoOSTreeView control |
CVideoOSTreeViewItem | Data class representing a tree view item to be used with VideoOSTreeView implementations |
CVideoOSWindow | VideoOSWindow control |
►NResources | |
CStrings | A strongly-typed resource class, for looking up localized strings, etc |
CDependencyObjectExtension | |
CHelpUserControl | This class can be used to display the general help or information page when the administrator selects the plug-in node |
►CItemPickerForm | This class is deprecated. Windows Forms controls are no longer supported. Use ItemPickerWpfWindow instead. A form used for selecting a single Item. After this form has been created, the properties should be set, and the Init() method should ALWAYS be called. |
CIsItemVisibleEventArgs | Send on the IsItemVisibleEvent event for checking if an Item should be visible |
CValidateEventArgs | Is used on the ValidateSelectionEvent event - when the client application can validate if an Item is selectable |
CItemPickerUserControl | This class is deprecated. Windows Forms controls are no longer supported. Use ItemPickerWpfWindow instead. The ItemPickerUserControl is used to select one or multiple items. The control has a layout of a TreeView with items to select from and a ListView with the selected items. Category and Kind dropdowns can be hidden. This control requires a call to Init() for the Icons to show up correctly. For adding this UserControl to a Form for selecting one or more cameras and one or more events, the following code could be used: |
CItemPickerWpfUserControl | The ItemPickerWpfUserControl can be embedded into any custom WPF control you create, to allow selecting one or more Items from a list. It should be configured using its properties |
CItemPickerWpfWindow | The ItemPickerWpfWindow can be used as a Dialog to allow the user to select one or more Items from a provided list. It should be configured using the properties |
CScrollableWindowsFormsHost | This class is a Windows Forms host which supports being inside a scroll container |
CUtil | A utility class to collect all Icons used in the system for both plug-ins and for the Environment. Lookup to an Icon is done via KindToImageIndex, and KindToCategory can be used for the default Category if an Kind |
CWaitCursor | A simple class to be used around code taking a bit of time to execute |
CWindowsFormsHostConstants | |
CWpfWaitCursor | A simple class to be used around code taking a bit of time to execute. This should be used in WPF application |
►NUtil | |
►NAdaptiveStreaming | |
CIStreamSelectionParams | Interface fro setting stream selection parameters |
►NError | |
CIErrorHandler | Interface for subscribing to generic error (of type exception) |
►NImages | |
CCropDefaultValues | Static class representing cropping rectangle default values (eg. no cropping) |
CDecoderDefaultValues | Static class representing decoder default values |
►NImageServer | |
CUserIdentification | Class handling identity of a user. Depending on user type, not all fields will be filled for a given user |
►CUserIdType | Class containing definitions of different user types |
CInternalSID | Handles 'fake' SID's for basic users |
CUserIDTypeConstants | Constant class for UserID specific information. E.g. Guids for UserId types |
►NPcm | |
CPcmHelper | Helper class containing different utilities |
►NPerformance | |
CElapseTimeTracker | |
CPerformanceInformation | Is used to store performance information, used by somee Environments |
CTimeInfoClass | |
►NSvc | |
CIServiceRegistrationService | |
CIServiceRegistrationServiceChannel | |
CServiceEndpoint | |
CServiceInfo | Class assisting in getting available registration service points from the management server |
CServiceRegistrationServiceClient | |
►NToolkitXmlProviders | |
CAudioDecoderXmlProvider | Class representing audio decoder toolkit with it's parameters |
CBaseToolkitXmlProvider | Base class for toolkit xml provider |
CIsSourceXmlProvider | Class wrapping the IS (Image server) source |
CIToolkitXmlProvider | Interface for chaining the toolkit xml providers |
CIToolkitXmlProviderParams | Base interface for toolkit provider params |
CMediaProcessingToolkitXmlProvider | Base class for media processing toolkits |
CProxyXmlProvider | Class wrapping the common source depending the FQID |
CRootToolkitXmlProviderParams | |
CToMediaConverter | Class providing convertions form item, fqid and kind to media string |
CXpcoDbSourceXmlProvider | Class wrapping the XPCO DB source (BLK files) |
CAnalyticsOverlayBuilder | A utility class to construct a bitmap that can be used as an overlay on top of video |
CByteArrayHelper | Helper class for work with byte arrays |
CConfigurationChangedService | For internal use only |
CDifferentiatedAdministrationRights | This class is only relevant for Corporate VMS systems, while running inside the Management Client |
CGuidUtil | Utility class for dealing with creation of unique Guids based on a string input. NOTE: Code borrowed and slightly modified (only SHA1 support) from this OpenSource project (license terms updated accordingly): https://github.com/Faithlife/FaithlifeUtility/blob/master/src/Faithlife.Utility/GuidUtility.cs |
CInternalConfigService | For internal use only |
►CInternalMediaService | For internal use only |
CLiveVideoConnectBitmapParams | For internal use only |
CLiveVideoConnectParams | For internal use only |
CLiveVideoRawConnectParams | For internal use only |
CMulticastConfigDoneEventArgs | For internal use only |
CPcmAudioConnectParams | For internal use only |
CRawConnectParams | For internal use only |
CTranscodedVideoConnectParams | For internal use only |
CVideoConnectParams | For internal use only |
CIPcmSourceSettings | Interface for getting audio parameters |
CJpegUtil | Util to analyze JPEG content |
CMigration | For internal use |
CPcmSourceSettings | Class that encapsulates PCM source settings |
CSecurityAccess | This class assists in maintaining security access for Items and validating what Items a user can access. The plug-in must be sure to register and unregister the Items that is under access control, e.g. has a SecurityAccess defined. This could be done in the ItemManager.ValidateAndSaveUserControl method with a call to RegisterItem(Item) and in the ItemManager.DeleteItem(Item) with a call to UnregisterItem(Item) |
►CServiceUtil | The ServiceUtil class is used as common point to register services and later retrieve a list of the registered services. Service types are identified by a Guid, and in case of multiple registrations of the same service type, an instance field is used to distinguish them |
CAddTokenBehavior | A SOAP behavior assisting in adding the Token to the soap headers |
CAddTokenMessageInspector | A SOAP message inspector assisting in adding the Token to the soap headers |
CBearerAuthorizationHeaderInspector | A SOAP message inspector assisting in adding the MipTokenCache to the soap headers |
CSort | Contains method for Sorting assistance |
CSpnFactory | The SpnFactory is a helper class to get the right SPN for a connection |
CTimeConvert | |
CTimeInterval | Responsible for representing a time interval. It is up to the consumer to handle the DateTimeKind of the TimeInterval instance. In any case, all DateTimeKinds are supported, but we highly recommend to use only UTC time! Instances are immutable |
CUrlUtil | Utility for URL formatting |
CViewItemUtility | Construct an XML node containg the definition of a View, as used by Video Wall |
CArgumentMIPException | Throw by MIP Environment when an argument is incorrect. Check innerException for more info |
CArgumentNullMIPException | Throw by MIP Environment when an argument is null. Check innerException for more info |
CClientControl | The class to access Client relevant methods |
CClientTypeNotAllowedMIPException | Throw when the provided client type is not allowed to connect |
CCommunicationContentMIPException | This exception is thrown if the received response is badly formed, is missing important information or contains invalid values. This exception may indicate a compatibility issue between the client and the server |
CCommunicationMIPException | Thrown when an underlying protocol threw an Exception, or received a Serialized Exception from the server side |
CConfigItem | An overloaded class of the Item class. Can be subclassed when you want new MIP Items and modifications to existing MIP Items reflect into the mother environments settings. Used by the Smart Client when creating and modifying Views, layouts and view groups in the smart client. Used by the Administrators to create, modify and delete generic events. Only supported for e-code family! For c-code use Configuration API instead |
►CConfiguration | Configuration provides access to all configuration objects within the Milestone Platform. This covers well known Milestone objects like Cameras, Servers, Presets events etc, but also 3rd party plug-in objects can be accessed though this interface. Access to this class is done via Configuration.Instance |
CRegistrationServiceEndpoint | Defines one individual endpoint, contained within some service. Multiple Endpoints are relevant for e.g. support of multiple Authentication types or multiple Uri's |
CServiceURIInfo | The information stored for each services |
CCroppingInfo | Class returned as part of the BitmapData class |
CEndpointNotFoundCommunicationMIPException | Thrown when specified host address, URL or IP address does not exist or is not responding |
CEnvironmentCapabilities | Used by the EnvironmentManager.Instance.HasCapability() method |
CEnvironmentManager | The EnvironmentManager is the top class for the MIP Environment. The class can always be accessed though: EnvironmentManager.Instance As it is a singleton |
CEnvironmentOptions | Options available for the EnvironmentManager.Instance.EnvironmentOptions dictionary |
CFQID | The Fully Qualified ID contains a complete set of fields to contact a server and get further details. The purpose is to identify an Item to the level where it contains enough information for contacting the correct server, on a relevant protocol, and obtain further information for the item from that server. The key identification are build up of: 1) ServerId.Id Guid - identify a specific server or set of configuration. 2) ParentId Guid - the parent FQID will contain this in the ObjectId field 3) ObjectId Guid - a unique id for this object (Item) If an FQID does not have a parent, the parentId is Guid.Empty To make lookup easier and to assist in displaying relevant selection choices for users, the following type fields are present: 1) FolderType - identify if this is some kind of grouping or collection 2) Kind Guid - identifies what type of object this FQID identifies. The Kind class contains a set of predefined values for all Milestone known Kinds, e.g. Kind.Camera is assigned to FQIDs for cameras and groups of cameras. Note: When some object cannot be identified by a Guid, but rather a string, the ObjectIdString can be used as an alternative to the ObjectId. It is though highly recommended to fill the ObjectId if possible. The FQID is primarily created by plug-in developed ItemManagers and during deserialization of configurations. This method is NOT intended for overrides, as MIP Environment need to be able to deserialize a XML string to a correct FQID object. A camera sample for XProtect Corporate: |
CGenericEventConfigItem | A base class which allows generic events to be reflected in the administrator kernels' as "shadow" user-defined events. This base class is not supposed to be instanciated directly. You must use the CreateGenericEventConfigItem() method from the Configuration class to create instance |
CImplementationMIPException | Thrown when some part of the plug-in has not been implemented correctly. A fix is often possible by changing the code |
CInternalMIPException | Throw by MIP Environment. This may be a 'should not happen' and indicate some internal MIP implementation problem |
CInvalidOperationMIPException | This exception is thrown if request sent from the client is invalid due to the state of the server |
CInvalidParameterMIPException | Thrown when a parameter is not valid A fix is often possible by changing the code |
CISourceData | Base interface for common properties between different video source datas |
CItem | This class is used as a base class of all objects and items, be it cameras, audio sources or plug-in developed objects. For simple Items that does not have any Children this base class itself can be used, often though you will need to implement a class that inherit from this Item and make overrides to GetChildren, HasChildren, GetParent and perhaps more methods |
CItemProperties | |
CIVideoSourceData | Interface for common properties between different video source datas |
CKind | Kind is a class that contains Milestone defined kinds as static members. Each field is a GUID. New plugins defines their own Kinds on the plugins ItemNodes. In the ItemPicker each Kind is represented with a specific icon. The ItemPicker uses the icon defined on the ItemNode. During load of the plugins the plug-in defined ItemNodes and their Kinds and Icons are added to the static Hashtable members of this class. |
CLicenseMIPException | Throw by MIP Environment when the server license limit has been reached. Ask operator to check Management Client license overview. |
CLicenseServiceMIPException | Throw when concurrent license check cannot get hold of the LicenseService. Check that the LicenseService is running in the EventServer, and that the ServiceRegistration contains the correct URL to this service |
CMessageFilterNotRegisteredMIPException | Thrown when MessageCommunication is used, and the server does not have any filter registered |
CMIPException | The common Exception for all exceptions thrown by the MIP environment |
CNotAuthorizedMIPException | Throw by the SecurityAccess class when calling CheckPermission, or when using the configuration API and the server is accessed for an object that is not accessible for user that is logged in |
CNotDualAuthorizedMIPException | Throw by the Login process if server requires dual authentication |
CNotSupportedMIPException | Throw by MIP Environment when calling a server that does not support the current method, check version of server side product |
CNoVideoInTimeSpanMIPException | Thrown when an export is started, but video is available in the given time span |
CPathNotFoundMIPException | Throw by MIP Environment when calling a server that does not have a configuration item corresponding to the provided path |
CPluginDefinition | The PluginDefinition is the ‘entry’ point to any plug-in. This is the starting point for any plug-in development and the class MUST be available for a plug-in to be loaded. Here the references to all other plug-in known objects and classes are defined. The class is an abstract class where all implemented methods and properties need to be declared with override. The class is constructed when the environment is loading the DLL |
CPositioningInformation | Defines the position for an Item, the direction and view zone |
CRestApiMIPException | Thrown when RestAPI communication has issues |
CServerFaultMIPException | Is thrown by the server having internal issues. Can be thrown when using configuration api |
CServerId | The ServerId holds enough information for creating a connection. Typically this can be used to construct an URL. For plug-in developed solutions the ServerId need to be understood by the plug-ins own ItemManager, as this class is the primary place for creating, deleting and getting Items. |
CTimeoutCommunicationMIPException | Thrown when a timeout has happened on an underlying session |
CUserContext | This class is used for stand alone applications and services that need to handle multiple users logging in to the same set of server(s). Some functions and methods are required to be called though this class instead of the usual Configuration.Instance.SomeMethod |
CValidateAndSaveMIPException | Can be thrown by the ValidateAndSaveUserControl and ValidateAndSaveItemSummary methods implemented by MIP Plug-ins, when the user entry is not correct. The management client/application will show a standard error dialog containing the message from the exception |
CAlarmCommandClient | The alarm command token is a WCF client class used against XProtect Corporate to handle alarms. VideoOS.Platform.Proxy.AlarmClient.IAlarmClient for a description of the available methods. Use VideoOS.Platform.Proxy.AlarmClient.AlarmClientManager whenever possible instead |
CCommunicationServiceClient | |
CIAlarmCommand | |
CIAlarmCommandChannel | |
CICommunicationService | |
CICommunicationServiceChannel | |
CILicenseService | |
CILicenseServiceChannel | |
CLicenseServiceClient |