Options
All
  • Public
  • Public/Protected
  • All
Menu
beta

Represents a SOUL patch.

https://soul.dev/

Hierarchy

Index

Constructors

constructor

  • Creates an SOUL patch object with the specified path. Paths can be absolute or relative to the JavaScript file being executed.

    Throws an exception if the file does not exist at the specified path.

    Parameters

    • path: string

    Returns SOULPatch

Properties

gain

gain: number

The gain for this object.

Defaults to 1.0.

gainDecibels

gainDecibels: number

The dBFS level for this object.

Defaults to 0.0

Optional id

The identifier of this node.

input

input: [ObjectID, Channel][]

The audio input channels of this audio unit.

midiIn

midiIn: [ObjectID, Channel]

The midi input for this audio unit.

output

output: [ObjectID, Channel][]

The audio output channels of this audio unit.

pan

pan: number

The pan for this object.

Defaults to 0.0; -1.0 = left, 0.0 = centre, 1.0 = right.

Optional parameters

parameters: Map<string, number>

Gets or sets the SOUL patch parameters. These values are only available after the SOUL patch has been successfully loaded. You can get/set new parameter values in any Pattern callback.

Usually parameters are sent with each step inside the Pattern.onSequence callback and this is here for that one special case where you'd want to set parameters directly from a [[Pattern.controllerMoved]], [[Pattern.aftertouchChanged]] or other callback(s) that do not allow adding steps.

Methods

connect

  • Connects this object's output to the specified destination object's input ("output" if the destination is a graph).

    Parameters

    • destination: AudioUnit | Graph

      The AudioUnit | Graph to which to connect.

    • Optional outputIndex: number

      An index specifying which output of this AudioUnit to connect to the destination.

    • Optional inputIndex: number

      An index describing which input of the destination you want to connect this AudioUnit to.

      Returns a reference to the destination AudioUnit object allowing you to chain multiple connect() calls. If the destination is a Graph object, connect() returns undefined.

    Returns AudioUnit | undefined

Generated using TypeDoc