Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.73 KB

README.md

File metadata and controls

54 lines (37 loc) · 2.73 KB
Raw

JACK (for Rust)

Rust bindings for JACK Audio Connection Kit.

Crates.io License
Docs.rs Test
📚 Documentation ❤️ Sponsor

Using JACK

The JACK server is usually started by the user or system. Clients can request that the JACK server is started on demand when they connect, but this can be disabled by creating a client with the NO_START_SERVER option or ClientOptions::default().

  • Linux and BSD users may install JACK1, JACK2 (preferred for low latency), or Pipewire JACK (preferred for ease of use) from their system package manager.
  • Windows users may install JACK from the official website or Chocolatey.
  • MacOS users may install JACK from the official website or Homebrew.

Refer to the docs.rs documentation for details about the API. For more general documentation, visit https://rustaudio.github.io/rust-jack.

Testing

Testing requires setting up a dummy server and running the tests using a single thread. rust-jack automatically configures cargo nextest to use a single thread.

# Set up a dummy server for tests. The script is included in this repository.
./dummy_jack_server.sh &
# Run tests
cargo nextest run

Note: If cargo nextest is not available, use RUST_TEST_THREADS=1 cargo test to run in single threaded mode.

Possible Issues

If the tests are failing, a possible gotcha may be timing issues.

  1. If using cargo test, try cargo nextest. The cargo nextest configuration is set up to run single threaded and to retry flaky tests.

Another case is that libjack may be broken on your setup. Try using libjack2 or pipewire-jack.