Skip to content

Commit 582d297

Browse files
committed
readme and depencies update
1 parent 6d26250 commit 582d297

File tree

4 files changed

+44
-38
lines changed

4 files changed

+44
-38
lines changed

README.md

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[![Dependencies](https://david-dm.org/chrisweb/web-audio-api-player/dev-status.png)](https://david-dm.org/chrisweb/web-audio-api-player)
2+
[![GitHub release](https://img.shields.io/github/release/chrisweb/web-audio-api-player.svg)](https://github.com/chrisweb/web-audio-api-player/releases)
3+
14
# web audio API player
25

36
## W3C web audio API
@@ -26,35 +29,34 @@ in the meantime check out what's in the examples directory (especially the [simp
2629

2730
## TODOs
2831

29-
* abort the loading of the sound if the user clicks play and then pause (or stop / next / previous) before the end of the buffering process (https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/abort)
30-
* allow cross fading songs "on end" if it's the next song in a playlist
31-
* create a web component UI (http://www.w3.org/TR/components-intro/)!?
32-
* currently the "find song in queue" can't retrieve songs by queue index, is this useful anyway?
33-
* let the user modify the audio graph, for example by adding / removíng nodes like a filter node, a panner node ...
34-
* implement suspend and resume: ctx.suspend() and resume of the context on pause / stop or if for some time no sound was played? ... to free device resources, as suspend returns a promise, does this mean suspending and resuming takes time? if so how much time does it take, based on that information we can decide when and how often we should resume / suspend
35-
* use the html audio element for backwards compatibility for IE11 and mobile android devices? (http://caniuse.com/#feat=audio-api / )
36-
* use the requestAnimation (https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame) frame or the requestidlecallback (https://developers.google.com/web/updates/2015/08/using-requestidlecallback / https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback) instead of setInterval for playing progress callback?
37-
* use web workers, especially for the decoding of the ArrayBuffer into an AudioBuffer, to not block the main thread while decoding?
38-
* cache (preload) AudioBuffers in localstorage, let the user set the amount of cached AudioBuffers, remove from cache by least used and by date when cache is full
39-
* add shuffle mode
40-
* add a loop song and loop queue mode
41-
* handle all error cases that are still unhandled
42-
* add support for more codecs (flac, wav, ogg vorbis, opus, aac): also check the available codecs and defined sources, play the first one that has matches and available codec, let user define order of preferred codecs for playerback
43-
* add promise fallback for IE11 and Android < 4.4.4?
44-
* add fallback for onended for IE11 (https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/onended)
45-
* publish on npm
46-
* add npm version badge / license badge / ... (http://shields.io/)
47-
* add dependencies check badge(s) (https://david-dm.org)
48-
* add browser compatibility table badge in readme (https://saucelabs.com/blog/new-open-sauce-ui-and-refreshed-build-status-badges)
49-
* write tests!!! (goal 100% coverage), add tests coverage badge ((https://coveralls.io)
50-
* add travis build check and badge (https://travis-ci.org)
51-
* add a contribution guide
52-
* write some documentation
53-
* put all the code related to the queue into a seperate library class (out of core)
54-
* add UI screenshot to readme
55-
* add demo (github pages)
56-
* for position and volume, allow to use a percentage or a value
57-
* add hooks to the sound object for all the native source node events https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode
32+
* abort the loading of the sound if the user clicks play and then pause (or stop / next / previous) before the end of the buffering process (https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/abort)
33+
* allow cross fading songs "on end" if it's the next song in a playlist
34+
* create a web component UI (http://www.w3.org/TR/components-intro/)!?
35+
* currently the "find song in queue" can't retrieve songs by queue index, is this useful anyway?
36+
* implement suspend and resume: ctx.suspend() and resume of the context on pause / stop or if for some time no sound was played? ... to free device resources, as suspend returns a promise, does this mean suspending and resuming takes time? if so how much time does it take, based on that information we can decide when and how often we should resume / suspend
37+
* use the html audio element for backwards compatibility for IE11 and mobile android devices? (http://caniuse.com/#feat=audio-api / )
38+
* use the requestAnimation (https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame) frame or the requestidlecallback (https://developers.google.com/web/updates/2015/08/using-requestidlecallback / https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback) instead of setInterval for playing progress callback?
39+
* use web workers, especially for the decoding of the ArrayBuffer into an AudioBuffer, to not block the main thread while decoding?
40+
* cache (preload) AudioBuffers in localstorage, let the user set the amount of cached AudioBuffers, remove from cache by least used and by date when cache is full
41+
* add shuffle mode
42+
* add a loop song and loop queue mode
43+
* handle all error cases that are still unhandled
44+
* add support for more codecs (flac, wav, ogg vorbis, opus, aac): also check the available codecs and defined sources, play the first one that has matches and available codec, let user define order of preferred codecs for playerback
45+
* add promise fallback for IE11 and Android < 4.4.4?
46+
* add fallback for onended for IE11 (https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/onended)
47+
* publish on npm
48+
* add npm version badge / license badge / ... (http://shields.io/)
49+
* add dependencies check badge(s) (https://david-dm.org)
50+
* add browser compatibility table badge in readme (https://saucelabs.com/blog/new-open-sauce-ui-and-refreshed-build-status-badges)
51+
* write tests!!! (goal 100% coverage), add tests coverage badge ((https://coveralls.io)
52+
* add travis build check and badge (https://travis-ci.org)
53+
* add a contribution guide
54+
* write some documentation
55+
* put all the code related to the queue into a seperate library class (out of core)
56+
* add UI screenshot to readme
57+
* add demo (github pages)
58+
* for position and volume, allow to use a percentage or a value
59+
* add hooks to the sound object for all the native source node events https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode
5860

5961
## DONE
6062

@@ -74,4 +76,9 @@ in the meantime check out what's in the examples directory (especially the [simp
7476
* play next song onEnded, add option to enable or disable automatic play next onEnded
7577
* add change position method
7678
* add loop queue option
77-
* make the core player options object optinal when initializing a new player
79+
* make the core player options object optinal when initializing a new player
80+
* let the user modify the audio graph, for example by adding / removíng nodes like a filter node, a panner node ...
81+
82+
## License
83+
84+
MIT

0 commit comments

Comments
 (0)