FMOscillator

FMOscillator implements a frequency modulation synthesis

+-------------+ +---------------+ +-------------+ | Carrier Osc | | Modulator Osc +>-------> GainNode | | +--->Output +---------------+ | +>----> frequency | +--> gain | +-------------+ | +-------------+ +-----------------+ | | modulationIndex +>--+ +-----------------+

import { FMOscillator } from "tone";
// a sine oscillator frequency-modulated by a square wave
const fmOsc = new FMOscillator("Ab3", "sine", "square").toDestination().start();

Hierarchy

Constructor

new FMOscillator (
frequency?:Frequency ,

The starting frequency of the oscillator.

type?:ToneOscillatorType ,

The type of the carrier oscillator.

modulationType?:ToneOscillatorType

The type of the modulator oscillator.

) => FMOscillator
new FMOscillator (
options?:Partial<FMConstructorOptions >
) => FMOscillator

Properties

baseType #

OscillatorType

The oscillator type without the partialsCount appended to the end


import { Oscillator } from "tone";
const osc = new Oscillator();
osc.type = "sine2";
console.log(osc.baseType); // "sine"

blockTime #

readonly Seconds

The number of seconds of 1 processing block (128 samples)

channelCount #

number

channelCount is the number of channels used when up-mixing and down-mixing connections to any inputs to the node. The default value is 2 except for specific nodes where its value is specially determined.

channelCountMode #

ChannelCountMode

channelCountMode determines how channels will be counted when up-mixing and down-mixing connections to any inputs to the node. The default value is "max". This attribute has no effect for nodes with no inputs.

  • "max" - computedNumberOfChannels is the maximum of the number of channels of all connections to an input. In this mode channelCount is ignored.
  • "clamped-max" - computedNumberOfChannels is determined as for "max" and then clamped to a maximum value of the given channelCount.
  • "explicit" - computedNumberOfChannels is the exact value as specified by the channelCount.

channelInterpretation #

ChannelInterpretation

channelInterpretation determines how individual channels will be treated when up-mixing and down-mixing connections to any inputs to the node. The default value is "speakers".

context #

BaseContext

The context belonging to the node.

debug #

boolean

Set this debug flag to log all events that happen in this class.

detune #

Signal<"cents" >

The detune value in cents (100th of a semitone).


import { now, PulseOscillator } from "tone";
const osc = new PulseOscillator("F3").toDestination().start();
// pitch it 1 octave = 12 semitones = 1200 cents
osc.detune.setValueAtTime(-1200, now());
osc.detune.setValueAtTime(1200, now() + 0.5);
osc.detune.linearRampToValueAtTime(0, now() + 1);
osc.stop(now() + 1.5);

disposed #

readonly boolean

Indicates if the instance was disposed. 'Disposing' an instance means that all of the Web Audio nodes that were created for the instance are disconnected and freed for garbage collection.

frequency #

Signal<"frequency" >

The frequency value of the oscillator


import { FMOscillator } from "tone";
const osc = new FMOscillator("Bb4").toDestination().start();
osc.frequency.rampTo("D2", 3);

harmonicity #

Signal<"positive" >

Harmonicity is the frequency ratio between the carrier and the modulator oscillators. A harmonicity of 1 gives both oscillators the same frequency. Harmonicity = 2 means a change of an octave.


import { FMOscillator } from "tone";
const fmOsc = new FMOscillator("D2").toDestination().start();
// pitch the modulator an octave below carrier
fmOsc.harmonicity.value = 0.5;

input #

undefined

Sources have no inputs

modulationIndex #

Signal<"positive" >

The modulation index which is in essence the depth or amount of the modulation. In other terms it is the ratio of the frequency of the modulating signal (mf) to the amplitude of the modulating signal (ma) -- as in ma/mf.

modulationType #

ToneOscillatorType

The type of the modulator oscillator

mute #

boolean

Mute the output.


import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// mute the output
osc.mute = true;

numberOfInputs #

readonly number

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

numberOfOutputs #

readonly number

The number of outputs of the AudioNode.

onstop #

onStopCallback

The callback to invoke when the source is stopped.

output #

OutputNode

The output note

partialCount #

number

'partialCount' offers an alternative way to set the number of used partials. When partialCount is 0, the maximum number of partials are used when representing the waveform using the periodicWave. When 'partials' is set, this value is not settable, but equals the length of the partials array. A square wave wave is composed of only odd harmonics up through the harmonic series. Partial count can limit the number of harmonics which are used to generate the waveform.


import { Oscillator } from "tone";
const osc = new Oscillator("C3", "square").toDestination().start();
osc.partialCount = 5;

partials #

number []

