Class BaseContext`Abstract`

Hierarchy (view full)

Emitter<"statechange" | "tick">
- BaseContext
  - Context

Implements

BaseAudioContextSubset

Constructors

constructor

new BaseContext(): BaseContext
Returns BaseContext
Inherited from Emitter.constructor

Properties

debug

debug: boolean = false

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

`Readonly` isOffline

isOffline: boolean = false

`Abstract` latencyHint

latencyHint: number | AudioContextLatencyCategory

`Abstract` lookAhead

lookAhead: number

`Readonly` name

name: string = "Emitter"

`Static` version

version: string = version

The version number semver

Accessors

`Abstract` currentTime

get currentTime(): number
Returns number
Implementation of BaseAudioContextSubset.currentTime
- Defined in Tone/core/context/BaseContext.ts:133

`Abstract` destination

get destination(): DestinationClass
Returns DestinationClass
- Defined in Tone/core/context/BaseContext.ts:145

disposed

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
Inherited from Emitter.disposed
- Defined in Tone/core/Tone.ts:94

`Abstract` draw

get draw(): DrawClass
Returns DrawClass
- Defined in Tone/core/context/BaseContext.ts:143

`Abstract` listener

get listener(): ListenerClass
Returns ListenerClass
- Defined in Tone/core/context/BaseContext.ts:139

`Abstract` rawContext

get rawContext(): AnyAudioContext
Returns AnyAudioContext
- Defined in Tone/core/context/BaseContext.ts:105

`Abstract` sampleRate

get sampleRate(): number
Returns number
Implementation of BaseAudioContextSubset.sampleRate
- Defined in Tone/core/context/BaseContext.ts:137

`Abstract` state

get state(): AudioContextState
Returns AudioContextState
Implementation of BaseAudioContextSubset.state
- Defined in Tone/core/context/BaseContext.ts:135

`Abstract` transport

get transport(): TransportClass
Returns TransportClass
- Defined in Tone/core/context/BaseContext.ts:141

Methods

`Abstract` addAudioWorkletModule

addAudioWorkletModule(_url): Promise<void>
Parameters
- _url: string
Returns Promise<void>
- Defined in Tone/core/context/BaseContext.ts:107

`Abstract` clearInterval

clearInterval(_id): this
Parameters
- _id: number
Returns this
- Defined in Tone/core/context/BaseContext.ts:129

`Abstract` clearTimeout

clearTimeout(_id): this
Parameters
- _id: number
Returns this
- Defined in Tone/core/context/BaseContext.ts:122

`Abstract` createAnalyser

createAnalyser(): AnalyserNode
Returns AnalyserNode
Implementation of BaseAudioContextSubset.createAnalyser
- Defined in Tone/core/context/BaseContext.ts:35

`Abstract` createAudioWorkletNode

createAudioWorkletNode(_name, _options?): AudioWorkletNode
Parameters
- _name: string
- Optional _options: Partial<AudioWorkletNodeOptions>
Returns AudioWorkletNode
- Defined in Tone/core/context/BaseContext.ts:100

`Abstract` createBiquadFilter

createBiquadFilter(): BiquadFilterNode
Returns BiquadFilterNode
Implementation of BaseAudioContextSubset.createBiquadFilter
- Defined in Tone/core/context/BaseContext.ts:41

`Abstract` createBuffer

createBuffer(_numberOfChannels, _length, _sampleRate): AudioBuffer
Parameters
- _numberOfChannels: number
- _length: number
- _sampleRate: number
Returns AudioBuffer
Implementation of BaseAudioContextSubset.createBuffer
- Defined in Tone/core/context/BaseContext.ts:43

`Abstract` createBufferSource

createBufferSource(): AudioBufferSourceNode
Returns AudioBufferSourceNode
Implementation of BaseAudioContextSubset.createBufferSource
- Defined in Tone/core/context/BaseContext.ts:39

`Abstract` createChannelMerger

createChannelMerger(_numberOfInputs?): ChannelMergerNode
Parameters
- Optional _numberOfInputs: number
Returns ChannelMergerNode
Implementation of BaseAudioContextSubset.createChannelMerger
- Defined in Tone/core/context/BaseContext.ts:49

`Abstract` createChannelSplitter

createChannelSplitter(_numberOfOutputs?): ChannelSplitterNode
Parameters
- Optional _numberOfOutputs: number
Returns ChannelSplitterNode
Implementation of BaseAudioContextSubset.createChannelSplitter
- Defined in Tone/core/context/BaseContext.ts:53

`Abstract` createConstantSource

createConstantSource(): ConstantSourceNode
Returns ConstantSourceNode
Implementation of BaseAudioContextSubset.createConstantSource
- Defined in Tone/core/context/BaseContext.ts:57

`Abstract` createConvolver

