Hiyve Components - v1.0.0
    Preparing search index...

    Interface ClickMaskerOptions

    How a ClickMasker is set up.

    interface ClickMaskerOptions {
        beatMs: number;
        countInBeats: number;
        firstBeatMs: number;
        maskMs?: number;
        maxLateMs?: number;
        minMatch?: number;
        sampleRate: number;
        template: Float32Array;
        templateSampleRate: number;
    }
    Index

    Properties

    beatMs: number

    Time from one click to the next

    countInBeats: number

    Clicks before the first beat

    firstBeatMs: number

    Stream time of the first beat after the count-in

    maskMs?: number

    How much of the stream is blanked around each click (default: 30 ms)

    maxLateMs?: number

    How late after its scheduled time a click may reach the microphone (default: 300 ms)

    minMatch?: number

    How well a count-in click must match the template to count, 0–1 (default: 0.25)

    sampleRate: number

    Sample rate of the stream being masked

    template: Float32Array

    The click as it was played

    templateSampleRate: number

    Sample rate the click was played at