Versions Compared

Old Version 1

changes.mady.by.user Harvey Buchan

Saved on

compared with

New Version 2

changes.mady.by.user Harvey Buchan

Saved on

Key

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

Introduction

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

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

...

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

    • Parameters: layout index

...

Settings

Global

  • Triggers and Actions for the entire application.

  • Loaded on application start.

Workspace

  • Triggers and Actions for specific Workspaces.

  • Loaded per workspace

Session

  • Triggers and Actions for specific Sessions.

  • Loaded on Session load