Interface OscillatorNode

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

MDN Reference

Hierarchy

AudioScheduledSourceNode
- OscillatorNode

Index

Properties

channelCount channelCountMode channelInterpretation context detune frequency numberOfInputs numberOfOutputs onended type

Methods

addEventListener connect disconnect dispatchEvent removeEventListener setPeriodicWave start stop

Properties

channelCount

channelCount: number

MDN Reference

channelCountMode

channelCountMode: ChannelCountMode

MDN Reference

channelInterpretation

channelInterpretation: ChannelInterpretation

MDN Reference

`Readonly` context

context: BaseAudioContext

MDN Reference

`Readonly` detune

detune: AudioParam

MDN Reference

`Readonly` frequency

frequency: AudioParam

MDN Reference

`Readonly` numberOfInputs

numberOfInputs: number

MDN Reference

`Readonly` numberOfOutputs

numberOfOutputs: number

MDN Reference

onended

onended: ((this, ev) => any)

Type declaration

- (this, ev): any
- MDN Reference
  Parameters
  - this: AudioScheduledSourceNode
  - ev: Event
  Returns any

type

type: OscillatorType

MDN Reference

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends "ended"
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: OscillatorNode
      
      ev: AudioScheduledSourceNodeEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void

Overrides AudioScheduledSourceNode.addEventListener
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

Overrides AudioScheduledSourceNode.addEventListener

connect

connect(destinationNode, output?, input?): AudioNode
MDN Reference
Parameters
- destinationNode: AudioNode
- Optional output: number
- Optional input: number
Returns AudioNode

Inherited from AudioScheduledSourceNode.connect
connect(destinationParam, output?): void
Parameters
- destinationParam: AudioParam
- Optional output: number
Returns void

Inherited from AudioScheduledSourceNode.connect

disconnect

disconnect(): void
MDN Reference

Returns void

Inherited from AudioScheduledSourceNode.disconnect
disconnect(output): void
Parameters
- output: number
Returns void

Inherited from AudioScheduledSourceNode.disconnect
disconnect(destinationNode): void
Parameters
- destinationNode: AudioNode
Returns void

Inherited from AudioScheduledSourceNode.disconnect
disconnect(destinationNode, output): void
Parameters
- destinationNode: AudioNode
- output: number
Returns void

Inherited from AudioScheduledSourceNode.disconnect
disconnect(destinationNode, output, input): void
Parameters
- destinationNode: AudioNode
- output: number
- input: number
Returns void

Inherited from AudioScheduledSourceNode.disconnect
disconnect(destinationParam): void
Parameters
- destinationParam: AudioParam
Returns void

Inherited from AudioScheduledSourceNode.disconnect
disconnect(destinationParam, output): void
Parameters
- destinationParam: AudioParam
- output: number
Returns void

Inherited from AudioScheduledSourceNode.disconnect

dispatchEvent

dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
Parameters
- event: Event
Returns boolean

Inherited from AudioScheduledSourceNode.dispatchEvent

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends "ended"
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: OscillatorNode
      
      ev: AudioScheduledSourceNodeEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

Overrides AudioScheduledSourceNode.removeEventListener
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Overrides AudioScheduledSourceNode.removeEventListener

setPeriodicWave

setPeriodicWave(periodicWave): void
MDN Reference
Parameters
- periodicWave: PeriodicWave
Returns void

start

start(when?): void
MDN Reference
Parameters
- Optional when: number
Returns void

Inherited from AudioScheduledSourceNode.start

stop

stop(when?): void
MDN Reference
Parameters
- Optional when: number
Returns void

Inherited from AudioScheduledSourceNode.stop

Interface OscillatorNode

Hierarchy

Index

Properties

Methods

Properties

channelCount

channelCountMode

channelInterpretation

Readonly context

Readonly detune

Readonly frequency

Readonly numberOfInputs

Readonly numberOfOutputs

onended

Type declaration

Parameters

this: AudioScheduledSourceNode

ev: Event

Returns any

type

Methods

addEventListener

Type Parameters

K extends "ended"

Parameters

type: K

listener: ((this, ev) => any)

Parameters

this: OscillatorNode

ev: AudioScheduledSourceNodeEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

connect

Parameters

destinationNode: AudioNode

Optional output: number

Optional input: number

Returns AudioNode

Parameters

destinationParam: AudioParam

Optional output: number

Returns void

disconnect

Returns void

Parameters

output: number

Returns void

Parameters

destinationNode: AudioNode

Returns void

Parameters

destinationNode: AudioNode

output: number

Returns void

Parameters

destinationNode: AudioNode

output: number

input: number

Returns void

Parameters

destinationParam: AudioParam

Returns void

Parameters

destinationParam: AudioParam

output: number

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

removeEventListener

Type Parameters

K extends "ended"

`Readonly` context

`Readonly` detune

`Readonly` frequency

`Readonly` numberOfInputs

`Readonly` numberOfOutputs

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` output: number

`Optional` input: number

`Optional` output: number

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` when: number

`Optional` when: number