ApexPainter member
ApexPainter.extractAllFrames
Published ApexPainter.extractAllFrames method.
apexify.jsCURRENTnode22node24node26
Source: lib-next/apex-painter/main.ts (opens in a new tab)Signature
(videoSource: string | Buffer, options?: ExtractAllFramesOptions) => Promise<{ source: string; frameNumber: number; time: number; }[]>Parameters
videoSource
string | Buffer<ArrayBufferLike>
options?
Options
6 / 6 option paths
| Option | Type | Contract | Allowed values | Runtime & capabilities |
|---|---|---|---|---|
| options | ||||
options.endTimePublished options.endTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.outputDirectoryPublished options.outputDirectory option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.outputFormatPublished options.outputFormat option. | "jpg" | "png" | OptionalDefault— | "jpg" "png" | node22 · node24 · node26 |
options.prefixPublished options.prefix option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.qualityPublished options.quality option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.startTimePublished options.startTime option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.endTime
OptionalPublished options.endTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.outputDirectory
OptionalPublished options.outputDirectory option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.outputFormat
OptionalPublished options.outputFormat option.
- Type
"jpg" | "png"- Default
- —
- Allowed
"jpg""png"- Runtime
- node22, node24, node26
options.prefix
OptionalPublished options.prefix option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.quality
OptionalPublished options.quality option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.startTime
OptionalPublished options.startTime option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Types
ExtractAllFramesOptions: ExtractAllFramesOptions
- outputFormat?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- outputDirectory?
string - quality?
number - prefix?
string - startTime?
number - endTime?
number
Return value
Promise<{ source: string; frameNumber: number; time: number; }[]>
The return contract is generated from the packed declaration. Async wrappers and nullable/undefined variants remain visible in the type model.
Errors
NOT APPLICABLE — no verified errors are bound to this API.
Limits
NOT APPLICABLE — no API-specific verified limits are bound to this API.
Related APIs
No explicit related API metadata.