Swift audio synthesis, processing, & analysis platform for iOS, macOS and tvOS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
AudioKit
AudioUnits
Developer
Documentation
Examples
Frameworks
Playgrounds
Tests
.gitignore
.swiftlint.yml
.travis.yml
AudioKit.podspec.json
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
VERSION

README.md

AudioKit V4.2

Build Status License Carthage compatible CocoaPods compatible Platform Twitter Follow

AudioKit is an audio synthesis, processing, and analysis platform for iOS, macOS, and tvOS. This document serves as a one-page introduction to AudioKit, but we have much more information available on the AudioKit websites:

AudioKitPro.com AudioKit.io
Features, News, Blog, and Highlighted Apps Developer Documentation
AudioKitPro AudioKit.io

Key Concepts

Nodes Operations Taps
Nodes are interconnectable signal processing components. Each node has an output and usually some parameters. If the nodes processes another signal, the nodes will also have an input. Operations are similar to nodes, except that they are signal processing components that exist inside of a single node. Operations can be used as parameters to other operations to create very complex results. Taps use nodes as their data source, but do not redirect the audio signal away from the source nodes output into other nodes. This allows a tap to be moved from node to node more freely and to be added after the audio signal path has started.

Installation

Installation details are found in the Frameworks README file.

AudioKit is also available via CocoaPods and Carthage Package managers:

Package Manager Config File Contents
Carthage Cartfile github "audiokit/AudioKit"
Cocoapods Podfile pod 'AudioKit', '~> 4.0'

Example Code

There are three Hello World projects, one for each of the Apple platforms: iOS, macOS, and tvOS. They play oscillators and display waveforms. The examples rely on AudioKit's frameworks so you can either download precompiled frameworks or build them yourself .

For Hello World, you only need to understand a few lines of code:

Code Description
var oscillator = AKOscillator() Create the sound generator
AudioKit.output = oscillator Tell AudioKit what to output
AudioKit.start() Start up AudioKit
oscillator.start() Start the oscillator
oscillator.frequency = random(in: 220...880) Set oscillator parameters
oscillator.stop() Stop the oscillator

Playgrounds

Playgrounds contain bite-size examples of AudioKit and serve as tutorials for many of AudioKit's core concepts and capabilities. There are over 100 playgrounds which cover basic tutorials, synthesis, physical modeling, file playback, MIDI, effects, filters, and analysis.

We provide all playgrounds as a macOS project that is ready to run in Xcode. Just download the AudioKitPlaygrounds.zip file from our releases page, open and build the project, and go to the playground pages to learn AudioKit's API in a fun way!

We have videos of most of the playgrounds in action, so you don't need to run Xcode to check them out, just go to AudioKit Playground Videos.

Playgrounds

Ray Wenderlich's AudioKit Tutorial

Check out the AudioKit tutorial on the Ray Wenderlich site. You’ll be taken on a fun and gentle journey through the framework via the history of sound synthesis and computer audio.

Getting help

Here are three methods for getting support which are roughly listed in order of what you should try first:

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

  2. If you don't have a problem that you can post to StackOverflow, you may post to our Google Group, but it is a moderated list and prepare to be rejected if the moderator believes your question is better suited for StackOverflow (most are).

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

Contributing Code

AudioKit is always being improved by our core team and our users. This is a rough outline of what we're working on currently.

When you want to modify AudioKit, check out the develop branch (as opposed to master), make your changes, and send us a pull request.

About Us

AudioKit was created by Aurelius Prochazka who is your life line if you need help! Matthew Fecher manages all of AudioKit's web sites and Stephane Peter is Aure's co-admin and manages AudioKit's releases.

But, there are many other important people in our family:

Group Description
Core Team The biggest contributors to AudioKit!
Slack Pro-level developer chat group, contact a core team member for an in invitation.
Contributors A list of all people who have submitted code to AudioKit.
Google Group App Announcements and mailing list for all users.