Skip to content

AudioKit/AudioKit

Repository files navigation

AudioKit

Build Status License Platform Reviewed by Hound Twitter Follow

AudioKit is an audio synthesis, processing, and analysis platform for iOS, macOS (including Catalyst), and tvOS.

Installation

In Xcode 13:

You can AudioKit and any of the other AudioKit libraries using Collections

  1. Select File -> Add Packages...
  2. Click the + icon on the bottom left of the Collections sidebar on the left.
  3. Choose Add Swift Package Collection from the pop-up menu.
  4. In the Add Package Collection dialog box, enter https://swiftpackageindex.com/AudioKit/collection.json as the URL and click the "Load" button.
  5. It will warn you that the collection is not signed, but it is fine, click "Add Unsigned Collection".
  6. Now you can add any of the AudioKit Swift Packages you need and read about what they do, right from within Xcode.

In Xcode 11 & 12:

To add AudioKit to your Xcode project

  1. Select File -> Swift Packages -> Add Package Dependency.
  2. Enter https://github.com/AudioKit/AudioKit for the URL. You can define which version range you want, or which branch to use, or even which exact commit you would like use.

Documentation

All AudioKit documentation is generated from this repository. The documentation that appear in the docs folder generate the AudioKit.io Web Site. API documentation appears on the Github wiki.

Examples

The AudioKit Cookbook contains many recipes for simple uses for AudioKit components.

Getting help

  1. Post your problem to StackOverflow with the #AudioKit hashtag.

  2. Once you are sure the problem is not in your implementation, but in AudioKit itself, you can open a Github Issue.

  3. If you, your team or your company is using AudioKit, please consider sponsoring Aure on Github Sponsors.