Tool Catalog
The 39 tools VenturiServer exposes, grouped by area. All ids (media, timelines, clips, markers) are strings. Positions and lengths are integer timeline frames; only source_in/source_out are frames of the media.
- Non-mutating per
ToolCall::mutates, so never held during a user gesture:get_project,get_timeline,get_clip,get_markers,render_frame,get_audio_levels,export_status,cancel_export,get_state,screenshot_ui. Every other tool counts as mutating. - Deferred (answered after background work):
import_media,import_otio,render_frame,get_audio_levels.
Project
| Tool | Purpose |
|---|---|
get_project | Media pool, timelines, folders, file path, unsaved flag |
new_project | Replace the open project with an empty one |
open_project | Open a .vvproj file |
save_project | Save to path or the current file |
Import
| Tool | Purpose |
|---|---|
import_media | Add files to the pool; answers once probed, with ids and failures |
import_otio | Import the timelines of an OpenTimelineIO file with their media |
Timelines and tracks
| Tool | Purpose |
|---|---|
create_timeline | New timeline with V1 and A1; not an undo step |
get_timeline | Tracks, clips and markers in full |
add_track | Append a video or audio track |
set_track | Mute, solo or lock a track |
Clips
| Tool | Purpose |
|---|---|
get_clip | One clip with all its effect values and keyframes |
insert_clip | Overwrite a media range at a frame: video plus linked audio per stream |
split | Cut clips at a frame; right halves stay linked |
delete_clips | Delete clips, leaving gaps or rippling |
delete_ranges | Remove frame ranges across tracks, optionally ripple; ranges can be media frames |
move_clips | Move clips to a new start and/or track |
trim_clip | Move one edge of a clip |
set_clip_properties | Static opacity, transform, gain, fades, enabled, fill |
set_clip_color | Tag clips with a palette colour |
set_transition | Set or remove the transition on a clip edge |
link_clips | Group clips so they move together |
unlink_clips | Dissolve the link groups of the given clips |
Generated clips
| Tool | Purpose |
|---|---|
add_title | Text title on a video track |
add_solid_color | Solid colour clip on a video track |
add_adjustment_clip | Clip whose effects apply to everything below it |
Markers
| Tool | Purpose |
|---|---|
add_marker | Marker on a frame or range, with note and colour |
get_markers | List a timeline's markers |
edit_marker | Change position, duration, note or colour |
delete_marker | Remove a marker |
Inspection
| Tool | Purpose |
|---|---|
render_frame | One timeline frame as PNG, decoded exactly and composited like the export |
get_audio_levels | RMS and peak per frame window, of a media stream or the timeline mix |
Export
| Tool | Purpose |
|---|---|
export | Start a background export of a timeline or range; returns a job id |
export_status | State, frames written, elapsed time, error |
cancel_export | Stop an export; the partial file stays |
History
| Tool | Purpose |
|---|---|
undo | Undo the last step: an agent call or a user action |
redo | Redo the last undone step |
Editor window only
| Tool | Purpose |
|---|---|
get_state | Open timeline, playhead, user selection |
screenshot_ui | PNG of the whole window |
set_active_timeline | Show a timeline in the editor |
Headless, the editor-only tools return an error asking to attach to the window.
No comments to display
No comments to display