Bitwig

trappar · Post by **trappar** » Fri Apr 18, 2014 8:05 pm

Hey all, I'm currently in the process of working on 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!

I use JetBrains Webstorm for my controller development, and so by including these stubs as an external library I get full code-hinting/autocompletion for anything Bitwig related. This is insanely helpful if you're planning on developing some code for an unsupported controller. This is the kind of auto-completion I'm talking about:

Here's what I've got so far. There's still quite a lot to do and I'd appreciate some help if anyone feels generous with their time but if not I'll keep plugging away at it!

trappar/bitwig-api-stubs on Github

Good luck with those controller scripts!

ThomasHelzle · Post by **ThomasHelzle** » Fri Apr 18, 2014 8:18 pm

Cool!

Can this be used with Komodo Edit somehow or is it specific to Webstorm?

Cheers,

Tom

dsan@mail.com · Post by **dsan@mail.com** » Fri Apr 18, 2014 8:23 pm

A resounding YES!

This will be very helpful to us who do not have scripting knowledge and enough experience to create a working script for our controllers.

Thank you for thinking this one up!

Looking forward to the results of your efforts Trappar

I am happy to assist you with what time I can muster (which is quite limited - day job you know

); however, be warned I am ignorant of coding and not sure how much help I can be

Happy Musiking!
dsan

Dazed Veins · Post by **Dazed Veins** » Fri Apr 18, 2014 8:30 pm

Happy scripting

trappar · Post by **trappar** » Fri Apr 18, 2014 8:31 pm

ThomasHelzle wrote:Can this be used with Komodo Edit somehow or is it specific to Webstorm?

I haven't tested it there, but it does seem Komodo Edit supports JSDoc, so I suspect it should work. It really just depends on how they manage external libraries/includes.

If you wouldn't mind testing it out for me that would be nice since I'd like to know what IDEs will support this, if not I'll probably test it out myself when I get the chance. Just let me know.

dsan@mail.com wrote:I am happy to assist you with what time I can muster (which is quite limited - day job you know ); however, be warned I am ignorant of coding and not sure how much help I can be

This actually isn't really coding at all haha, it's just reformatting their reference guide. Lots of copy paste into a very specific syntax. I'm making good headway though so I probably won't really need any help. Thanks for offering though!

ThomasHelzle · Post by **ThomasHelzle** » Fri Apr 18, 2014 8:46 pm

Worked on first try:
- Download the Files from Github as a Zip, extract to any folder you like (I added it to the documents/Bitwig Studio Folder).

- Open Komodo Edit, go to Edit -> Preferences -> Languages -> JavaScript and add the "api" folder from the download to the list with the "+" sign.
(Komodo Edit is a great free Editor: http://www.activestate.com/komodo-edit/downloads Check out the dark theme

)

- Enjoy trappars work, showing available commands etc. while typing.

Great stuff trappar!!!

I'll link here from the Ressources and Scripting Threads.

Cheers,

Tom

trappar · Post by **trappar** » Sat Apr 19, 2014 12:48 am

Hey guys I could use some help with figuring out how the nested classes NoteInput.NoteExpression, PrimaryDevice.ChainLocation, and PrimaryDevice.DeviceType work and how I can build stubs for them. I'm pretty sure if I can at least figure out how you're supposed to use them then I could mock up something which will help you do those things while maybe not perfectly matching the way the API is structured.

Everything else so far has been fairly easy.. but with these parts some help would be greatly appreciated

TeotiGraphix · Post by **TeotiGraphix** » Sat Apr 19, 2014 9:24 am

Hi,

Since those are actually enumerations, seems to me they would just be represented as static variables in javascript.

PrimaryDevice.ChainLocation = {};
PrimaryDevice.ChainLocation.FIRST = 0;
PrimaryDevice.ChainLocation.LAST = 1;
PrimaryDevice.ChainLocation.NEXT = 2;
PrimaryDevice.ChainLocation.PREVIOUS = 3;

etc. (notice no 'prototype')

I haven't used these yet in my actual code but I know this is how they translate to Java on the Bitwig side.

Mike