The partials describes the relative amplitude of each of the harmonics of the oscillator. The first value in the array is the first harmonic (i.e. the fundamental frequency), the second harmonic is an octave up, the third harmonic is an octave and a fifth, etc. The resulting oscillator output is composed of a sine tone at the relative amplitude at each of the harmonic intervals.


import { Oscillator } from "tone";
const osc = new Oscillator("F3").toDestination().start();
osc.partials = [1, 0, 0.4, 1, 0.2];

phase #

Degrees

The phase is the starting position within the oscillator's cycle. For example a phase of 180 would start halfway through the oscillator's cycle.

sampleTime #

readonly Seconds

The duration in seconds of one sample.

state #

readonly BasicPlaybackState

Returns the playback state of the source, either "started" or "stopped".


import { Player } from "tone";
const player = new Player("https://tonejs.github.io/examples/audio/FWDL.mp3", () => {
	player.start();
	console.log(player.state);
}).toDestination();

type #

ToneOscillatorType

The oscillator's type. Also capable of setting the first x number of partials of the oscillator. For example: "sine4" would set be the first 4 partials of the sine wave and "triangle8" would set the first 8 partials of the triangle wave.


import { Oscillator } from "tone";
const osc = new Oscillator();
osc.type = "sine2";

static version #

string

The version number semver

volume #

Param<"decibels" >

The volume of the output in decibels.


import { PWMOscillator } from "tone";
const source = new PWMOscillator().toDestination();
source.volume.value = -6;

Methods

asArray #

Returns an array of values which represents the waveform.

asArray (
length= 1024:number
) => Promise<Float32Array >

chain #

Connect the output of this node to the rest of the nodes in series.


import { Destination, Filter, Oscillator, Volume } from "tone";
const osc = new Oscillator().start();
const filter = new Filter();
const volume = new Volume(-8);
// connect a node to the filter, volume and then to the master output
osc.chain(filter, volume, Destination);
chain (
...nodes:InputNode []
) => this

connect #

connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode

connect (
destination:InputNode ,

The output to connect to

outputNum= 0:number ,

The output to connect from

inputNum= 0:number

The input to connect to

) => this

disconnect #

disconnect the output

disconnect (
destination?:InputNode ,
outputNum= 0:number ,
inputNum= 0:number
) => this

dispose #

Clean up.

dispose ( ) => this

fan #

connect the output of this node to the rest of the nodes in parallel.

fan (
...nodes:InputNode []
) => this

get #

Get the object's attributes.


import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.get());
// returns {"type" : "sine", "frequency" : 440, ...etc}
get ( ) => FMOscillatorOptions

static getDefaults #

Returns all of the default options belonging to the class.

getDefaults ( ) => FMOscillatorOptions

immediate #

Return the current time of the Context clock without any lookAhead.

immediate ( ) => Seconds

now #

Return the current time of the Context clock plus the lookAhead.

now ( ) => Seconds

restart #

stop and restart the oscillator

restart (
time?:Time
) => this

set #

Set multiple properties at once with an object.


import { Filter } from "tone";
const filter = new Filter();
// set values using an object
filter.set({
	frequency: 300,
	type: "highpass"
});
set ( ) => this

start #

Start the source at the specified time. If no time is given, start the source now.


import { Oscillator } from "tone";
const source = new Oscillator().toDestination();
source.start("+0.5"); // starts the source 0.5 seconds from now
start (
time?:Time ,

When the source should be started.

offset?:Time ,
duration?:Time
) => this

stop #

Stop the source at the specified time. If no time is given, stop the source now.


import { Oscillator } from "tone";
const source = new Oscillator().toDestination();
source.start();
source.stop("+0.5"); // stops the source 0.5 seconds from now
stop (
time?:Time

When the source should be stopped.

) => this

sync #

Sync the source to the Transport so that all subsequent calls to start and stop are synced to the TransportTime instead of the AudioContext time.


import { Oscillator, Transport } from "tone";
const osc = new Oscillator().toDestination();
// sync the source so that it plays between 0 and 0.3 on the Transport's timeline
osc.sync().start(0).stop(0.3);
// start the transport.
Transport.start();
// set it to loop once a second
Transport.loop = true;
Transport.loopEnd = 1;
sync ( ) => this

toDestination #

Connect the output to the context's destination node.

toDestination ( ) => this

toFrequency #

Convert the input to a frequency number

toFrequency (
freq:Frequency
) => Hertz

toMaster # DEPRECATED

Connect the output to the context's destination node. See toDestination

toMaster ( ) => this

toSeconds #

Convert the incoming time to seconds

toSeconds (
time?:Time
) => Seconds

toString #

Convert the class to a string


import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.toString());
toString ( ) => string

toTicks #

Convert the input time into ticks

toTicks (
time?:Time | TimeClass
) => Ticks

unsync #

Unsync the source to the Transport. See Source.sync

unsync ( ) => this