AudioBufferSourceNode

An audio source consisting of in-memory audio data, stored in an AudioBuffer. This is the node to use when playing back one-shot or looping sounds (e.g. game sound effects and music).

new AudioBufferSourceNode(context, options): AudioBufferSourceNode

Parameters

Parameter	Type
`context`	`BaseAudioContext`
`options`	`AudioBufferSourceOptions`

See

https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/AudioBufferSourceNode

Properties

Property	Type	Description	Inherited from
`onended`	`null` \| (`this`, `ev`) => `any`	MDN Reference	`globalThis.AudioBufferSourceNode.onended` `AudioScheduledSourceNode`.`onended`

Accessors

buffer

get buffer(): null | AudioBuffer

The AudioBuffer providing the audio asset to play.

See

https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/buffer

set buffer(buffer): void

MDN Reference

Parameters

Parameter	Type
`buffer`	`null` \| `AudioBuffer`

Implementation of

globalThis.AudioBufferSourceNode.buffer

channelCount

get channelCount(): number

See

https://developer.mozilla.org/docs/Web/API/AudioNode/channelCount

set channelCount(v): void

MDN Reference

Parameters

Parameter	Type
`v`	`number`

Implementation of

globalThis.AudioBufferSourceNode.channelCount

Inherited from

AudioScheduledSourceNode.channelCount

channelCountMode

get channelCountMode(): ChannelCountMode

See

https://developer.mozilla.org/docs/Web/API/AudioNode/channelCountMode

set channelCountMode(v): void

MDN Reference

Parameters

Parameter	Type
`v`	`ChannelCountMode`

Implementation of

globalThis.AudioBufferSourceNode.channelCountMode

Inherited from

AudioScheduledSourceNode.channelCountMode

channelInterpretation

get channelInterpretation(): ChannelInterpretation

See

https://developer.mozilla.org/docs/Web/API/AudioNode/channelInterpretation

set channelInterpretation(v): void

MDN Reference

Parameters

Parameter	Type
`v`	`ChannelInterpretation`

Implementation of

globalThis.AudioBufferSourceNode.channelInterpretation

Inherited from

AudioScheduledSourceNode.channelInterpretation

context

get context(): BaseAudioContext

The BaseAudioContext which the node participates in.

See

https://developer.mozilla.org/docs/Web/API/AudioNode/context

Implementation of

globalThis.AudioBufferSourceNode.context

detune

get detune(): AudioParam

Detuning of the playback, in cents.

See

https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/detune

Implementation of

globalThis.AudioBufferSourceNode.detune

loop

get loop(): boolean

See

https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/loop

set loop(v): void

MDN Reference

Parameters

Parameter	Type
`v`	`boolean`

loopEnd

get loopEnd(): number

See

https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/loopEnd

set loopEnd(v): void

MDN Reference

Parameters

Parameter	Type
`v`	`number`

Implementation of

globalThis.AudioBufferSourceNode.loopEnd

loopStart

get loopStart(): number

See

https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/loopStart

set loopStart(v): void

MDN Reference

Parameters

Parameter	Type
`v`	`number`

Implementation of

globalThis.AudioBufferSourceNode.loopStart

numberOfInputs

get numberOfInputs(): number

See

https://developer.mozilla.org/docs/Web/API/AudioNode/numberOfInputs

Implementation of

globalThis.AudioBufferSourceNode.numberOfInputs

Inherited from

AudioScheduledSourceNode.numberOfInputs

numberOfOutputs

get numberOfOutputs(): number

See

https://developer.mozilla.org/docs/Web/API/AudioNode/numberOfOutputs

Implementation of

globalThis.AudioBufferSourceNode.numberOfOutputs

Inherited from

AudioScheduledSourceNode.numberOfOutputs

playbackRate

get playbackRate(): AudioParam

Speed factor at which the audio asset will be played (1 = normal). Since no pitch correction is applied, this changes the pitch of the sound as well.

See

https://developer.mozilla.org/docs/Web/API/AudioBufferSourceNode/playbackRate

