Guide · Open source
How to use AudioKit: install, add packages and get help
Updated · written with AI from the project's own documentation and checked against our catalogue data
AudioKit is an open-source platform for adding audio synthesis, processing, and analysis to apps on iOS, macOS (including Catalyst), and tvOS. It is written in Swift and aimed at developers, not end users. This guide shows how to add AudioKit to an Xcode project, where to find documentation and examples, and where to get help when something breaks.
AudioKitAudioKit/AudioKit · ★ 11.5k · MIT Install options & downloads Quick start
- 1Install Xcode and Swift. AudioKit's prerequisites are Xcode and Swift. Make sure both are set up before adding the library.
- 2Open Add Package Dependencies. In Xcode, choose File -> Add Package Dependencies...
- 3Load the AudioKit collection. Add the package collection using https://swiftpackageindex.com/AudioKit/collection.json and click Load.
- 4Add the packages you need. Pick the AudioKit packages your app requires, reading their descriptions in Xcode as you go.
- 5Read the docs and Cookbook. Use the AudioKit.io docs and the AudioKit Cookbook recipes to see how components are used.
- 6Ask for help if needed. Post on StackOverflow with #AudioKit, and open a GitHub issue only if the problem is in AudioKit itself.
What AudioKit does
AudioKit lets an app generate tones, apply effects, or measure what it hears. The project describes itself as an audio synthesis, processing, and analysis platform for iOS, macOS, and tvOS.
It is distributed as a set of Swift packages, so you add only the pieces your app needs.
Install AudioKit in Xcode using Collections
The README recommends adding AudioKit through Xcode's Collections feature. You need Xcode and Swift. The steps below follow the README's order.
Once the collection is loaded, you can add any AudioKit package you need and read what each one does from within Xcode.
- Select File -> Add Package Dependencies...
- Click the + icon in the bottom left corner of the Collections sidebar.
- Select Add Package Collection... from the pop-up menu.
- Enter https://swiftpackageindex.com/AudioKit/collection.json as the URL and click Load.
- Add the AudioKit packages you need.
Clone the repository
The README's install command clones the source repository. Use this if you want to read or build the code directly rather than adding packages through Xcode.
git clone https://github.com/AudioKit/AudioKitFind documentation and examples
Documentation is published on the AudioKit.io website. You can also generate it inside Xcode by opening the Product menu and choosing Build Documentation.
For working code, the AudioKit Cookbook contains many recipes showing simple uses of AudioKit components. Swift Playgrounds is named in the project's use cases as a way to learn audio programming through examples.
Get help when you are stuck
Start by searching or posting on StackOverflow using the #AudioKit tag. The README suggests opening a GitHub issue only after you are sure the problem is in AudioKit itself and not in your own code.
- Post your question on StackOverflow with the #AudioKit hashtag.
- Open a GitHub issue at github.com/audiokit/AudioKit/issues if the problem is in AudioKit.
What people use it for
- Adding a synthesizer to an iOS or macOS music app
- Applying effects to audio in a Swift app
- Measuring incoming audio in a tool built for Apple platforms
- Learning audio programming through Cookbook recipes and Swift Playgrounds
Frequently asked questions
Is AudioKit free to use?
AudioKit is released under the MIT licence, as shown in the repository. Check the LICENSE file in the repository for the full terms before using it in a project.
What do I need to install AudioKit?
The README lists Xcode and Swift as prerequisites. AudioKit is added to an Xcode project as Swift packages.
Does AudioKit work on Android or Windows?
No. The README only lists iOS, macOS (including Catalyst), and tvOS, so it is not presented as a tool for Android, Windows, or Linux.
How do I install AudioKit in Xcode?
Use File -> Add Package Dependencies, then add the AudioKit collection from https://swiftpackageindex.com/AudioKit/collection.json. You can then add the individual packages you need.
Where can I find AudioKit examples?
The AudioKit Cookbook on GitHub contains many recipes for simple uses of AudioKit components.
How does AudioKit compare to Tone.js or JUCE?
AudioKit targets Swift apps on Apple platforms. Tone.js is a web audio framework, and JUCE is a C++ framework for audio applications. Pick based on your language and target platform.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
AudioKit suits Swift developers who need synthesis, effects, or analysis in iOS, macOS, or tvOS apps, and those who want to learn audio programming through its examples. It is not a ready-made music app, and it is not a fit for Android, Windows, or Linux. The README does not describe an API stability policy, so teams that need long-term API guarantees should check that before committing.
Install options & downloads