Skip to content

Studio Script Reference: Bridge actions

These actions send messages and state to the host application via the Bridge data source.

context.actions.sendBridgeMessage()

Sends a custom event message to the host application.

Example:

js
context.actions.sendBridgeMessage({
  event: 'my-event',
  metadata: {
    score: 42
  }
});

context.actions.sendBridgeMute()

Sends a mute state to the host application's player.

Example:

js
context.actions.sendBridgeMute({ mute: true });

context.actions.sendBridgeSpeed()

Sends a playback speed to the host application's player.

Example:

js
context.actions.sendBridgeSpeed({ speed: 1.5 });

context.actions.sendBridgeState()

Sends a player state string to the host application.

Example:

js
context.actions.sendBridgeState({ state: 'playing' });

context.actions.sendBridgeTime()

Sends a timecode (in milliseconds) to the host application's player.

Example:

js
context.actions.sendBridgeTime({ timecode: 12500 });

context.actions.sendBridgeVideoScale()

Sends a video scale transform to the host application. All position values are normalized (0–1). Duration is in milliseconds.

Example:

js
context.actions.sendBridgeVideoScale({
  scaleX: 0.5,
  scaleY: 0.5,
  pivotX: 0.5,
  pivotY: 0.5,
  duration: 500
});

context.actions.sendBridgeVolume()

Sends a volume level (0–100) to the host application's player.

Example:

js
context.actions.sendBridgeVolume({ volume: 80 });