Skip to content
forked from pixijs/sound

WebAudio API playback library, with filters. Modern audio playback for modern browsers.

License

Notifications You must be signed in to change notification settings

ehtick/pixijs-sound

 
 

Repository files navigation

PixiJS Sound

WebAudio API playback library, with filters. Modern audio playback for modern browsers.

Node.js CI npm version

Features

  • Pausing and resuming
  • Independent volume control
  • Support blocking or layered sounds (multiple instances)
  • Support for PIXI.Assets system
  • Dynamic filters:
    • ReverbFilter
    • DistortionFilter
    • EqualizerFilter
    • StereoFilter
    • TelephoneFilter

Known Compatibility

  • Chrome 58+
  • Firefox 52+
  • Safari 11+
  • iOS 11+

Usage

Installation is available by NPM:

npm i @pixi/sound --save

To import into your project, for instance, when using Webpack, Parcel, Rollup, or another bundler:

import { sound } from '@pixi/sound';

sound.add('my-sound', 'path/to/file.mp3');
sound.play('my-sound');

Browser Usage

If you're using a <script> element to import @pixi/sound into your project, then the SoundLibrary object is PIXI.sound global.

<!-- PixiJS must be imported before @pixi/sound -->
<script src="https://unpkg.com/pixi.js/dist/browser/pixi.min.js"></script>

<!-- found here, if not using CDN "./node_modules/@pixi/sound/dist/pixi-sound.js" -->
<script src="https://unpkg.com/@pixi/sound/dist/pixi-sound.js"></script>

<script>
    PIXI.sound.add('my-sound', 'path/to/file.mp3');
    PIXI.sound.play('my-sound');
</script>

Versions Compatibility

PixiJS PixiJS Sound
v5.x - v6.x v4.x
v7.x v5.x
v8.x v6.x

Resources

License

MIT License.

About

WebAudio API playback library, with filters. Modern audio playback for modern browsers.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%