bgm.stop

Stops the currently playing BGM.

Parameters

Parameter	Type	Description
options	BgmStopOptions	Optional stop configuration (e.g., fade-out). Omit for immediate stop.

Returns

Promise<void>

Example

// Immediate stop
await audio.bgm.stop();

// Fade out over 2 seconds
await audio.bgm.stop({
  fadeOut: { durationSecs: 2.0, easing: "easeOut" },
});