TouchInstinct
/
StreamingKit
310
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Readme: spelling, etc.

This commit is contained in:
Steven Luscher 2013-07-06 11:59:32 -07:00
parent 08287bc6a7
commit ba4e44b8a2
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,7 +2,7 @@
[Homepage](http://tumtumtum.github.com/audjustable)
Audjustable is audio streaming class for iOS and OSX. Audjustable uses CoreAudio to decompress and playback audio whilst providing a clean and simple object-oriented API.
Audjustable is an audio streaming class for iOS and OSX. Audjustable uses CoreAudio to decompress and playback audio whilst providing a clean and simple object-oriented API.
The primary motivation of this project was to decouple the input (DataSource/InputStreams) from the actual player logic in order to allow advanced customizable input handling such as: HTTP streaming, encryption, auto-recovery, dynamic-buffering. Along the way other features such as gapless playback were added as the opportunity arose.
@ -14,7 +14,7 @@ The primary motivation of this project was to decouple the input (DataSource/Inp
* Mostly asynchronous API
* Buffered and gapless playback
* Easy to implement audio data sources (HTTP and local file system DataSources provided)
* Easy to extend DataSource to support adaptive buffering, encryption etc
* Easy to extend DataSource to support adaptive buffering, encryption, etc.
* Optimised for low CPU/battery usage
## Usage
@ -23,7 +23,7 @@ Download the [source](https://github.com/tumtumtum/audjustable/zipball/master) w
If you would like to integrate the AudioPlayer directly into your project you only need to copy the files inside the `/Audjustable/Classes/AudioPlayer` [directory](https://github.com/tumtumtum/audjustable/tree/master/Audjustable/Classes/AudioPlayer) into your project.
Audjustable is also available as a [Cooapod](http://cocoapods.org/?q=audjustable).
Audjustable is also available as a [Cocoapod](http://cocoapods.org/?q=audjustable).
## Code
@ -36,7 +36,7 @@ There are two main classes. The `DataSource` class which is the abstract base c
AudioPlayer* audioPlayer = [[AudioPlayer alloc] init];
audioPlayer.delegate = self;
// Queue on a URL to play. Each queue item has a unique ID (item1) that to identify the related file in delegate callbacks
// Queue on a URL to play. Each queue item has a unique ID (item1) that to identify the related file in delegate callbacks
[audioPlayer setDataSource:[audioPlayer dataSourceFromURL:@"https://github.com/downloads/tumtumtum/audjustable/sample.m4a"] withQueueItemId:@"item1"];
@ -47,4 +47,4 @@ audioPlayer.delegate = self;
Background playback on iOS is easily added to your application by calling the `AudioSessionInitialize` in your AppDelegate.
### Authors and Contributors
Copyright 2012, Thong Nguyen (@tumtumtum)
Copyright 2012, Thong Nguyen (@tumtumtum)