OmniOscillator < OscType >

OmniOscillator aggregates Tone.Oscillator, Tone.PulseOscillator, Tone.PWMOscillator, Tone.FMOscillator, Tone.AMOscillator, and Tone.FatOscillator into one class. The oscillator class can be changed by setting the type. omniOsc.type = "pwm" will set it to the Tone.PWMOscillator. Prefixing any of the basic types ("sine", "square4", etc.) with "fm", "am", or "fat" will use the FMOscillator, AMOscillator or FatOscillator respectively. For example: omniOsc.type = "fatsawtooth" will create set the oscillator to a FatOscillator of type "sawtooth".


import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator("C#4", "pwm");

Hierarchy

Constructor

new OmniOscillator (
frequency?:Frequency ,

The initial frequency of the oscillator.

type?:OmniOscillatorType

The type of the oscillator.

) => OmniOscillator
new OmniOscillator ( ) => OmniOscillator

Properties

baseType #

OscillatorType | "pwm" | "pulse"

The base type of the oscillator. See Oscillator.baseType


import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator(440, "fmsquare4");
omniOsc.sourceType; // 'fm'
omniOsc.baseType; // 'square'
omniOsc.partialCount; // 4

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.

count #

IsFatOscillator<OscType , number >

The number of detuned oscillators when sourceType === "fat". See FatOscillator.count

debug #

boolean

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

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.

harmonicity #

readonly IsAmOrFmOscillator<OscType , Signal<"positive" > >

Harmonicity is the frequency ratio between the carrier and the modulator oscillators. See AMOscillator or FMOscillator

input #

undefined

Sources have no inputs

modulationFrequency #

readonly IsPWMOscillator<OscType , Signal<"frequency" > >

The modulationFrequency Signal of the oscillator when sourceType === "pwm" see PWMOscillator

Range: 0.1 to 5

modulationIndex #

readonly IsFMOscillator<OscType , Signal<"positive" > >

The modulation index when the sourceType === "fm" See FMOscillator.

modulationType #

IsAmOrFmOscillator<OscType , ToneOscillatorType >

The type of the modulator oscillator. Only if the oscillator is set to "am" or "fm" types. See AMOscillator or FMOscillator

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

partials #

number []

The value is an empty array when the type is not "custom". This is not available on "pwm" and "pulse" oscillator types. See Oscillator.partials

sampleTime #

readonly Seconds

The duration in seconds of one sample.

sourceType #

OmniOscSourceType

The source type of the oscillator.


import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator(440, "fmsquare");
console.log(omniOsc.sourceType); // 'fm'

spread #

IsFatOscillator<OscType , Cents >

The detune spread between the oscillators when sourceType === "fat". See FatOscillator.count

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 #

OmniOscillatorType

The type of the oscillator. Can be any of the basic types: sine, square, triangle, sawtooth. Or prefix the basic types with "fm", "am", or "fat" to use the FMOscillator, AMOscillator or FatOscillator types. The oscillator could also be set to "pwm" or "pulse". All of the parameters of the oscillator's class are accessible when the oscillator is set to that type, but throws an error when it's not.


import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator().toDestination().start();
omniOsc.type = "pwm";
// modulationFrequency is parameter which is available
// only when the type is "pwm".
omniOsc.modulationFrequency.value = 0.5;

import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator().toDestination().start();
// an square wave frequency modulated by a sawtooth
omniOsc.type = "fmsquare";
omniOsc.modulationType = "sawtooth";

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;

width #

readonly IsPulseOscillator<OscType , Signal<"audioRange" > >

The width of the oscillator when sourceType === "pulse". See PWMOscillator.width


import { OmniOscillator } from "tone";
const omniOsc = new OmniOscillator(440, "pulse");
// can access the width attribute only if type === "pulse"
omniOsc.width.value = 0.2;

Methods

asArray #

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}

static getDefaults #

Returns all of the default options belonging to the class.

getDefaults ( ) => OmniOscillatorOptions

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 #

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