OscillatorNode

open class OscillatorNode(context: BaseAudioContext, options: OscillatorOptions = definedExternally) : AudioScheduledSourceNode(source)

The OscillatorNode interface represents a periodic waveform, such as a sine wave.

MDN Reference

Constructors

Link copied to clipboard
constructor(context: BaseAudioContext, options: OscillatorOptions = definedExternally)

Properties

Link copied to clipboard

The channelCount property of the AudioNode interface represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.

Link copied to clipboard

The channelCountMode property of the AudioNode interface represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

Link copied to clipboard

The channelInterpretation property of the AudioNode interface represents an enumerated value describing how input channels are mapped to output channels when the number of inputs/outputs is different.

Link copied to clipboard

The read-only context property of the the node is participating in.

Link copied to clipboard

The detune property of the OscillatorNode interface is an a-rate AudioParam representing detuning of oscillation in cents.

Link copied to clipboard

The frequency property of the OscillatorNode interface is an a-rate AudioParam representing the frequency of oscillation in hertz.

Link copied to clipboard

The numberOfInputs property of the AudioNode interface returns the number of inputs feeding the node.

Link copied to clipboard

The numberOfOutputs property of the AudioNode interface returns the number of outputs coming out of the node.

Link copied to clipboard

The type property of the OscillatorNode interface specifies what shape of waveform the oscillator will output.

Functions

Link copied to clipboard
fun connect(destinationParam: AudioParam, output: Int = definedExternally)

fun connect(destinationNode: AudioNode, output: Int = definedExternally, input: Int = definedExternally): AudioNode

The connect() method of the AudioNode interface lets you connect one of the node's outputs to a target, which may be either another AudioNode (thereby directing the sound data to the specified node) or an change the value of that parameter over time.

Link copied to clipboard

The disconnect() method of the AudioNode interface lets you disconnect one or more nodes from the node on which the method is called.

fun disconnect(output: Int)
fun disconnect(destinationNode: AudioNode)
fun disconnect(destinationParam: AudioParam)
fun disconnect(destinationNode: AudioNode, output: Int)
fun disconnect(destinationParam: AudioParam, output: Int)
fun disconnect(destinationNode: AudioNode, output: Int, input: Int)
Link copied to clipboard
Link copied to clipboard
fun setPeriodicWave(periodicWave: PeriodicWave)

The setPeriodicWave() method of the OscillatorNode interface is used to point to a PeriodicWave defining a periodic waveform that can be used to shape the oscillator's output, when ``js-nolint setPeriodicWave(wave) `` - wave - : A PeriodicWave object representing the waveform to use as the shape of the oscillator's output.

Link copied to clipboard
fun start(when: Double = definedExternally)

The start() method on AudioScheduledSourceNode schedules a sound to begin playback at the specified time.

Link copied to clipboard
fun stop(when: Double = definedExternally)

The stop() method on AudioScheduledSourceNode schedules a sound to cease playback at the specified time.

Link copied to clipboard