https://github.com/megahertz/gulp-audiosprite
Gulp wrapper for audiosprite, which is ffmpeg wrapper that will take in multiple audio files and combines them into a single file
https://github.com/megahertz/gulp-audiosprite
Last synced: 9 months ago
JSON representation
Gulp wrapper for audiosprite, which is ffmpeg wrapper that will take in multiple audio files and combines them into a single file
- Host: GitHub
- URL: https://github.com/megahertz/gulp-audiosprite
- Owner: megahertz
- License: mit
- Created: 2016-01-14T09:32:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-20T16:20:38.000Z (over 7 years ago)
- Last Synced: 2025-07-19T11:02:03.680Z (11 months ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 3
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-audiosprite
[](https://travis-ci.org/megahertz/gulp-audiosprite)
[](https://badge.fury.io/js/gulp-audiosprite)
[](https://david-dm.org/megahertz/gulp-audiosprite)
## Installation
Install with [npm](https://npmjs.org/package/gulp-audiosprite):
`npm install --save-dev gulp-audiosprite`
Also you need to [install ffmpeg](http://ffmpeg.org/download.html). ffmpeg
should be available in a PATH environment variable
## Usage
```javascript
var audiosprite = require('gulp-audiosprite');
gulp.task('audiosprite', function() {
return gulp.src('src/sounds/*.wav')
.pipe(audiosprite({
format: 'howler'
}))
.pipe(gulp.dest('dist/sounds'));
});
```
## Options
Options are tha same as for [audiosprite](https://github.com/tonistiigi/audiosprite/):
Name | Default | Description
------------|-------------------|-----------------------------------------------------------
output | "sprite" | Name for the output files.
path | "" | Path for files to be used on final JSON.
export | "ogg,m4a,mp3,ac3" | Limit exported file types. Comma separated extension list.
format | "jukebox" | Format of the output JSON file (jukebox, howler, createjs).
log | "info" | Log level (debug, info, notice).
autoplay | null | Autoplay sprite name.
loop | null | Loop sprite name, can be passed multiple times.
silence | 0 | Add special "silence" track with specified duration.
gap | 1 | Silence gap between sounds (in seconds).
minlength | 0 | Minimum sound duration (in seconds).
bitrate | 128 | Bit rate. Works for: ac3, mp3, mp4, m4a, ogg.
vbr | -1 | VBR [0-9]. Works for: mp3. -1 disables VBR.
samplerate | 44100 | Sample rate.
channels | 1 | Number of channels (1=mono, 2=stereo).
rawparts | "" | Include raw slices(for Web Audio API) in specified formats.