<commit_before>

# GWT-SoundManager2
GWT-SoundManager2 is a wrapper for the SoundManager2 library to allow easy use with GWT (Google Web Toolkit). 

Its aim is to take a proven, well supported, and mature solution for playing audio (SoundManager2) in the browser  and provide a robust, updated, and easy to use GWT interface. Ideally, it's the quickest way to add audio to your GWT application!

##Why another SoundManager2 wrapper for GWT?
After reviewing other wrappers and audio libraries such as: 
[gwt-sound](http://code.google.com/p/gwt-sound/) [gwt-sm](http://code.google.com/p/gwtsm/) [gwt-voice](http://code.google.com/p/gwt-voices/)  
It looked like the state of audio in GWT applications was being neglected and not supported. Most of the aforementioned libraries are either dated, not supported, or don't provide the full range of functionality that is capable with SoundManager2.

This wrapper was created as a fork of gwt-sound, originally written by <NAME>. It's now based on GWT 2.4 and the latest version of SoundManager2 (Which now has killer support for all kinds of browsers. Horray for Android and Iphone!) It was developed for, and currently being used by, [Coolhandjuke](http://www.coolhandjuke.com).

Follow us on [Twitter](www.twitter.com/coolhandjuke)! Any issues or questions are more than welcome.
#Quick Start to using GWT-SoundManager2
##Add it to your project

Reference the jar file in your classpath. The latest .jar can be found here [gwt-soundmanager2-0.0.1-SNAPSHOT.jar](https://github.com/downloads/rcaloras/gwt-soundmanager2/gwt-soundmanager2-0.0.1-SNAPSHOT.jar), in the [Downloads](https://github.com/rcaloras/gwt-soundmanager2/downloads) tab.
###If you're using maven
```bash
git clone git://github.com/rcaloras/gwt-soundmanager2.git 
cd gwt-soundmanager2 
mvn compile package install
```
...add the dependency to your pom.xml.   
```xml
      <dependency>
         <groupId>com.chj</groupId>
         <artifactId>gwt-soundmanager2</artifactId>
         <version>0.0.1-SNAPSHOT</version>
      </dependency>
```

###Inherit it in your gwt.xml
```xml
 <inherits name="GwtSoundManager2"/>
```


##Use it to make some noise!
```java
   final String SOUND_ID = 'soundID';
   SoundManager sm = SoundManager.quickStart();
   sm.play(SOUND_ID, '/path/to/some/.mp3');
```

###Need to configure SoundManager2?
Obtain an SM2 instance, configure it, and then beginDelayedInit.
```java
  SoundManager soundManager = SoundManager.getInstance();
  soundManager.setUseHtml5Audio(true)
  soundManager.setFlashVersion(9);
  soundManager.setNoSWFCache(true);
  soundManager.setFlashLoadTimeout(1000);
  //SoundManager must be init'd before it can be used.
  soundManager.beginDelayedInit();
```
  
##Official SoundManager2 Documentation
SoundManager2 documentation and resources can be found at [Schillmania](http://www.schillmania.com/projects/soundmanager2/doc/). Much thanks to Scott Schiller for the awesome SoundManager2 project.
http://www.schillmania.com/projects/soundmanager2/
<commit_msg>Fixed Twitter link in readme.<commit_after>

# GWT-SoundManager2
GWT-SoundManager2 is a wrapper for the SoundManager2 library to allow easy use with GWT (Google Web Toolkit). 

Its aim is to take a proven, well supported, and mature solution for playing audio (SoundManager2) in the browser  and provide a robust, updated, and easy to use GWT interface. Ideally, it's the quickest way to add audio to your GWT application!

##Why another SoundManager2 wrapper for GWT?
After reviewing other wrappers and audio libraries such as: 
[gwt-sound](http://code.google.com/p/gwt-sound/) [gwt-sm](http://code.google.com/p/gwtsm/) [gwt-voice](http://code.google.com/p/gwt-voices/)  
It looked like the state of audio in GWT applications was being neglected and not supported. Most of the aforementioned libraries are either dated, not supported, or don't provide the full range of functionality that is capable with SoundManager2.

This wrapper was created as a fork of gwt-sound, originally written by <NAME>. It's now based on GWT 2.4 and the latest version of SoundManager2 (Which now has killer support for all kinds of browsers. Horray for Android and Iphone!) It was developed for, and currently being used by, [Coolhandjuke](http://www.coolhandjuke.com).

Follow us on [Twitter](http://www.twitter.com/coolhandjuke)! Any issues or questions are more than welcome.
#Quick Start to using GWT-SoundManager2
##Add it to your project

Reference the jar file in your classpath. The latest .jar can be found here [gwt-soundmanager2-0.0.1-SNAPSHOT.jar](https://github.com/downloads/rcaloras/gwt-soundmanager2/gwt-soundmanager2-0.0.1-SNAPSHOT.jar), in the [Downloads](https://github.com/rcaloras/gwt-soundmanager2/downloads) tab.
###If you're using maven
```bash
git clone git://github.com/rcaloras/gwt-soundmanager2.git 
cd gwt-soundmanager2 
mvn compile package install
```
...add the dependency to your pom.xml.   
```xml
      <dependency>
         <groupId>com.chj</groupId>
         <artifactId>gwt-soundmanager2</artifactId>
         <version>0.0.1-SNAPSHOT</version>
      </dependency>
```

###Inherit it in your gwt.xml
```xml
 <inherits name="GwtSoundManager2"/>
```


##Use it to make some noise!
```java
   final String SOUND_ID = 'soundID';
   SoundManager sm = SoundManager.quickStart();
   sm.play(SOUND_ID, '/path/to/some/.mp3');
```

###Need to configure SoundManager2?
Obtain an SM2 instance, configure it, and then beginDelayedInit.
```java
  SoundManager soundManager = SoundManager.getInstance();
  soundManager.setUseHtml5Audio(true)
  soundManager.setFlashVersion(9);
  soundManager.setNoSWFCache(true);
  soundManager.setFlashLoadTimeout(1000);
  //SoundManager must be init'd before it can be used.
  soundManager.beginDelayedInit();
```
  
##Official SoundManager2 Documentation
SoundManager2 documentation and resources can be found at [Schillmania](http://www.schillmania.com/projects/soundmanager2/doc/). Much thanks to <NAME> for the awesome SoundManager2 project.
http://www.schillmania.com/projects/soundmanager2/

{'fraction_non_alphanumeric': 0.10437654830718414, 'fraction_numerical': 0.013542526837324525, 'mean_word_length': 4.550870760769936, 'pattern_counts': {'":': 0, '<': 24, '<?xml version=': 0, '>': 24, 'https://': 4, 'lorem ipsum': 0, 'www.': 8, 'xml': 8}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4833362', 'n_tokens_mistral': 1898, 'n_tokens_neox': 1813, 'n_words': 629}