Studio Script Reference: General actions

context.actions.callFunction()

Programmatically calls a user-defined function.

Example:

context.actions.callFunction({
  function: 'dc61dc36-b0f4-4dc9-a9a8-7f4ec0088ac7',
  params: {
    myParam: 'value'
  }
});

context.actions.canvasDraw()

Triggers a draw call on a Canvas layer.

Example:

context.actions.canvasDraw({
  target: 'dc61dc36-b0f4-4dc9-a9a8-7f4ec0088ac7'
});

context.actions.cloudCapture()

Captures a screenshot of the target element during cloud rendering.

Example:

context.actions.cloudCapture({
  target: 'dc61dc36-b0f4-4dc9-a9a8-7f4ec0088ac7'
});

context.actions.openDebugger()

Opens the Ease Live debugger panel.

Example:

context.actions.openDebugger();

context.actions.openUrl()

Opens a URL in the browser. Not supported in cloud render contexts.

Example:

context.actions.openUrl({
  url: 'https://example.com'
});

context.actions.passDataToComponent()

Passes data into a Component layer.

Example:

context.actions.passDataToComponent({
  target: 'dc61dc36-b0f4-4dc9-a9a8-7f4ec0088ac7',
  data: {
    title: 'Hello world'
  }
});

context.actions.playTimeline()

Plays a timeline animation on a scene.

Inspector: General → Play animation

Example:

context.actions.playTimeline({
  target: 'dc61dc36-b0f4-4dc9-a9a8-7f4ec0088ac7',
  targetTimeline: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'
});

context.actions.setTimecodeSupport()

Enables or disables timecode support at runtime.

Example:

context.actions.setTimecodeSupport({ value: true });
context.actions.setTimecodeSupport({ value: false });

context.actions.subscribeToProgram()

Subscribes the overlay to a different program at runtime.

Example:

context.actions.subscribeToProgram({
  programId: 'e6c5b13a-2fd8-40e3-9d65-4d1062da075f',
  timecodeSupport: true
});