Sign in

v1

latestOpenAPI 3.1.0MIT OR Apache-2.02026-07-17107151343.7 KB
flows

Trigger a scene transition on a compositor block.

Animates the transition between two inputs on a compositor/mixer block. Supported transition types:

  • cut: Instant switch (no animation)
  • fade: Cross-fade via alpha blending
  • slide_left: New input slides in from the right
  • slide_right: New input slides in from the left
  • slide_up: New input slides in from the bottom
  • slide_down: New input slides in from the top
post/api/flows/{flow_id}/blocks/{block_id}/transition

Path parameters

flow_idstring required

Flow ID (UUID)

block_idstring required

Block instance ID (e.g., 'comp_1')

Request body

duration_msinteger

Duration of the transition in milliseconds (ignored for "cut")

from_inputinteger required

Index of the currently active input (0-based)

to_inputinteger required

Index of the input to transition to (0-based)

transition_typestring

Type of transition: "cut", "fade", "slide_left", "slide_right", "slide_up", "slide_down"

Response

Transition triggered successfully

actual_transition_typestring required

The transition type that was actually executed. Differs from transition_type when the engine downgraded the request — e.g. Slide/Push across heterogeneous PiP/input sources downgrades to "fade".

duration_msinteger required

Duration of the transition in milliseconds

messagestring required

Success message

transition_typestring required

The transition type requested by the client.