1.1.2 • Published 8 years ago

detect-media-element-source v1.1.2

Weekly downloads
6
License
MIT
Repository
github
Last release
8 years ago

detect-media-element-source

experimental

Detects whether the browser correctly supports WebAudio's createMediaElementSource(), by playing a short looping noise segment and seeing whether signal is non-zero.

For example: Desktop Chrome/FF support media element sources, but mobile iOS 9.2 Safari does not. In unsupported browsers, you need to buffer and decode the entire audio file in order to use it with the WebAudio API.

Note :warning:

Because of the way the WebAudio and browser APIs are constantly in flux, this may not be a robust and long-term solution to detecting this feature. There is no reliable way to detect this feature across all browsers, except for actually watching the result of an AnalyserNode over your own <audio> source, and then falling back to a buffer source in such a case. However, that requires additional UX hurdles on mobile (for touch-to-play audio).

Install

npm install detect-media-element-source --save

Example

var detectMedia = require('detect-media-element-source')

detectMedia(function (supported) {
  if (supported) {
    // ... audioContext.createMediaElementSource()
  } else {
    // ... audioContext.createBufferSource()
  }
})

Usage

NPM

detectMediaElementSource(cb, [audioContext], [timeoutDelay], [ignoreCache])

Detects whether createMediaElementSource works as expected with the WebAudio API, calling cb with true if supported, false otherwise.

audioContext is optional (a new temporary context will be used) but encouraged.

timeoutDelay defaults to 250ms (550ms if userAgent shows Safari), but can be configured to allow the loop to play for a longer/shorter time before deciding the result.

License

MIT, see LICENSE.md for details.