OscillatorNode

@native @JSType

The OscillatorNode interface represents a periodic waveform, like a sine wave. It is an AudioNode audio-processing module that causes a given frequency of sine wave to be created — in effect, a constant tone.

An OscillatorNode is created using the AudioContext.createOscillator method. It always has exactly one output and no inputs, both with the same amount of channels. Its basic property defaults (see AudioNode for definitions) are:

  • Number of inputs: 0
  • Number of outputs: 1
  • Channel count mode: max
  • Channel count: 2 (not used in the default count mode)
  • Channel interpretation: speakers
trait AudioNode
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Concrete methods

def setPeriodicWave(wave: PeriodicWave): Unit

Used to point to a PeriodicWave defining a periodic waveform that can be used to shape the oscillator's output, when type = "custom" is used.

Used to point to a PeriodicWave defining a periodic waveform that can be used to shape the oscillator's output, when type = "custom" is used.

This replaces the now-obsolete OscillatorNode.setWaveTable.

def start(when: Double): Unit

This method specifies the exact time to start playing the tone.

This method specifies the exact time to start playing the tone.

def stop(when: Double): Unit

This method specifies the exact time to stop playing the tone.

This method specifies the exact time to stop playing the tone.

Inherited methods

def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], options: EventListenerOptions): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

This implementation accepts a settings object of type EventListenerOptions.

Inherited from:
EventTarget
def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], useCapture: Boolean): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

Inherited from:
EventTarget
def connect(audioParam: AudioParam): Unit

Allows us to connect one output of this node to one input of an audio parameter.

Allows us to connect one output of this node to one input of an audio parameter.

Inherited from:
AudioNode
def connect(audioNode: AudioNode): Unit

Allows us to connect one output of this node to one input of another node.

Allows us to connect one output of this node to one input of another node.

Inherited from:
AudioNode
def disconnect(output: AudioNode): Unit

Allows us to disconnect the current node from another one it is already connected to.

Allows us to disconnect the current node from another one it is already connected to.

Value parameters:
output

The index describing which output of the AudioNode is going to be disconnected.

Inherited from:
AudioNode
def dispatchEvent(evt: Event): Boolean

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Inherited from:
EventTarget
def hasOwnProperty(v: String): Boolean
Inherited from:
Object
def isPrototypeOf(v: Object): Boolean
Inherited from:
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from:
Object
def removeEventListener[T <: Event](`type`: String, listener: Function1[T, _], options: EventListenerOptions): Unit

Removes the event listener previously registered with EventTarget.addEventListener.

Removes the event listener previously registered with EventTarget.addEventListener.

This implementation accepts a settings object of type EventListenerOptions.

Inherited from:
EventTarget
def removeEventListener[T <: Event](`type`: String, listener: Function1[T, _], useCapture: Boolean): Unit

Removes the event listener previously registered with EventTarget.addEventListener.

Removes the event listener previously registered with EventTarget.addEventListener.

Inherited from:
EventTarget
def toLocaleString(): String
Inherited from:
Object
def valueOf(): Any
Inherited from:
Object

Concrete fields

var `type`: String

Represents the shape of the oscillator wave generated. Different waves will produce different tones.

Represents the shape of the oscillator wave generated. Different waves will produce different tones.

An a-rate AudioParam representing detuning of oscillation in cents (though the AudioParam returned is read-only, the value it represents is not.)

An a-rate AudioParam representing detuning of oscillation in cents (though the AudioParam returned is read-only, the value it represents is not.)

An a-rate AudioParam representing the frequency of oscillation in hertz (though the AudioParam returned is read-only, the value it represents is not.)

An a-rate AudioParam representing the frequency of oscillation in hertz (though the AudioParam returned is read-only, the value it represents is not.)

var onended: Function1[Event, _]

Used to set the event handler for the ended event, which fires when the tone has stopped playing.

Used to set the event handler for the ended event, which fires when the tone has stopped playing.

Inherited fields

var channelCount: Int

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.

Inherited from:
AudioNode

Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

Inherited from:
AudioNode

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

The possible values are "speakers" or "discrete".

Inherited from:
AudioNode

Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.

Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.

Inherited from:
AudioNode

Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

Inherited from:
AudioNode

Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

Inherited from:
AudioNode