Read an object track
read_trackRead an object track: its corners and box on each frame in any space (source pixels by default, or film, film_norm, clip), each frame's state (tracked, carried, lost) and quality score, and the track's quality verdict with its flagged ranges, e.g. "top right corner drifts off the surface from 4.30s". Use it to see which frames to fix before you pin to a track, and after a fix. Free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| range | Yes | [from, to] seconds to read (atSpace says what they are). null reads the whole track. | |
| space | Yes | The space of the corners in the answer. null or source: pixels of the asset. source_norm: 0 to 1 of the asset. film: scene pixels from the frame's centre. film_tl: scene pixels from its top left. film_norm: 0 to 1 of the frame. clip: the clip's own picture. Film spaces need a clip that plays the asset at that second; a frame no clip shows has source corners only. | |
| clipId | Yes | The film clip that plays this asset, when space or atSpace needs one and several clips play it. null picks the clip that shows the asset at that time. | |
| detail | Yes | How many frames the answer lists: brief lists 12, normal (null) 60, full every frame up to 600 with each frame's quality reasons. Frames are picked evenly over the range, and the first frame of each flagged range is always listed. | |
| atSpace | Yes | What this call's times are. null or source: seconds into the asset file. timeline: seconds of the film, read through the clip that plays the asset then (clipId to pick one). | |
| trackId | Yes | The object track id, as the tracking tool printed it or search_assets lists it (objectTracks). | |
| projectId | Yes | The project this call runs on without changing the open project. null (or leaving it out) uses the open project. wait_for_jobs takes the projectId of the calls that started the jobs. |