Bosch. |  |
BVMS Script API documentation
Classes| Class | Description | |
|---|---|---|
 | AccessSystemDoor | Access system door handle used in IAccessSystemDoorManager. |
| AccessSystemReader | Access system reader handle used in IAccessSystemDoorManager. |
| AlarmCameraActionSetting | This class describes the configured alarm-triggered actions for a specific camera. |
| AlarmData | Data used for alarm. This class contains detailed information associated with a certain alarm. |
| AlarmImagePaneSetting | This class describes the content to be displayed in a specific alarm image pane. |
| AlarmReceiver | It is an abstract class. Create your own class derived from AlarmReceiver. |
| AnalogMonitor | Analog Monitor Handle |
| AuditTrailExportSdkException | AuditTrailExportSdkException is a subclass of SdkException which contains an additional property ExportResultCode (of type AuditTrailFaultCode) indicating the reason for the exception. |
| Camera | Handle for cameras |
| CameraFilter | Represents an immutable object which describes the camera's criteria for the search filter. |
| CompoundEvent | CompoundEvent handle |
| Constants | Container for various constants. |
| Decoder | Decoder handle. Represents a pane on a monitor that is connected to a decoder device. |
| Device | Handle for devices |
| DeviceInfoT | Information about a device. |
| DisplayLayout | An instance of this class holds an identifier of one of the supported layouts for a display that is connected to a decoder. It contains also some information about that layout. For getting the display-layouts supported by a certain decoder, use the method GetSupportedDisplayLayouts(Decoder). |
| Document | Handle for document/map objects. |
| DocumentInfo | Info about a document. |
| DomeCamera | Handle for PTZ cameras. |
| EventData | Information about an event. |
| EventDataStateInfo | State information. |
| EventReceiver | It is an abstract class. Create your own class derived from EventReceiver. |
| ExportParameters | Parameters required to trigger a video export ExportRecordings(ExportParameters). All fields except the EncryptionPassword are mandatory. |
| ImagePane | Summary description for ImagePane. |
| Input | Input Handle |
| IntrusionPanelArea | IntrusionPanel Area Handle |
| IntrusionPanelDoor | IntrusionPanel door handle |
| IntrusionPanelPoint | IntrusionPanel point handle |
| IntrusionPanelPointState | Information about a state of an IntrusionPanelPoint. |
| LogbookSearchParameters | An object of this class is used to specify comparison criteria for searching logbook entries. |
| LogbookSearchSdkException | A LogbookSdkExcpetion is a SdkException which contains an additional property SearchResultCode (of type LogbookSearchResultCode) indicating the reason for the exception. |
| MailProvider | Handle for mail provider |
| Matrix | Matrix Handle (Kreuzschiene, Allegiant) |
| NetworkAdapterInfo | Information about a network adapter of a management server. |
| PredefinedPosition | Specifies a predefined position. |
| Recorder | Handle for recorders |
| RecordingInfo | Obsolete. Please use FindRecordings(Guid) |
| Relay | Relay Handle |
| RemoteClientApi | Establishes a remote connection to a OperatorClient. |
| RemoteServerApi | Establishes a remote connection to a Management Server. |
| Schedule | Handle for Schedule objects |
| SdkException | Base-class for all exception thrown by the SDK. |
| SdkHandle | Base for all SDK handle like classes. |
| Sequence | Handle for sequence objects. A handle of this type refers to a camera-sequence being currently displayed in an image pane or on an analog monitor. |
| SequenceSeed | Handle for sequence-seed objects. The SDK documentation denotes the definition of a camera-sequence in the configuration as "sequence seed". |
| SmsProvider | Obsolete. Handle for sms provider. This handle is not supported anymore. |
| Storage | A Device handle for an iSCSI storage device. |
| SystemTimeInfo | |
| TriggeredRecordingData | Information about a triggered recording. |
| UnauthorizedAccessSdkException | An exception thrown by SDK when the logged-on user does not have the necessary permission for the operation. |
| VirtualInput | VirtualInput Handle |
Structures| Structure | Description | |
|---|---|---|
 | ScheduleStateTransition | Represents an inmutable object which describes a state transition of the BVMS schedule. |
Interfaces| Interface | Description | |
|---|---|---|
 | IAccessSystemDoorManager | Provides methods for managing doors of an access system. |
