LowLatencyAudio

LowLatencyAudio is a native plugin for PhoneGap. This implementation is designed to be compatible with PhoneGap 3.0 CLI deployment, and supports both iOS and Android.

Installation

The LowLatencyAudio plugin can be added to your project via the PhoneGap command line tools. Simply use the following command to add this to your project:

phonegap local plugin add https://github.com/triceam/LowLatencyAudio

Usage

1. Preload the audio asset - Note: Make sure to wait for phonegap deviceready event before atteptimpting to load assets
2. Play the audio asset
3. When done, unload the audio asset

API methods

preloadFX: function ( id, assetPath, success, fail)
    params: ID - string unique ID for the audio file
            assetPath - the relative path to the audio asset within the www directory
            success - success callback function
            fail - error/fail callback function
    detail: 
            The preloadFX function loads an audio file into memory.  Assets that are loaded using preloadFX are managed/played using AudioServices methods from the AudioToolbox framework.   These are very low-level audio methods and have minimal overhead.  Audio loaded using this function is played using AudioServicesPlaySystemSound.   These assets should be short, and are not intended to be looped or stopped.   They are fully concurrent and polyphonic.

preloadAudio: function ( id, assetPath, voices, success, fail) 
    params: ID - string unique ID for the audio file
            assetPath - the relative path to the audio asset within the www directory
            voices - the number of polyphonic voices available
            success - success callback function
            fail - error/fail callback function
    detail: 
            The preloadAudio function loads an audio file into memory.  Assets that are loaded using preloadAudio are managed/played using AVAudioPlayer.   These have more overhead than assets laoded via preloadFX, and can be looped/stopped.   By default, there is a single "voice" - only one instance that will be stopped & restarted when you hit play.  If there are multiple voices (number greater than 0), it will cycle through voices to play overlapping audio.

play: function (id, success, fail)  
    params: ID - string unique ID for the audio file
            success - success callback function
            fail - error/fail callback function
    detail: 
            Plays an audio asset

loop: function (id, success, fail)  
    params: ID - string unique ID for the audio file
            success - success callback function
            fail - error/fail callback function
    detail: 
            Loops an audio asset infinitely - this only works for assets loaded via preloadAudio

stop: function (id, success, fail)  
    params: ID - string unique ID for the audio file
            success - success callback function
            fail - error/fail callback function
    detail: 
            Stops an audio file - this only works for assets loaded via preloadAudio

unload: function (id, success, fail)    
    params: ID - string unique ID for the audio file
            success - success callback function
            fail - error/fail callback function
    detail: 
            Unloads an audio file from memory

License

THIS SOFTWARE IS PROVIDED BY ANDREW TRICE "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANDREW TRICE OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.