Close Menu

audiokit

Introduction

Welcome to the documentation page for AudioKit – a powerful audio synthesis, processing, and analysis framework for iOS, macOS, and tvOS.

Compatibility

AudioKit supports the following platforms:

  • iOS 9.0+
  • macOS 10.11+
  • tvOS 9.0+

Installation

To install AudioKit, you can use CocoaPods or Swift Package Manager (SPM). Follow the steps below based on your preferred method:

Using CocoaPods

To install AudioKit using CocoaPods:

  • Add `pod ‘AudioKit’, ‘~> 5.1’` to your Podfile.
  • Run `pod install` from the Terminal.
  • Import AudioKit in your project using `import AudioKit`.

Using Swift Package Manager (SPM)

To install AudioKit using Swift Package Manager (SPM):

  • In Xcode, select File -> Swift Packages -> Add Package Dependency.
  • Enter the AudioKit GitHub URL: `https://github.com/AudioKit/AudioKit`
  • Choose the desired version of AudioKit and click Next.
  • Follow the prompts to complete the installation.
  • Import AudioKit in your project using `import AudioKit`.

Getting Started

Once you have successfully installed AudioKit, you can begin using its powerful audio capabilities in your projects. Use the following steps to get started:

Initializing AudioKit

To initialize AudioKit, you must create an instance of `AKManager` and call its `start()` function:


import AudioKit
AudioKit.start()

Creating and Connecting Nodes

AudioKit operates using a node-based system. You can create various audio nodes and connect them to form your desired audio processing chain. Here’s an example:


// Create nodes
let oscillator = AKOscillator()
let filter = AKLowPassFilter(oscillator)
let reverb = AKReverb(filter)

// Connect nodes
AudioKit.output = reverb
AudioKit.start()

Playing Audio

To start playing audio, simply call the `start()` function on your root node:


oscillator.start()

Documentation and Examples

For further guidance and examples on using AudioKit, please refer to the official AudioKit documentation. It contains comprehensive information about all available audio processing nodes, controls, and utilities provided by AudioKit.

Community and Support

If you encounter any issues, have questions, or want to get involved with the AudioKit community, please visit the AudioKit forums.

For bug reports or feature requests, please use the AudioKit GitHub repository.