1JACKTRIP(1)                      User Commands                     JACKTRIP(1)
2
3
4

NAME

6       JackTrip - Debug sources for package jacktrip
7

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

17   REQUIRED ARGUMENTS: One of:
18       -s, --server
19              Run in P2P Server Mode
20
21       -c, --client <peer_hostname_or_IP_num>
22              Run in P2P Client Mode
23
24       -S, --jacktripserver
25              Run in Hub Server Mode
26
27       -C, --pingtoserver <peer_name_or_IP>
28              Run in Hub Client Mode
29
30   OPTIONAL ARGUMENTS:
31       -n, --numchannels #
32              Number of Input and Output Channels (default: 2)
33
34       -q, --queue
35              #  (2  or  more)           Queue  Buffer  Length, in Packet Size
36              (default: 4)
37
38       -r, --redundancy
39              # (1 or more)          Packet Redundancy to avoid glitches  with
40              packet losses (default: 1)
41
42       -o, --portoffset
43              #                       Receiving bind port and peer port offset
44              from default 4464
45
46       -B, --bindport
47              #                  Set only the bind port number (default: 4464)
48
49       -P, --peerport
50              #                  Set only the peer port number (default: 4464)
51
52       -U, --udpbaseport
53              Set only the server udp base port number (default: 61002)
54
55       -b, --bitres
56              # (8, 16, 24, 32)      Audio Bit Rate Resolutions (default:  16,
57              32 uses floating-point)
58
59       -p, --hubpatch
60              #  (0, 1, 2, 3, 4, 5)   Hub auto audio patch, only has effect if
61              running HUB SERVER mode, 0=server-to-clients, 1=client loopback,
62              2=client fan out/in but not loopback, 3=reserved for TUB, 4=full
63              mix, 5=no auto patching (default: 0)
64
65       -z, --zerounderrun
66              Set buffer to zeros when underrun occurs (default: wavetable)
67
68       -t, --timeout
69              Quit after 10 seconds of no network activity
70
71       -l, --loopback
72              Run in Loop-Back Mode
73
74       -j, --jamlink
75              Run in JamLink Mode (Connect to a JamLink Box)
76
77       -J, --clientname
78              Change default client name (default: JackTrip)
79
80       -K, --remotename
81              Change default remote client  name  when  connecting  to  a  hub
82              server  (the  default  is  derived from this computer's external
83              facing IP address)
84
85       -L, --localaddress
86              Change default local host IP address (default: 127.0.0.1)
87
88       -D, --nojackportsconnect
89              Don't connect default audio ports in jack
90
91       --bufstrategy
92              # (0, 1, 2)            Use alternative jitter buffer
93
94       --broadcast <broadcast_queue>
95              Turn on broadcast output ports with extra  queue  (requires  new
96              jitter buffer)
97
98       --udprt
99              Use RT thread priority for network I/O
100
101   OPTIONAL SIGNAL PROCESSING:
102       -f, --effects # | paramString | help
103              Turn  on  incoming  and/or  outgoing compressor and/or reverb in
104              Client - see `-f help' for details
105
106       -O, --overflowlimiting i|o[w]|io[w]|n|help
107              Use audio limiter(s) in Client, i=incoming from network,  o=out‐
108              going  to  network,  io=both,  n=no limiters, w=warn if limiting
109              (default=n). Say -O help for more.
110
111       -a, --assumednumclients help|#  (1,2,...)  Assumed  number  of  Clients
112              (sources) mixing at Hub Server (otherwise 2 assumed by -O)
113
114   ARGUMENTS TO USE JACKTRIP WITHOUT JACK:
115       -R, --rtaudio
116              Use system's default sound system instead of Jack
117
118       -T, --srate
119              #                     Set  the sampling rate, works on --rtaudio
120              mode only (default: 48000)
121
122       -F, --bufsize
123              #                    Set the buffer  size,  works  on  --rtaudio
124              mode only (default: 128)
125
126       -d, --deviceid
127              #                     The  rtaudio device id --rtaudio mode only
128              (default: 0)
129
130   ARGUMENTS TO DISPLAY IO STATISTICS:
131       -I, --iostat <time_in_secs>
132              Turn on IO stat reporting with specified interval (in seconds)
133
134       -G, --iostatlog <log_file>
135              Save stat log into a file (default: print in stdout)
136
137       -x, --examine-audio-delay <print_interval_in_secs> | help
138              Print round-trip audio  delay  statistics.  See  `-x  help'  for
139              details.
140
141   ARGUMENTS TO SIMULATE NETWORK ISSUES:
142       --simloss <rate>
143              Simulate packet loss
144
145       --simjitter <rate>,<d>
146              Simulate jitter, d is max delay in packets
147
148   HELP ARGUMENTS:
149       -v, --version
150              Prints Version Number
151
152       -V, --verbose
153              Verbose mode, prints debug messages
154
155       -h, --help
156              Prints this Help
157

159       Copyright © 2008-2020 Juan-Pablo Caceres, Chris Chafe.  SoundWIRE group
160       at CCRMA, Stanford University
161
162
163
164JackTrip VERSION: 1.3.0          January 2021                      JACKTRIP(1)
Impressum