List of tested BVMS Scripts (Simple scriplets examples)

This article contains the overview of tested BVMS scripts. Select the one of interest for you:

No.	📚 Simple scriplets examples	Description
1	What is the SDK functionality in Bosch Video Management System and how to create a scriptlet?	This article will provide a basic explanation and simple examples of the interfacing (scripting, calling functions by external applications) functionality in Bosch Video Management System. Also, this article contains the BVMS SDK Help files.
2	How to run external executable within BVMS SDK scriplet?	-
3	Creating a scriptlet	This section provides a step-by-step guide on how to design and implement scriptlets to enhance system functionality. It covers key concepts such as understanding the BVMS scriptlet editor, writing scripts and testing the scriptlet within the BVMS environment.
4	How to configure (copy-paste) an example scriplet in BVMS Configuration Client?	You can create a Command Script using the following scripting languages: C# http://VB.Net You cannot change the scripting language of an existing Command Script. You can create a Client Script or a Server Script. You can add multiple scriptlets to every script.
5	Use a Hardware decoder and show an OSD-Message	Display a string on the decoder using the decoder manager
6	Open and close a relay	This scriptlet opens and closes a specific relay. This scriptlet is meant to be used in a server script
7	Toggle a set of relays	This scriptlet toggles a set of relays based on each relay state. Open relays are closed and vice versa.
8	A scriptlet with a switch case block	In this example a server scriptlet is presented which switches different sets of relays in dependency of an argument string. In this special case we use the event arguments (“e”) which provide for example the device name (“e.DeviceName”). Take motion detection as the event that triggers this script. If “Camera 1” triggers then the script does that, if “Camera 2” triggers it does something else, and so on… In the switch case block you define the different behaviors per option. The default behavior can be set in the default block, E.g. in the default case don’t do anything.
9	Fill a monitor with cameras 1-9	This example uses the client script API. It changes the layout on the client and fills the image panes with different cameras.
10	If an input is “on” then reposition a dome camera	This example is just one command, using an if-construct and the command to reposition a dome camera. Here the camera is found by logical number.
11	Remote connection with Exception Handler	Use “ConnectToServerApi()” to connect remotely to a Bosch VMS client or server. The connection commands are protected with try/catch blocks, so that the application does not crash if the connection to the Remote API fails.
12	Control Operator Client in response to a Virtual Input Data event and read out the data	This example shows you how to react within the Operator client on a certain event (e.g. by opening a dedicated cameo).. An executable reads out the EventData and switches through the Virtual Input Data field one. Different data causes different reactions. The default block defines the behavior if the value is not matching or unknown.
13	Change the Decoder Layout with BVMS SDK script	It is not a working script, that can be used directly. Follow the instructions in comments of the script to tailor it for your use.
14	BVMS SDK scriplet to receive and react on server events	Expected result: Control Operator Client, whenever a Virtual Input changes state (either ON->OFF or vice-versa). Example: When Virtual Input (any) is open- some action follows in Op Client OR When Virtual Input (any) is closed, some action follows
15	How to enable & disable audio recording for a specific camera using Virtual Input in BVMS	This is just an example how to start and stop an audio recording of a camera on particular BVMS event that trigger scriplets. Any event could be used. For example Operator Client Event Buttons, can be used, when the requirement is that the operator should be able to start and stop recording from Operator Client.
16	How is the example script to set Operator Client in full screen mode & favorites loaded on startup?	In order for BVMS Operator Client to start in full screen mode and load default favorites, use this example scriplet that turns full screen mode and creates and displays a simple favorites of one camera.