Configuration and Helper Tool

$3

Configuration and helper tools for bitwig-websocket-rpc.

Options:
-V, --version output the version number
-h, --help output usage information

Commands:
install [options] Install Bitwig Studio WebSockets RPC server extension.
config [options] Configure RPC modules.
report [options] Report accessible RPC methods and evnets of current configuration as JSON.
actions [options] Report result of Application#getActions() as JSON.
events [options] Monitor events.
logs [options] Trace controller script logs.

$ npx bws-rpc install --help
Usage: install [options]

Install Bitwig Studio WebSockets RPC server extension.

Options:
-e, --extension-dir Bitwig Studio Extension directory
(default: "/Extensions")
-h, --help output usage information

$ npx bws-rpc config --help
Usage: config [options]

Configure RPC modules.

Options:
-u, --url Bitwig Studio WebSockets URL (default: "ws://localhost:8887")
-f, --file config file(.js|.json) path.
-a, --all enable all RPC methods and events.
this option is ignored by -f, --file option.
-b, --abbrev enable abbreviated method and event name (experimental),
this option is ignored by -f, --file option.
-p, --print dry run, print current or intended configuration as JSON.
-h, --help output usage information

Module Use

$3

const wait = millis => {
return new Promise(resolve => setTimeout(resolve, millis));
};

(async() => {
// configure interesting modules.
// this function trigger restart of extension.
// so all client connections will be closed by server.
await bitwig('ws://localhost:8887', {
useTransport: true
});
// recommended client library.
// https://github.com/elpheria/rpc-websockets
const ws = new WebSocket('ws://localhost:8887', {
autoconnect: true,
reconnect: true
});

ws.on('open', async () => {
// host module is accessible without configuration.
ws.notify('host.showPopupNotification', ['Hello Bitwig Studio!']);

try {
// SettableBooleanValue Transport#isPlaying()
// this calling will causes error. this is a limitation of Bitwig API.
const isPlaying0 = await ws.call('transport.isPlaying');
console.log('isPlaying0:', isPlaying0);
} catch (err) {
// { code: -32603,
// message: 'Internal error',
// data: 'Trying to get a value while not being subscribed.' }
console.log(err);
}

// start subscribing interesting events
ws.subscribe([
'transport.getPosition',
'transport.isPlaying'
]);

// now you can read Transport#isPlaying()
// Value#subscribe() is invoked internally because of subscribing event.

// SettableBooleanValue Transport#isPlaying()
const isPlaying1 = await ws.call('transport.isPlaying');
// boolean Transport#isPlaying().get()
const isPlaying2 = await ws.call('transport.isPlaying.get');
// Both values are same boolean value.
// API's value objects (inherited Value class) are serialized via custom serializer.
// see com.github.jhorology.bitwig.websocket.protocol.jsonrpc.BitwigAdapters
console.log('isPlaying1:', isPlaying1, ', isPlaying2:', isPlaying2);

// handling events
ws.on('transport.getPosition', position => {
console.log("position:", position);
});
ws.on('transport.isPlaying', playing => {
console.log("playing:", playing ? 'start' : 'stop');
});

await wait(1000);
ws.notify('transport.play');
await wait(3000);
ws.notify('transport.stop');
await wait(1000);
// unsbscrive events
ws.unsubscribe([
'transport.getPosition',
'transport.isPlaying'
]);
// close a connection
ws.close();
});
})();

$3