Class Master

The master bus of an AudioDevice: the final routing point that every Channel eventually connects into, and which connects to AudioContext.destination. Can also host its own effect chain and directly attached AudioClip instances via an internal AudioClipPlayer.

Example

import { Master, Channel } from "@fluex/fluexgl-dsp";

const master = new Master(context);
const channel = new Channel(context);

channel.send(master);

---

Constructor

Constructs a new Master channel, wiring input → effects → gainNode → analyserNode → context.destination, and creates its internal AudioClipPlayer.

new Master(context: AudioContext): Master;

Arguments

• context: AudioContext - The AudioContext used to create this master channel's internal audio nodes.

---

Properties

id: string

A unique id, automatically generated when constructing a new master channel. Should NOT be changed.

channels: Channel[]

All Channel instances currently attached to this master via attachChannel().

effects: Effector[]

List of attached Effector instances, wired between input and gainNode.

input: GainNode | null

Input node of this master channel. Channels are connected here (directly, or through the effect chain) when attached.

gainNode: GainNode | null

Gain node used to control the overall output volume of this master channel.

analyserNode: AnalyserNode | null

Analyser node used for visualization / analysis of the master signal, placed right before context.destination.

context: AudioContext | null

The AudioContext this master channel was constructed with.

audioClipPlayer: AudioClipPlayer | null

AudioClipPlayer owned by this master channel. Used to attach and play AudioClip instances directly into the master bus.

---

Methods

attachEffect(effect: Effector): void

Adds an Effector to this master channel, initializes it using this channel's AudioContext, and rebuilds the internal effect chain routing. Effects are processed in the order they were attached, and connected through their inputNode and outputNode. Logs an error if the effect is already attached.

Spatial renderers (SpatialAudioRenderer2D, SpatialAudioRenderer3D) attach a Limiter to their own master channel by default (not when they are given an output). Effects attached afterwards come after that limiter.

Arguments

• effect: Effector - The effect instance to attach.

Returns

• void

detachEffect(effect: Effector): void

Removes an attached Effector from this master channel, disconnects its outputNode, and rebuilds the internal effect chain routing. Logs an error if the effect is not part of this master channel.

Arguments

• effect: Effector - The effect instance to detach.

Returns

• void

attachChannel(channel: Channel): void

Registers a Channel as connected into this master channel's input, and adds this master to the channel's masters. Logs an error if the channel is already attached. This is normally called for you via channel.send(master).

Arguments

• channel: Channel - The channel to attach.

Returns

• void

detachChannel(channel: Channel): boolean

Disconnects a previously attached Channel from this master channel's input, and removes this master from the channel's masters. This is normally called for you via channel.unsend(master).

Detaching a channel that is not attached only logs a warning and does not throw, so it is safe to call at any time.

Arguments

• channel: Channel - The channel to detach.

Returns

• boolean - true when the channel has been detached, false when it was not attached.

Warnings

• WARNING:FLUEXGL-DSP@0005 (WarningCodes.CHANNEL_NOT_ATTACHED) - The channel is not attached to this master channel.

detachAllChannels(): void

Detaches every attached channel from this master channel.

Arguments

No arguments

Returns

• void

hasChannel(channel: Channel): boolean

Returns whether the given Channel is attached to this master channel.

Arguments

• channel: Channel

Returns

• boolean

hasAudioClipPlayer(): boolean

Returns whether this master channel has a constructed AudioClipPlayer.

Arguments

No arguments

Returns

• boolean - true if audioClipPlayer is defined, otherwise false.

attachAudioClip(audioClip: AudioClip): void

Attaches an AudioClip directly to this master channel via its internal AudioClipPlayer. Logs an error if this master channel has no audioClipPlayer.

Arguments

• audioClip: AudioClip - The audio clip to attach.

Returns

• void

Events

This class does not emit custom events.

---

Getters and setters

This class does not define public getters or setters.

---

Examples

Example 1: getting the default master channel from a device

import { DspPipeline } from "@fluex/fluexgl-dsp";

(async function () {
    const pipeline = new DspPipeline({
        pathToWasm: "/data/fluexgl-dsp-wasm_bg.wasm",
        pathToWorklet: "/data/fluexgl-dsp-processor.worklet"
    });

    await pipeline.initializeDpsPipeline();

    const audioDevice = await pipeline.resolveDefaultAudioOutputDevice();
    if (!audioDevice) return;

    const master = audioDevice.getMasterChannel();
    const channel = audioDevice.createChannel();

    channel.send(master);
})();

Example 2: playing an audio clip directly through the master

import { AudioClip } from "@fluex/fluexgl-dsp";

const master = audioDevice.getMasterChannel();
const clip = new AudioClip(audioSourceData);

clip.send(master);
clip.play();