Interface: AudioContext

Defined in: types/desktop-engine.d.ts:5170

Plays to the speakers. Needs the "audio" permission in manifest.json, otherwise it stays "suspended". Kept alive until close(), like in browsers

Extends

• BaseAudioContext

Properties

audioWorklet

readonly audioWorklet: undefined;

Defined in: types/desktop-engine.d.ts:5133

AudioWorklet isn't supported

Inherited from

BaseAudioContext.audioWorklet

---

baseLatency

readonly baseLatency: number;

Defined in: types/desktop-engine.d.ts:5172

Seconds

---

currentTime

readonly currentTime: number;

Defined in: types/desktop-engine.d.ts:5127

Seconds since the context started, the time of start(), stop() and automation

Inherited from

BaseAudioContext.currentTime

---

destination

readonly destination: AudioDestinationNode;

Defined in: types/desktop-engine.d.ts:5128

Inherited from

BaseAudioContext.destination

---

listener

readonly listener: AudioListener;

Defined in: types/desktop-engine.d.ts:5129

Inherited from

BaseAudioContext.listener

---

onstatechange

onstatechange: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:5134

Inherited from

BaseAudioContext.onstatechange

---

outputLatency

readonly outputLatency: number;

Defined in: types/desktop-engine.d.ts:5174

Seconds

---

sampleRate

readonly sampleRate: number;

Defined in: types/desktop-engine.d.ts:5125

Inherited from

BaseAudioContext.sampleRate

---

sinkId

readonly sinkId: string;

Defined in: types/desktop-engine.d.ts:5176

Always "": the default output device

---

state

readonly state: AudioContextState;

Defined in: types/desktop-engine.d.ts:5131

"interrupted" while the app pauses the content

Inherited from

BaseAudioContext.state

Methods

addEventListener()

Call Signature

addEventListener<K>(
   type, 
   listener, 
   options?
): void;

Defined in: types/desktop-engine.d.ts:5159

A boolean options (capture) is ignored

Type Parameters

Type Parameter
K extends "statechange"

Parameters

Parameter	Type
type	K
listener	(this, event) => void
options?	| boolean | AddEventListenerOptions

Returns

void

Inherited from

BaseAudioContext.addEventListener

Call Signature

addEventListener(
   type, 
   listener, 
   options?
): void;

Defined in: types/desktop-engine.d.ts:5160

A boolean options (capture) is ignored

Parameters

Parameter	Type
type	string
listener	| EventListenerOrEventListenerObject | null
options?	| boolean | AddEventListenerOptions

Returns

void

Inherited from

BaseAudioContext.addEventListener

---

close()

close(): Promise<void>;

Defined in: types/desktop-engine.d.ts:5182

Stops the sound and frees the context

Returns

Promise<void>

---

createAnalyser()

createAnalyser(): AnalyserNode;

Defined in: types/desktop-engine.d.ts:5144

Returns

AnalyserNode

Inherited from

BaseAudioContext.createAnalyser

---

createBiquadFilter()

createBiquadFilter(): BiquadFilterNode;

Defined in: types/desktop-engine.d.ts:5139

Returns

BiquadFilterNode

Inherited from

BaseAudioContext.createBiquadFilter

---

createBuffer()

createBuffer(
   numberOfChannels, 
   length, 
   sampleRate
): AudioBuffer;

Defined in: types/desktop-engine.d.ts:5150

Parameters

Parameter	Type
numberOfChannels	number
length	number
sampleRate	number

Returns

AudioBuffer

Inherited from

BaseAudioContext.createBuffer

---

createBufferSource()

createBufferSource(): AudioBufferSourceNode;

Defined in: types/desktop-engine.d.ts:5136

Returns

AudioBufferSourceNode

Inherited from

BaseAudioContext.createBufferSource

---

createChannelMerger()

createChannelMerger(numberOfInputs?): ChannelMergerNode;

Defined in: types/desktop-engine.d.ts:5149

Parameters

Parameter	Type
numberOfInputs?	number

Returns

ChannelMergerNode

Inherited from

BaseAudioContext.createChannelMerger

---

createChannelSplitter()

createChannelSplitter(numberOfOutputs?): ChannelSplitterNode;

Defined in: types/desktop-engine.d.ts:5148

Parameters

Parameter	Type
numberOfOutputs?	number

Returns

ChannelSplitterNode

Inherited from

BaseAudioContext.createChannelSplitter

---

createConstantSource()

createConstantSource(): ConstantSourceNode;

Defined in: types/desktop-engine.d.ts:5138

Returns

ConstantSourceNode

Inherited from

BaseAudioContext.createConstantSource

---

createConvolver()

createConvolver(): ConvolverNode;

Defined in: types/desktop-engine.d.ts:5146

Returns

ConvolverNode

Inherited from

BaseAudioContext.createConvolver

---

createDelay()

createDelay(maxDelayTime?): DelayNode;

Defined in: types/desktop-engine.d.ts:5141

Parameters

Parameter	Type
maxDelayTime?	number

Returns

DelayNode

Inherited from

BaseAudioContext.createDelay

---

createDynamicsCompressor()

