Skip to content

@liminal-hq/undertone / createMasterBus

Function: createMasterBus() ​

createMasterBus(ctx, options?): MasterBus

Defined in: masterBus.ts:89

Creates a master bus: voices play into bus.input, pass a gain stage and a limiter, and reach output (the speakers by default). Undertone writes straight to the destination otherwise, so a dense mix can peak near or above full scale; routing it through this keeps it in range.

Nothing is created until you call this, and it is an ordinary object you hold, so a game with several mix groups can make one per group. The limiter is skipped, with a warning, when the output has more than two channels (a dynamics compressor only handles stereo, so it would collapse a surround mix) or when the context has no createDynamicsCompressor; the gain stage still works.

Parameters ​

ctx ​

AudioContextLike

options? ​

MasterBusOptions = {}

Returns ​

MasterBus