spessasynth_core documentation
    Preparing search index...

    Class BasicInstrument

    This class represents a single instrument, a layer below the BasicPreset.

    Index
    globalZone: BasicZone = ...

    Instrument's global zone. Its parameters are overridden by the local zone parameters.

    linkedTo: BasicPreset[] = []

    Instrument's linked presets (the presets that use it).

    name: string = ""

    The name of this instrument.

    zones: BasicInstrumentZone[] = []

    The instrument's local zones. These are limited to specific key/velocity ranges and contain associated samples.

    • Deletes a given instrument zone if it has no uses.

      Parameters

      • index: number

        The index of the zone to delete.

      • force: boolean = false

        Force deletes the zone instead of the safe deletion.

      Returns boolean

      True if the zone has been deleted, false otherwise.

    • Globalizes the instrument in-place. This means trying to move as many generators and modulators to the global zone as possible to reduce clutter and the count of parameters.

      If fully successful, this should have no effect on the audio produced.

      Returns void