Notoriously Punctual Manatee

    @pixi/sound
    TypeScript icon, indicating that this package has built-in type declarations

    4.2.0 • Public • Published

    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.Loader system
    • Dynamic filters:
      • ReverbFilter
      • DistortionFilter
      • EqualizerFilter
      • StereoFilter
      • TelephoneFilter

    Known Compatibility

    • Chrome 58+
    • Firefox 49+
    • Safari 10+
    • iOS 9+
    • IE 9+

    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>

    Resources

    License

    MIT License.

    Install

    npm i @pixi/sound

    DownloadsWeekly Downloads

    2,484

    Version

    4.2.0

    License

    MIT

    Unpacked Size

    710 kB

    Total Files

    11

    Last publish

    Collaborators

    • andrewstart
    • dev7355608
    • bigtimebuddy