Skip to content
This repository has been archived by the owner on Dec 27, 2022. It is now read-only.


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Failed to load latest commit information.

AudioKit AUv3 Plugin & Stand-alone Example

License Twitter Follow

With this code, we hope to inspire the next generation of music app creators.

This project was created with Award-winning professors Kennard Garrett & Henny tha Bizness at historic Morehouse College's music tech department. The AudioKit development team was led by Jeff Cooper and Matthew Fecher.


This repo is currently a Beta WIP.

Code Features

  • Complete music app example, full source included
  • Use as an iOS AUv3 plugin in hosts like GarageBand, AUM, BeatMaker 3, Cubasis 3, and more
  • AU Parameter Automation
  • Use as standalone app without a host
  • Save/recall AU Params in host
  • FX examples including Reverb, Tremolo, AutoPan, more...
  • ADSR Envelope (Attack, Decay, Sustain, Release)
  • Robust preset & bank system and UI
  • MIDI input for notes, pitch bend, mod wheel
  • On screen "Piano" keyboard that can be customized
  • MIDI Learn knobs
  • Example code written entirely in Swift 5 & AudioKit 4

Getting Started

If you're new to AudioKit, you can learn more and view getting started links: here.

This repo branch uses CocoaPods to add AudioKit 4 to your project. If you're using a newer version of Xcode, you may need to add AudioKit 4 manually without using CocoaPods.

Using the Terminal app in your mac, change directories to the folder that contains this project. The correct directory contains a file called Podfile

Run pod install from the command line. This will add AudioKit & AudioKit UI to project

Then open AU Example.xcworkspace in Xcode


  • Mac or computer running Xcode 11 (Free Download)
  • Knowledge of programming, specifically Swift & the iOS SDK

If you are new to iOS development, I highly recommend the Ray Wenderlich videos. There is also a great tutorial on basic synthesis with AudioKit here.

Included Sounds

This repo includes sounds AnalogMatthew sampled from his TX81z hardware FM synthesizer for example purposes. Please use your own sounds in your app.

Sound Manipulation

There are all kinds of filters, effects, and other audio manipulation classes included with AudioKit to get you started. You can browse the documentation here.

And, explore over 100+ playgrounds, created by the lovely & talented Aure Prochazka. These byte size code playgrounds allow you to easily experiment with sound & code.

Additionally, these docs and tips will also prove valuable if you want to dive in at a deeper level than the AKSampler.

Making Graphics

IMPORTANT: You need to change the graphics to upload an app to the app store. Apple does not allow apps to use stock template graphics. Plus, you want your app to be part of the expression of your artistic vision.

For example, if you were releasing a new music album, you would not want to use someone else's album artwork. You would want your own!

Think of the GUI as an extension of your sample/music artform. It is a way to impress upon users your own style and give them a feel for your sonic personality.

If graphic coding is not your cup of tea, the easiest way to make synth controls and knobs with code is to use PaintCode. I made almost all the graphic elements for this app with PaintCode. I've included the PaintCode source files for most of these UI elements here. You can use them as a starting place to learn how to make controls. You can start with these files and change the color, sizes, etc.

Luckily, I've already included the coding part of handling knobs in this repo. You only have to worry about the graphics.

knob in ib

If you'd rather make knobs and controls with a graphic rendering software packgage that exports image frames (or a dedicated tool like KnobMan), here's some example code I wrote demonstrating using images to create knobs here.


Code Usage

You are free to:

(1) Use this app as a learning tool.
(2) Re-skin this app (change the graphics), use your own sound samples, and upload to the app store.
(3) Change the graphics, use your own sounds, and include this as part of a bigger app you are building.
(4) Contribute code back to this project and improve this code for other people.

If you use any code, it would be great if you gave this project some credit or a mention. The more love this code receives, the better we can make it for everyone. And, give AudioKit a shout-out when you can! :)

If you make an app with this code, please let us know! We think you're awesome, and would love to hear from you and/or feature your app.

IMPORTANT: You must change the graphics and sounds if you upload this to the app store.

What Sounds Can You Use In Your App?

Please get permission from the content creators before you use any free sounds on the internet. Even if sounds are available for free, it does not mean they are licensed to be used in an interactive app.

The best thing to do is to create or sample your own custom instruments. Generally, you can sample an acoustic instrument or voice without worry. This includes things like Pianos, Flutes, Horns, Human Voice, Guitars, Hand Claps, Foot stomps, etc.

Thanks and Credits

Huge thanks to all the beta testers and the folks on the AudioKit Slack Group, AudioBus Forum, & Facebook iOS Musician groups! Without your support and positive reviews, this would not be possible.

The AudioKit developement team was led by Jeff Cooper and Matthew Fecher.

AudioKit Founder Aure Prochazka

AKSampler by Shane Dunne

This app would not be possible without all the AudioKit contributors:
AudioKit Contributions

Legal Notices

This is an open-source project intended to bring joy and music to people, and enlighten people on how to build custom instruments and iOS apps. All product names and images, trademarks and artists names are the property of their respective owners, which are in no way associated or affiliated with the creators of this app, including AudioKit, AudioKit Pro, LLC, and the other contributors.

Product names and images are used solely for the purpose of identifying the specific products related to DAWs, iOS hosts, synthesizers, sampling, sound design, and music making. Use of these names and images does not imply any cooperation or endorsement.

This Readme text does not constitute legal advice. We take no responsibility for any actions resulting from using this code.