ottsch · Post by **ottsch** » Sat Apr 19, 2014 10:35 am

Thanks a lot!

marvotron · Post by **marvotron** » Sat Apr 19, 2014 11:53 am

TeotiGraphix wrote:Hi,

Since those are actually enumerations, seems to me they would just be represented as static variables in javascript.

PrimaryDevice.ChainLocation = {};
PrimaryDevice.ChainLocation.FIRST = 0;
PrimaryDevice.ChainLocation.LAST = 1;
PrimaryDevice.ChainLocation.NEXT = 2;
PrimaryDevice.ChainLocation.PREVIOUS = 3;

etc. (notice no 'prototype')

I haven't used these yet in my actual code but I know this is how they translate to Java on the Bitwig side.

I think thats right.

Coincidentally, i'd started building my own set of stubs, but these are nicer with the doc comments and whatnot.

I just submitted a pull request for the enum changes.

dsan@mail.com · Post by **dsan@mail.com** » Sat Apr 19, 2014 12:44 pm

ThomasHelzle wrote:Worked on first try:
- Download the Files from Github as a Zip, extract to any folder you like (I added it to the documents/Bitwig Studio Folder).

- Open Komodo Edit, go to Edit -> Preferences -> Languages -> JavaScript and add the "api" folder from the download to the list with the "+" sign.
(Komodo Edit is a great free Editor: http://www.activestate.com/komodo-edit/downloads Check out the dark theme )

- Enjoy trappars work, showing available commands etc. while typing.

Great stuff trappar!!!

I'll link here from the Ressources and Scripting Threads.

Cheers,

Tom

Thomas, trappar:
I dl'd all necessary files and placed them as instructed (I'm sure of this); however, when running Komodo Edit I'm not getting the suggestions like in trappar's example pic/movie.

The only time I get a suggestion is when I write "function"....I get the suggested "function" in a box but no list of functions.

If I start a line host. - no suggestions.

Any ideas?

Thanks!

Happy Musiking!
dsan

ThomasHelzle · Post by **ThomasHelzle** » Sat Apr 19, 2014 2:18 pm

Hey dsan, no, not really.

When I type "host." I get:

Just to makes sure:
- You pointed Komodo to the "api" folder in which there are the xxxx.js files from trappar?
- Make sure you have "Code Intelligence" Auto Complete and Calltips active in Komodo Preferences (not sure what the defaults are).

If all else fails you can PM me and I give you my Skype address for a debugging session

Cheers,

Tom

dsan@mail.com · Post by **dsan@mail.com** » Sat Apr 19, 2014 3:12 pm

Thanks Tom - got it figured out. Yes, settings are correct - first things I looked into.

It seems if I create a new document I do not get the hints; however, if I open an existing document I get the hints.

Strange

All working now.....but still lost

Thanks again!

Happy Musiking!
dsan

ThomasHelzle · Post by **ThomasHelzle** » Sat Apr 19, 2014 3:19 pm

Not that strange actually, but maybe not obvious either: the file needs to have a .js extension so Komodo knows that it is supposed to be Javascript. A new document has no extension...

Just save it with a proper name and it should work.

Cheers,

Tom

trappar · Post by **trappar** » Sat Apr 19, 2014 3:32 pm

marvotron wrote:
TeotiGraphix wrote:Hi,

Since those are actually enumerations, seems to me they would just be represented as static variables in javascript.

PrimaryDevice.ChainLocation = {};
PrimaryDevice.ChainLocation.FIRST = 0;
PrimaryDevice.ChainLocation.LAST = 1;
PrimaryDevice.ChainLocation.NEXT = 2;
PrimaryDevice.ChainLocation.PREVIOUS = 3;

etc. (notice no 'prototype')

I haven't used these yet in my actual code but I know this is how they translate to Java on the Bitwig side.
I think thats right.

Coincidentally, i'd started building my own set of stubs, but these are nicer with the doc comments and whatnot.

I just submitted a pull request for the enum changes.

Thanks guys

I just merged in those changes.

Bitwig

KVR Audio

Bitwig JS API Method Stubs