Merge pull request phonegap#931 from keenan/master

Linking to externally hosted Audio Encode plugin
kstan79 · Dec 8, 2012 · bf5df5b · bf5df5b
2 parents d7702ca + f5b3536
commit bf5df5b
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 174 deletions.
diff --git a/iOS/AudioEncode/AudioEncode.h b/iOS/AudioEncode/AudioEncode.h
diff --git a/iOS/AudioEncode/AudioEncode.js b/iOS/AudioEncode/AudioEncode.js
diff --git a/iOS/AudioEncode/AudioEncode.m b/iOS/AudioEncode/AudioEncode.m
diff --git a/iOS/AudioEncode/README.md b/iOS/AudioEncode/README.md
@@ -1,52 +1,6 @@
 ## PhoneGap AudioEncode Plugin ##
- * by Lyle Pratt
- * Updated Oct 2012 by Keenan Wyrobek for Cordova 2.1.0
 
-## About this Plugin ##
-
-This plugin lets you easily convert WAV audio into M4A audio. It is useful when using Phonegap's audio capture or media recording functionality. Uploading WAV files on via cellular connections is not advised. M4A encoded files are 1/4 to 1/10 the size.
-
-## Using the Plugin ##
-
-The plugin creates a global CompressAudio(originalSrc, success, fail, obj) method.
- * originalSrc: (required) This is a string path to the local file to encode. This is typically the fullPath property of the entry passed to the success of a fileSystem.root.getFile call
- * success: (required) This function is called when the encoding has completed successfully. It will be called in one of two ways.
-  * if obj is passed into CompressAudio - success(m4ASource, obj)
-  * if obj is not passed into CompressAudio - success(m4ASource)
- * fail: (required) This function is called on encode failure and will be passed a statusCode.
- * obj: (optional) this object is passed through to success function.
-
-Example:
-
-		CompressAudio(pathToWavFile, success, fail);
-
-		var success = function(newM4APath) {
-			//Do something with your new encoded audio (upload it?)
-			console.log(newM4APath);
-		}
-
-		var fail = function(statusCode) {
-			//Why did it fail?
-			console.log(statusCode);
-		}
-
-## Adding the Plugin to your project ##
-
-Using this plugin requires [iPhone PhoneGap](http://github.com/phonegap/phonegap-iphone)
-
-1. This plug in has been tested with Cordova/PhoneGap 2.1.0
-2. Add the .h and .m files to your Plugins folder in your project.
-3. Add the .js files to your "www" folder on disk, and add reference(s) to the .js files in your html file(s).
-
-## LICENSE ##
-
-The MIT License
-
-Copyright (c) 2011 Lyle Pratt
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+This plugin lets you easily convert/compress/encode WAV audio into M4A audio. It is useful when using Phonegap's audio capture or media recording functionality. Uploading WAV files on via cellular connections is not advised. M4A encoded files are 1/4 to 1/10 the size.
 
+Project is hosted here.
+https://github.com/keenan/cordova-phonegap-audio-encode