Video Thumbnail Extractor

video-thumbnail-extractor

Use Video Thumbnail Extractor through the Zavilo SDK. Check input limits, parameters, output and supported modes below.

H · HeadlessI · InteractiveE · Embedded

Tool IDvideo-thumbnail-extractor

Version1

ExecutionCLIENT

WorkloadSTANDARD

ModesHeadless, Interactive, Embedded

Quick actions

Input files 1Output files 1–50

Result handling → Recipes → Integration examples → Playground →

Input

Accepted input contract for this Tool.

Kind	file
File count	1 – 1
Accepted MIME types	video/mp4, video/webm, video/quicktime

Parameters

Pass these values through request.options.

Parameter	Type	Required	Default	Allowed / Range	Description
`extractionMode`	enum	Optional	`single`	single \| interval \| even	single extracts one timestamp, interval extracts every N seconds, and even extracts N frames across the video.
`timestamp`	number	Optional	`0`	0 – ∞	Thumbnail time in seconds. Used when input.data.times is not provided.
`intervalSeconds`	number	Optional	`5`	0.1 – 3600	For interval mode, extract one frame every N seconds.
`frameCount`	integer	Optional	`10`	1 – 50	For even mode, extract this many evenly spaced frames.
`format`	enum	Optional	`jpg`	jpg \| png	Output thumbnail format.
`quality`	number	Optional	`0.9`	0.5 – 1	JPG output quality from 0.5 to 1.0.
`maxLongSide`	integer	Optional	`0`	0 – 4096	Maximum thumbnail long side in pixels. 0 keeps the video resolution.

Output

Result contract returned after successful processing.

Type	files
File count	1 – 50
MIME types	image/jpeg, image/png
Metadata	width, height, duration, inputBytes, outputBytes, outputCount
ZIP archive	Yes · threshold 2

Basic usage

Choose a supported integration mode and copy the generated starter code.

Headless

const result = await client.run("video-thumbnail-extractor", {
  file,
  options: { extractionMode: "single", timestamp: 0, intervalSeconds: 5, frameCount: 10 }
});
console.log(result.files, result.data, result.metadata);

Interactive

await client.open({
  tool: "video-thumbnail-extractor",
  input: { file },
  options: { extractionMode: "single", timestamp: 0, intervalSeconds: 5, frameCount: 10 },
  onComplete(result) { console.log(result.files, result.data, result.metadata); }
});

Embedded

await client.mount({ tool: "video-thumbnail-extractor", target: "#zavilo-tool", mode: "embedded" });

This page is generated from the SDK Tool Definition used by the runtime.