Skip to main content
Version: 0.31.0

Interface: VideoEffect<FrameOptions>

Defined in: core/types.ts:143

Type Parameters​

Type ParameterDefault type
FrameOptionsunknown

Properties​

frameOptions()?​

readonly optional frameOptions: () => FrameOptions

Defined in: core/types.ts:150

The effect's live per-frame options, for callers that drive VideoEffectSession.frameKernel on another runtime.

Returns​

FrameOptions


id​

readonly id: string

Defined in: core/types.ts:144


segmentationInput​

readonly segmentationInput: SegmentationInputKind

Defined in: core/types.ts:145

Methods​

create()​

create(context): Promise<VideoEffectSession<FrameOptions>>

Defined in: core/types.ts:151

Parameters​

ParameterType
contextVideoEffectContext

Returns​

Promise<VideoEffectSession<FrameOptions>>