Skip to content

Commit

Permalink
Changed "Sound.js" name to "SoundJS".
Browse files Browse the repository at this point in the history
  • Loading branch information
TooTallNate committed Sep 28, 2010
1 parent 94462d2 commit ceddf63
Show file tree
Hide file tree
Showing 19 changed files with 73 additions and 73 deletions.
8 changes: 4 additions & 4 deletions API.md
@@ -1,7 +1,7 @@
Sound.js - API
SoundJS - API
==============

`Sound.js` is designed to have a simple and familiar API. Two new global
`SoundJS` is designed to have a simple and familiar API. Two new global
constructors are exposed: [`Sound`](#Sound) and
[`SoundChannel`](#SoundChannel), which are designed to loosely resemble Flash's
[Sound](http://www.adobe.com/livedocs/flash/9.0/ActionScriptLangRefV3/flash/media/Sound.html)
Expand All @@ -14,7 +14,7 @@ API's.
### Sound ###

The `Sound` class is what you will be mostly working with. Playing sounds with
`Sound.js` starts by loading an audio resource with the `new Sound`
`SoundJS` starts by loading an audio resource with the `new Sound`
constructor.

<a name="Sound#new"></a>
Expand Down Expand Up @@ -71,7 +71,7 @@ This value is checked every time `new Sound` is called. If it is set to
<a name="Sound.version"></a>
#### Sound.version → `String` ####

The version String of `Sound.js`. Can be useful for debugging or verification
The version String of `SoundJS`. Can be useful for debugging or verification
purposes.


Expand Down
18 changes: 9 additions & 9 deletions README.md
@@ -1,17 +1,17 @@
Sound.js
SoundJS
========

`Sound.js` is a library that provides browsers with a JavaScript sound API
`SoundJS` is a library that provides browsers with a JavaScript sound API
that first tries audio files with native HTML5 Audio and falls back to Flash
when necessary.

Specifically, the `Sound.js` API offers the ability to play the same sound
Specifically, the `SoundJS` API offers the ability to play the same sound
file more than once at a time, even while the same sound is already playing.
This is also known as multi-layering sounds.

### Motivation: ###

`Sound.js` is specifically created for the
`SoundJS` is specifically created for the
[Simple Game Framework](http://www.simplegameframework.com) HTML engine. HTML5
Audio is a nice idea, but the spec provides no multi-layering support, meaning
a single `<audio>` instance can only play it's `src` once at a time. There's
Expand All @@ -20,7 +20,7 @@ type is not supported, and that's where Flash can come in behind the scenes.

### Features: ###

* Provides a simple API to load sounds initially, and create play instances
* Provides a simple API to load sounds initially, and create _play instances_
when the sound has enough data to start playing or has loaded completely.
* First attempts to use native HTML5 Audio to load and play back the sound.
* Falls back to Flash when HTML5 fails or is not implemented.
Expand All @@ -40,7 +40,7 @@ type is not supported, and that's where Flash can come in behind the scenes.
setTimeout(playShot, 234);
});

View the [full API docs](http://github.com/TooTallNate/Sound.js/blob/master/API.md)
View the [full API docs](http://github.com/TooTallNate/SoundJS/blob/master/API.md)
for the complete picture.

#### Building Flash Source and Minimizing JavaScript ####
Expand All @@ -64,9 +64,9 @@ tool to compile the HaXe source into a Flash SWF file.

#### License ####

`Sound.js` incorporates some Flash libraries licensed under the
`SoundJS` incorporates some Flash libraries licensed under the
[LGPL license](http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License),
`Sound.js` must be released as LGPL as well.
`SoundJS` must be released as LGPL as well.

See the [`COPYING.LESSER`](http://github.com/TooTallNate/Sound.js/blob/master/COPYING.LESSER)
See the [`COPYING.LESSER`](http://github.com/TooTallNate/SoundJS/blob/master/COPYING.LESSER)
file for full legal text.
2 changes: 1 addition & 1 deletion index.html
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Sound.js</title>
<title>SoundJS</title>
<link href="style.css" rel="stylesheet" type="text/css">

<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/prototype/1.6.1.0/prototype.js"></script>
Expand Down
8 changes: 4 additions & 4 deletions src/haxe/MP3.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/

Expand Down
8 changes: 4 additions & 4 deletions src/haxe/MP3Channel.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/
import flash.events.Event;
Expand Down
8 changes: 4 additions & 4 deletions src/haxe/Main.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/
import flash.external.ExternalInterface;
Expand Down
8 changes: 4 additions & 4 deletions src/haxe/OGG.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/

Expand Down
8 changes: 4 additions & 4 deletions src/haxe/OGGChannel.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/
import flash.Vector;
Expand Down
8 changes: 4 additions & 4 deletions src/haxe/Sound.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/

Expand Down
8 changes: 4 additions & 4 deletions src/haxe/SoundChannel.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/

Expand Down
8 changes: 4 additions & 4 deletions src/haxe/SoundEvent.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/
import flash.events.Event;
Expand Down
8 changes: 4 additions & 4 deletions src/haxe/WAV.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/
import flash.events.Event;
Expand Down
8 changes: 4 additions & 4 deletions src/haxe/WAVChannel.hx
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/
import flash.events.Event;
Expand Down
8 changes: 4 additions & 4 deletions src/js/Main.js
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/
(function(global) {
Expand Down
8 changes: 4 additions & 4 deletions src/js/Sound.js
@@ -1,20 +1,20 @@
/**
* Copyright (c) 2010 Nathan Rajlich
*
* This file is part of Sound.js.
* This file is part of SoundJS.
*
* Sound.js is free software: you can redistribute it and/or modify
* SoundJS is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* Sound.js is distributed in the hope that it will be useful,
* SoundJS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sound.js. If not, see <http://www.gnu.org/licenses/>.
* License along with SoundJS. If not, see <http://www.gnu.org/licenses/>.
*
*/

Expand Down

0 comments on commit ceddf63

Please sign in to comment.