EYeyevinn
flows

Take a stinger from PGM to PVW.

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

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 clip played must be this file (the entry at index, or the cued one); otherwise the take fails with 409.

indexinteger nullable

Playlist index to play. Defaults to the cued clip.

Response

Take started

downgraded_from'classic' | 'track_matte' | 'mask_only'

How a stinger switches the program beneath the clip.

duration_msinteger required
filestring required

The clip played.

indexinteger required
take_idinteger required

Identifies this take in StingerStarted, StingerCompleted and StingerFailed.

take_to_air_msnumber double required

Time from the request to the clip's first frame on air.

variant'classic' | 'track_matte' | 'mask_only' required

How a stinger switches the program beneath the clip.

Changes