Type

Clip

A clip as project.get returns it. Fields with a default are left out of the JSON when they hold it.

Fields

  • audioStreamintegeroptional

    Which of the media's audio streams this clip plays, by the stream's index in the file - see MediaItem. None is the first in file order, which is every clip from before files with several were told apart and every clip of a file with one.

  • backgroundBackgroundoptional

    What fills the frame behind this clip's picture, over the timeline's Timeline: None follows the timeline's, and Some(Background::None) is black under a timeline that has one. Only a picture on the lowest picture lane has a background at all; see Timeline.

  • blendstringoptional

    How the picture's colour meets what is beneath it: "normal", "multiply", "screen", "add", "lighten", "darken".

  • cropCropoptional

    What is cut off each edge of the source before it is fitted, as fractions of the source's width and height.

  • cutoutCutoutoptional

    The background taken away by a mask rather than a key colour; see Cutout. Keying by colour is a package on videoEffects.

  • detachedFromstringoptional

    On a detached audio clip: the video clip the sound came from.

  • durationnumberoptional · default 1

    Seconds of timeline the clip occupies. Source seconds divided by speed; never below a sixtieth of a second.

  • enhancedEnhancedoptional

    The clip's Enhance: the media it was cut from and the enhanced copy of it, and which of the two it shows. Absent until Enhance has made a copy; switching it off shows the original again without running the model a second time.

  • fadeInnumberoptional · default 0

    Seconds of audio ramp-in from silence at the head. Zero for none.

  • fadeOutnumberoptional · default 0

    Seconds of audio ramp-out to silence at the tail. Zero for none.

  • filtersAppliedFilter[]optional

    Audio filters, in order - order is audible. On a sound layer, the chain it runs over the mix.

  • flipHbooloptional

    Mirrored left to right.

  • flipVbooloptional

    Mirrored top to bottom.

  • idstringoptional · default ""

    Minted by the editor ("c1", "c2", ...); how every command names its target. Survives splits - the head keeps the id - and merges.

  • keysClipKey[]optional

    The user's own keys, sorted by property and then by at. Empty is a clip whose properties are the constants above. A keyed property's keys travel absolutely: they replace the constant rather than ride on it.

  • kindClipKindoptional · default "video"

    What this clip renders as. Follows the media's kind, and is rewritten when a template slot is filled with a different kind of file.

  • masksMask[]optional

    The shapes that keep part of the picture, top first; see Mask.

  • mediaIdstringoptional · default ""

    Empty for a text clip, which has no file behind it.

  • motionClipMotionoptional

    How it comes on, goes off and moves in between; see ClipMotion.

  • mutedbooloptional

    True when a video clip's embedded audio is detached out of it.

  • namestringoptional · default "clip"

    Display label. Snapshotted from the media's name (or a title's first line) at creation, then the user's to change.

  • offsetXnumberoptional · default 0

    Offset from centred, as a fraction of frame width / height.

  • offsetYnumberoptional · default 0

    The vertical half of offsetX's pair; positive moves down.

  • opacitynumberoptional · default 1

    Blend strength over whatever is beneath, in 0..1.

  • preservePitchbooloptional · default true

    Keep voices at their natural pitch when speed is not 1. On by default; off gives the tape-machine chipmunk/slow-motion sound.

  • rotationnumberoptional · default 0

    Clockwise rotation in degrees, about the picture's centre.

  • scalenumberoptional · default 1

    Multiplier over the fitted size. 1 fills the frame, preserving aspect.

  • shapeShapeStyleoptional

    The figure, when this is a shape clip.

  • sourceStartnumberoptional · default 0

    In-point: how far into the media the clip starts.

  • speednumberoptional · default 1

    Playback rate. 1 is normal. With a curve set this is the curve's mean, kept in step by the commands that set either.

  • speedCurveSpeedPoint[]optional

    Speed as it changes over the clip: points of (at, speed), at a fraction of the clip's timeline length. None is the constant rate.

  • stabilizeStabilizeoptional

    The camera's shake taken out; see Stabilize. None is off.

  • startnumberoptional · default 0

    Seconds from the start of the timeline.

  • stretchXnumberoptional

    A multiplier on the fitted width beyond scale, for a picture pulled wider or narrower than its aspect; 1 keeps the aspect.

  • stretchYnumberoptional

    The same for the height.

  • textTextStyleoptional

    The overlay, when this is a text clip.

  • trackIdstringoptional · default ""

    The lane this clip sits on. Always a track of the same timeline; the reader drops clips whose track vanished.

  • transitionInTransitionoptional

    The transition on the cut into this clip, if any.

  • videoEffectsAppliedFilter[]optional

    Video effects, in order - the visual sibling of filters.

  • voiceVoiceMixoptional

    The voice in the clip's sound set apart from everything else, each at a level of its own; see VoiceMix. None plays it as recorded.

  • volumenumberoptional · default 1

    Linear gain, 1 being unity.

A clip fresh from addClip:

{
  "id": "c2",
  "trackId": "T1",
  "mediaId": "m1",
  "name": "take1.mp4",
  "kind": "video",
  "start": 0.0,
  "duration": 6.12,
  "sourceStart": 0.0,
  "volume": 1.0,
  "fadeIn": 0.0,
  "fadeOut": 0.0,
  "scale": 1.0,
  "offsetX": 0.0,
  "offsetY": 0.0,
  "rotation": 0.0,
  "opacity": 1.0,
  "speed": 1.0,
  "preservePitch": true,
  "filters": [],
  "videoEffects": []
}