Automations and Scripts

Reeltime Pro allows you to automatically trigger a video routing configuration or run a script based on a specific event.

Managing automations

You can create and manage automations in the Automation Manager window. Choose “Automation Manager…” from the application menu to open the Automation Manager window.

Automation Manager with configured automations to trigger video routing configurations

By clicking the “+” button below the automations table you can add a new automation. By clicking the “-“ button you can remove the selected automation. By clicking “Edit…” you can modify the selected automation.

Adding an automation

Setting up an automation

When clicking “+” below the automations table of the Automation Manager, a panel is opened that lets you choose

  • the event, that shall trigger the event, and
  • the action, that shall be performed when the event happens.

Available events:

  • Switch to Input Slot: Choose one of the options to trigger an action when the user switches to a specific device slot, the library slot, or if any slot change occurs (“Any”).

 

 

 

  • Recording: Chose one of the start or stop events for recording in individual or any slot.
  • Application: Choose one of the options to trigger an action when the application started or is going to quit, or goes to foreground or background.

Available actions:

  • Slots: Choose one of the actions with slots such as switching viewing modes, refreshing framegrabs, or locking external control panels.
  • View: Choose one of the actions for configuring the user interface, such as showing or hiding scopes, configuring the slot appearance, or enable or disable dim mode.
  • Video Routing Configurations: Choose one of the saved video routing configurations to apply the configuration, or create a new configuration.
  • Video Capture Device: Chose a configure capture device to move it to the current slot. This can be used to use one capture device for multiple slots together using video routing configurations.
  • Scripts: Choose one of the installed and executable scripts. See Scripts and Automation for more details on scripts.

Click “Add” to save the new automation. If the automation is enabled, the chosen action will be triggered automatically when the selected event occurs.

Enabling and disabling automations

You can enable and disable single automations by checking the checkbox besides the automation in the automation table.

You can completely disable automations by clicking the automations button in the bottom bar of Livegrade’s main window. Please note that the automations button is only shown, if at least one automation is configured.

Event and action logging and error

In the bottom bar of Livegrade’s main window the automation button indicates when an action has been triggered by switching to a blue icon if a n action has been triggered successfully.

You can click on the automation button to disable all automation temporarily.

If an action failed (e.g. because a video routing setting cannot be applied), the automation button indicates this with a yellow icon. The tooltip of the automation button shows additional information about the failed automation.

A complete log of all automation can be reviewed in the “Event Log” tab of the automation manager. Successful automations, but also error messages of failed actions are displayed there. The event log is cleared when the application quits, so you only see log entries of automations since the last start of the application.

 

The application comes with the capability to run scripts from within the application. Scripts can be run manually (e.g. via keyboard shortcuts), or automated (via the Automation Manager).

The application provides environment variables to pass information of the current state of the application (e.g. current slot name, currently selected folder name) to the script.

Installing Scripts

You can use any script that is executable in Terminal. The script language is only limited by the available interpreters on your computer. macOS comes with most common interpreters pre-installed (e.g. Python, perl, Bash, ruby), but you can also install you own interpreters (e.g. Lua).

In order to be usable by the application, scripts need to be

  • installed in the Scripts folder in ~/Library/Application Support/Pomfort/LivegradeStudio5/and
  • have the executable-flag set.

You can open the Scripts folder by choosing “Show in Finder…” in the “Scripts” submenu of the application menu. Move any scripts to this folder.

For a script file to be executable by the application, the executable flag must be set for that script file in the file system. You can use the Terminal to set the executable flag:

$ cd “~/Library/Application Support/Pomfort/LivegradeStudio5/Scripts”
$ chmod +x MY-CUSTOM.SCRIPT

All scripts also need to start with a Shebang with an interpreter directive (e.g. #!/usr/bin/ruby ) so that the application knows what interpreter to use in order to run the script.

Running Scripts

Installed scripts that have the executable flag set will show up in the “Scripts” submenu of the application menu.

You can run these scripts manually by choosing the menu entry for a scripts.

You can assign keyboard shortcuts to run these scripts with the Keyboard Shortcuts manager .

You can assign MIDI events to run these scripts with the MIDI mapper.

Automating Scripts

You can let the application run scripts automatically on certain events by configuring script actions in the Automation Manager.

Example Script and Environment Variables

If the Scripts folder doesn’t contain executable scripts (e.g. on first start of the application), a sample shell script is installed in the Scripts folder, that illustrates the use of the environment variables.

You can inspect the script by choosing “Show in Finder…” in the “Scripts” submenu of the application menu.

Debugging Scripts

You can see the output of a script in the Automation Manager’s “Logs” tab – no matter of the script has been run manually or through automation.

The log shows both the standard output pipe and the standard error pipe.

The event log is cleared when the application quits, so you only see log entries of automations since the last start of the application.

If a script doesn’t exit with exit code “0” (which is the default exit code), the application plays the system beep.