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 (C) 2008-2022 Juan-Pablo Caceres, Chris Chafe. SoundWIRE group at CCRMA, Stanford University This build of JackTrip is subject to LGPL license. JackTrip source code is released under MIT and GPL licenses. See LICENSE.md file for more information. VERSION: 2.2.5 OPTIONS REQUIRED ARGUMENTS: One of: -s, --server Run in P2P Server Mode -c, --client Run in P2P Client Mode -S, --jacktripserver Run in Hub Server Mode -C, --pingtoserver Run in Hub Client Mode OPTIONAL ARGUMENTS: -n, --numchannels # Number of Input and Output Channels (# greater than 0, default: 2) --receivechannels # Number of receive Channels from the network (# greater than 0) --sendchannels # Number of send Channels to the network (# greater than 0) -q, --queue # (2 or more) Queue Buffer Length, in Packet Size (default: 4) -r, --redundancy # (1 or more) Packet Redundancy to avoid glitches with packet losses (default: 1) -o, --portoffset # Receiving bind port and peer port offset from default 4464 -B, --bindport # Set only the bind port number (default: 4464) -P, --peerport # Set only the peer port number (default: 4464) -U, --udpbaseport Set only the server udp base port number (default: 61002) -b, --bitres # (8, 16, 24, 32) Audio Bit Rate Resolutions (default: 16, 32 uses floating-point) -z, --zerounderrun Set buffer to zeros when underrun occurs (default: wavetable) -t, --timeout Quit after 10 seconds of no network activity -l, --loopback Run in Loop-Back Mode -j, --jamlink Run in JamLink Mode (Connect to a JamLink Box) -J, --clientname Change default client name (default: JackTrip) -K, --remotename Change default remote client name when connecting to a hub server (the default is derived from this computer's external facing IP address) --appendthreadid Append thread ID to client names -L, --localaddress Change default local host IP address (default: 127.0.0.1) -D, --nojackportsconnect Don't connect default audio ports in jack --bufstrategy # (0, 1, 2, 3, 4) Use alternative jitter buffer --broadcast Duplicate receive ports with the specified broadcast_queue length. Broadcast outputs have higher latency but less packet loss. --udprt Use RT thread priority for network I/O OPTIONS FOR AUDIO PATCHING IN HUB SERVER MODE: -p, --hubpatch # (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) -i, --includeserver Include audio to and from the server in the mix when patching. Only affects -p 2 (client fan out/in but not loopback) and -p 4 (full mix) patch modes. -u, --upmix Upmix mono clients to stereo when patching OPTIONAL SIGNAL PROCESSING: -f, --effects # | paramString | help Turn on incoming and/or outgoing compressor and/or reverb in Client - see `-f help' for details -O, --overflowlimiting i|o[w]|io[w]|n|help 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) -T, --srate # Set the sampling rate, works only on some audio backends (default: 48000) -F, --bufsize # Set the buffer size, works only on some audio backends (default: 128) ARGUMENTS TO USE JACKTRIP WITHOUT JACK: -R, --rtaudio Use system's default sound system instead of Jack --audiodevice "input-output device name" --audiodevice "input device name","output device name" --audioinputdevice "input device name" --audiooutputdevice "output device name" Set audio device to use; if not set, the default device will be used --listdevices List available audio devices -d, --deviceid # Set rtaudio device id (DEPRECATED, use --audiodevice instead) ARGUMENTS TO DISPLAY IO STATISTICS: -I, --iostat Turn on IO stat reporting with specified interval (in seconds) -G, --iostatlog Save stat log into a file (default: print in stdout) -x, --examine-audio-delay | help Print round-trip audio delay statistics. See `-x help' for details. ARGUMENTS TO SIMULATE NETWORK ISSUES: --simloss Simulate packet loss --simjitter , Simulate jitter, d is max delay in packets ARGUMENTS FOR HUB CLIENT/SERVER AUTHENTICATION: -A, --auth Use authentication on the client side, or require it on the server side --certfile The certificate file to use on the hub server --keyfile The private key file to use on the hub server --credsfile The file containing the stored usernames and passwords --username The username to use when connecting as a hub client (if not supplied here, this is read from standard input) --password The password to use when connecting as a hub client (if not supplied here, this is read from standard input) ARGUMENTS FOR THE GUI: --gui Force JackTrip to run with the GUI. If not using VirtualStudio mode, command line switches in the required arguments, optional arguments (except -l, -j, -L, --appendthreadid), audio patching, and authentication sections will be honoured, and default settings will be used where arguments aren't supplied. Options from other sections will be ignored (and the last used settings will be loaded), except for -V, and the --version and --help switches which will override this. --classic-gui Force JackTrip to run with the Classic Mode GUI. --deeplink Handle a deeplink URL in the format jacktrip://join/ by connecting as a hub client HELP ARGUMENTS: -v, --version Prints Version Number -V, --verbose Verbose mode, prints debug messages -h, --help Prints this Help COPYRIGHT Copyright (C) 2008-2022 Juan-Pablo Caceres, Chris Chafe. SoundWIRE group at CCRMA, Stanford University This build of JackTrip is subject to LGPL license. JackTrip source code is released under MIT and GPL licenses. See LICENSE.md file for more information. JackTrip VERSION: 2.2.5 March 2024 JACKTRIP(1)