Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noonpacific/npaudiostream
Continuously stream a playlist of audio through a lightweight Objective-C library.
https://github.com/noonpacific/npaudiostream
audio ios objective-c osx stream swift tvos
Last synced: 3 months ago
JSON representation
Continuously stream a playlist of audio through a lightweight Objective-C library.
- Host: GitHub
- URL: https://github.com/noonpacific/npaudiostream
- Owner: NoonPacific
- License: mit
- Created: 2015-08-20T10:19:46.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-08-05T09:36:00.000Z (over 5 years ago)
- Last Synced: 2024-10-14T16:44:21.614Z (3 months ago)
- Topics: audio, ios, objective-c, osx, stream, swift, tvos
- Language: Objective-C
- Homepage:
- Size: 400 KB
- Stars: 23
- Watchers: 6
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/Carthage/Carthage)
[](http://cocoapods.org/pods/NPAudioStream)
[](http://cocoapods.org/pods/NPAudioStream)
[](http://cocoapods.org/pods/NPAudioStream)
[](http://twitter.com/NoonPacific)
NPAudioStream is a lightweight Objective-C library to continuously stream a playlist of audio on iOS, tvOS, and macOS. NPAudioStream excels at maintaining audio playback over a poor network connection.
## Features
- Audio controls represent the most common music interface behaviors (e.g. play, pause, skip, seek, shuffle).
- Array/index style of url management elegantly binds to table view selection.
- Optionally prebuffer the next track, even when shuffling.
- Detect when a source is not streamable and automatically skip to the next song in the stream.
- Repeat functionality supports one track or the whole stream.
- Shuffle functionality mimics iPod behavior.
#### iOS only
- Manages background tasks to ensure your app remains active during network interruptions
- Pauses and resumes playback in response to a phone call interruption
## Installation
### CocoaPods
The recommended method of installation is through [CocoaPods](http://cocoapods.org). Add the following line to your Podfile, then run `pod install`.
#### Podfile
```ruby
pod 'NPAudioStream', '~> 1.0'
```
For iOS, be sure to [add support for background audio](https://developer.apple.com/library/ios/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/BackgroundExecution/BackgroundExecution.html#//apple_ref/doc/uid/TP40007072-CH4-SW26) as well.
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate NPAudioStream into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "NoonPacific/NPAudioStream" ~> 1.1
```
Run `carthage update` to build the framework and drag the built `NPAudioStream.framework` into your Xcode project.
### Manual Installation
1. [Download NPAudioStream](https://github.com/NoonPacific/NPAudioStream/archive/master.zip)
2. Drag the `NPAudioStream` directory into your Xcode project, and ensure the files are copied into your project's directory.
3. In your Xcode project, navigate to *Target > Build Phases > Link Binary with Libraries* and add the `AVFoundation` framework.
4. For iOS, be sure to [add support for background audio](https://developer.apple.com/library/ios/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/BackgroundExecution/BackgroundExecution.html#//apple_ref/doc/uid/TP40007072-CH4-SW26).
## Basic Example
The simplest usage of NPAudioStream involves creating an instance, populating the `urls` property, then selecting an index for playback. NPAudioStream was built with the intention of streaming [SoundCloud](https://soundcloud.com) audio, so the following example demonstrates how to stream an array of SoundCloud URLs on iOS.
**Note: Be sure to replace `YOUR_CLIENT_ID` with your own [SoundCloud Client ID](http://soundcloud.com/you/apps_).**
#### AppDelegate.m
```objective-c
#import "NPAudioStream.h"
@implementation AppDelegate {
NPAudioStream *audioStream;
}
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
audioStream = [NPAudioStream new];
NSArray *urlStrings = @[@"https://api.soundcloud.com/tracks/216878983/stream",
@"https://api.soundcloud.com/tracks/215647717/stream",
@"https://api.soundcloud.com/tracks/218064667/stream",
@"https://api.soundcloud.com/tracks/206986247/stream"
];
NSMutableArray *urls = [NSMutableArray arrayWithCapacity:urlStrings.count];
// append SoundCloud Client ID and create NSURL objects
for (NSString *urlString in urlStrings) {
NSString *streamURLString = [NSString stringWithFormat:@"%@?client_id=YOUR_CLIENT_ID", urlString];
NSURL *url = [NSURL URLWithString:streamURLString];
[urls addObject:url];
}
[audioStream setUrls:urls];
[audioStream selectIndexForPlayback:0];
return YES;
}
@end
```
## Example Projects
NPAudioStream includes a workspace with two example projects - one for macOS and one for iOS (tvOS coming later). These projects showcase the most common patterns to build a music interface.
#### Add your SoundCloud Client ID
These examples use SoundCloud URLs, thus a [SoundCloud Client ID](http://soundcloud.com/you/apps_) is required. In the root directory, duplicate the file named `keys-example.json`, rename the new file to `keys.json`, then add your SC Client ID to `keys.json`.
## Device support
NPAudioStream supports iOS 8.0+, tvOS 9.0+, and macOS 10.8+.
## About
NPAudioStream is created and maintained by [Alex Givens](https://github.com/AlexGivens) for [Noon Pacific](http://noonpacific.com) – the chillest way to discover new music every Monday 🌴
NPAudioStream is released under the MIT license. See LICENSE for details.