createConvolver(): ConvolverNode
Returns ConvolverNode
Implementation of BaseAudioContextSubset.createConvolver
- Defined in Tone/core/context/BaseContext.ts:59

`Abstract` createDelay

createDelay(_maxDelayTime?): DelayNode
Parameters
- Optional _maxDelayTime: number
Returns DelayNode
Implementation of BaseAudioContextSubset.createDelay
- Defined in Tone/core/context/BaseContext.ts:61

`Abstract` createDynamicsCompressor

createDynamicsCompressor(): DynamicsCompressorNode
Returns DynamicsCompressorNode
Implementation of BaseAudioContextSubset.createDynamicsCompressor
- Defined in Tone/core/context/BaseContext.ts:63

`Abstract` createGain

createGain(): GainNode
Returns GainNode
Implementation of BaseAudioContextSubset.createGain
- Defined in Tone/core/context/BaseContext.ts:65

`Abstract` createIIRFilter

createIIRFilter(_feedForward, _feedback): IIRFilterNode
Parameters
- _feedForward: number[] | Float32Array
- _feedback: number[] | Float32Array
Returns IIRFilterNode
Implementation of BaseAudioContextSubset.createIIRFilter
- Defined in Tone/core/context/BaseContext.ts:67

`Abstract` createMediaElementSource

createMediaElementSource(_element): MediaElementAudioSourceNode
Parameters
- _element: HTMLMediaElement
Returns MediaElementAudioSourceNode
- Defined in Tone/core/context/BaseContext.ts:88

`Abstract` createMediaStreamDestination

createMediaStreamDestination(): MediaStreamAudioDestinationNode
Returns MediaStreamAudioDestinationNode
- Defined in Tone/core/context/BaseContext.ts:92

`Abstract` createMediaStreamSource

createMediaStreamSource(_stream): MediaStreamAudioSourceNode
Parameters
- _stream: MediaStream
Returns MediaStreamAudioSourceNode
- Defined in Tone/core/context/BaseContext.ts:84

`Abstract` createOscillator

createOscillator(): OscillatorNode
Returns OscillatorNode
Implementation of BaseAudioContextSubset.createOscillator
- Defined in Tone/core/context/BaseContext.ts:37

`Abstract` createPanner

createPanner(): PannerNode
Returns PannerNode
Implementation of BaseAudioContextSubset.createPanner
- Defined in Tone/core/context/BaseContext.ts:72

`Abstract` createPeriodicWave

createPeriodicWave(_real, _imag, _constraints?): PeriodicWave
Parameters
- _real: number[] | Float32Array
- _imag: number[] | Float32Array
- Optional _constraints: PeriodicWaveConstraints
Returns PeriodicWave
Implementation of BaseAudioContextSubset.createPeriodicWave
- Defined in Tone/core/context/BaseContext.ts:74

`Abstract` createStereoPanner

createStereoPanner(): StereoPannerNode
Returns StereoPannerNode
Implementation of BaseAudioContextSubset.createStereoPanner
- Defined in Tone/core/context/BaseContext.ts:80

`Abstract` createWaveShaper

createWaveShaper(): WaveShaperNode
Returns WaveShaperNode
Implementation of BaseAudioContextSubset.createWaveShaper
- Defined in Tone/core/context/BaseContext.ts:82

`Abstract` decodeAudioData

decodeAudioData(_audioData): Promise<AudioBuffer>
Parameters
- _audioData: ArrayBuffer
Returns Promise<AudioBuffer>
Implementation of BaseAudioContextSubset.decodeAudioData
- Defined in Tone/core/context/BaseContext.ts:94

dispose

dispose(): this
Clean up

Returns this
Inherited from Emitter.dispose
- Defined in Tone/core/util/Emitter.ts:120

emit

emit(event, ...args): this
Invoke all of the callbacks bound to the event with any arguments passed in.
Parameters
- event: any
  The name of the event.
- Rest ...args: any[]
  The arguments to pass to the functions listening.
Returns this
Inherited from Emitter.emit
- Defined in Tone/core/util/Emitter.ts:94

`Abstract` getConstant

getConstant(_val): AudioBufferSourceNode
Parameters
- _val: number
Returns AudioBufferSourceNode
- Defined in Tone/core/context/BaseContext.ts:131

`Abstract` immediate

immediate(): number
Returns number
- Defined in Tone/core/context/BaseContext.ts:149

`Abstract` now

now(): number
Returns number
- Defined in Tone/core/context/BaseContext.ts:147

off

off(event, callback?): this
Remove the event listener.
Parameters
- event: "statechange" | "tick"
  The event to stop listening to.
- Optional callback: ((...args) => void)
  The callback which was bound to the event with Emitter.on. If no callback is given, all callbacks events are removed.
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Inherited from Emitter.off
- Defined in Tone/core/util/Emitter.ts:66

on

on(event, callback): this
Bind a callback to a specific event.
Parameters
- event: "statechange" | "tick"
  The name of the event to listen for.
