1JACKTRIP(1) User Commands JACKTRIP(1)
2
6 JackTrip - manual page for JackTrip VERSION: 1.4.1
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-2021 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 1.4.1
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 -p, --hubpatch # (0, 1, 2, 3, 4, 5)
67 Hub auto audio patch, only has effect if running HUB SERVER
68 mode, 0=server-to-clients, 1=client loopback, 2=client fan
69 out/in but not loopback, 3=reserved for TUB, 4=full mix, 5=no
70 auto patching (default: 0)
71 -z, --zerounderrun
73 Set buffer to zeros when underrun occurs (default: wavetable)
74 -t, --timeout
76 Quit after 10 seconds of no network activity
77 -l, --loopback
79 Run in Loop-Back Mode
80 -j, --jamlink
82 Run in JamLink Mode (Connect to a JamLink Box)
83 -J, --clientname
85 Change default client name (default: JackTrip)
86 -K, --remotename
88 Change default remote client name when connecting to a hub
89 server (the default is derived from this computer's external
90 facing IP address)
91 --appendthreadid
93 Append thread ID to client names
94 -L, --localaddress
96 Change default local host IP address (default: 127.0.0.1)
97 -D, --nojackportsconnect
99 Don't connect default audio ports in jack
100 --bufstrategy # (0, 1, 2)
102 Use alternative jitter buffer
103 --broadcast <broadcast_queue>
105 Duplicate receive ports with the specified broadcast_queue
106 length. Broadcast outputs have higher latency but less packet
107 loss.
108 --udprt
110 Use RT thread priority for network I/O
111 OPTIONAL SIGNAL PROCESSING:
113 -f, --effects # | paramString | help
114 Turn on incoming and/or outgoing compressor and/or reverb in
115 Client - see `-f help' for details
116 -O, --overflowlimiting i|o[w]|io[w]|n|help
118 Use audio limiter(s) in Client, i=incoming from network, o=out‐
119 going to network, io=both, n=no limiters, w=warn if limiting
120 (default=n). Say -O help for more.
121 -a, --assumednumclients help|# (1,2,..)
123 Assumed number of Clients (sources) mixing at Hub Server (other‐
124 wise 2 assumed by -O)
125 ARGUMENTS TO USE JACKTRIP WITHOUT JACK:
127 -R, --rtaudio
128 Use system's default sound system instead of Jack
129 -T, --srate #
131 Set the sampling rate, works on --rtaudio mode only (default:
132 48000)
133 -F, --bufsize #
135 Set the buffer size, works on --rtaudio mode only (default: 128)
136 --audiodevice "input-output device name"
138 --audiodevice "input device name","output device name"
140 Set audio device to use; if not set, the default device will be
141 used
142 --listdevices
144 List available audio devices
145 -d, --deviceid #
147 Set rtaudio device id (DEPRECATED, use --audiodevice instead)
148 ARGUMENTS TO DISPLAY IO STATISTICS:
150 -I, --iostat <time_in_secs>
151 Turn on IO stat reporting with specified interval (in seconds)
152 -G, --iostatlog <log_file>
154 Save stat log into a file (default: print in stdout)
155 -x, --examine-audio-delay <print_interval_in_secs> | help
157 Print round-trip audio delay statistics. See `-x help' for de‐
158 tails.
159 ARGUMENTS TO SIMULATE NETWORK ISSUES:
161 --simloss <rate>
162 Simulate packet loss
163 --simjitter <rate>,<d>
165 Simulate jitter, d is max delay in packets
166 ARGUMENTS FOR HUB CLIENT/SERVER AUTHENTICATION:
168 -A, --auth
169 Use authentication on the client side, or require it on the
170 server side
171 --certfile
173 The certificate file to use on the hub server
174 --keyfile
176 The private key file to use on the hub server
177 --credsfile
179 The file containing the stored usernames and passwords
180 --username
182 The username to use when connecting as a hub client (if not sup‐
183 plied here, this is read from standard input)
184 --password
186 The password to use when connecting as a hub client (if not sup‐
187 plied here, this is read from standard input)
188 HELP ARGUMENTS:
190 -v, --version
191 Prints Version Number
192 -V, --verbose
194 Verbose mode, prints debug messages
195 -h, --help
197 Prints this Help
198
200 Copyright © 2008-2021 Juan-Pablo Caceres, Chris Chafe. SoundWIRE group
201 at CCRMA, Stanford University This build of JackTrip is subject to LGPL
202 license. JackTrip source code is released under MIT and GPL licenses.
203 See LICENSE.md file for more information.
204JackTrip VERSION: 1.4.1 November 2021 JACKTRIP(1)