Type

ClipPatch

A partial update to one clip. Every field optional; transitionIn and text are double-optional so "clear it" and "leave it alone" stay distinct on the wire (absent = untouched, null = cleared).

Fields

  • audioStreamintegeroptional

    Which of the media's audio streams the clip plays, by stream index: absent leaves it alone, null goes back to the file's first, a value names one. See Clip::audio_stream.

  • backgroundBackgroundoptional

    The clip's own background over the timeline's: absent leaves it alone, null goes back to following the timeline's, a value - black included - is the clip's own. See Clip::background.

  • blendstringoptional

    The blend mode's name; empty is normal.

  • cropCropoptional

    The crop, same three-way wire semantics as transitionIn: absent leaves it alone, null takes it off, a value replaces it.

  • fadeInnumberoptional

    New fade-in length in seconds, floored at 0.

  • fadeOutnumberoptional

    New fade-out length in seconds, floored at 0.

  • filtersAppliedFilter[]optional

    Wholesale replacement of the audio filter chain - the UI sends the full list, not a diff.

  • flipHbooloptional

    Mirror left to right.

  • flipVbooloptional

    Mirror top to bottom.

  • masksMask[]optional

    The masks, top first: absent leaves them alone, a list replaces them, empty takes them all off. Tidied on the way in; an empty or repeated id is minted anew. Each carries its own keys (setMaskKey).

  • motionClipMotionoptional

    The entrance, exit and loop, same three-way wire semantics as crop: absent leaves them alone, null takes them all off, a value replaces them, tidied on the way in.

  • mutedbooloptional

    Whether the clip's own sound is silenced: true mutes it, false lets it play again. A detach sets this on the video it took the sound from, so this is also how a video whose detached sound was later deleted gets its voice back.

  • namestringoptional

    New display name, taken verbatim. A later text patch overwrites it with the title's first line.

  • opacitynumberoptional

    New opacity, clamped into 0..=1.

  • preservePitchbooloptional

    New pitch-preservation setting, taken as sent.

  • shapeShapeStyleoptional

    A shape clip's figure and paint, whole: absent leaves it alone. Only a shape clip takes it.

  • textTextStyleoptional

    The title styling, same three-way wire semantics as transitionIn. Setting a style also renames the clip after its first line.

  • transitionInTransitionoptional

    The transition on the cut into the clip: absent leaves it alone, null clears it, a value replaces it.

  • videoEffectsAppliedFilter[]optional

    Wholesale replacement of the video effect chain, like filters.

  • volumenumberoptional

    New gain; floored at 0, deliberately not capped at 1 - boosting quiet footage is legitimate.