@mcut/media
ScrubFrameCache
Generated TypeScript API reference for the public mcut SDK.
mcut SDK / media/src / ScrubFrameCache
Class: ScrubFrameCache
Defined in: packages/media/src/scrub-cache.ts:17
Constructors
Constructor
new ScrubFrameCache(maxFrames?, minGapMs?): ScrubFrameCache;Defined in: packages/media/src/scrub-cache.ts:23
Parameters
maxFrames?
number = 150
minGapMs?
number = 90
Frames closer together than this are considered duplicates.
Returns
ScrubFrameCache
Accessors
size
Get Signature
get size(): number;Defined in: packages/media/src/scrub-cache.ts:74
Returns
number
Methods
capture()
capture(source, timeMs): void;Defined in: packages/media/src/scrub-cache.ts:30
Capture the element's current frame if this instant isn't cached yet.
Parameters
source
HTMLVideoElement
timeMs
number
Returns
void
clear()
clear(): void;Defined in: packages/media/src/scrub-cache.ts:78
Returns
void
nearest()
nearest(timeMs): OffscreenCanvas | null;Defined in: packages/media/src/scrub-cache.ts:64
The cached frame nearest timeMs, or null when the cache is empty.
Parameters
timeMs
number
Returns
OffscreenCanvas | null