Skip to content
Method stubs for Bitwig's javascript api
HTML JavaScript CSS
Latest commit 39f401c Aug 17, 2015 @trappar Update README.md
Failed to load latest commit information.
api_docs Update for 1.0.9RC1 Jun 10, 2014
src Update for 1.0.8 RC3 May 4, 2014
.gitignore Add .gitignore Apr 18, 2014
CHANEGELOG.md Release 1.0 Apr 19, 2014
LICENSE Create LICENSE Aug 11, 2014
README.md Update README.md Aug 17, 2015
version.txt Release 1.0 Apr 19, 2014

README.md

Bitwig Javascript API Stubs

A manual conversion of the Bitwig Control Surface Scripting API into javascript method stubs complete with JSDoc. If you're working on any controller scripts this should be super helpful to you! Here's the sort of code-completion these stubs will give you...

Example of code-completion in action

This repository is now deprecated!

Bitwig comes bundled with method stubs based on this work as of version 1.0.12. This repository is still up for historical purposes only.

IMPORTANT!

Report any issues you find! Report issues however is easiest for you...

Installation

Click "Download Zip" on the right side of this page. Extract to any folder you like.

JetBrains WebStorm
  1. Open Preferences -> Javascript -> Libraries -> "Add..."
  2. Enter a "Name" for this library (Bitwig API)
  3. Add the "src" folder from the download to the list with the "+" sign and clicking "Attach Directory"
  4. (OPTIONAL) Disable HTML/HTML5 libraries

Optionally you may want adjust this setting for better code completion 1. Open Preferences -> Javascript 2. Disable "Weaker type guess for completion"

Komodo Edit
  1. Go to Edit -> Preferences -> Languages -> JavaScript
  2. Add the "src" folder from the download to the list with the "+" sign.

Notes

Feel free to try using this in other IDEs/editors and let me know how well it works. WebStorm seems to have the best support right now with full autocompletion and type-hinting. Komodo Edit has support for autocompletion but no type-hinting .. but it's free!

Also, you may be wondering why a copy of the Bitwig Control Surface Scripting API doc files are included with this. It is so that when a new version comes out I can bring in those files and see what has changed. This way I can keep up-to-date with any changes that are made to the API!

Known issues

  • The API documentation doesn't list when parameters are optional as far as I can tell, so I'm going to have to fix those as I find them.

Thanks

  • TeotiGraphix and marvotron for helping out with the enum parts!
  • The Bitwig team for actually releasing API documentation with their software! -nudge nudge- come on Ableton...
Something went wrong with that request. Please try again.