jack2 codebase
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

110 lines
2.3KB

  1. .TH JACK_NETSOURCE "1" "!DATE!" "!VERSION!"
  2. .SH NAME
  3. jack_netsource \- Netjack Master client for one slave
  4. .SH SYNOPSIS
  5. \fBjack_netsource\fR [ \fI-H\fR hostname ] [ \fIoptions\fR ]
  6. .SH DESCRIPTION
  7. \fBjack_netsource\fR The Master side of a netjack connection. Represents the slave jackd -dnet in the master jack graph.
  8. Most connection parameters are configured via the netsource, and the slave will set itself up according to the commandline
  9. option given to jack_netsource.
  10. .br
  11. Netjack allows low latency audio connections over general IP networks. When using celt for compression, it is even possible
  12. to establish transatlantic links, with latencies not much over the actual ping time.
  13. .br
  14. But the main usecase is of course a LAN, where it can achieve one jack period of latency.
  15. .SH OPTIONS
  16. .TP
  17. \fB-h\fR this help text
  18. .TP
  19. \fB-H\fR \fIslave host\fR
  20. .br
  21. Host name of the slave JACK
  22. .TP
  23. \fB-o\fR \fInum channels\fR
  24. .br
  25. Number of audio playback channels
  26. .TP
  27. \fB-i\fR \fInum channels\fR
  28. .br
  29. Number of audio capture channels
  30. .TP
  31. \fB-O\fR \fInum channels\fR
  32. .br
  33. Number of midi playback channels
  34. .TP
  35. \fB-I\fR \fInum channels\fR
  36. .br
  37. Number of midi capture channels
  38. .TP
  39. \fB-n\fR \fIperiods\fR
  40. .br
  41. Network latency in JACK periods
  42. .TP
  43. \fB-p\fR \fIport\fR
  44. .br
  45. UDP port that the slave is listening on
  46. .TP
  47. \fB-r\fR \fIreply port\fR
  48. .br
  49. UDP port that we are listening on
  50. .TP
  51. \fB-B\fR \fIbind port\fR
  52. .br
  53. reply port, for use in NAT environments
  54. .TP
  55. \fB-b\fR \fIbitdepth\fR
  56. .br
  57. Set transport to use 16bit or 8bit
  58. .TP
  59. \fB-c\fR \fIbytes\fR
  60. .br
  61. Use CELT encoding with <bytes> per period and channel
  62. .TP
  63. \fB-m\fR \fImtu\fR
  64. .br
  65. Assume this mtu for the link
  66. .TP
  67. \fB-R\fR \fIN\fR
  68. .br
  69. Redundancy: send out packets N times.
  70. .TP
  71. \fB-e\fR
  72. .br
  73. skip host-to-network endianness conversion
  74. .TP
  75. \fB-N\fR \fIjack name\fR
  76. .br
  77. Reports a different client name to jack
  78. .TP
  79. .TP
  80. \fB-s\fR, \fB--server\fR \fIservername\fR
  81. .br
  82. Connect to the jack server named \fIservername\fR
  83. .TP
  84. \fB-h\fR, \fB--help\fR
  85. .br
  86. Display help/usage message
  87. .TP
  88. \fB-v\fR, \fB--version\fR
  89. .br
  90. Output version information and exit
  91. .SH EXAMPLES
  92. .PP
  93. run a 4 audio channel bidirectional link with one period of latency and no midi channels. Audio data is flowing uncompressed over the wire:
  94. .br
  95. On \fIhostA\fR:
  96. .IP
  97. \fBjackd \-d alsa \fR
  98. .br
  99. \fBjack_netsource \-H hostB -n1 -i4 -o4 -I0 -O0 \fR
  100. .PP
  101. On \fIhostB\fR:
  102. .IP
  103. \fBjackd \-d net \fR