SwiftAudioManager

SwiftAudioManager RoadMap

• 0.1.0 Foundation features
• 0.2.0 Downloading & Local storage
• 0.3.0 Key - Url - Music system
• 0.4.0 List of keys of stored music
• 0.5.0 BGM Fading
• 0.6.0 Auto play next in the list

Open issue

• Multiple SFX players, but share one common buffer?

Usage

Step1: preparation

If all audio resources are local, skip this step

For local file URL:

Currently, SwiftAudioManager works around URL. For local audio assets that bundled with the code base, you can retrive its URL by using this line of code:

Bundle.main.url(forResource: "audio name", withExtension: "mp3")

For online file link:

SwiftAudioManager needs a valid link - one that will work on browser. For example: https://www.example.com/sounds/1/example.mp3 link If you do have it ready, then go ahead and download the audio file by using this piece of codes:

// Note that the link string needs to be converted to URL
SwiftAudioManager.shared.prepareAssets(_ urlList: ["local url/link"]) { outcomeList in
	for outcome in outcomeList {
		// outcome is a typealias: (url: URL, success: Bool)
		if !outccome.success {
			// handle file retrieve/download failure for current local url/link
		}
	}
}

Note: the downloaded sound files will be persistantly cached in disk.

Step2: how to play Sounds

• Play as BGM(background music): A BMG that will constantly be playing. The song will be played again if it ends. The new song will override the old song, one BGM at a time.

  SwiftAudioManager.shared.playAsBGM("local url/link")
  

• Play as SFX(sound effect): Sounds like a click, swipe, or a clap. The new SFX will be played instantly, overlapping the current SFX, even if they are the same sound.

  SwiftAudioManager.shared.playAsSFX("local url/link")
  

Other useful methods:

• Stop all sound effect:

  SwiftAudioManager.shared.enabled = false
  

Working Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

iOS 10.0+, Swift 4

Installation

SwiftAudioManager is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'SwiftAudioManager'

Author

[email protected]

License

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