Sounds and music

The sound module is a wrapper around the Tone.js library. It provides a simple interface for playing sounds and saves the current state at each step.

import { narration, newLabel, sound } from "@drincs/pixi-vn";

export const startLabel = newLabel("start", [
    async () => {
        await sound.play("sfx_whoosh", { delay: 0.1 });
        await sound.play("bgm_cheerful", { loop: true, channel: "bgm" });
        narration.dialogue =
            "Hello, I'm a cheerful background music that will loop forever until you stop me.";
    },
    () => {
        sound.pause("bgm_cheerful");
        narration.dialogue = "I'm paused, but I can be resumed.";
    },
    () => {
        sound.resume("bgm_cheerful");
        narration.dialogue = "I'm back!";
    },
]);

Initialize

It is also recommended to define channels immediately after game initialization. To do this, you can use the sound.addChannel function.

import { Game, sound } from "@drincs/pixi-vn";

Game.init(body, {
    // ...
}).then(() => {
    sound.addChannel("bgm", { background: true });
    sound.addChannel("sfx");
    sound.defaultChannelAlias = "sfx";
});

Play

The basic functionality is to start a sound (asset). This can be done using the play function. The play function generates a media instance that you can interact with to control the produced sound.

Transitions

Pause and resume

There are various ways to pause individual or multiple media.

Edit

It is possible to edit almost all settings at any time for different purposes.

Stop

To stop a sound, you can use the stop function.

Filters

Filters are elements that allow advanced customization of sounds.

Other features