Studio Script Reference: Sceenic actions

These actions control the Sceenic video conferencing integration.

context.actions.sceenicConnect()

Connects to a Sceenic session using a token and display name.

Example:

context.actions.sceenicConnect({
  token: 'my-session-token',
  name: 'Carl'
});

context.actions.sceenicCreateGroup()

Creates a synchronized group session. Requires a token and a client name.

Example:

context.actions.sceenicCreateGroup({
  token: 'my-group-token',
  clientName: 'Host'
});

context.actions.sceenicDisableAudio()

Disables the local user's audio.

Example:

context.actions.sceenicDisableAudio();

context.actions.sceenicDisableVideo()

Disables the local user's video.

Example:

context.actions.sceenicDisableVideo();

context.actions.sceenicDisconnect()

Disconnects from the current Sceenic session.

Example:

context.actions.sceenicDisconnect();

context.actions.sceenicEnableAudio()

Enables the local user's audio.

Example:

context.actions.sceenicEnableAudio();

context.actions.sceenicEnableVideo()

Enables the local user's video.

Example:

context.actions.sceenicEnableVideo();

context.actions.sceenicGroupChangeVolume()

Changes the volume for all participants in the group.

Example:

context.actions.sceenicGroupChangeVolume({ volume: 80 }); // 0–100

context.actions.sceenicGroupMute()

Mutes all participants in the group.

Example:

context.actions.sceenicGroupMute();

context.actions.sceenicGroupPause()

Pauses synchronized playback for the group.

Example:

context.actions.sceenicGroupPause();

context.actions.sceenicGroupPlay()

Starts synchronized playback for the group.

Example:

context.actions.sceenicGroupPlay();

context.actions.sceenicGroupUnmute()

Unmutes all participants in the group.

Example:

context.actions.sceenicGroupUnmute();

context.actions.sceenicSetGroupPosition()

Sets the playback position for the group.

Example:

context.actions.sceenicSetGroupPosition({ position: 30000 }); // ms

context.actions.sceenicSetMediaQuality()

Sets the media quality for the Sceenic session. All fields are optional.

Example:

context.actions.sceenicSetMediaQuality({
  width: 1280,
  height: 720,
  frameRate: 30
});

context.actions.sceenicStartSynchronize()

Starts synchronized playback across all group participants.

Example:

context.actions.sceenicStartSynchronize();

context.actions.sceenicStopSynchronize()

Stops synchronized playback.

Example:

context.actions.sceenicStopSynchronize();

context.actions.sceenicToggleAudio()

Toggles the local user's audio on/off.

Example:

context.actions.sceenicToggleAudio();

context.actions.sceenicToggleVideo()

Toggles the local user's video on/off.

Example:

context.actions.sceenicToggleVideo();