EYeyevinn
flows

Cue a stinger clip: load it and park it on its first frame, so a take starts it without delay.

Changed on
post/api/flows/{flow_id}/blocks/{block_id}/stinger/cue

Request

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

Path parameters

flow_idstring required

Flow ID (UUID)

block_idstring required

Vision mixer block instance ID

Request body

filestring nullable

When set, the playlist entry at index must be this file; a library changed by someone else since the client read it fails with 409.

indexinteger required

Playlist index on the stinger source.

Response

Clip cued; the stinger state after the cue

cued_indexinteger nullable

The clip a take plays when it names none.

last_cue_msinteger nullable

How long the last cue took.

matte_supportedboolean required

Whether the matte variants run here (GPU mixer).

preroll_msinteger required

Take-to-air delay.

problemstring nullable

Why stingers cannot run, when they cannot.

readyboolean required

The cued clip is loaded and parked on its first frame.

runningboolean required

A take is on air.

source_block_idstring nullable

The Media Player wired to the stinger input.

Changes