@tsparticles/plugin-sounds

tsParticles Sounds Plugin

tsParticles plugin for particles sounds effect.

How to use it

CDN / Vanilla JS / jQuery

The CDN/Vanilla version JS has one required file in vanilla configuration:

Including the tsparticles.plugin.sounds.min.js file will export the function to load the plugin:

loadSoundsPlugin;

Usage

Once the scripts are loaded you can set up tsParticles and the plugin like this:

(async () => {
  await loadSoundsPlugin(tsParticles);

  await tsParticles.load({
    id: "tsparticles",
    options: {
      /* options */
    },
  });
})();

ESM / CommonJS

This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:

$ npm install @tsparticles/plugin-sounds

or

$ yarn add @tsparticles/plugin-sounds

Then you need to import it in the app, like this:

const { tsParticles } = require("@tsparticles/engine");
const { loadSoundsPlugin } = require("@tsparticles/plugin-sounds");

(async () => {
  await loadSoundsPlugin(tsParticles);
})();

or

import { tsParticles } from "@tsparticles/engine";
import { loadSoundsPlugin } from "@tsparticles/plugin-sounds";

(async () => {
  await loadSoundsPlugin(tsParticles);
})();

Changelog

3.5.0 (2024-07-01)

Features

• added customization for animation loop, fixes #5355 (76d9dfd)