# waudsprite

> Audio Sprite Generator for waud.js

Latest version **1.0.3** (published 2017-01-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install waudsprite
pnpm add waudsprite
yarn add waudsprite
bun add waudsprite
```

Provides the command `waudsprite`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2017-01-10 |
| First published | 2016-01-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Adi Reddy Mora |
| Maintainers | adireddy |
| Keywords | audio, audio-sprite, waud, ffmpeg, web audio, web audio api, haxe, javascript, audio, web, sounds, audiocontext, library, waud.js, waud |

## Links

- npm: https://www.npmjs.com/package/waudsprite
- Repository: https://github.com/adireddy/waudsprite
- Homepage: https://github.com/adireddy/waudsprite#readme
- Issues: https://github.com/adireddy/waudsprite/issues
- npm.io page: https://npm.io/package/waudsprite

## Dependencies (8)

- [async](https://npm.io/package/async.md) ~0.9.0
- [grunt](https://npm.io/package/grunt.md) latest
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0
- [winston](https://npm.io/package/winston.md) ~1.0.0
- [optimist](https://npm.io/package/optimist.md) ~0.6.1
- [grunt-cli](https://npm.io/package/grunt-cli.md) latest
- [grunt-exec](https://npm.io/package/grunt-exec.md) latest
- [underscore](https://npm.io/package/underscore.md) ~1.8.3

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2017-01-10
- 1.0.2 — 2016-08-19
- 1.0.1 — 2016-08-19
- 1.0.0 — 2016-08-18
- 0.0.3 — 2016-01-07
- 0.0.2 — 2016-01-07
- 0.0.1 — 2016-01-07

## README

# waudsprite [![npm version](https://badge.fury.io/js/waudsprite.svg)](https://www.npmjs.com/package/waudsprite)

<a href="http://waudjs.com"><img class="logo" width="280" height="60" src="http://waud.github.io/images/logo/logo.png" alt="Waud"/></a>

Audio Sprite Generator for [waud.js](https://github.com/waud/waud) - ported from [audiosprite](https://github.com/tonistiigi/audiosprite).

### Installation

```
npm install -g waudsprite
```

### Dependencies

You need `FFmpeg` framework and `ogg` codecs to use **`waudsprite`**.

Install on OSX using `brew`:

```
brew install ffmpeg --with-theora --with-libogg --with-libvorbis
```

### Usage

```
waudsprite --loop loop --autoplay loop  -o assets/sprite -e m4a assets/*.mp3
```

The above command generates the following json:

```json
{
	"src": "assets/sprite.m4a",
	"sprite": [
		{
			"name": "bell",
			"start": 0,
			"duration": 2.1149886621315193,
			"loop": false
		},
		{
			"name": "canopening",
			"start": 4,
			"duration": 2,
			"loop": false
		},
		{
			"name": "glass",
			"start": 7,
			"duration": 0.5485714285714289,
			"loop": false
		},
		{
			"name": "loop",
			"start": 9,
			"duration": 56.032653061224494,
			"loop": true
		}
	]
}
```

### Help

```
waudsprite --help
info: Usage: waudsprite [options] *.mp3
info: Options:
  --output, -o      Name for the output files.                                   [default: "sprite"]
  --path, -u        Path for files to be used on final JSON.                     [default: ""]
  --export, -e      Limit exported file types. Comma separated extension list.   [default: "ogg,m4a,mp3,ac3"]
  --log, -l         Log level (debug, info, notice, warning, error).             [default: "info"]
  --autoplay, -a    Autoplay sprite name.                                        [default: null]
  --loop            Loop sprite name, can be passed multiple times.              [default: null]
  --gap, -g         Silence gap between sounds (in seconds).                     [default: 1]
  --minlength, -m   Minimum sound duration (in seconds).                         [default: 0]
  --bitrate, -b     Bit rate. Works for: ac3, mp3, mp4, m4a, ogg.                [default: 128]
  --vbr, -v         VBR [0-9]. Works for: mp3. -1 disables VBR.                  [default: -1]
  --samplerate, -r  Sample rate.                                                 [default: 44100]
  --channels, -c    Number of channels (1=mono, 2=stereo).                       [default: 1]
  --rawparts, -p    Include raw slices(for Web Audio API) in specified formats.  [default: ""]
  --help, -h        Show this help message.
```

### Licensing Information

<a rel="license" href="http://opensource.org/licenses/MIT">
<img alt="MIT license" height="40" src="http://upload.wikimedia.org/wikipedia/commons/c/c3/License_icon-mit.svg" /></a>

This content is released under the [MIT](http://opensource.org/licenses/MIT) License.

### Contributor Code of Conduct ###

[Code of Conduct](https://github.com/CoralineAda/contributor_covenant) is adapted from [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4)

---
_Source: https://npm.io/package/waudsprite · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._