createDynamicsCompressor(): DynamicsCompressorNode;

Defined in: types/desktop-engine.d.ts:5145

Returns

DynamicsCompressorNode

Inherited from

BaseAudioContext.createDynamicsCompressor

---

createGain()

createGain(): GainNode;

Defined in: types/desktop-engine.d.ts:5135

Returns

GainNode

Inherited from

BaseAudioContext.createGain

---

createIIRFilter()

createIIRFilter(feedforward, feedback): IIRFilterNode;

Defined in: types/desktop-engine.d.ts:5140

Parameters

Parameter	Type
feedforward	Iterable<number>
feedback	Iterable<number>

Returns

IIRFilterNode

Inherited from

BaseAudioContext.createIIRFilter

---

createMediaElementSource()

createMediaElementSource(mediaElement): never;

Defined in: types/desktop-engine.d.ts:5184

Not supported: throws a "NotSupportedError" DOMException

Parameters

Parameter	Type
mediaElement	HTMLMediaElement

Returns

never

---

createMediaStreamDestination()

createMediaStreamDestination(): never;

Defined in: types/desktop-engine.d.ts:5188

Not supported: throws a "NotSupportedError" DOMException

Returns

never

---

createMediaStreamSource()

createMediaStreamSource(mediaStream): never;

Defined in: types/desktop-engine.d.ts:5186

Not supported: throws a "NotSupportedError" DOMException

Parameters

Parameter	Type
mediaStream	unknown

Returns

never

---

createOscillator()

createOscillator(): OscillatorNode;

Defined in: types/desktop-engine.d.ts:5137

Returns

OscillatorNode

Inherited from

BaseAudioContext.createOscillator

---

createPanner()

createPanner(): PannerNode;

Defined in: types/desktop-engine.d.ts:5143

Returns

PannerNode

Inherited from

BaseAudioContext.createPanner

---

createPeriodicWave()

createPeriodicWave(
   real, 
   imag, 
   constraints?
): PeriodicWave;

Defined in: types/desktop-engine.d.ts:5151

Parameters

Parameter	Type
real	Iterable<number>
imag	Iterable<number>
constraints?	PeriodicWaveConstraints

Returns

PeriodicWave

Inherited from

BaseAudioContext.createPeriodicWave

---

createScriptProcessor()

createScriptProcessor(
   bufferSize?, 
   numberOfInputChannels?, 
   numberOfOutputChannels?
): never;

Defined in: types/desktop-engine.d.ts:5153

Not supported: throws a "NotSupportedError" DOMException

Parameters

Parameter	Type
bufferSize?	number
numberOfInputChannels?	number
numberOfOutputChannels?	number

Returns

never

Inherited from

BaseAudioContext.createScriptProcessor

---

createStereoPanner()

createStereoPanner(): StereoPannerNode;

Defined in: types/desktop-engine.d.ts:5142

Returns

StereoPannerNode

Inherited from

BaseAudioContext.createStereoPanner

---

createWaveShaper()

createWaveShaper(): WaveShaperNode;

Defined in: types/desktop-engine.d.ts:5147

Returns

WaveShaperNode

Inherited from

BaseAudioContext.createWaveShaper

---

decodeAudioData()

decodeAudioData(
   audioData, 
   successCallback?, 
   errorCallback?
): Promise<AudioBuffer>;

Defined in: types/desktop-engine.d.ts:5158

Decodes a whole audio file (a format macOS decodes) into a buffer at the context's sample rate. The data is copied, not detached. Rejects with an "EncodingError" DOMException when it can't be decoded; the callbacks are optional

Parameters

Parameter	Type
audioData	ArrayBuffer | ArrayBufferView<ArrayBufferLike>
successCallback?	((decodedData) => void) | null
errorCallback?	((error) => void) | null

Returns

Promise<AudioBuffer>

Inherited from

BaseAudioContext.decodeAudioData

---

dispatchEvent()

dispatchEvent(event): boolean;

Defined in: types/desktop-engine.d.ts:3937

Returns false when a listener called preventDefault() on a cancelable event

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

BaseAudioContext.dispatchEvent

---

getOutputTimestamp()

getOutputTimestamp(): AudioTimestamp;

Defined in: types/desktop-engine.d.ts:5177

Returns

AudioTimestamp

---

removeEventListener()

Call Signature

removeEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:5161

Type Parameters

Type Parameter
K extends "statechange"

Parameters

Parameter	Type
type	K
listener	(this, event) => void

Returns

void

Inherited from

BaseAudioContext.removeEventListener

Call Signature

removeEventListener(type, listener): void;

Defined in: types/desktop-engine.d.ts:5162

Parameters

Parameter	Type
type	string
listener	| EventListenerOrEventListenerObject | null

Returns

void

Inherited from

BaseAudioContext.removeEventListener

---

resume()

resume(): Promise<void>;

Defined in: types/desktop-engine.d.ts:5179

Rejects with a "NotAllowedError" DOMException without the "audio" permission, "InvalidStateError" once closed

Returns

Promise<void>

---

suspend()

suspend(): Promise<void>;

Defined in: types/desktop-engine.d.ts:5180

Returns

Promise<void>