Scroll to navigation

JACKTRIP(1) User Commands JACKTRIP(1)

NAME

JackTrip - high-quality system for audio network performances

SYNOPSIS

jacktrip [-s|-c|-S|-C hostIPAddressOrURL] [options]

DESCRIPTION

JackTrip: A System for High-Quality Audio Network Performance over the Internet Copyright © 2008-2020 Juan-Pablo Caceres, Chris Chafe. SoundWIRE group at CCRMA, Stanford University VERSION: 1.3.0

OPTIONS

REQUIRED ARGUMENTS: One of:

Run in P2P Server Mode
Run in P2P Client Mode
Run in Hub Server Mode
Run in Hub Client Mode

OPTIONAL ARGUMENTS:

Number of Input and Output Channels (default: 2)
# (2 or more) Queue Buffer Length, in Packet Size (default: 4)
# (1 or more) Packet Redundancy to avoid glitches with packet losses (default: 1)
# Receiving bind port and peer port offset from default 4464
# Set only the bind port number (default: 4464)
# Set only the peer port number (default: 4464)
Set only the server udp base port number (default: 61002)
# (8, 16, 24, 32) Audio Bit Rate Resolutions (default: 16, 32 uses floating-point)
# (0, 1, 2, 3, 4, 5) Hub auto audio patch, only has effect if running HUB SERVER mode, 0=server-to-clients, 1=client loopback, 2=client fan out/in but not loopback, 3=reserved for TUB, 4=full mix, 5=no auto patching (default: 0)
Set buffer to zeros when underrun occurs (default: wavetable)
Quit after 10 seconds of no network activity
Run in Loop-Back Mode
Run in JamLink Mode (Connect to a JamLink Box)
Change default client name (default: JackTrip)
Change default remote client name when connecting to a hub server (the default is derived from this computer's external facing IP address)
Change default local host IP address (default: 127.0.0.1)
Don't connect default audio ports in jack
# (0, 1, 2) Use alternative jitter buffer
Turn on broadcast output ports with extra queue (requires new jitter buffer)
Use RT thread priority for network I/O

OPTIONAL SIGNAL PROCESSING:

Turn on incoming and/or outgoing compressor and/or reverb in Client - see `-f help' for details
Use audio limiter(s) in Client, i=incoming from network, o=outgoing to network, io=both, n=no limiters, w=warn if limiting (default=n). Say -O help for more.

-a, --assumednumclients help|# (1,2,...) Assumed number of Clients (sources) mixing at Hub Server (otherwise 2 assumed by -O)

ARGUMENTS TO USE JACKTRIP WITHOUT JACK:

Use system's default sound system instead of Jack
# Set the sampling rate, works on --rtaudio mode only (default: 48000)
# Set the buffer size, works on --rtaudio mode only (default: 128)
# The rtaudio device id --rtaudio mode only (default: 0)

ARGUMENTS TO DISPLAY IO STATISTICS:

Turn on IO stat reporting with specified interval (in seconds)
Save stat log into a file (default: print in stdout)
Print round-trip audio delay statistics. See `-x help' for details.

ARGUMENTS TO SIMULATE NETWORK ISSUES:

Simulate packet loss
Simulate jitter, d is max delay in packets

HELP ARGUMENTS:

Prints Version Number
Verbose mode, prints debug messages
Prints this Help

COPYRIGHT

Copyright © 2008-2020 Juan-Pablo Caceres, Chris Chafe. SoundWIRE group at CCRMA, Stanford University

January 2021 JackTrip VERSION: 1.3.0