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

Updated README

This commit is contained in:
Thong Nguyen 2014-02-02 15:30:34 +00:00
parent db5b9d92ed
commit 43a9f8b26f
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,24 +1,25 @@
## StreamingKit
StreamingKit (formally Audjustable) is an audio streaming library for iOS and Mac OSX. StreamingKit uses CoreAudio to decompress and playback audio whilst providing a clean and simple object-oriented API.
StreamingKit (formally Audjustable) is an audio playback and streaming library for iOS and Mac OSX. StreamingKit uses CoreAudio to decompress and playback audio (using hardware or software codecs) whilst providing a clean and simple object-oriented API.
The primary motivation of this project was to decouple the input data sources from the actual player logic in order to allow advanced customizable input handling such as HTTP streaming, encryption/decryption, auto-recovery, dynamic-buffering. Along the way other features such as gapless playback were added.
The primary motivation of this project was to decouple the input data sources from the actual player logic in order to allow advanced customizable input handling such as HTTP streaming, encryption/decryption, auto-recovery, dynamic-buffering. StreamingKit is the only streaming and playback library that supports gapless playback between audio files with differing formats.
## Main Features
* Simple OOP API
* Easy to read source
* Mostly asynchronous API
* Buffered and gapless playback between all format types
* Easy to implement audio data sources (Local, HTTP, Auto Recovering HTTP DataSources are provided)
* Easy to extend DataSource to support adaptive buffering, encryption, etc
* Optimised for low CPU/battery usage
* Comes with example iOS and Mac OSX apps
* As of version 0.2.0 StreamingKit uses the AudioUnit API rather than the slower AudioQueues API which allows real-time interception of the raw PCM data for features such as level metering, EQ, etc.
* Simple OOP API.
* Easy to read source.
* Mostly asynchronous API.
* Buffered and gapless playback between all format types.
* Easy to implement audio data sources (Local, HTTP, Auto Recovering HTTP DataSources are provided).
* Easy to extend DataSource to support adaptive buffering, encryption, etc.
* Optimised for low CPU/battery usage.
* Optimised for linear data sources. Random access sources are required only for seeking.
* Comes with example iOS and Mac OSX apps*
* StreamingKit 0.2.0 uses the AudioUnit API rather than the slower AudioQueues API which allows real-time interception of the raw PCM data for features such as level metering, EQ, etc.
## Installation
StreamingKit is also available as a [Cocoapod](http://cocoapods.org/?q=StreamingKit) and a static lib. You can also simply copy all the source files located inside StreamingKit/StreamingKit/* into your Xcode project.
StreamingKit is available as a [Cocoapod](http://cocoapods.org/?q=StreamingKit). You can also simply copy all the source files located inside StreamingKit/StreamingKit/* into your Xcode project.
## Example
@ -42,13 +43,13 @@ audioPlayer.delegate = self;
[audioPlayer appendFrameFilterWithName:@"MyCustomFilter" block:^(UInt32 channelsPerFrame, UInt32 bytesPerFrame, UInt32 frameCount, void* frames)
{
...
}
}];
````
## More
More documentation is available on the project [wiki](https://github.com/tumtumtum/StreamingKit/wiki)
More documentation is available on the project [Wiki](https://github.com/tumtumtum/StreamingKit/wiki)
### Authors and Contributors
Copyright (c) 2012-2014, Thong Nguyen (@tumtumtum)
Copyright (c) 2012-2014, Thong Nguyen ([@tumtumtum](http://www.twitter.com/tumtumtum))