Audio · class

MixBus

class MixBus

import { MixBus } from '@driftengine/audio';

Constructor

`new`

constructor(name: string, context: BaseAudioContext, scheduleAt: ScheduleClock, options?: BusOptions)

Parameter	Type	Description
`name`	`string`
`context`	`BaseAudioContext`
`scheduleAt`	`ScheduleClock`
`options?`	`BusOptions`

Properties

Name	Type	Description
`name`readonly	`string`
`input`readonly	`GainNode`	The fader. Sources and child buses connect here.
`tap`readonly	`GainNode`	Where sends listen from. Unity, always.
`output`readonly	`GainNode`	What the parent hears. Unity, always.
`parent`readonly	`MixBus \| null`
`onSoloChanged`	`(() => void) \| null`	Set by the console when it adopts this bus, so a solo anywhere re-resolves the whole tree.

Accessors

Name	Type	Description
`children`get	`readonly MixBus[]`
`level`get	`number`
`muted`get	`boolean`
`soloed`get	`boolean`
`sendTargets`get	`readonly MixBus[]`	Every return this bus feeds, for a snapshot to capture.
`duckedTo`get	`number`	What this bus is ducked to, 1 when it is not. See `duck`.

Methods

`feedFromInput`

feedFromInput(node: AudioNode): void

Feed a node from this bus's signal as it arrives, before any insert. See inputTaps.

Parameter	Type	Description
`node`	`AudioNode`

`insert`

insert(insert: MixInsert, options?: InsertOptions): void

Append a stage to this bus's own signal path. See InsertOptions.postSend.

Parameter	Type	Description
`insert`	`MixInsert`
`options?`	`InsertOptions`

`send`

send(returnBus: MixBus, amount: number): void

Feed a return bus from this one, at amount.

Parameter	Type	Description
`returnBus`	`MixBus`
`amount`	`number`

Idempotent per target: asking twice moves the existing send rather than building a second one, because this is called from per-frame code in every consumer that has ever used it and a send node per frame is a graph that grows until the page stops.

`sendAmount`

sendAmount(returnBus: MixBus): number

What this bus was last asked to send to that return, or 0 if it has never sent to it.

Parameter	Type	Description
`returnBus`	`MixBus`

`setLevel`

setLevel(level: number): void

Parameter	Type	Description
`level`	`number`

`fadeLevel`

fadeLevel(level: number, seconds: number): void

Move to a level over an explicit time, rather than at the fader's own smoothing.

Parameter	Type	Description
`level`	`number`
`seconds`	`number`

A fader is a control and wants to feel immediate; a snapshot recall is an edit and takes as long as it was asked to take. Both write the same mirrored level, so the mix knows where it is either way — which AudioGraph.fadeMusic deliberately does not do, because a fade there is part of an edit that has to return to the player's setting when it is over.

`duck`

duck(factor: number, seconds: number): void

Move over the top of the fader and back, without moving the fader.

Parameter	Type	Description
`factor`	`number`
`seconds`	`number`

duck(0, 0.4) takes this bus away over four tenths of a second; duck(1, 0.4) brings it back to exactly whatever the fader is set to, including a setting the player changed in between. Cost: this is a second thing multiplying into one parameter, so a caller that ducks and forgets to release leaves a bus quiet with a fader that says otherwise — which is why duckedTo is readable rather than private.

`setMute`

setMute(muted: boolean): void

Parameter	Type	Description
`muted`	`boolean`

`setSolo`

setSolo(soloed: boolean): void

Parameter	Type	Description
`soloed`	`boolean`

`setSoloGate`

setSoloGate(gate: number): void

Written by the console alone. 1 is audible, 0 is silenced by somebody else's solo.

Parameter	Type	Description
`gate`	`number`