Developer
Log in

Actions

Transitions

6 actions in the Transitions group. Each is its own JSON-RPC method, and also runs through action.run.

transition.setSet the transition

Sets the transition a scene switch plays (unless the incoming scene has its own), how long it takes and whether it plays reversed, as the transition picker, duration and Reverse next to Take do. Give a type, the name of a saved transition, a duration, reverse, or any of them together.

Keyscope: control

Parameters

  • transitiontextoptional

    A type (cut, fade, fade_to_color, slide, swipe, luma_wipe, move) or an effect (zoom_in, zoom_out, blur, spin_blur, pixelate, swirl, ripple, glitch, dissolve, directional_wipe, clock_wipe, iris, barn_doors, blinds, checkerboard, page_curl, cube, flip, luma_burn, sliding_bars, color_shift) with its usual settings, a pack transition by its word, pack: and its id (pack:cube; the transitions topic's pack lists them), or the name of a saved transition (a stinger or a custom shader is used by its saved name). Left out, the type stays.

    Up to 120 characters

  • duration_msintegeroptional

    How long it takes. Left out, a type keeps the current duration and a saved transition its own. A stinger lasts as long as its video.

    0 to 20000 ms

  • reversebooloptional

    Play it backward with its pictures swapped: it still goes from the scene on air to the next, its motion the other way. A cut, a stinger and a move ignore it. Left out, it stays as it is.

Result

  • transitionTransitionSummaryalways

    The default transition now.

    Fields of transition
    • duration_msintegeralways

      How long it takes; a stinger lasts as long as its video.

    • namestringalways

      Its saved name, else its type's (or effect's, or pack transition's) name.

    • reversebooleanalways

      Whether it plays backward with its pictures swapped.

    • typestringalways

      cut, fade, fade_to_color, slide, swipe, luma_wipe, move, effect, shader, pack or stinger.

Live state

transitions.default_name string

The name of the transition a switch plays. From the transitions topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "transition.set"
}

In the SDKs

C#
Task<TransitionSetResult> TransitionSetAsync(CancellationToken cancellationToken = default)
Python
async def transition_set(self, *, duration_ms: int | None = None, reverse: bool | None = None, transition: str | None = None) -> TransitionSetResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "duration_ms": {
        "description": "How long it takes. Left out, a type keeps the current duration and a saved transition its own. A stinger lasts as long as its video.",
        "maximum": 20000,
        "minimum": 0,
        "type": "integer"
      },
      "reverse": {
        "description": "Play it backward with its pictures swapped: it still goes from the scene on air to the next, its motion the other way. A cut, a stinger and a move ignore it. Left out, it stays as it is.",
        "type": "boolean"
      },
      "transition": {
        "description": "A type (cut, fade, fade_to_color, slide, swipe, luma_wipe, move) or an effect (zoom_in, zoom_out, blur, spin_blur, pixelate, swirl, ripple, glitch, dissolve, directional_wipe, clock_wipe, iris, barn_doors, blinds, checkerboard, page_curl, cube, flip, luma_burn, sliding_bars, color_shift) with its usual settings, a pack transition by its word, pack: and its id (pack:cube; the transitions topic's pack lists them), or the name of a saved transition (a stinger or a custom shader is used by its saved name). Left out, the type stays.",
        "maxLength": 120,
        "type": "string"
      }
    },
    "required": [],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "transition": {
        "additionalProperties": false,
        "description": "The default transition now.",
        "properties": {
          "duration_ms": {
            "description": "How long it takes; a stinger lasts as long as its video.",
            "type": "integer"
          },
          "name": {
            "description": "Its saved name, else its type's (or effect's, or pack transition's) name.",
            "type": "string"
          },
          "reverse": {
            "description": "Whether it plays backward with its pictures swapped.",
            "type": "boolean"
          },
          "type": {
            "description": "cut, fade, fade_to_color, slide, swipe, luma_wipe, move, effect, shader, pack or stinger.",
            "type": "string"
          }
        },
        "required": [
          "type",
          "name",
          "duration_ms",
          "reverse"
        ],
        "title": "TransitionSummary",
        "type": "object"
      }
    },
    "required": [
      "transition"
    ],
    "type": "object"
  }
}

transition.waitWait until the transition finishes

Answers once the scene transition playing now has finished (after a moment's look when none is playing, so a switch sent just before is waited for). A controller holds the presses after it until then: switch, wait, then show a layer.

Keyscope: control

Parameters

None. Leave params out.

Result

  • playedbooleanalways

    Whether a transition played while it waited.

  • waited_msintegeralways

    How long it waited.

Live state

transitions.in_progress bool

On while a transition plays. From the transitions topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "transition.wait"
}

