flows

Add a clip to the stinger library (the stinger source's playlist). Adding a file already in the library returns it unchanged. Upload the file first with the media API when it is not on the server yet.

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

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 required

Path relative to the media directory (as the media API names files), an absolute path, or a URI.

Response

The clip, as it plays here

analysis_errorstring nullable

Why the clip's analysis failed, when it did. It is not retried until the file changes or the library is reloaded.

cut_point_msinteger nullable

Effective cut point for a classic take.

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

How a stinger switches the program beneath the clip.

filestring required

Playlist entry (path or URI).

indexinteger required

Playlist index on the stinger source.

missingboolean

The clip's file is not on disk (deleted or renamed since it was added). Only a local file can be missing.

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

How a stinger switches the program beneath the clip.

Changes