Scripting Abilities > Scripting Commands

Currently, the following scripting commands and script sections are available:

Sections

[Header] - To specify the button text in different languages

[Description] - To explain the functionality of the script in different languages.

[Commands] - To specify the steps performed by the script

Commands

- No prefix

WaitFor - Ask script to wait:

WaitFor = <Seconds to wait>

EventList

EventList.CreateVideo – Create video in HMC from the current event list:

EventList. CreateVideo = Full|Cut, Markers all|none|select, Videos all|select

MMPlayer

MMPlayer.ShowCamera - Ask remote player to show one source and specify its audio state (default is off - write 'on').

MMPlayer.ShowCamera = Target MMPlayer name, Source name, audio state

MMPlayer.CloseAll - Ask remote player to close all video windows

MMPlayer.CloseAll = Target MMPlayer name

MMPlayer.ApplyLayout - Specify the layout that must be used to display the sources send.

MMPlayer.ApplyLayout = Target MMPlayer name, Layout name

Network

Network.Find - Force application to find all Mangold apps on the specified IP address:

Network.Find = IP Address

PTZ

PTZ.CallPreset – Call preset on all PTZ cameras in the current scenario:

PTZ.CallPreset = PTZ preset name

Scenario

Scenario.Open – Create a new recording session using the specified scenario with an optional session name:

Scenario.Open = Scenario name{, Session name}

Example: Scenario.Open = "Windows devices","Test record"

Scenario.Start – Start recording of the specified session:

Scenario.Start = Session name

Scenario.Stop – Stop recording of the specified session:

Scenario.Stop = Session name

Session

Session.Open – Open a recorded session for debriefing:

Session.Open = Session name

Show

Show.Message - Show message window on the screen that needs to be confirmed with OK:

Show.Message = Message text

Web

Web.ShowMedia - Ask the application to show media in the client browser:

Web.ShowMedia = Media ID, Viewer ID

Example Script

This example a predefined preset is called to position one or more cameras. Additionally, mulitple cameras are send to different viewing rooms.

[Header]

english = Window // name shown on the button if language is English.

deutsch = Fenster // name shown on the button if language is German

[Description]

english = Focus on the window. Show cameras Camera 1 and Camera 2 in the respective viewing rooms and apply the Window-Layout 'ProjectorView' to the viewer in viewing room 1.

deutsch = Auf dem Fenster fokussieren. Die Kameras abc und xyz im Mitschauraum anzeigen und für Mitschraum 1 das Fenster-Layout 'ProjektorView' anwenden.

[Commands]

PTZ.CallPreset = Window

MMPlayer.CloseAll = Viewing Room 1

MMPlayer.ShowCamera = Viewing Room 1, Camera 1, on

MMPlayer.ShowCamera = Viewing Room 1, Camera 2

WaitFor = 5

MMPlayer.ApplyLayout = Viewing Room 1, ProjectorView

MMPlayer.ShowCamera = Viewing Room 2, Camera 1, on

IMPORTANT: To set the audio state, you need VSP version 4 or up in combination with the MMP 4.4.1 or up.