Triggers and Actions

The Triggers and Actions system allows users and integrators to create customisable experiences by defining events (Triggers) that initiate specific Actions. This documentation provides information on the different types of triggers, actions, and how to configure and manage them.

Key Features

• Customisable Triggers and Actions.

• Support for various trigger types:

  • Common Layer

  • Contextual Layer

  • Workspace

• Predefined action templates

• Global, Workspace and Session specific settings.

Triggers

Global ICE Triggers

• URI Message

  • Description: Configures an ICE API endpoint to be treated as a trigger

  • Parameters:

    • triggerName (String): The name of the trigger.

  • Example: ta/trigger?triggerName=triggerNameValue. See API Introduction for information on the ICE API

Common Layer Triggers

General

• Name

  • Description: Triggered when the name of the layer changes.

  • Parameters: Name

• Enabled

  • Description: Triggered when the enabled state of the layer changes.

  • Parameters: Enabled state toggle

Geometry

• Position

  • Description: Triggered when the layer's position changes.

  • Parameters: Position (X, Y)

Interaction

• Selected

  • Description: Triggered when the layer is selected.

• Deselected

  • Description: Triggered when the layer is deselected.

Contextual Layer Triggers

Video

• Playback State

  • Description: Responds to changes in the playback state of the video layer.

  • Parameters: State (playing, stopped, ended, paused)

• Playhead

  • Description: Triggered at specific playhead positions.

  • Parameters: Playhead normalised (0-1)

WebView

• URL

  • Description: Triggered when the URL of the WebView changes.

  • Parameters: URL

Home

• Layout Changed

  • Description: Triggered when the home layout changes.

  • Parameters: Layout name

Workspace Triggers

• Inactivity

  • Description: Triggered after a period of no user interaction.

  • Parameters: Duration in seconds

Trigger Setup

1. Browse Sources:

   • Navigate through the options in the "Sources" column. This column displays all available sources that can trigger events.

2. Select a Trigger Event:

   • When you select a source, the "Events" column will update to show all the trigger events available for the selected source.

   • Choose the desired trigger event from the "Events" column.

3. Configure Trigger Parameters:

   • After selecting a trigger event, the "Parameters" column will display the required options for that event.

   • Fill in the necessary parameters to define the conditions required for the Trigger to happen

Trigger Event Parameters

When setting up a trigger event, certain parameters may be required. Each parameter will have a specific value and a condition that must be met for the event to be triggered. Understanding these conditions is important for accurately configuring your triggers.

Available Conditions:

1. OnChanged

   • Description: The event will trigger whenever the parameter value changes.

   • Use Case: Useful for dynamic events, such as monitoring changes in a variable or property.

2. EqualTo

   • Description: The event will trigger when the parameter value is exactly equal to the specified value.

   • Use Case: Ideal for precise matching, such as triggering an action when a counter reaches a specific number.

3. NotEqualTo

   • Description: The event will trigger when the parameter value does not match the specified value.

   • Use Case: Suitable for excluding a specific condition, such as triggering an alert when a status is anything other than "OK".

4. LessThan

   • Description: The event will trigger when the parameter value is less than the specified value.

   • Use Case: Useful for threshold-based events

5. LessThanOrEqualTo

   • Description: The event will trigger when the parameter value is less than or equal to the specified value.

   • Use Case: Appropriate for inclusive thresholds, such as activating a feature when a counter is at or below a particular limit.

6. GreaterThan

   • Description: The event will trigger when the parameter value is greater than the specified value.

   • Use Case: Ideal for upper-bound thresholds, such as initiating a response when a video playhead exceeds a certain point in time.

7. GreaterThanOrEqualTo

   • Description: The event will trigger when the parameter value is greater than or equal to the specified value.

   • Use Case: Suitable for inclusive upper bounds, such as enabling a function when a level reaches or surpasses a target value.

Actions

Actions are grouped by devices, with ICE itself serving as a device for internal system actions. Additionally, other devices will be added in future versions. For instructions on configuring specific devices, refer to the corresponding device page. Currently available devices include:

• ICE: See Device - ICE

• DMX: See Device - DMX

Settings

Global

Global settings encompass Triggers and Actions that are active for the entire application, regardless of the specific workspace or session in use. These settings ensure that core functionalities are always available.

• Activation: Loaded on application start and remain active throughout the application's runtime.

Workspace

Workspace settings define Triggers and Actions specific to individual workspaces. These settings allow for customisation tailored to different environments within the ICE.

• Activation: Loaded when a workspace is opened and remain active while the workspace is in use.

• Deactivation: Removed when another workspace is opened

Session

Session settings apply to Triggers and Actions specific to individual sessions. These settings provide session-level customisation and are only active for the duration of the session.

• Activation: Loaded when a session is initiated and remain active only while that session is in use.

• Deactivation: removed when the session is cleared or another session is loaded