@mcut/compositor
FrameSource
Generated TypeScript API reference for the public mcut SDK.
mcut SDK / compositor/src / FrameSource
Interface: FrameSource
Defined in: packages/compositor/src/types.ts:12
Supplies pixel data for media assets at a given source time. The preview
implementation is allowed to be approximate (pooled <video> elements);
the export implementation must be exact (decoded samples). Keeping this
behind an interface is what lets one compositor serve both.
Methods
getFrame()
getFrame(assetId, sourceTimeMs): CanvasImageSource | null;Defined in: packages/compositor/src/types.ts:17
Image for assetId at sourceTimeMs (media-local time, after trim).
Return null when no frame is available yet; the compositor skips it.
Parameters
assetId
`a-${string}`
sourceTimeMs
number
Returns
CanvasImageSource | null