Skip to main content
Version: 0.31.0

Interface: VideoEffectFrameKernel<FrameOptions>

Defined in: core/types.ts:124

The per-frame entry points of an effect session as standalone worklet functions, for callers that encode frames on another JS runtime. FrameOptions are the effect's visual options, supplied on every call because a copied state cannot observe later changes.

Type Parameters​

Type ParameterDefault type
FrameOptionsunknown

Properties​

state​

readonly state: VideoEffectKernelState

Defined in: core/types.ts:125

Methods​

encode()​

encode(state, frame, options): void

Defined in: core/types.ts:127

Parameters​

ParameterType
stateVideoEffectKernelState
frameVideoEffectFrame
optionsFrameOptions

Returns​

void


offer()​

offer(state, input): void

Defined in: core/types.ts:126

Parameters​

ParameterType
stateVideoEffectKernelState
inputSegmentationInput

Returns​

void


reset()​

reset(state): void

Defined in: core/types.ts:132

Parameters​

ParameterType
stateVideoEffectKernelState

Returns​

void