Permalink
8f2acd6 Mar 5, 2018
3 contributors

Users who have contributed to this file

@aure @megastep @jblang94
38 lines (22 sloc) 2.98 KB

AudioKit Frameworks

AudioKit is distributed as a couple of universal static frameworks with minimal dependencies on all supported platforms. This makes AudioKit easy to integrate within your own projects.

AudioKit requires at least iOS 9.0, macOS 10.11 (El Capitan) or tvOS 9.0. Your deployment target needs to be set to at least one of these versions to link with AudioKit.

Using the compiled frameworks in your projects

  • Select the target in your Xcode project that will link with AudioKit.
  • Drag and drop the AudioKit.framework bundle in the Linked Frameworks and Libraries section of the General tab.
  • Repeat for AudioKitUI.framework if you are using the optional UI elements for your platform.
  • Make sure to add -lstdc++ to the Other Linker Flags setting in your target.
  • For Objective-C Projects, make sure that the Embedded Content Contains Swift Code build setting is set to YES for your target. AudioKit is a Swift library that depends on the Swift runtime being available.
  • For pure Objective-C projects (no Swift files), you will need to add this path to the library search paths of your target: $(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME)

Alternative: include the AudioKit library from source

This may be the preferred method if you need to debug or develop code in AudioKit, as Xcode is still notoriously bad at handling precompiled Swift frameworks in other projects.

You may obtain the source code archive directly from GitHub, or you may also clone the official repository.

  • Drag and drop the AudioKit For {platform}.xcodeproj file to your project in Xcode. The file is located within the AudioKit/{platform} subdirectory in the repository, where {platform} is one of iOS, macOS or tvOS.
  • In the Build Phases tab, add AudioKit.framework in Target Dependencies for your target. Also add AudioKitUI.framework as needed.
  • Make sure to add -lstdc++ to the Other Linker Flags setting in your target.

Building universal frameworks from scratch

If you are tinkering with AudioKit itself, you may also want to build a set of universal frameworks from source. We provide a script to do just that, which is how the actual binaries are produced for each new release of AudioKit.

Go to the Frameworks directory and run the ./build_frameworks.sh script. You will need to have the Xcode command line tools installed. Optionally, install the xcpretty Ruby gem to prettify the ouput.

The built frameworks are dropped in the Frameworks/AudioKit-{platform} directory, where platform is one of iOS, tvOS or macOS. Note that when building from source, all included examples assume that the frameworks have been previously built in this location.

Optionally, you may restrict which platforms to build the frameworks for by setting the PLATFORMS environment variable prior to calling the script. The following example only builds for iOS and tvOS, skipping macOS:

PLATFORMS="iOS tvOS" ./build_frameworks.sh