- callback: ((...args) => void)
  The callback to invoke when the event is emitted
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Inherited from Emitter.on
- Defined in Tone/core/util/Emitter.ts:29

once

once(event, callback): this
Bind a callback which is only invoked once
Parameters
- event: "statechange" | "tick"
  The name of the event to listen for.
- callback: ((...args) => void)
  The callback to invoke when the event is emitted
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns this
Inherited from Emitter.once
- Defined in Tone/core/util/Emitter.ts:49

`Abstract` resume

resume(): Promise<void>
Returns Promise<void>
- Defined in Tone/core/context/BaseContext.ts:115

`Abstract` setInterval

setInterval(_fn, _interval): number
Parameters
- _fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- _interval: number
Returns number
- Defined in Tone/core/context/BaseContext.ts:124

`Abstract` setTimeout

setTimeout(_fn, _timeout): number
Parameters
- _fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- _timeout: number
Returns number
- Defined in Tone/core/context/BaseContext.ts:117

toJSON

toJSON(): Record<string, any>
Returns Record<string, any>
- Defined in Tone/core/context/BaseContext.ts:156

toString

toString(): string
Convert the class to a string

Returns string
Example
```
const osc = new Tone.Oscillator();
console.log(osc.toString());
```
Inherited from Emitter.toString
- Defined in Tone/core/Tone.ts:104

`Static` getDefaults

getDefaults(): BaseToneOptions
Returns all of the default options belonging to the class.

Returns BaseToneOptions
Inherited from Emitter.getDefaults
- Defined in Tone/core/Tone.ts:39

`Static` mixin

mixin(constr): void
Add Emitter functions (on/off/emit) to the object
Parameters
- constr: any
Returns void
Inherited from Emitter.mixin
- Defined in Tone/core/util/Emitter.ts:109

Class BaseContextAbstract

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns BaseContext

Properties

debug

Readonly isOffline

Abstract latencyHint

Abstract lookAhead

Readonly name

Static version

Accessors

Abstract currentTime

Returns number

Abstract destination

Returns DestinationClass

disposed

Returns boolean

Abstract draw

Returns DrawClass

Abstract listener

Returns ListenerClass

Abstract rawContext

Returns AnyAudioContext

Abstract sampleRate

Returns number

Abstract state

Returns AudioContextState

Abstract transport

Returns TransportClass

Methods

Abstract addAudioWorkletModule

Parameters

Returns Promise<void>

Abstract clearInterval

Parameters

Returns this

Abstract clearTimeout

Parameters

Returns this

Abstract createAnalyser

Returns AnalyserNode

Abstract createAudioWorkletNode

Parameters

Returns AudioWorkletNode

Abstract createBiquadFilter

Returns BiquadFilterNode

Abstract createBuffer

Parameters

Returns AudioBuffer

Abstract createBufferSource

Returns AudioBufferSourceNode

Abstract createChannelMerger

Parameters

Returns ChannelMergerNode

Abstract createChannelSplitter

Parameters

Returns ChannelSplitterNode

Abstract createConstantSource

Returns ConstantSourceNode

Abstract createConvolver

Returns ConvolverNode

Abstract createDelay

Parameters

Returns DelayNode

Abstract createDynamicsCompressor

Returns DynamicsCompressorNode

Abstract createGain

Returns GainNode

Abstract createIIRFilter

Parameters

Returns IIRFilterNode

Abstract createMediaElementSource

Class BaseContext`Abstract`

`Readonly` isOffline

`Abstract` latencyHint

`Abstract` lookAhead

`Readonly` name

`Static` version

`Abstract` currentTime

`Abstract` destination

`Abstract` draw

`Abstract` listener

`Abstract` rawContext

`Abstract` sampleRate

`Abstract` state

`Abstract` transport

`Abstract` addAudioWorkletModule

`Abstract` clearInterval

`Abstract` clearTimeout

`Abstract` createAnalyser

`Abstract` createAudioWorkletNode

`Abstract` createBiquadFilter

`Abstract` createBuffer

`Abstract` createBufferSource

`Abstract` createChannelMerger

`Abstract` createChannelSplitter

`Abstract` createConstantSource

`Abstract` createConvolver

`Abstract` createDelay

`Abstract` createDynamicsCompressor

`Abstract` createGain

`Abstract` createIIRFilter

`Abstract` createMediaElementSource

`Abstract` createMediaStreamDestination

`Abstract` createMediaStreamSource

`Abstract` createOscillator

`Abstract` createPanner

`Abstract` createPeriodicWave

`Abstract` createStereoPanner

`Abstract` createWaveShaper

`Abstract` decodeAudioData

`Abstract` getConstant

`Abstract` immediate

`Abstract` now

`Abstract` resume

`Abstract` setInterval

`Abstract` setTimeout

`Static` getDefaults

`Static` mixin