3pillarlabs/ios-audio-player

Name: ios-audio-player

Owner: 3Pillar Global Open Source

Description: iOSAudioPlayer is a Swift based iOS module that provides player control features.

Created: 2016-01-15 07:52:06.0

Updated: 2017-08-17 05:47:56.0

Pushed: 2016-12-27 11:08:49.0

Homepage:

Size: 47583

Language: Makefile

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

iOS Audio Player

iOSAudioPlayer is a Swift based iOS module that provides player control features. This module represents a wrapper over AVPlayer. It is available starting with iOS 8.

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

Installation

iOSAudioPlayer framework works with iOS 9.0 or later. Make sure that the framework is added to 'Embedded Binaries' list. After this, you just import the framework in the file where you will use it.

Carthage

Run Terminal

• Navigate to project folder
• Add code to Cartfile:

ub "3pillarlabs/ios-audio-player"

• Run carthage by using command:

hage update

• Add the “iOSAudioPlayer” to the list of “Embedded Binaries” (located inside Xcode -> Target -> General tab) from Carthage/Build/iOS in project folder

Usage

1. Import iOSAudioPlayer Framework

2. Use shared instance of TPGAudioPlayer class, by calling TPGAudioPlayer.sharedInstance().

3. Play a certain media file by calling method:

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

5. Skip a certain time interval using method:

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

7. Seek the player to a certain offset:

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

9. Check the duration of the current player item:

10.   public var durationInSeconds: Double { get }
    

11. Check current progress of the player on the current player item:

12.   public var currentTimeInSeconds: Double { get }
    

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

14.   public let TPGMediaLoadedStateNotification: String
    

In the demo project you're able to see how the framework is used.

License

iOSAudioPlayer is released under MIT license. See LICENSE for details.

About this project

iOSAudioPlayer is developed and maintained by 3Pillar Global.