# Interface: SynthPatchOscillatorOptionsObject

## Highcharts. SynthPatchOscillatorOptionsObject

Configuration for an oscillator for the synth.

### Requires

- module:modules/sonification

### Members

#### attackEnvelope :Highcharts.SynthEnvelope|undefined

  Volume envelope for note attack, specific to this oscillator.

  ##### Type:

  - Highcharts.SynthEnvelope | undefined

#### detune :number|undefined

  Applies a detuning of all frequencies. Set in cents. Defaults to 0.

  ##### Type:

  - number | undefined

#### fixedFrequency :number|undefined

  Play a fixed frequency for the oscillator - ignoring input frequency. The frequency multiplier is still applied.

  ##### Type:

  - number | undefined

#### fmOscillator :number|undefined

  Index of another oscillator to use as carrier, with this oscillator being used as a frequency modulator. Note: If the carrier is a pulse oscillator, the modulation will be on pulse width instead of frequency, allowing for PWM effects.

  ##### Type:

  - number | undefined

#### freqMultiplier :number|undefined

  A multiplier for the input frequency of the oscillator. Defaults to 1. If this is for example set to 4, an input frequency of 220Hz will cause the oscillator to play at 880Hz.

  ##### Type:

  - number | undefined

#### highpass :Highcharts.SynthPatchPassFilter|undefined

  Highpass filter options for the oscillator.

  ##### Type:

  - Highcharts.SynthPatchPassFilter | undefined

#### lowpass :Highcharts.SynthPatchPassFilter|undefined

  Lowpass filter options for the oscillator.

  ##### Type:

  - Highcharts.SynthPatchPassFilter | undefined

#### pulseWidth :number|undefined

  Width of the pulse waveform. Only applies to "pulse" type oscillators. A width of 0.5 is roughly equal to a square wave. This is the default.

  ##### Type:

  - number | undefined

#### releaseEnvelope :Highcharts.SynthEnvelope|undefined

  Volume envelope for note release, specific to this oscillator.

  ##### Type:

  - Highcharts.SynthEnvelope | undefined

#### type :Highcharts.SynthPatchOscillatorType|undefined

  The type of oscillator. This describes the waveform of the oscillator.

  ##### Type:

  - Highcharts.SynthPatchOscillatorType | undefined

#### vmOscillator :number|undefined

  Index of another oscillator to use as carrier, with this oscillator being used as a volume modulator. The first oscillator in the array has index 0, and so on. This option can be used to produce tremolo effects.

  ##### Type:

  - number | undefined

#### volume :number|undefined

  A volume modifier for the oscillator. Defaults to 1.

  ##### Type:

  - number | undefined

#### volumePitchTrackingMultiplier :number|undefined

  A tracking multiplier used for frequency dependent behavior. For example, by setting the volume tracking multiplier to 0.01, the volume will be lower at higher notes. The multiplier is a logarithmic function, where 1 is at ca 50Hz, and you define the output multiplier for an input frequency around 3.2kHz.

  ##### Type:

  - number | undefined