Namespaces | |
| namespace | Export |
| namespace | Hid |
Classes | |
| class | ActiveElementsOverlayRenderParameters |
| Defines how WPF UIElements are placed on top of video. Used by ImageViewerAddOn.ActiveElementsOverlay methods. More... | |
| class | AudioPlayer |
| 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. More... | |
| class | AudioPlayerControl |
| 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: More... | |
| class | BitmapSource |
| class | CameraViewControlItem |
| Use this class to represent a camera view item that should be part of the ViewControl. More... | |
| class | ClientAction |
| 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. More... | |
| class | ClientActionGroup |
| Defines a client action group. Groups support hierarchies. More... | |
| class | ConfigurationItemBase |
| Abstract base class for specialized configuration item classes. More... | |
| class | ConnectionState |
| Current state information for a session. More... | |
| class | ConnectResponseEventArgs |
| The argument filled on the ConnectResponse event. More... | |
| class | ConnectResponseEventEventArgs |
| The argument filled on the ConnectResponseEvent. More... | |
| class | CustomViewControlItem |
| Use this class to represent any view item that should be part of the ViewControl. More... | |
| class | DataViewControlItem |
| Use this class to represent a data based view item that should be part of the ViewControl. More... | |
| class | ExportManager |
| 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. More... | |
| class | ExportParameters |
| Contains all relevant parameters selected by the user or environment used for an export. The class is build by the Environment. More... | |
| class | GisMapViewControlItem |
| Use this class to represent a Gis map view item that should be part of the ViewControl. More... | |
| class | ImageDisplayedEventArgs |
| For each image being displayed that argument is filled with the Image time, and passed to this class via the ImageDisplayedEvent. More... | |
| class | ImageOrPaintInfoChangedEventArgs |
| The argument filled on the ImageOrPaintInfoChanged event. More... | |
| class | ImageViewerAddOn |
| 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. More... | |
| class | ImageViewerControl |
| 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: More... | |
| class | ImageViewerWpfControl |
| 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: More... | |
| class | IndependentPlaybackModeEventArgs |
| Implements the class that contains the EventArgs for independent playback mode changed events. More... | |
| class | LiveStreamInformationEventArgs |
| The argument filled on the LiveStreamInformationEvent. More... | |
| class | LiveStreamInformationReceivedEventArgs |
| The argument filled on the LiveStreamInformationReceived event. More... | |
| class | LoginPlugin |
| 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. More... | |
| class | LoginUserControl |
| 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. More... | |
| class | MapViewControlItem |
| Use this class to represent a map view item that should be part of the ViewControl. More... | |
| class | Model |
| class | OptionsDialogPlugin |
| 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. More... | |
| class | OptionsDialogUserControl |
| 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. More... | |
| class | PassRequestEventArgs |
| class | PlaybackController |
| Build-in controller containing playback information and events, e.g. current play time, goto, prev, next etc. More... | |
| class | PlaybackControllerBase |
| The PlaybackControllerBase is used internally by the MIP Environment for controlling timing and commands around playback. It is identified by a FQID. More... | |
| class | PlaybackUserControl |
| 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. More... | |
| class | PlaybackUserControlMini |
| 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. More... | |
| class | PlaybackWpfUserControl |
| Interaction logic for PlaybackWpfControl.xaml. More... | |
| class | PlaybackWpfUserControlInternal |
| Internal use only. Use PlaybackWpfUserControl instead. More... | |
| class | PlaybackWpfUserControlMini |
| Interaction logic for PlatformPlaybackWpfControl.xaml. | |
| class | PropertiesUserControl |
| 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. More... | |
| class | PropertiesUserControlWpfWrapper |
| class | PropertiesWpfUserControl |
| 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. More... | |
| class | PropertiesWpfUserControlWinFormsWrapper |
| class | PropertyClass |
| Abstract class incapsulating a key-value based property list. More... | |
| class | RawSource |
| 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. More... | |
| class | RecordedImageReceivedEventArgs |
| For each recorded image being displayed that argument is filled with the Image time, and passed to this class via the RecordedImageReceivedEvent. More... | |
| class | SequenceCache |
| Very simple cache that can hold SequenceData objects. | |
| class | SettingsPanelPlugin |
| Represents a plug-in that can be integrated into the Settings panel. More... | |
| class | ShapesOverlayRenderParameters |
| Defines how WPF shapes is placed on top of video. Used by ImageViewerControl.ShapesOverlay methods. More... | |
| class | SidePanelPlaceDefinition |
| Defines a side panel placement. Used in SidePanelPlugin.SidePanelPlaceDefinitions. More... | |
| class | SidePanelPlugin |
| 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. More... | |
| class | SidePanelUserControl |
| 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. More... | |
| class | SidePanelUserControlWpfWrapper |
| class | SidePanelWpfUserControl |
| 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. More... | |
| class | SidePanelWpfUserControlWinFormsWrapper |
| class | SpeedSliderValueConvertor |
| class | Theme |
| 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. More... | |
| class | TimeEventArgs |
| class | TimelineDataArea |
| 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. More... | |
| class | TimelineSequencesEventArgs |
| EventArgs class to be used with the TimelineSequenceSource.SequencesRetrieved event. More... | |
| class | TimelineSequenceSource |
| 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. More... | |
| class | TimelineSourceQueryResult |
| Class for holding timeline data from a source for one interval. More... | |
| class | TimeLineUserControl |
| 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. More... | |
| class | TimeSpanSliderTextConvertor |
| class | TimeSpanSliderValueConvertor |
| class | ToolbarPluginWpfUserControl |
| The WPF UserControl to be displayed when the user activates a toolbar plugin instance. More... | |
| class | VideoControl |
| 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. More... | |
| class | ViewAndLayoutItem |
| 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. More... | |
| class | ViewControl |
| ViewControl is an easy to use UI component for showing a collection of viewitems in a MIP plugin UI. More... | |
| class | ViewControlItem |
| Base class for all ViewControlItems. More... | |
| class | ViewControlItemArgs |
| Event argument for SelectedItemChanged. More... | |
| class | ViewControlItemDataArgs |
| Event argument for ItemPropertiesChanged. More... | |
| class | ViewGroup |
| The content of a ViewGroup: Data and Info. More... | |
| class | ViewGroupData |
| The XML content of a ViewGroup. More... | |
| class | ViewGroupInfo |
| Contains the header information for a Smart Client view group. More... | |
| class | ViewItemManager |
| 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. More... | |
| class | ViewItemPlugin |
| 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. More... | |
| class | ViewItemToolbarPlaceDefinition |
| Defines view item toolbar placement information. Used in ViewItemToolbarPlugin.ViewItemToolbarPlaceDefinition. More... | |
| class | ViewItemToolbarPlugin |
| The ViewItemToolbarPlugin defines a plug-in that resides in the view item toolbar in the Smart Client. More... | |
| class | ViewItemToolbarPluginInstance |
| 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. More... | |
| class | ViewItemUserControl |
| 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. More... | |
| class | ViewItemWpfUserControl |
| 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. More... | |
| class | ViewItemWpfUserControlWinFormsWrapper |
| class | ViewLayout |
| The Layout represent a specific Smart Client view layout without content. This class is provided by the PluginDefinition. More... | |
| class | WindowInformation |
| This class provide information of the currently executing window. It is accessed from the ViewItemUserControl.WindowInformation. More... | |
| class | WorkSpaceNotification |
| Class defining a works space notification. More... | |
| class | WorkSpacePlugin |
| The abstract base class a MIP plugin can implement for having a WorkSpace tab available in the Smart Client. More... | |
| class | WorkSpaceToolbarPlaceDefinition |
| Defines work space toolbar placement information. Used in WorkSpaceToolbarPlugin.WorkSpaceToolbarPlaceDefinition. More... | |
| class | WorkSpaceToolbarPlugin |
| The WorkSpaceToolbarPlugin defines a plug-in that resides in the work space toolbar in the Smart Client. More... | |
| class | WorkSpaceToolbarPluginGroup |
| 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. More... | |
| class | WorkSpaceToolbarPluginInstance |
| 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. More... | |
Enumerations | |
| enum | ImageViewerType { Unspecified , CameraViewItem , HotspotViewItem , CarouselViewItem , MatrixViewItem , MIP , BookmarkEditDialog , RecordingPreview , SequenceExplorerPreview , CameraNavigationViewItem , CameraNavigationViewItemPreview , Export , ManagePresets , SearchResultPreview , SmartSearchSelection } |
| The type of ViewItem containing the ImageViewerControl. You can e.g. decide to not place any overlay on a CarouselViewItem, as it changes too often. More... | |
| enum | OverlayPlacement { FollowImageViewport , FollowDigitalZoom , FollowWindow } |
| Defines how the overlay will be placed: More... | |
| enum | OverlayTextId { None = 0 , NotInitialized = 3 , NotConnected = 4 , ConnectionFailed = 5 , Connecting = 6 , Connected = 7 , BeforeDatabaseStart = 10 , AfterDatabaseEnd = 11 , ConnectionRefused = 12 , ConnectionLost = 13 , InternalError = 14 , NoImagesInDatabase = 16 , RunningOutOfDiskSpace = 22 , CameraConnectionLost = 23 , DatabaseFailed = 24 , LiveFeedStoppedCausedByNoMotion = 25 , ImmerVisionEnabledButFailedToInitialize = 32 } |
| Defines the available built-in text messages. The value is used to control how to display text via the EnableOverlayedText method. More... | |
| enum | SidePanelPluginPlace { LivePanel , PlaybackPanel , SetupPanel , Undefined } |
| Defines which side panel should host a plug-in. More... | |
| enum | ThemeType { Dark , Light } |
| The available Smart Client themes. More... | |
| enum | TimelineMode { Minimal = 0 , Full = 1 } |
| Timeline mode used in conjunction with the VideoControl to manipulate the displayed timeline. More... | |
| enum | ToolbarPluginOverflowMode { NeverInOverflow , AlwaysInOverflow , AsNeeded } |
| Defines the overflow behavior of toolbar plugins. More... | |
| enum | ToolbarPluginType { Action , UserControl , Toggle , Hold } |
| Defines the toolbar plugin types. More... | |
| enum | ViewGroupType { Normal = 0 } |
| Identifies the type of ViewGroup begin returne. More... | |
Functions | |
| delegate void | ConnectResponseEventHandler (object sender, ConnectResponseEventEventArgs e) |
| delegate void | ImageDisplayedHandler (object sender, ImageDisplayedEventArgs e) |
| delegate void | LiveStreamInformationHandler (object sender, LiveStreamInformationEventArgs liveInformation) |
| delegate void | PassRequestEventHandler (object sender, PassRequestEventArgs e) |
| delegate void | RecordedImageReceivedHandler (object sender, RecordedImageReceivedEventArgs e) |
The type of ViewItem containing the ImageViewerControl.
You can e.g. decide to not place any overlay on a CarouselViewItem, as it changes too often.
Defines how the overlay will be placed:
| Enumerator | |
|---|---|
| FollowImageViewport | |
| FollowDigitalZoom | |
| FollowWindow | |
Defines the available built-in text messages. The value is used to control how to display text via the EnableOverlayedText method.
The available Smart Client themes.
| Enumerator | |
|---|---|
| Dark | |
| Light | |
Timeline mode used in conjunction with the VideoControl to manipulate the displayed timeline.
| Enumerator | |
|---|---|
| Minimal | Mode showing only minimal controls for the selected camera only. |
| Full | Mode showing controls similar to Smart Client. |
Defines the overflow behavior of toolbar plugins.
Defines the toolbar plugin types.
| Enumerator | |
|---|---|
| Action | Plugin will perform an action when activated by the user. |
| UserControl | Plugin will provide a user control that will be presented to the user when activated by the user. |
| Toggle | Plugin wil react on ViewItemToolbarPluginInstance.IsChecked changes. |
| Hold | Plugin wil react on ViewItemToolbarPluginInstance.IsHeld changes. |
Identifies the type of ViewGroup begin returne.
| Enumerator | |
|---|---|
| Normal | |
| delegate void VideoOS.Platform.Client.ConnectResponseEventHandler | ( | object | sender, |
| ConnectResponseEventEventArgs | e ) |
| delegate void VideoOS.Platform.Client.ImageDisplayedHandler | ( | object | sender, |
| ImageDisplayedEventArgs | e ) |
| delegate void VideoOS.Platform.Client.LiveStreamInformationHandler | ( | object | sender, |
| LiveStreamInformationEventArgs | liveInformation ) |
| delegate void VideoOS.Platform.Client.PassRequestEventHandler | ( | object | sender, |
| PassRequestEventArgs | e ) |
| delegate void VideoOS.Platform.Client.RecordedImageReceivedHandler | ( | object | sender, |
| RecordedImageReceivedEventArgs | e ) |