New Cantabile-JS API and Documentation

For those who might be interested, I’ve just put up a new version of Cantabile-JS.

For those who don’t know this is a JavaScript library that allows controlling Cantabile Performer using its built in network server.

This version is not backwards compatible with the previous library. Also this is still subject to change, but is much closer to what I’ll eventually settle on as a stable version going forward. If you have existing code using cantabile-js, it would be worth porting to this new library at some point.

The underlying network API hasn’t changed.

What’s changed:

  • Removed the need to “open” end points - they’re now connected automatically when accessing the endpoint property for the first time.
  • The bindings API has been reworked
  • Support for markdown show notes
  • Available as NPM package and browser packages
  • TypeScript definitions files now included (.d.ts)
  • All new documentation site
  • Miscellaneous other changes and tweaks
  • Several bug fixes and many documentation fixes

See the documentation here.

Also, I’m going to start putting together some more examples - if there’s something specific you’d like to see covered, let me know.

Finally, one more insider insight. I’m considering updating Cantabile to support scripting inside songs and racks. These scripts would be hosted automatically by Cantabile but run in a separate node process. If your curious to get a head start on what might be possible (and suggest additional things), this API will be starting point for that work.

3 Likes