In the SDKs

C#
Task<TransitionWaitResult> TransitionWaitAsync(CancellationToken cancellationToken = default)
TypeScript
transitionWait(): Promise<TransitionWaitResult>
Python
async def transition_wait(self) -> TransitionWaitResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {},
    "required": [],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "played": {
        "description": "Whether a transition played while it waited.",
        "type": "boolean"
      },
      "waited_ms": {
        "description": "How long it waited.",
        "type": "integer"
      }
    },
    "required": [
      "waited_ms",
      "played"
    ],
    "type": "object"
  }
}

scene.transition_overrideSet a scene's transition

Sets the transition that plays whenever a scene comes on air (its "transition into this scene"), in place of the default; "default" clears it.

Keyscope: manage

Parameters

  • scenescenerequired

    The scene. Give its id or name.

    Choices in scenes

  • transitiontextoptional

    A type (cut, fade, fade_to_color, slide, swipe, luma_wipe, move), an effect (as for transition.set), a pack transition (pack:cube, as for transition.set), the name of a saved transition, or "default" to clear the scene's own. Left out with a duration or reverse, the scene's own (or the default's) type stays.

    Up to 120 characters

  • duration_msintegeroptional

    How long it takes.

    0 to 20000 ms

  • reversebooloptional

    Play it backward with its pictures swapped (as for transition.set).

Result

  • scenestring (uuid)always

    The scene's id.

  • transitionTransitionSummaryalwayscan be null

    Its own transition now; null when the default plays.

    Fields of transition
    • duration_msintegeralways

      How long it takes; a stinger lasts as long as its video.

    • namestringalways

      Its saved name, else its type's (or effect's, or pack transition's) name.

    • reversebooleanalways

      Whether it plays backward with its pictures swapped.

    • typestringalways

      cut, fade, fade_to_color, slide, swipe, luma_wipe, move, effect, shader, pack or stinger.

Live state

scenes.items[scene].transition object

The scene's own transition ({type, name, duration_ms, reverse}), or null while the default plays. From the scenes topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "scene.transition_override",
  "params": {
    "scene": "<scene id or name>"
  }
}

In the SDKs

C#
Task<SceneTransitionOverrideResult> SceneTransitionOverrideAsync(SceneTransitionOverrideParams parameters, CancellationToken cancellationToken = default)
TypeScript
sceneTransitionOverride(params: SceneTransitionOverrideParams): Promise<SceneTransitionOverrideResult>
Python
async def scene_transition_override(self, *, scene: str, duration_ms: int | None = None, reverse: bool | None = None, transition: str | None = None) -> SceneTransitionOverrideResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "duration_ms": {
        "description": "How long it takes.",
        "maximum": 20000,
        "minimum": 0,
        "type": "integer"
      },
      "reverse": {
        "description": "Play it backward with its pictures swapped (as for transition.set).",
        "type": "boolean"
      },
      "scene": {
        "description": "The scene. Give its id or name.",
        "minLength": 1,
        "type": "string"
      },
      "transition": {
        "description": "A type (cut, fade, fade_to_color, slide, swipe, luma_wipe, move), an effect (as for transition.set), a pack transition (pack:cube, as for transition.set), the name of a saved transition, or \"default\" to clear the scene's own. Left out with a duration or reverse, the scene's own (or the default's) type stays.",
        "maxLength": 120,
        "type": "string"
      }
    },
    "required": [
      "scene"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "scene": {
        "description": "The scene's id.",
        "format": "uuid",
        "type": "string"
      },
      "transition": {
        "additionalProperties": false,
        "description": "Its own transition now; null when the default plays.",
        "properties": {
          "duration_ms": {
            "description": "How long it takes; a stinger lasts as long as its video.",
            "type": "integer"
          },
          "name": {
            "description": "Its saved name, else its type's (or effect's, or pack transition's) name.",
            "type": "string"
          },
          "reverse": {
            "description": "Whether it plays backward with its pictures swapped.",
            "type": "boolean"
          },
          "type": {
            "description": "cut, fade, fade_to_color, slide, swipe, luma_wipe, move, effect, shader, pack or stinger.",
            "type": "string"
          }
        },
        "required": [
          "type",
          "name",
          "duration_ms",
          "reverse"
        ],
        "title": "TransitionSummary",
        "type": [
          "object",
          "null"
        ]
      }
    },
    "required": [
      "scene",
      "transition"
    ],
    "type": "object"
  }
}

studio.modeStudio mode

