ApexPainter member
ApexPainter.extractFrames
Published ApexPainter.extractFrames method.
apexify.jsCURRENTnode22node24node26
Source: lib-next/apex-painter/main.ts (opens in a new tab)Signature
(videoSource: string | Buffer, options: ExtractFramesOptions) => Promise<{ source: string; isRemote: boolean; }[]>Parameters
videoSource
string | Buffer<ArrayBufferLike>
options
Options
7 / 7 option paths
| Option | Type | Contract | Allowed values | Runtime & capabilities |
|---|---|---|---|---|
| options | ||||
options.frameSelectionPublished options.frameSelection option. | { start?: number; end?: number; } | OptionalDefault— | — | node22 · node24 · node26 |
options.frameSelection.endPublished options.frameSelection.end option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.frameSelection.startPublished options.frameSelection.start option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.intervalPublished options.interval option. | number | RequiredDefaultRequired | — | 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.watermarkPublished options.watermark option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.frameSelection
OptionalPublished options.frameSelection option.
- Type
{ start?: number; end?: number; }- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.frameSelection.end
OptionalPublished options.frameSelection.end option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.frameSelection.start
OptionalPublished options.frameSelection.start option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.interval
RequiredPublished options.interval option.
- Type
number- Default
- Required
- 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.watermark
OptionalPublished options.watermark option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Types
ExtractFramesOptions: ExtractFramesOptions
- outputDirectory?
string - interval
number - outputFormat?
"jpg" | "png"- variant 1
"jpg" - variant 2
"png"
- variant 1
- frameSelection?
__type: { start?: number; end?: number; }- start?
number - end?
number
- start?
- watermark?
string
Return value
Promise<{ source: string; isRemote: boolean; }[]>
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.