Class ActiveGuardFactory
  • Overview
  • Download
  • Interface detail
  • How to use
Show / Hide Table of Contents
  • ActiveGuard.Plugins.OSS.Common.Utitlity
    • ActiveGuardFactory
    • ActiveGuardFactory.OnHandleOpenRecordingEventHandler
    • ActiveGuardFactory.OnHandleSaveCurentUserEventHandler
    • ActiveGuardFactory.OnHandleSavePresetEventHandler
    • ActiveGuardFactory.OnHandleSaveServerConnectionsEventHandler
    • ActiveGuardFactory.OnHandleSaveUserManagementEventHandler
  • ActiveGuard.Plugins.OSS.Models
    • CameraMap
    • Map
    • MediaInfo
    • ServerConnection
    • User
    • UserMng
  • ActiveGuard.Plugins.OSS.Views
    • PluginSetupView
    • ThumbnailSearchView

Class ActiveGuardFactory

Inheritance
System.Object
ActiveGuardFactory
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: ActiveGuard.Plugins.OSS.Common.Utitlity
Assembly: ActiveGuard.Plugins.OSS.dll
Syntax
public static class ActiveGuardFactory

Properties

CurrentUser

Information of current login user

Declaration
public static User CurrentUser { get; set; }
Property Value
Type Description
User

ErrorCode

Error code

Declaration
public static string ErrorCode { get; set; }
Property Value
Type Description
System.String

IsSaveCurrentUserSuccess

Flag to know saving user's information is success or not

Declaration
public static bool IsSaveCurrentUserSuccess { get; set; }
Property Value
Type Description
System.Boolean

IsSaveUserConfigSuccess

Flag to know saving user's configuration is success or not

Declaration
public static bool IsSaveUserConfigSuccess { get; set; }
Property Value
Type Description
System.Boolean

IsServerConnectionSuccess

Flag to know saving server's information is success or not

Declaration
public static bool IsServerConnectionSuccess { get; set; }
Property Value
Type Description
System.Boolean

Maps

List of map's information

Declaration
public static List<Map> Maps { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Map>

MediaElement

UI of media player

Declaration
public static UIElement MediaElement { get; set; }
Property Value
Type Description
UIElement

MediaInfo

Information of media (video to playback)

Declaration
public static MediaInfo MediaInfo { get; set; }
Property Value
Type Description
MediaInfo

ServerConnections

List of ActiveGuard server connection

Declaration
public static List<ServerConnection> ServerConnections { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ServerConnection>

UserMngs

List of user management's information

Declaration
public static List<UserMng> UserMngs { get; set; }
Property Value
Type Description
System.Collections.Generic.List<UserMng>

Methods

GetCurrentUser()

Get information of current login user

Declaration
public static User GetCurrentUser()
Returns
Type Description
User

Information of current login user

GetMaps()

Get list of maps from VMS side

Declaration
public static List<Map> GetMaps()
Returns
Type Description
System.Collections.Generic.List<Map>

List of map information

GetMediaInfo()

Get media information

Declaration
public static MediaInfo GetMediaInfo()
Returns
Type Description
MediaInfo

Media information

GetServerConnections()

Get list of server connections

Declaration
public static List<ServerConnection> GetServerConnections()
Returns
Type Description
System.Collections.Generic.List<ServerConnection>

List of server connections from VMS side

GetUserMngConfig()

Get list of user management

Declaration
public static List<UserMng> GetUserMngConfig()
Returns
Type Description
System.Collections.Generic.List<UserMng>

OpenPlaybackCB()

Handle event to openning video

Declaration
public static void OpenPlaybackCB()

SaveCurrentUserCB()

Save information of current user

Declaration
public static void SaveCurrentUserCB()

SavePresetCB()

Handle event when save preset

Declaration
public static void SavePresetCB()

SaveServerConnectionsCB()

Handle event to save server connections

Declaration
public static void SaveServerConnectionsCB()

SaveUserMngConfigCB()

Handle event to save server connections

Declaration
public static void SaveUserMngConfigCB()

SetCurrentUser(User)

Setting login user information

Declaration
public static void SetCurrentUser(User userlogin)
Parameters
Type Name Description
User userlogin

User login VMS

  • If userlogin is null, display messege ERR001 ( userlogin can not be null or empty. )
  • If UserName of user login is null, display messege ERR001 ( userlogin can not be null or empty. )
  • If UserName over 128 characters, display messege ERR002 ( UserName too long.)
  • If StartPlaybackTime's value less than 0 or greater than 59, display messege ERR004 ( StartPlaybackTime invaild.)

SetMaps(List<Map>)

Setting list of map

Declaration
public static void SetMaps(List<Map> listMap)
Parameters
Type Name Description
System.Collections.Generic.List<Map> listMap

List of map from VMS side

SetMediaElement(UIElement)

Setting UI of playback control from VMS

Declaration
public static void SetMediaElement(UIElement mediaPlayer)
Parameters
Type Name Description
UIElement mediaPlayer

Playback control

  • If mediaPlayer = Null, display messege ERR005 : MediaPlayer can not be null

SetServerConnections(List<ServerConnection>)

Setting list of server connections

Declaration
public static void SetServerConnections(List<ServerConnection> serverConnections)
Parameters
Type Name Description
System.Collections.Generic.List<ServerConnection> serverConnections

List of server connections from VMS side

  • If IPAddress of connection server is null, display messege ERR001 ( IPAddress can not be null or empty. )
  • If IPAddress of connection server over 128 characters, display messege ERR002 ( IPAddress too long.)
  • If Port's value of connection server less than 1 or greater than 35536, display messege ERR002 ( Port invaild.)
  • If UserName to login connection server is null, display messege UserName ( UserName can not be null or empty. )
  • If UserName to login connection server over 32 characters, display messege UserName ( UserName too long. )

SetUserMngConfig(List<UserMng>)

Setting list of user management

Declaration
public static void SetUserMngConfig(List<UserMng> listUserConfig)
Parameters
Type Name Description
System.Collections.Generic.List<UserMng> listUserConfig

List User name from VMS

  • If UserName of user login is null, display messege ERR001 ( userlogin can not be null or empty. )
  • If UserName over 128 characters, display messege ERR002 ( UserName too long.)

Events

OnHandleOpenRecordingEvent

Declaration
public static event ActiveGuardFactory.OnHandleOpenRecordingEventHandler OnHandleOpenRecordingEvent
Event Type
Type Description
ActiveGuardFactory.OnHandleOpenRecordingEventHandler

OnHandleSaveCurrentUserEvent

Declaration
public static event ActiveGuardFactory.OnHandleSaveCurentUserEventHandler OnHandleSaveCurrentUserEvent
Event Type
Type Description
ActiveGuardFactory.OnHandleSaveCurentUserEventHandler

OnHandleSavePresetEvent

Declaration
public static event ActiveGuardFactory.OnHandleSavePresetEventHandler OnHandleSavePresetEvent
Event Type
Type Description
ActiveGuardFactory.OnHandleSavePresetEventHandler

OnHandleSaveServerConnectionsEvent

Declaration
public static event ActiveGuardFactory.OnHandleSaveServerConnectionsEventHandler OnHandleSaveServerConnectionsEvent
Event Type
Type Description
ActiveGuardFactory.OnHandleSaveServerConnectionsEventHandler

OnHandleSaveUserManagementEvent

Declaration
public static event ActiveGuardFactory.OnHandleSaveUserManagementEventHandler OnHandleSaveUserManagementEvent
Event Type
Type Description
ActiveGuardFactory.OnHandleSaveUserManagementEventHandler
In This Article
Back to top Generated by DocFX