Interface PatchRecorderOptions

Patch recorder options.

interface PatchRecorderOptions {
    filter?: (patches: Patch[], inversePatches: Patch[]) => boolean;
    onPatches?: OnPatchesListener;
    recording?: boolean;
}

Properties

filter? onPatches? recording?

Properties

Optionalfilter

filter?: (patches: Patch[], inversePatches: Patch[]) => boolean

An optional callback filter to select wich patches to record/skip. It will be executed before the event is added to the events list.

Type declaration

    • (patches: Patch[], inversePatches: Patch[]): boolean

    • Parameters

      • patches: Patch[]

        Patches about to be recorded.

      • inversePatches: Patch[]

        Inverse patches about to be recorded.

      Returns boolean

      true to record the patch, false to skip it.

OptionalonPatches

onPatches?: OnPatchesListener

An optional callback run once a patch is recorded. It will be executed after the event is added to the events list.

Param: patches

Patches just recorded.

Param: inversePatches

Inverse patches just recorded.

Optionalrecording

recording?: boolean

If the patch recorder is initially recording when created.

Settings

Member Visibility

On This Page

Properties