Skip to main content

isMasterLimiterEnabled

Added in 5.8.0

isMasterLimiterEnabled(): boolean;

Whether the master limiter is currently active.

Return TypeDescription
booleantrue when the limiter is in the output chain, false when it is not

This reflects the live state of the audio graph, so it stays correct whether the limiter was enabled through the config or later via setMasterLimiter().


Example

const soundHub = new SoundHub({ masterLimiter: true });

soundHub.isMasterLimiterEnabled(); // true

soundHub.setMasterLimiter(false);
soundHub.isMasterLimiterEnabled(); // false

Handy for keeping a toggle in your UI in sync with the actual state:

checkbox.checked = soundHub.isMasterLimiterEnabled();