iOS Audio Player

iOSAudioPlayer is a Swift based iOS module that provides player control features. This module represents a wrapper over AVPlayer.

Project Rationale

The purpose of the framework is to provide a simple in app solution for player controls, by offering the following features:

• Play & pause functionality
• Player items management
• Notifications triggered for main player states
• Notifications triggered for each media item package load
• Skip a certain time interval methods
• Seek to a certain offset method
• Play in background and control from springboard when in sleep state

Requirements

• iOS 8.0+
• Xcode 8.2+

Installation

Manually

If you prefer not to use CocoaPods, you can integrate iOSAudioPlayer into your project manually.

Embedded Framework

• Open up Terminal, cd into your top-level project directory, and run the following command “if” your project is not initialized as a git repository:

$ git init

• Add iOSAudioPlayer as a git submodule by running the following command:

$ git submodule add hhttps://github.com/3pillarlabs/ios-audio-player.git

• Open the new iOSAudioPlayer folder, and drag the iOSAudioPlayer.xcodeproj into the Project Navigator of your application’s Xcode project.

It should appear nested underneath your application’s blue project icon. Whether it is above or below all the other Xcode groups does not matter.

• Select the iOSAudioPlayer.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.
• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the “Targets” heading in the sidebar.
• In the tab bar at the top of that window, open the “General” panel.
• Click on the + button under the “Embedded Binaries” section.
• You will see two different iOSAudioPlayer.xcodeproj folders each with two different versions of the iOSAudioPlayer.framework nested inside a Products folder.

It does not matter which Products folder you choose from, but it does matter whether you choose the top or bottom iOSAudioPlayer.framework.

• Select the top iOSAudioPlayer.framework for iOS.

• And that’s it!

The iOSAudioPlayer.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Source File

If you prefer to rock it old-school, iOSAudioPlayer can be integrated by adding all the Swift files located inside the Classes directory (Classes/*.*) directly into your project. Note that you will no longer need to import iOSAudioPlayer since you are not actually loading a framework.

Usage

• Use shared instance of TPGAudioPlayer class, by calling TPGAudioPlayer.sharedInstance().
• Play a certain media file by calling method:

public func playPauseMediaFile(audioUrl: NSURL, springboardInfo: [String : AnyObject], startTime: Double, completion: (previousItem: String?, stopTime: Double) -> ())

• Skip a certain time interval using method:

public func skipDirection(skipDirection: iOSAudioPlayer.SkipDirection, timeInterval: Double, offset: Double)

• Seek the player to a certain offset:

public func seekPlayerToTime(value: Double, completion: (() -> Void)!)

• Check the duration of the current player item:

public var durationInSeconds: Double { get }

• Check current progress of the player on the current player item:

public var currentTimeInSeconds: Double { get }

• Listen to the notification which is triggered when a certain media file package is loaded:

public let TPGMediaLoadedStateNotification: String

In the “Example for iOSAudioPlayer” project you’re able to see how the framework is used.

Communication

• If you found a bug, open an issue github.
• If you have a feature request, open an issue github.
• If you want to contribute, submit a pull request github.

About this project

iOSAudioPlayer is developed and maintained by 3Pillar Global.

License

iOSAudioPlayer is available under the MIT license. See the LICENSE file for more info.