Class OmniOscillator<OscType>

OmniOscillator aggregates all of the oscillator types into one.

Example

return Tone.Offline(() => {
const omniOsc = new Tone.OmniOscillator("C#4", "pwm").toDestination().start();
}, 0.1, 1);

Type Parameters

  • OscType extends AnyOscillator

Hierarchy

Implements

  • Omit<ToneOscillatorInterface, "type">

Constructors

Properties

context: BaseContext

The context belonging to the node.

debug: boolean = false

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

detune: Signal<"cents">
frequency: Signal<"frequency">
input: undefined = undefined

Sources have no inputs

name: string = "OmniOscillator"
onstop: onStopCallback

The callback to invoke when the source is stopped.

output: OutputNode

The output node

volume: Param<"decibels">

The volume of the output in decibels.

Example

const source = new Tone.PWMOscillator().toDestination();
source.volume.value = -6;
version: string = version

The version number semver

Accessors

  • get baseType(): OscillatorType | "pulse" | "pwm"
  • The base type of the oscillator.

    Returns OscillatorType | "pulse" | "pwm"

    See

    Oscillator.baseType

    Example

    const omniOsc = new Tone.OmniOscillator(440, "fmsquare4");
    console.log(omniOsc.sourceType, omniOsc.baseType, omniOsc.partialCount);
  • set baseType(baseType): void
  • Parameters

    • baseType: OscillatorType | "pulse" | "pwm"

    Returns void

  • get blockTime(): number
  • The number of seconds of 1 processing block (128 samples)

    Returns number

    Example

    console.log(Tone.Destination.blockTime);
    
  • get 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.

    Returns number

  • set channelCount(channelCount): void
  • Parameters

    • channelCount: number

    Returns void

  • get 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.

    Returns ChannelCountMode

  • set channelCountMode(channelCountMode): void
  • Parameters

    • channelCountMode: ChannelCountMode

    Returns void

  • get 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".

    Returns ChannelInterpretation

  • set channelInterpretation(channelInterpretation): void
  • Parameters

    • channelInterpretation: ChannelInterpretation

    Returns void

  • get disposed(): 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.

    Returns boolean

  • get mute(): boolean
  • Mute the output.

    Returns boolean

    Example

    const osc = new Tone.Oscillator().toDestination().start();
    // mute the output
    osc.mute = true;
  • set mute(mute): void
  • Parameters

    • mute: boolean

    Returns void

  • get numberOfInputs(): number
  • The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

    Returns number

    Example

    const node = new Tone.Gain();
    console.log(node.numberOfInputs);
  • get numberOfOutputs(): number
  • The number of outputs of the AudioNode.

    Returns number

    Example

    const node = new Tone.Gain();
    console.log(node.numberOfOutputs);
  • get state(): BasicPlaybackState
  • Returns the playback state of the source, either "started" or "stopped".

    Returns BasicPlaybackState

    Example

    const player = new Tone.Player("https://tonejs.github.io/audio/berklee/ahntone_c3.mp3", () => {
    player.start();
    console.log(player.state);
    }).toDestination();
  • get 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.

    Returns OmniOscillatorType

    Example

    const omniOsc = new Tone.OmniOscillator().toDestination().start();
    omniOsc.type = "pwm";
    // modulationFrequency is parameter which is available
    // only when the type is "pwm".
    omniOsc.modulationFrequency.value = 0.5;
  • set type(type): void
  • Parameters

    • type: OmniOscillatorType

    Returns void

Methods

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

    Parameters

    Returns this

    Example

    const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/handdrum-loop.mp3");
    player.autostart = true;
    const filter = new Tone.AutoFilter(4).start();
    const distortion = new Tone.Distortion(0.5);
    // connect the player to the filter, distortion and then to the master output
    player.chain(filter, distortion, Tone.Destination);
  • connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode

    Parameters

    • destination: InputNode

      The output to connect to

    • outputNum: number = 0

      The output to connect from

    • inputNum: number = 0

      The input to connect to

    Returns this

  • disconnect the output

    Parameters

    • Optional destination: InputNode
    • outputNum: number = 0
    • inputNum: number = 0

    Returns this

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

    Parameters

    Returns this

    Example

    const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/conga-rhythm.mp3");
    player.autostart = true;
    const pitchShift = new Tone.PitchShift(4).toDestination();
    const filter = new Tone.Filter("G5").toDestination();
    // connect a node to the pitch shift and filter in parallel
    player.fan(pitchShift, filter);
  • Return the current time of the Context clock without any lookAhead.

    Returns number

    Example

    setInterval(() => {
    console.log(Tone.immediate());
    }, 100);
  • Return the current time of the Context clock plus the lookAhead.

    Returns number

    Example

    setInterval(() => {
    console.log(Tone.now());
    }, 100);
  • Start the source at the specified time. If no time is given, start the source now.

    Parameters

    Returns this

    Example

    const source = new Tone.Oscillator().toDestination();
    source.start("+0.5"); // starts the source 0.5 seconds from now
  • Stop the source at the specified time. If no time is given, stop the source now.

    Parameters

    • Optional time: Unit.Time

      When the source should be stopped.

    Returns this

    Example

    const source = new Tone.Oscillator().toDestination();
    source.start();
    source.stop("+0.5"); // stops the source 0.5 seconds from now
  • 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.

    Returns this

    Example

    const osc = new Tone.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.
    Tone.Transport.start();
    // set it to loop once a second
    Tone.Transport.loop = true;
    Tone.Transport.loopEnd = 1;
  • Connect the output to the context's destination node.

    Returns this

    Example

    const osc = new Tone.Oscillator("C2").start();
    osc.toDestination();
  • Convert the input to a frequency number

    Parameters

    Returns number

    Example

    const gain = new Tone.Gain();
    console.log(gain.toFrequency("4n"));
  • Convert the incoming time to seconds. This is calculated against the current TransportClass bpm

    Parameters

    Returns number

    Example

    const gain = new Tone.Gain();
    setInterval(() => console.log(gain.toSeconds("4n")), 100);
    // ramp the tempo to 60 bpm over 30 seconds
    Tone.getTransport().bpm.rampTo(60, 30);
  • Convert the class to a string

    Returns string

    Example

    const osc = new Tone.Oscillator();
    console.log(osc.toString());
  • Convert the input time into ticks

    Parameters

    Returns number

    Example

    const gain = new Tone.Gain();
    console.log(gain.toTicks("4n"));