forked from CreateJS/SoundJS
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SoundJS 0.2.0 offers an even better way to work with audio in HTML5, including a target plugin model. This commit includes the FlashPlugin for fallback support. Check out the TestSuite for usage. Signed-off-by: Lanny McNie <lanny@gskinner.com>
- Loading branch information
Lanny McNie
committed
Apr 3, 2012
1 parent
ec02ffc
commit 12fbc69
Showing
91 changed files
with
5,915 additions
and
3,940 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,28 @@ | ||
The SoundJS JavaScript library provides a simple API, and some powerful features to make working with audio a breeze. | ||
|
||
- .add() - Too many sound instances on page (combined between all sounds) will stop sound working, this varies on browser/hardware safest number is found max of 35 channels | ||
|
||
- .play() - Too many playing instances (combined between all sounds) will stop sound working till all windows are closed. The exact number is undefined but has been observed as low as 10 looping sounds in Chrome. | ||
SOUNDJS LIBRARY: | ||
|
||
SoundJS is a library to make working with the audio on the web easier. It provides a consistent API for playing audio in different browsers, including using a target plugin model to provide an easy way to provide additional audio plugins like Web Audio, and a Flash fallback. A mechanism has been provided for easily tying in audio preloading to PreloadJS (http://preloadjs.com) | ||
|
||
The home page for SoundJS can be found at http://soundjs.com/ | ||
|
||
There is a GitHub repository, which includes downloads, issue tracking, & a wiki at https://github.com/CreateJS/SoundjS/ | ||
|
||
It was built by gskinner.com, and is released for free under the MIT license, which means you can use it for almost any purpose (including commercial projects). We appreciate credit where possible, but it is not a requirement. | ||
|
||
SoundJS is currently in alpha. We will be making significant improvements to the library, samples, and documentation over the coming weeks. Please be aware that this may necessitate changes to the existing API. | ||
|
||
|
||
The key classes are: | ||
|
||
SoundJS | ||
The core API for playing sounds. Simply call SoundJS.play(sound, options), and a sound instance is created that can be used to control the audio, and receive events when it is complete, loops, or is interrupted. | ||
|
||
SoundInstance | ||
A controllable sound object that wraps the actual plugin implementation, providing a consistent API for audio playback, no matter what happens in the background. Sound instances can be paused, muted, and stopped, and the volume, pan (where available), and position using the simple API. | ||
|
||
HTMLAudioPlugin | ||
The default, built-in plugin, which manages audio playback via the HTML5 <audio> tag. | ||
|
||
FlashPlugin | ||
An additional plugin which uses a flash shim (and SWFObject) to playback audio using Flash. | ||
|
||
Have a look at the included examples and API documentation for more in-depth information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Version 0.2.0 | ||
**************************************************************************************************** | ||
Second release, corresponding with the release of the CreateJS suite of tools (createjs.com). | ||
This version includes a target plugin model that abstracts audio playback to various plugins, which | ||
can be prioritized. Other updates include controllable sound instances, which are returned when a | ||
sound is played, providing a much easier way to control audio once it has started playback. | ||
|
||
|
||
Version 0.1.0 | ||
**************************************************************************************************** | ||
Initial release. |
Binary file not shown.
Oops, something went wrong.