EYeyevinn
flows

Trigger a scene transition on a compositor block.

Changed on

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

Request

  • The document declares no server URL.
  • Auth
    none declared

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 nullable

Index of the currently active input (0-based). Required, except for a "stinger", which always takes the vision mixer's PGM to its PVW.

stinger_clipinteger nullable

Stinger only (transition_type "stinger"): playlist index of the clip to play on the stinger source. Defaults to the cued clip. A stinger's length is the clip's, so duration_ms is ignored for it.

to_inputinteger nullable

Index of the input to transition to (0-based). Required, except for a "stinger".

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" — and reads "morph" when a PiP-aware take moved or re-cropped a source present on both sides instead of dissolving it. "morph" is a report only, not an accepted request type.

duration_msinteger required

Duration of the transition in milliseconds

messagestring required

Success message

transition_typestring required

The transition type requested by the client.

Changes

  • d13f12490670Revision changes
    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became optional

    • info

      the request property became optional

  • b680d9fbbba8Revision changes
    • info

      added the required property to the response with the status