Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OfflineAudioContext

Package version

An AudioContext interface representing an audio-processing graph built from linked together AudioNodes. In contrast with a standard AudioContext, an OfflineAudioContext doesn't render the audio to the device hardware; instead, it generates it, as fast as it can, and outputs the result to an AudioBuffer.

Hierarchy

Index

Properties

BaseAudioContext

BaseAudioContext: { constructor: any; prototype: BaseAudioContext }

Type declaration

audioWorklet

audioWorklet: AudioWorklet

currentTime

currentTime: number

destination

length

length: number

listener

listener: AudioListener

oncomplete

oncomplete: ((this: OfflineAudioContext, ev: OfflineAudioCompletionEvent) => any) | null

onstatechange

onstatechange: ((this: BaseAudioContext, ev: Event) => any) | null

sampleRate

sampleRate: number

state

Methods

addEventListener

createAnalyser

createBiquadFilter

createBuffer

  • createBuffer(numberOfChannels: number, length: number, sampleRate: number): AudioBuffer
  • Parameters

    • numberOfChannels: number
    • length: number
    • sampleRate: number

    Returns AudioBuffer

createBufferSource

createChannelMerger

  • Parameters

    • Optional numberOfInputs: undefined | number

    Returns ChannelMergerNode

createChannelSplitter

createConstantSource

createConvolver

createDelay

  • createDelay(maxDelayTime?: undefined | number): DelayNode
  • Parameters

    • Optional maxDelayTime: undefined | number

    Returns DelayNode

createDynamicsCompressor

createGain

  • Returns GainNode

createIIRFilter

  • createIIRFilter(feedforward: number[], feedback: number[]): IIRFilterNode
  • Parameters

    • feedforward: number[]
    • feedback: number[]

    Returns IIRFilterNode

createOscillator

createPanner

  • Returns PannerNode

createPeriodicWave

createScriptProcessor

  • createScriptProcessor(bufferSize?: undefined | number, numberOfInputChannels?: undefined | number, numberOfOutputChannels?: undefined | number): ScriptProcessorNode
  • Parameters

    • Optional bufferSize: undefined | number
    • Optional numberOfInputChannels: undefined | number
    • Optional numberOfOutputChannels: undefined | number

    Returns ScriptProcessorNode

createStereoPanner

createWaveShaper

decodeAudioData

dispatchEvent

  • dispatchEvent(event: 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.

    Parameters

    Returns boolean

removeEventListener

resume

  • Returns Promise<void>

startRendering

  • Returns Promise<AudioBuffer>

suspend

  • suspend(suspendTime: number): Promise<void>
  • Parameters

    • suspendTime: number

    Returns Promise<void>

Generated using TypeDoc