Types
The JSON shapes that requests carry and replies return.
Every field is camelCase. A field marked optional may be absent from a reply; a request may leave it out.
Replies
VersionInfoThe build and the contract it speaksEditorViewWhat every mutating call returnsProjectInfoEverything needed to reopen a projectStartedA job the API has begunWrittenA file the API wrotePictureA frame handed back without touching the diskJobStatusHow one job standsJobStateWhere a job is in its lifeDoneThe empty reply, an object so every reply is oneSettingsViewThe session's settings, as the window shows themDirsThe app's directories, as paths
Project and timeline
What project.get returns as project, and what project.document writes to concat.json. Every field is camelCase; a field marked optional may be absent from a reply, and a request may leave it out.
Clips
ClipOne placed piece of a timelineClipKindWhat a clip can be - wider thanMediaKindbecause a text clip has no file behind itClipPatchA partial update to one clipClipMoveWhere one clip is going, in a multi-clip moveTrimEdgeWhich end of a clip a trim dragsCropA cropStabilizeA clip's stabilizationEnhancedA clip's Enhance, once it has a copyTransitionA transition on the cut into a clipVoiceMixVoice isolation on a clip's soundVoiceKindThe two kinds of voice isolation, each its own model
Motion and keys
ClipMotionHow a clip comes on, goes off and moves in betweenMotionMoveAn entrance or an exitClipLoopA loop by name -pulse,heartbeat,float,wiggle,sway,jitter,spin,flicker,breathe- a lap everyseconds, atamount(1 as designed)ClipKeyOne user-set keyKeyPropertyWhich property a user-set key belongs toKeyEaseHow a key is approached from the one before itSpeedPointOne point of a speed curveParamKeyOne key on one parameter of an applied effect
Masks and cutouts
MaskOne of a clip's masksMaskModeHow a mask joins the masks above it in its clip's listMaskSourceWhat a mask is drawn fromMaskShapeWhich shape a clip's mask keepsCutoutHow a picture's background is taken away when there is no key colour to removeCutoutModeThe two ways a cutout decides what staysSubjectWhat a cutout keepsBrushToolThe four brushes of a custom cutoutStrokeOne brush stroke over a cutout
Titles
TextStyleA title's stylingTextRunA stretch of a title's words with a look of its ownRunStyleWhat a stretch of a title's words wears over the title's own lookTextAlignHow a title's lines sit within their block, and which point of the block the clip's position pinsTextCaseDisplay casing, independent of the editable source textCustomFontA font the user added from disk
Shapes
ShapeStyleHow a shape clip is paintedShapeKindWhich figure a shape clip drawsShapeGradientHow a shape's inside is coloured past its one colourShapeShadowA shadow under a shape - or, with no distance and a bright colour, a glow around itStrokeAlignWhere an outline sits on a figure's edgeStrokeDashThe outline's patternLineHeadWhat a line wears on an end
Media
MediaItemOne entry in the media binMediaKindWhat a piece of media isMediaOriginWhat made a media file, when it was the editor and not the user's importNewMediaA media item as probed by the host, before the model mints its idAudioTrackOne audio stream of a media file, as the probe reported itMediaSummaryWhatprobehands backVideoStreamInfoA video stream, as the UI sees itAudioStreamInfoAn audio stream, as the UI sees itColorRangeThe levels a media file's picture spans, when the person says so over whatever the file claimsColorSpaceThe colour a picture is in