Implementation of

globalThis.AudioBufferSourceNode.playbackRate

Methods

addEventListener()

addEventListener(type, callback, options?): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

Parameters

Parameter	Type
`type`	`string`
`callback`	`null` \| `EventListenerOrEventListenerObject`<`any`>
`options`?	`boolean` \| `AddEventListenerOptions`

Returns

void

Implementation of

globalThis.AudioBufferSourceNode.addEventListener

Inherited from

AudioScheduledSourceNode.addEventListener

See

https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener

connect()

connect(destinationNode, output, input)

connect(destinationNode, output?, input?): AudioNode

Connects one of the node's outputs to a destination node, directing the processed audio data to it.

Note

Connecting to an AudioParam is not currently supported in nx.js.

Parameters

Parameter	Type
`destinationNode`	`AudioNode`
`output`?	`number`
`input`?	`number`

Returns

AudioNode

Implementation of

globalThis.AudioBufferSourceNode.connect

Inherited from

AudioScheduledSourceNode.connect

See

https://developer.mozilla.org/docs/Web/API/AudioNode/connect

connect(destinationParam, output)

connect(destinationParam, output?): void

Parameters

Parameter	Type
`destinationParam`	`AudioParam`
`output`?	`number`

Returns

void

Implementation of

globalThis.AudioBufferSourceNode.connect

Inherited from

AudioScheduledSourceNode.connect

disconnect()

disconnect(): void

Disconnects one or more nodes from the node.

Returns

void

Implementation of

globalThis.AudioBufferSourceNode.disconnect

Inherited from

AudioScheduledSourceNode.disconnect

See

https://developer.mozilla.org/docs/Web/API/AudioNode/disconnect

disconnect(output)

disconnect(output): void

Parameters

Parameter	Type
`output`	`number`

Returns

void

Implementation of

globalThis.AudioBufferSourceNode.disconnect

Inherited from

AudioScheduledSourceNode.disconnect

disconnect(destinationNode)

disconnect(destinationNode): void

Parameters

Parameter	Type
`destinationNode`	`AudioNode`

Returns

void

Implementation of

globalThis.AudioBufferSourceNode.disconnect

Inherited from

AudioScheduledSourceNode.disconnect

disconnect(destinationNode, output)

disconnect(destinationNode, output): void

Parameters

Parameter	Type
`destinationNode`	`AudioNode`
`output`	`number`

Returns

void

Implementation of

globalThis.AudioBufferSourceNode.disconnect

Inherited from

AudioScheduledSourceNode.disconnect

disconnect(destinationNode, output, input)

disconnect(destinationNode, output, input): void

Parameters

Parameter	Type
`destinationNode`	`AudioNode`
`output`	`number`
`input`	`number`

Returns

void

Implementation of

globalThis.AudioBufferSourceNode.disconnect

Inherited from

AudioScheduledSourceNode.disconnect

disconnect(destinationParam)

disconnect(destinationParam): void

Parameters

Parameter	Type
`destinationParam`	`AudioParam`

Returns

void

Implementation of

globalThis.AudioBufferSourceNode.disconnect

Inherited from

AudioScheduledSourceNode.disconnect

disconnect(destinationParam, output)

disconnect(destinationParam, output): void

Parameters

Parameter	Type
`destinationParam`	`AudioParam`
`output`	`number`

Parameter	Type
`event`	`Event`

Parameter	Type
`type`	`string`
`callback`	`null` \| `EventListenerOrEventListenerObject`<`any`>
`options`?	`boolean` \| `EventListenerOptions`

Parameter	Type	Default value	Description
`when`	`number`	`0`	Time (in context seconds) the playback should begin. Values in the past begin immediately.
`offset`	`number`	`0`	Offset (in seconds) into the buffer where playback should begin.
`duration`?	`number`	`undefined`	Duration (in seconds) of buffer content to play.

Parameter	Type	Default value	Description
`when`	`number`	`0`	Time (in context seconds) the playback should stop. Values in the past stop immediately.