Polyend Tracker Library - v0.1.1
    Preparing search index...

    Interface InstrumentData

    Represents all the instrument data.

    ℹ️ There is no need to create this yourself. Use Tracker.createInstrument instead.

    interface InstrumentData {
        automations: Automation[];
        bitdepth: number;
        cutoff: number;
        delaySend: number;
        endPoint: number;
        filterEnabled: boolean;
        filterType: InstrumentFilterType;
        finetune: number;
        granular: Granular;
        header: InstrumentHeader;
        isActive: boolean;
        loopPoint1: number;
        loopPoint2: number;
        numSlices: number;
        overdrive: number;
        panning: number;
        playmode: InstrumentPlayMode;
        resonance: number;
        reverbSend: number;
        sample: SampleBankSlot;
        selectedSlice: number;
        slices: number[];
        startPoint: number;
        tune: number;
        volume: number;
        wav: ArrayBuffer;
        wavetableCurrentWindow: number;
        getSampleAsBlob(): Blob;
        setSample(wav: ArrayBuffer): void;
    }
    Index

    Properties

    automations: Automation[]

    Array of all the available automations.

    • [0] = Volume
    • [1] = Panning
    • [2] = Cutoff
    • [3] = Wavetable Position
    • [4] = Granular Position
    • [5] = Finetune
    bitdepth: number

    Instrument bit depth. Valid range: 4 - 16 (integer).

    cutoff: number

    Filter cutoff. Valid range: 0.0 - 1.0 (float).

    delaySend: number

    Instrument delay send. Valid range: 0.0 - 1.0 (float).

    endPoint: number

    End point of sample (in frames). Valid range: 0 to 65535 (maximum for unsigned 16-bit integer).

    filterEnabled: boolean

    Filter enabled flag.

    Filter type.

    finetune: number

    Instrument fine tuning (cents). Valid range: -100 - 100 (integer).

    granular: Granular

    Granular properties.

    Instrument header.

    isActive: boolean

    Instrument active flag (unused)

    loopPoint1: number

    Loop point 1 (Start of Loop). Valid range: 0 to 65535 (maximum for unsigned 16-bit integer).

    loopPoint2: number

    Loop point 2 (End of Loop). Valid range: 0 to 65535 (maximum for unsigned 16-bit integer).

    numSlices: number

    Integer value for number of set slices. Valid value range: 0 to 47 (integer).

    overdrive: number

    Instrument overdrive. Valid range: 0 - 100 (integer).

    panning: number

    Instrument panning. Valid range: -1.0 - 1.0 (float). 0.0 = center

    Indicates the playmode for the instrument.

    resonance: number

    Filter resonance. Valid range: 0.0 - 4.3 (float).

    reverbSend: number

    Instrument reverb send. Valid range: 0.0 - 1.0 (float).

    Sample data/properties.

    selectedSlice: number

    Integer value representing the last selected slice on the tracker. Valid value range: 0 to 47 (integer).

    slices: number[]

    Array of slice positions. Always contains 48 values. Use numSlices to check which ones are actually used. Valid value range: 0 to 65535 (maximum for unsigned 16-bit integer).

    startPoint: number

    Start point of sample (in frames). Valid range: 0 to 65535 (maximum for unsigned 16-bit integer).

    tune: number

    Instrument coarse tuning (semitones). Valid range: -24 - 24 (integer).

    volume: number

    Instrument volume. Valid range: 0.0 - 2.0 (float). 0.0 = 0db.

    ArrayBuffer containing a valid 16bit 44.1khz WAV file.

    wavetableCurrentWindow: number

    Integer value representing current active window within a wavetable.

    Methods