Overlay media
overlay_mediaOverlay an image or video onto another with control over position, size, opacity, fade, and chroma keying for watermarks, picture-in-picture, or green-screen effects.
Instructions
Composite an image or video on top of another — picture-in-picture, watermark, or a chroma-keyed composite.
Position with a named corner or explicit x/y, scale with 'width', and fade it in and out of existence with 'start'/'end'. Set chroma_key to a hex colour to key out a green or blue screen from the overlay before compositing.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | No | Explicit x in pixels, overriding position. | |
| y | No | Explicit y in pixels, overriding position. | |
| end | No | Null means to the end of the base clip. | |
| start | No | ||
| width | No | Scale the overlay to this width. | |
| encode | No | ||
| margin | No | ||
| opacity | No | ||
| position | No | Named position, e.g. 'top-right', 'center', 'bottom-left'. | top-right |
| chroma_key | No | Key out this colour from the overlay, e.g. '#00FF00' for a green screen. | |
| input_path | Yes | Path to the source media file. | |
| output_path | No | Destination file. If omitted, the output is written into the job's workspace directory and its path is returned by job_result. | |
| chroma_blend | No | ||
| overlay_path | Yes | Image or video to composite on top. | |
| chroma_similarity | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tool | Yes | ||
| job_id | Yes | ||
| status | No | queued | |
| message | No | Job queued. Poll job_status for progress, then job_result. |