Turns studio mode on, off, or the other way: on, a preview scene sits next to what's on air, edits happen there, and Take puts it on air with the transition. Turning it on previews the scene on air.

Keyscope: control

Parameters

  • modechoiceoptional

    On, off, or toggle.

    One of on off toggle · Default "toggle"

Result

  • studio_modebooleanalways

Live state

transitions.studio_mode bool

On while studio mode is on. From the transitions topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "studio.mode"
}

In the SDKs

C#
Task<StudioModeResult> StudioModeAsync(CancellationToken cancellationToken = default)
Python
async def studio_mode(self, *, mode: StudioModeMode | None = None) -> StudioModeResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "mode": {
        "default": "toggle",
        "description": "On, off, or toggle.",
        "enum": [
          "on",
          "off",
          "toggle"
        ],
        "type": "string"
      }
    },
    "required": [],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "studio_mode": {
        "type": "boolean"
      }
    },
    "required": [
      "studio_mode"
    ],
    "type": "object"
  }
}

scene.previewPreview a scene

Puts a scene in studio mode's preview, for the next Take (turning studio mode on if it's off). What's on air doesn't change.

Keyscope: control

Parameters

  • scenescenerequired

    The scene to preview. Give its id or name.

    Choices in scenes

Result

  • namestringalwayscan be null
  • previewstring (uuid)always

    The id of the scene in preview.

  • studio_modebooleanalways

    Always true: previewing turns studio mode on.

Live state

transitions.preview == scene bool

On while this scene is in preview. From the transitions topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "scene.preview",
  "params": {
    "scene": "<scene id or name>"
  }
}

In the SDKs

C#
Task<ScenePreviewResult> ScenePreviewAsync(ScenePreviewParams parameters, CancellationToken cancellationToken = default)
TypeScript
scenePreview(params: ScenePreviewParams): Promise<ScenePreviewResult>
Python
async def scene_preview(self, *, scene: str) -> ScenePreviewResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "scene": {
        "description": "The scene to preview. Give its id or name.",
        "minLength": 1,
        "type": "string"
      }
    },
    "required": [
      "scene"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "name": {
        "type": [
          "string",
          "null"
        ]
      },
      "preview": {
        "description": "The id of the scene in preview.",
        "format": "uuid",
        "type": "string"
      },
      "studio_mode": {
        "description": "Always true: previewing turns studio mode on.",
        "type": "boolean"
      }
    },
    "required": [
      "preview",
      "name",
      "studio_mode"
    ],
    "type": "object"
  }
}

studio.takeTake

In studio mode, puts the preview scene on air with the transition into it; what was on air becomes the preview, so a second Take goes back.

Keyscope: control

Parameters

None. Leave params out.

Result

  • programstring (uuid)always

    The id of the scene now on air.

  • transitionTransitionSummaryalways

    The transition it plays.

    Fields of transition
    • duration_msintegeralways

      How long it takes; a stinger lasts as long as its video.

    • namestringalways

      Its saved name, else its type's (or effect's, or pack transition's) name.

    • reversebooleanalways

      Whether it plays backward with its pictures swapped.

    • typestringalways

      cut, fade, fade_to_color, slide, swipe, luma_wipe, move, effect, shader, pack or stinger.

Live state

transitions.in_progress bool

On while a transition plays. From the transitions topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "studio.take"
}

In the SDKs

C#
Task<StudioTakeResult> StudioTakeAsync(CancellationToken cancellationToken = default)
TypeScript
studioTake(): Promise<StudioTakeResult>
Python
async def studio_take(self) -> StudioTakeResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {},
    "required": [],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "program": {
        "description": "The id of the scene now on air.",
        "format": "uuid",
        "type": "string"
      },
      "transition": {
        "additionalProperties": false,
        "description": "The transition it plays.",
        "properties": {
          "duration_ms": {
            "description": "How long it takes; a stinger lasts as long as its video.",
            "type": "integer"
          },
          "name": {
            "description": "Its saved name, else its type's (or effect's, or pack transition's) name.",
            "type": "string"
          },
          "reverse": {
            "description": "Whether it plays backward with its pictures swapped.",
            "type": "boolean"
          },
          "type": {
            "description": "cut, fade, fade_to_color, slide, swipe, luma_wipe, move, effect, shader, pack or stinger.",
            "type": "string"
          }
        },
        "required": [
          "type",
          "name",
          "duration_ms",
          "reverse"
        ],
        "title": "TransitionSummary",
        "type": "object"
      }
    },
    "required": [
      "program",
      "transition"
    ],
    "type": "object"
  }
}

to open · ↑ ↓ to move · Esc to close