sound - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #llm #go #golang #rust #nodejs #java #windows #vue #ios #open-source

sound

(★ 476)

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

File Explorer

Download Latest Version (.zip)

- - main.yml
- CODE_OF_CONDUCT.md
- settings.json
- - .eslintrc.json
  - demo.js
  - filters.js
  - index.js
  - sprites.js
- - examples.css
  - range.css
- - applause.mp3
  - applause.ogg
  - bird.mp3
  - boing.mp3
  - buzzer.mp3
  - car.mp3
  - chime.mp3
  - github.svg
  - logo.svg
  - mechanical.mp3
  - musical.mp3
  - sprite.mp3
  - success.mp3
  - sword.mp3
  - whistle.mp3
- demo.html
- filters.html
- index.html
- sprites.html
- - DistortionFilter.ts
  - EqualizerFilter.ts
  - Filter.ts
  - index.ts
  - MonoFilter.ts
  - ReverbFilter.ts
  - StereoFilter.ts
  - StreamFilter.ts
  - TelephoneFilter.ts
- - HTMLAudioContext.ts
  - HTMLAudioInstance.ts
  - HTMLAudioMedia.ts
  - index.ts
- - IMedia.ts
  - IMediaContext.ts
  - IMediaInstance.ts
  - index.ts
- - index.ts
  - playOnce.ts
  - render.ts
  - sineTone.ts
  - supported.ts
- - index.ts
  - WebAudioContext.ts
  - WebAudioInstance.ts
  - WebAudioMedia.ts
  - WebAudioNodes.ts
  - WebAudioUtils.ts
- browser.ts
- Filterable.ts
- index.ts
- instance.ts
- Sound.ts
- soundAsset.ts
- SoundLibrary.ts
- SoundSprite.ts
- - alert-12.mp3
  - alert-4.mp3
  - alert-4.ogg
  - alert-7.mp3
  - dataUrlResources.ts
  - musical-11.mp3
  - silence.mp3
- .eslintrc.json
- htmlaudio.test.ts
- index.test.ts
- suite.ts
- webaudio.test.ts
.gitignore
.npmrc
LICENSE
package-lock.json
package.json
README.md
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/pixijs/sound

Downloads the entire project code from GitHub to your computer.

cd sound

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm i @pixi/sound --save

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PixiJS Sound

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

[![Node.js CI](https://github.com/pixijs/sound/workflows/Node.js%20CI/badge.svg)](https://github.com/pixijs/sound/actions?query=workflow%3A%22Node.js+CI%22) [![npm version](https://badge.fury.io/js/%40pixi%2Fsound.svg)](https://badge.fury.io/js/%40pixi%2Fsound)

**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](https://npmjs.org):

```bash
npm i @pixi/sound --save
```

To import into your project, for instance, when using [Webpack](https://webpack.js.org/), [Parcel](https://parceljs.org/), [Rollup](https://rollupjs.org/), or another bundler:

```typescript
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.

```html

<script src="https://unpkg.com/pixi.js/dist/browser/pixi.min.js"></script>

<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

* [Releases](https://github.com/pixijs/sound/releases)
* [Basics](https://pixijs.io/sound/examples/index.html)
* [Sprites](https://pixijs.io/sound/examples/sprites.html)
* [Filters](https://pixijs.io/sound/examples/filters.html)
* [Demo](https://pixijs.io/sound/examples/demo.html)
* [API Documentation](https://pixijs.io/sound/docs/index.html)

## License

MIT License.