Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

vinyl-singer

jkeylu22MIT0.0.4

A vinyl mp3 player

vinyl, gulp, lame, speaker, singer, mp3, player, stream

readme

vinyl-singer

NPM

Example

var gulp = require('gulp')
  , Singer = require('vinyl-singer');

gulp.src('/path/to/*.mp3').pipe(Singer());

Options

options.highWaterMark

Type: Number Default: 1

The maximum number of songs to store in the internal buffer waiting to play.

options.isTransformer

Type: Boolean Default: false

Default singer like a Writable Stream. Once you do singer.pipe(another), the played songs will stored in the internal buffer waiting to be consumed.

options.defaultVolume

Type: Number Default: 1

Range: 0 - 1

options.decoderHighWaterMark

Type: Number Default: 4 * 1024