Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Customisable Triggers and Actions.

  • Support for various trigger types:

    • Common Layer

    • Contextual Layer

    • Workspace

  • Predefined action templates

  • Global, Workspace and Session specific settings.

...

image-20240710-154204.pngImage Added

Triggers

Common Layer Triggers

...

  • Inactivity

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

    • Parameters: Duration in seconds

Global Igloo Core Engine Triggers

  • URI Message

    • Description: Configures an Igloo Core Engine API endpoint to be treated as a trigger

    • Parameters:

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

    • Example: ta/trigger?triggerName=triggerNameValue. See Igloo Core Engine API for information on the Igloo Core Engine API

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

...

  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

ICE System Actions

  • Generic ICE Message

    • Description: Send an ICE API message, see the API docs for details

    • Parameters: ICE URI message

Workspace Actions

  • Clear Cookies

    • Description: Clears WebView cookies and refreshes and current WebView layers

  • Stereo 3D

    • Description: Sets the Stereo 3D enabled state of the Workspace

    • Parameters: enabled state

Layers List Actions

  • Clear Layers

    • Description: Clears all layers currently in the Workspace

  • Go Home

    • Description: Enabled the Home layer, equivalent to pressing the Home button

Common Layer Actions

  • Remove Layer

    • Description: Removes the layer from the workspace

  • Set Layer Position

    • Description: Sets the position of the Layer on the canvas

    • Parameters: Position (X, Y) in normalised coordinates (0-1)

  • Set Layer Scale

    • Description: Sets the scale of the Layer on the canvas

    • Parameters: Scale as a normalised value (0-1)

Contextual Layer Actions

Video

  • Play

    • Description: Sets the video to play

  • Pause

    • Description: Sets the video to pause

  • Set Playhead

    • Description: Sets the video to playhead to the specified parameter value

    • Parameters: Playhead normalised (0-1)

  • Set Volume

    • Description: Sets the videos volume to the specified parameter value

    • Parameters: volume (0-1)

Home

Set Active Layout

...

Description: Sets the Home layout to the specified parameter value

...

Actions are grouped by devices, with Igloo Core Engine 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:

...

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.

...

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

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

  • Deactivation: Removed when another workspace is opened

...