1JACKTRIP(1) User Commands JACKTRIP(1)
2
6 JackTrip - "high-quality system for audio network performances"
7
9 jacktrip [-s|-c|-S|-C hostIPAddressOrURL] [options]
10
12 JackTrip: A System for High-Quality Audio Network Performance over the
13 Internet Copyright © 2008-2022 Juan-Pablo Caceres, Chris Chafe. Sound‐
14 WIRE group at CCRMA, Stanford University This build of JackTrip is sub‐
15 ject to LGPL license. JackTrip source code is released under MIT and
16 GPL licenses. See LICENSE.md file for more information. VERSION:
17 2.1.0
18
20 REQUIRED ARGUMENTS: One of:
21 -s, --server
22 Run in P2P Server Mode
23 -c, --client <peer_hostname_or_IP_num>
25 Run in P2P Client Mode
26 -S, --jacktripserver
28 Run in Hub Server Mode
29 -C, --pingtoserver <peer_name_or_IP>
31 Run in Hub Client Mode
32 OPTIONAL ARGUMENTS:
34 -n, --numchannels #
35 Number of Input and Output Channels (# greater than 0, default:
36 2)
37 --receivechannels #
39 Number of receive Channels from the network (# greater than 0)
40 --sendchannels #
42 Number of send Channels to the network (# greater than 0)
43 -q, --queue # (2 or more)
45 Queue Buffer Length, in Packet Size (default: 4)
46 -r, --redundancy # (1 or more)
48 Packet Redundancy to avoid glitches with packet losses (default:
49 1)
50 -o, --portoffset #
52 Receiving bind port and peer port offset from default 4464
53 -B, --bindport #
55 Set only the bind port number (default: 4464)
56 -P, --peerport #
58 Set only the peer port number (default: 4464)
59 -U, --udpbaseport
61 Set only the server udp base port number (default: 61002)
62 -b, --bitres # (8, 16, 24, 32)
64 Audio Bit Rate Resolutions (default: 16, 32 uses floating-point)
65 -z, --zerounderrun
67 Set buffer to zeros when underrun occurs (default: wavetable)
68 -t, --timeout
70 Quit after 10 seconds of no network activity
71 -l, --loopback
73 Run in Loop-Back Mode
74 -j, --jamlink
76 Run in JamLink Mode (Connect to a JamLink Box)
77 -J, --clientname
79 Change default client name (default: JackTrip)
80 -K, --remotename
82 Change default remote client name when connecting to a hub
83 server (the default is derived from this computer's external
84 facing IP address)
85 --appendthreadid
87 Append thread ID to client names
88 -L, --localaddress
90 Change default local host IP address (default: 127.0.0.1)
91 -D, --nojackportsconnect
93 Don't connect default audio ports in jack
94 --bufstrategy # (0, 1, 2, 3, 4)
96 Use alternative jitter buffer
97 --broadcast <broadcast_queue>
99 Duplicate receive ports with the specified broadcast_queue
100 length. Broadcast outputs have higher latency but less packet
101 loss.
102 --udprt
104 Use RT thread priority for network I/O
105 OPTIONS FOR AUDIO PATCHING IN HUB SERVER MODE:
107 -p, --hubpatch # (0, 1, 2, 3, 4, 5)
108 Hub auto audio patch, only has effect if running HUB SERVER
109 mode, 0=server-to-clients, 1=client loopback, 2=client fan
110 out/in but not loopback, 3=reserved for TUB, 4=full mix, 5=no
111 auto patching (default: 0)
112 -i, --includeserver
114 Include audio to and from the server in the mix when patching.
115 Only affects -p 2 (client fan out/in but not loopback) and -p 4
116 (full mix) patch modes.
117 -u, --upmix
119 Upmix mono clients to stereo when patching
120 OPTIONAL SIGNAL PROCESSING:
122 -f, --effects # | paramString | help
123 Turn on incoming and/or outgoing compressor and/or reverb in
124 Client - see `-f help' for details
125 -O, --overflowlimiting i|o[w]|io[w]|n|help
127 Use audio limiter(s) in Client, i=incoming from network, o=out‐
128 going to network, io=both, n=no limiters, w=warn if limiting
129 (default=n). Say -O help for more.
130 -a, --assumednumclients help|# (1,2,..)
132 Assumed number of Clients (sources) mixing at Hub Server (other‐
133 wise 2 assumed by -O)
134 -T, --srate #
136 Set the sampling rate, works only on some audio backends (de‐
137 fault: 48000)
138 -F, --bufsize #
140 Set the buffer size, works only on some audio backends (default:
141 128)
142 ARGUMENTS TO USE JACKTRIP WITHOUT JACK:
144 -R, --rtaudio
145 Use system's default sound system instead of Jack
146 --audiodevice "input-output device name"
148 --audiodevice "input device name","output device name"
150 --audioinputdevice "input device name"
152 --audiooutputdevice "output device name"
154 Set audio device to use; if not set, the default device will be
155 used
156 --listdevices
158 List available audio devices
159 -d, --deviceid #
161 Set rtaudio device id (DEPRECATED, use --audiodevice instead)
162 ARGUMENTS TO DISPLAY IO STATISTICS:
164 -I, --iostat <time_in_secs>
165 Turn on IO stat reporting with specified interval (in seconds)
166 -G, --iostatlog <log_file>
168 Save stat log into a file (default: print in stdout)
169 -x, --examine-audio-delay <print_interval_in_secs> | help
171 Print round-trip audio delay statistics. See `-x help' for de‐
172 tails.
173 ARGUMENTS TO SIMULATE NETWORK ISSUES:
175 --simloss <rate>
176 Simulate packet loss
177 --simjitter <rate>,<d>
179 Simulate jitter, d is max delay in packets
180 ARGUMENTS FOR HUB CLIENT/SERVER AUTHENTICATION:
182 -A, --auth
183 Use authentication on the client side, or require it on the
184 server side
185 --certfile
187 The certificate file to use on the hub server
188 --keyfile
190 The private key file to use on the hub server
191 --credsfile
193 The file containing the stored usernames and passwords
194 --username
196 The username to use when connecting as a hub client (if not sup‐
197 plied here, this is read from standard input)
198 --password
200 The password to use when connecting as a hub client (if not sup‐
201 plied here, this is read from standard input)
202 ARGUMENTS FOR THE GUI:
204 --gui Force JackTrip to run with the GUI. If not using VirtualStudio
205 mode, command line switches in the required arguments, optional
206 arguments (except -l, -j, -L, --appendthreadid), audio patching,
207 and authentication sections will be honoured, and default set‐
208 tings will be used where arguments aren't supplied. Options from
209 other sections will be ignored (and the last used settings will
210 be loaded), except for -V, and the --version and --help switches
211 which will override this.
212 --classic-gui
214 Force JackTrip to run with the Classic Mode GUI.
215 --deeplink
217 Handle a deeplink URL in the format jacktrip://join/<studio_id>
218 by connecting as a hub client
219 HELP ARGUMENTS:
221 -v, --version
222 Prints Version Number
223 -V, --verbose
225 Verbose mode, prints debug messages
226 -h, --help
228 Prints this Help
229 Build Info: Fedora release 39 (Thirty Nine) Copyright © 2008-2022
231 Juan-Pablo Caceres, Chris Chafe. SoundWIRE group at CCRMA, Stanford
232 University This build of JackTrip is subject to LGPL license. JackTrip
233 source code is released under MIT and GPL licenses. See LICENSE.md
234 file for more information.
235JackTrip VERSION: 2.1.0 November 2023 JACKTRIP(1)