Class Modulator

constructor

• new Modulator(
      primarySource?: ModulatorSource,
      secondarySource?: ModulatorSource,
      destination?: GeneratorType,
      amount?: number,
      transformType?: ModulatorTransformType,
  ): Modulator

  Creates a new modulator.

  Parameters

  • primarySource: ModulatorSource = ...

    An optional primary source.

  • secondarySource: ModulatorSource = ...

    An optional secondary source.

  • destination: GeneratorType = GeneratorTypes.invalid

    An optional destination can be set here.

  • amount: number = 0

    An optional amount.

  • transformType: ModulatorTransformType = 0

    An optional transform type.

  Returns Modulator

destination

ReadonlyprimarySource

ReadonlysecondarySource

transformAmount

transformType

StaticcopyFrom

• copyFrom(mod: Modulator): Modulator

  Copies a modulator.

  Parameters

  • mod: Modulator

    The modulator to copy.

  Returns Modulator

  The copied modulator.

StaticisIdentical

• isIdentical(mod1: Modulator, mod2: Modulator, checkAmount?: boolean): boolean

  Checks if the pair of modulators is identical (in SF2 terms)

  Parameters

  • mod1: Modulator

    Modulator 1 to compare.

  • mod2: Modulator

    Modulator 2 to compare.

  • checkAmount: boolean = false

    If the amount should be checked too. SF2 specification compares everything except amount.

  Returns boolean

  True if the two modulators are identical.