addAnnotation
Add text callouts, arrows, or blur masks over a span of an edited video timeline to label moments or hide private details.
Instructions
Add an annotation over a span of the edited timeline (virtual seconds). type picks what it is: 'text' (the default) for callouts, labels and titles; 'figure' for an arrow pointing at something; 'blur' for a privacy mask that blurs or pixelates what is under it, the way to hide an email address, a token, a password field or any private detail the recording shows. Image annotations are not available here: they need a file, added in the editor. x/y place the centre, 0–100 percent of the annotation's box (default the centre). Text and arrows sit on the output frame, the whole picture padding included, as the editor places them: zooms and padding never move them. A blur sits on the recording's picture instead, so x/y/width/height are percent of the recording and it stays on what it hides when padding or a zoom moves the picture. A text box is sized to its words and kept inside the frame; it is drawn on a dark plate by default, and fontSize, color, background, bold and animation set its look. An arrow or a blur takes width/height (default 30 × 20) and its own data: figureData {arrowDirection, color, strokeWidth} for an arrow, blurData {type 'blur' or 'mosaic', shape 'rectangle' or 'oval', color, intensity, blockSize} for a blur. The result reads the annotation back as getCurrentDocument reports it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | No | ||
| y | No | ||
| bold | No | ||
| text | No | ||
| type | No | text: words on the frame. figure: an arrow. blur: a privacy mask that blurs or pixelates what is under it, such as an email address or a token on screen. | text |
| color | No | Text colour, a CSS colour such as #ffffff. | |
| width | No | Box width, in percent of the annotation's box: the output frame for an arrow, the recording's picture for a blur. Not for text, whose box is its words. | |
| endSec | Yes | ||
| height | No | Box height, in percent of the same box as width. | |
| blurData | No | A blur's look: type blur or mosaic, shape rectangle or oval, color of the mosaic grid, intensity, blockSize. | |
| fontSize | No | Text size; 32 is the editor's default, a title reads well at 56 to 80. | |
| startSec | Yes | ||
| animation | No | How the text enters: typewriter types it out, pop springs it in, and so on. | |
| projectId | No | The project to act on, from listProjects. Omit it only for the project open in the OpenScreen editor, which works only while the app runs. | |
| background | No | Colour of the plate behind the text, or "none" for no plate. | |
| figureData | No | An arrow's direction, colour and stroke width. |