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

Package detail

audio-context

audiojs33.3kMITdeprecated1.0.3TypeScript support: definitely-typed

Depends on Web-Audio-API implementation. Use either web-audio-api, web-audio-js or web-audio-engine package.

A WebAudio Context singleton

webaudio, audio, audiojs, context, singleton

readme

audio-context Build Status unstable Greenkeeper badge npm license

Creates a WebAudio context singleton with the given options. Returns null if not supported.

Example

var audioCtx = require('audio-context')()

You can also create an OfflineAudioContext in case you would like to process (faster) without any rendering.

var offlineContext = require('audio-context')({offline: true})

Usage

npm install audio-context

ctx = createContext(options|sampleRate)

Returns a singleton audio context for the given sampleRate.

The options:

  • sampleRate - if specified, will set the context sampleRate.
  • latencyHint - if specified, will control latency. One of 'balanced', 'playback', 'interaction' (default) or number.
  • offline - if specified, will create OfflineAudioContext.
  • length - if specified, will set number of frames for offline context.
  • channels - if specified, will set number of channels for offline context.
  • {...contextAttributes} any other options for the context.

Handles vendor prefixing for audio contexts. Returns null if we are not in a browser, or if the context is not available, or if there was an error creating the context.

Running tests

# Run tests in tape-run's default browser
npm test

# Run in a specified browser.
# See https://github.com/juliangruber/tape-run#runopts for options
npm test -- --browser firefox

License

MIT

changelog

0.1.0 / 2014-07-29

  • ignore node_modules
  • Merge pull request #4 from oncletom/bump-version
  • v0.1.0
  • Merge pull request #3 from oncletom/feature-offline-context
  • new cannot be used for an OfflineAudioContext as specific arguments are required.
  • offlineAudioContext
  • Testing audio-context/offline export.
  • window object is now an explicit dependency.
  • Enabled npm test
  • Merge pull request #1 from EvanHahn/patch-1
  • Prioritize unprefixed AudioContext
  • use testling