Skip to content

Reference

Command catalogue

Every editing command a batch can contain, with its scope and phase.

Last updated:

An edit call is a list of operations; each operation is one of these commands. Each page has the arguments, an example and the errors.

CommandSummaryScopePhase
asset.removeRemoves an asset that no item uses.mediaalpha
audio.addPlaces an audio asset, or the audio of a video asset, on an audio track.editalpha
audio.duckLowers a music item while speech sounds, with a ramp down before and a ramp up after.editbeta
audio.mark_beatsWrites markers on a music item at the beats of its audio.editbeta
caption.addAdds a caption item with timed words.editprototype
caption.edit_wordChanges the text of one word of a caption, or removes the word.editalpha
caption.from_transcriptCreates captions for the speech of a clip from its transcript.editalpha
caption.mergeJoins two captions of one track into one that spans both.editalpha
caption.retime_from_clipRetimes the captions linked to a clip after the clip was moved, trimmed or sped up.editalpha
caption.set_breaksSets the forced line breaks of a caption.editalpha
caption.set_styleSets or clears the style override of one caption.editalpha
caption.set_wordsReplaces the words of a caption.editalpha
caption.splitSplits a caption into two at a word boundary.editalpha
clip.addPlaces a video or image asset on a visual track.editprototype
clip.remove_silencesCuts the silent stretches out of a clip, leaving one clip per stretch of speech.editalpha
clip.set_blurSets the blur radius of a clip.editbeta
clip.set_colorSets the brightness, contrast and saturation of a clip.editalpha
clip.set_filterSets the colour filter of a clip and how much of it is mixed in.editbeta
clip.set_framingSets how the asset of a clip is fitted into the frame and how much of each side is cropped.editalpha
clip.set_speedChanges the speed of a clip or audio item while keeping the same source range.editalpha
font.addAdds a user font family to the project, or more weights to one it already has.mediabeta
font.removeRemoves a user font family from the project.mediabeta
item.crossfadeSets a matching fade-out and fade-in on two overlapping visual items of different tracks.editalpha
item.deleteRemoves items, and optionally closes the freed space.editprototype
item.duplicateCopies an item to another position, optionally on another track.editalpha
item.moveMoves an item in time, to another track of the same kind, or both.editprototype
item.renameSets the label of an item.editalpha
item.set_audioSets the volume, the fades or the mute flag of a clip or audio item.editalpha
item.set_transformSets the position, scale, rotation or opacity of a visual item.editalpha
item.set_transitionSets or removes the transition on one edge of a visual item.editalpha
item.splitSplits an item into two at a timeline frame.editprototype
item.trimMoves the start edge or the end edge of an item to a timeline position.editprototype
keyframe.clearRemoves all keyframes of one property, or of every property.editalpha
keyframe.removeRemoves the keyframe of a property at a frame.editalpha
keyframe.setAdds or replaces a keyframe of one animated property of an item.editalpha
project.renameSets the project name.editprototype
settings.setSets the frame size, the background colour or the loudness target.editprototype
settings.set_fpsChanges the project frame rate and rescales every time quantity.editalpha
shape.addAdds a rectangle, rounded rectangle or ellipse to a visual track.editalpha
shape.setChanges the shape, size, colours, stroke or radius of a shape item.editalpha
slot.fillFills a template slot with media, text or caption words.editalpha
slot.markMarks an item as a template slot.editalpha
slot.unmarkRemoves the slot marking of an item.editalpha
template.set_infoSets the description and the named colours of the template.editalpha
text.addAdds a text item to a visual track.editprototype
text.apply_presetAnimates one edge of a visual item with a named preset.editalpha
text.setChanges the content or the style of a text item.editprototype
timeline.close_gapCloses the empty range that contains a given frame on a track.editalpha
track.addAdds an empty track at a place in the track order.editprototype
track.moveChanges the place of a track in the track order.editprototype
track.removeRemoves a track, and its items when with_items is true.editprototype
track.set_caption_styleMerges a partial caption style into a track, or replaces it.editprototype
track.updateSets the name, the hidden flag or the muted flag of a track.editprototype