| IAccessSystemReaderManager | Provides methods for managing credential-readers of an access system. |
| IAlarmConfigurationManager | This interface gives access to the currently active alarm settings in the BVMS configuration. |
| IAlarmManager | API for working with alarms. |
| IAnalogMonitorManager | API for working with analog monitors |
| IApplicationManager | Summary description for ILoginManager. |
| IAuditTrailManager | Interface provides access to configuration change Audit Trail management. Currently supports export of Audit Trail data through Server scriptlet only. |
| ICameraManager | Summary description for CameraManager. |
| IClientApi | Access to Client Api |
| ICompoundEventManager | ICompoundEventManager (This is really a ICompundDeviceManager, but we will keep consistent with the naming of the ConfigClient |
| IConfigurationManager | Interface that describes possible operations with BVMS configuration. |
| IContentManager | Summary description for IContentManager. |
| IDecoderManager | This interface provides methods for managing decoder devices, respectively the video streams, to be displayed on the monitors that are connected to decoder devices. Please note that Decoder handle does not refer to a decoder-device, but rather to a decoder monitor pane, which is displayed on a monitor that is connected to a decoder device. |
| IDeviceManager | IDeviceManager. |
| IDocumentManager | Summary description for IDocumentManager. |
| IDomeCameraManager | Summary description for IDomeCameraManager. |
| IEventManager | API for working with events. |
| IInputManager | Summary description for IInputManager. |
| IIntrusionPanelAreaManager | Provides methods for IntrusionPanel areas management |
| IIntrusionPanelDoorManager | Provides methods for IntrusionPanel doors management |
| IIntrusionPanelPointManager | Provides methods for IntrusionPanel points management |
| ILicenseChecker | Obsolete. interface for license checker |
| ILogbook | The interface ILogbook gives access to the system logbook of the video management system. |
| IMatrixManager | Manages Video Matrixes (Kreuzschienen, Allegiant) |
| IRecorderManager | Summary description for IRecorderManager |
| IRelayManager | Summary description for IRelayManager. |
| IScheduleManager | Summary description for IScheduleManager. |
| ISdkLogger | To be implemented by the Sdk user. Construction of RemoteServerApi, RemoteClientApi or RemoteClientApiEnterprise optionally allows specification of an instance of this interface in order to provide additional information for example in case of errors. |
| ISendMail | Methods for sending emails through several providers The default provider is currently the first provider found in the repository. |
| ISendManager | Methods for sending notifications by different protocols, including email and sms |
| ISendSms | Obsolete. Methods for sending SMS through several providers. The default provider is currently the first provider found in the repository. Methods provided by this interface are not working anymore. |
| ISequenceManager | This interface provides methods for discovering camera-sequences defined in the configuration (SequenceSeeds) and camera-sequences currently being displayed in image panes or on analog monitors (Sequences) and methods for controlling the display of sequences. |
| IServerApi | Access to Client Api. |
| IServerInformationManager | Interface that describes possible operations with ServerInformationManager such as GetVideoNetworkAdapterInfo, GetSoftwareVersion and GetProductName. |
 | IStorageManager | Allows to get Storages from BVMS configuration. |
| ISystemTimeManager | Summary description for ISystemTimeManager. |
| ITimelineManager | Interface for remoting the Timeline. |
| IVirtualInputManager | Summary description for IVirtualInputManager. |
Enumerations| Enumeration | Description | |
|---|---|---|
 | AccessSystemDoorContactState | State of a door-contact of an AccessSystemDoor. |
| AccessSystemDoorOperationMode | Operation mode of an AccessSystemDoor. For the meaning of the door operation modes see the documentation of the access control system. |
| AccessSystemDoorState | State of the lock of an AccessSystemDoor. |
| AlarmCameraDisplayOption | Options for displaying camera-related content in an alarm image pane. |
| AlarmImagePaneContentType | Specifies the content type to be displayed in an alarm image pane. |
| AlarmState | State of alarms. |
| AsfQuality | Quality values for ASF exports |
| AuditTrailFaultCode | Result of Audit Trail export. |
| CameraProtocolType | Filter by camera protocol. |
| ChangeStateResult | Result of an alarm state change. |
| ConnectionState | Describes the connection state of devices |
| DocumentType | type of a document. |
| ExportFormat | Format of video used for export: mp4, mov, native. |
| FilterAlarmType | Filter for the alarm types |
| InputState | Input state |
| IntrusionPanelDoorState | IntrusionPanel door state |
| IntrusionPanelPointStateValue | Values of an IntrusionPanelPoints state. |
| LogbookSearchResultCode | The final state of a logbook search |
| RecordingMode | Recording Mode |
| RecordingType | Recording type specification |
| RelayState | Relay state |
| ScheduleStateTransitionType | Type of the schedule state transition object |
| SystemInfoKind | Gets a value that indicates whether the system information represented by this instance belongs to Operator Client, Management Server or is not available. |