Zwerm3 Jack

This library will be used as a backend to run Jack and Jacktrip processes in the Zwerm3 environment.

API

$3

This will make connection between a sender and a receiver.

$3

This will disconnect a sender and a receiver.

$3

This will get all the paths related to Jack. This function will check the OS (Windows, macOS or Linux) to generate the paths.

$3

This will get all the paths related to Jacktrip. This function will get the Jacktrip binary used in this package.

$3

Get the system clients of Jack.

$3

This will return a boolean whether Jack is running or not.

$3

This will return a boolean whether Jacktrip is running or not.

$3

This will return all the hub clients (e.g. the connected clients if Jacktrip is running in hub mode)

$3

Kills all the Jack and Jacktrip processes.

$3

Kills the Jacktrip proces.

$3

Kills the Jack proces.

$3

Start a Jack instance on the host.

jackParams
- device: string: The device to use, defaults the one selected in the OS
- channels: number: The amount of channels to use
- sampleRate: number: The sample rate
- bufferSize: number: The buffer size

optionalParams
- onLog: (message: string) => void

$3

Starts a Jack instance on the host. This returns a promise, so waiting until the Jack instance started is possible.

$3

Start a Jacktrip instance as a server on the host.

jacktripParams
- hub: boolean
- hubPatchMode: HubPatchMode
- channels: number
- queueBuffer: number
- debug: boolean
- bitRate: BitRate
- redundancy: number

$3

Start a Jacktrip instance as a server on the host. This returns a promise, so waiting until the Jacktrip instance started is possible.

$3

Start a Jacktrip instance as a client on the HUB server.

$3

Start a Jacktrip instance as a client on the HUB server. This returns a promise, so waiting until the Jacktrip instance started is possible.

$3

Start a Jacktrip HUB server instance.

$3

Start a Jacktrip HUB server instance. This returns a promise, so waiting until the Jacktrip instance started is possible.

$3

Start a Jacktrip Peer 2 Peer client.

$3

Start a Jacktrip Peer 2 Peer client asynchronously.

$3

Start a Jacktrip Peer 2 Peer server.

$3

Start a Jacktrip Peer 2 Peer server asynchronously.

Authors

- Tim De Paepe
- Kasper Jordaens