Skip to content

Commit 57b932b

Browse files
gavvgavv
committed
Update docs for cli tools
1 parent 3f43695 commit 57b932b

File tree

7 files changed

+202
-104
lines changed

7 files changed

+202
-104
lines changed

‎docs/man/roc-copy.1‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,8 @@ Input from stdin, output to stdout:
154154
.sp
155155
.nf
156156
.ft C
157-
$ roc\-copy \-vv \-\-input\-format=wav \-i file:\- \-\-output\-format=wav \-o file:\- >./output.wav <./input.wav
157+
$ roc\-copy \-vv \-\-input\-format=wav \-i file:\- \e
158+
\-\-output\-format=wav \-o file:\- >./output.wav <./input.wav
158159
.ft P
159160
.fi
160161
.UNINDENT

‎docs/man/roc-recv.1‎

Lines changed: 56 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -277,81 +277,86 @@ $ roc\-recv \-vv \-s rtp://0.0.0.0:10001
277277
.UNINDENT
278278
.UNINDENT
279279
.sp
280-
Bind two source and repair endpoints to all IPv4 interfaces (but not IPv6):
280+
Bind source, repair, and control endpoints to all IPv4 interfaces (but not IPv6):
281281
.INDENT 0.0
282282
.INDENT 3.5
283283
.sp
284284
.nf
285285
.ft C
286-
$ roc\-recv \-vv \-s rtp+rs8m://0.0.0.0:10001 \-r rs8m://0.0.0.0:10002
286+
$ roc\-recv \-vv \-s rtp+rs8m://0.0.0.0:10001 \-r rs8m://0.0.0.0:10002 \e
287+
\-c rtcp://0.0.0.0:10003
287288
.ft P
288289
.fi
289290
.UNINDENT
290291
.UNINDENT
291292
.sp
292-
Bind two source and repair endpoints to all IPv6 interfaces (but not IPv4):
293+
Bind source, repair, and control endpoints to all IPv6 interfaces (but not IPv4):
293294
.INDENT 0.0
294295
.INDENT 3.5
295296
.sp
296297
.nf
297298
.ft C
298-
$ roc\-recv \-vv \-s rtp+rs8m://[::]:10001 \-r rs8m://[::]:10002
299+
$ roc\-recv \-vv \-s rtp+rs8m://[::]:10001 \-r rs8m://[::]:10002 \-c rtcp://[::]:10003
299300
.ft P
300301
.fi
301302
.UNINDENT
302303
.UNINDENT
303304
.sp
304-
Bind two source and repair endpoints to a particular network interface:
305+
Bind source, repair, and control endpoints to a particular network interface:
305306
.INDENT 0.0
306307
.INDENT 3.5
307308
.sp
308309
.nf
309310
.ft C
310-
$ roc\-recv \-vv \-s rtp+rs8m://192.168.0.3:10001 \-r rs8m://192.168.0.3:10002
311+
$ roc\-recv \-vv \-s rtp+rs8m://192.168.0.3:10001 \-r rs8m://192.168.0.3:10002 \e
312+
\-c rtcp://192.168.0.3:10003
311313
.ft P
312314
.fi
313315
.UNINDENT
314316
.UNINDENT
315317
.sp
316-
Bind three source, repair, and control endpoints:
318+
Bind endpoints to a particular multicast address and join to a multicast group on a particular network interface:
317319
.INDENT 0.0
318320
.INDENT 3.5
319321
.sp
320322
.nf
321323
.ft C
322-
$ roc\-recv \-vv \e
323-
\-s rtp+rs8m://192.168.0.3:10001 \-r rs8m://192.168.0.3:10002 \-c rtcp://192.168.0.3:10003
324+
$ roc\-recv \-vv \-s rtp+rs8m://225.1.2.3:10001 \-r rs8m://225.1.2.3:10002 \e
325+
\-c rtcp://225.1.2.3:10003 \e
326+
\-\-miface 192.168.0.3
324327
.ft P
325328
.fi
326329
.UNINDENT
327330
.UNINDENT
328331
.sp
329-
Bind two source and repair endpoints to a particular multicast address and join to a multicast group on a particular network interface:
332+
Bind two sets of source, repair, and control endpoints (six endpoints in total):
330333
.INDENT 0.0
331334
.INDENT 3.5
332335
.sp
333336
.nf
334337
.ft C
335-
$ roc\-recv \-vv \-s rtp+rs8m://225.1.2.3:10001 \-r rs8m://225.1.2.3:10002 \-\-miface 192.168.0.3
338+
$ roc\-recv \-vv \e
339+
\-s rtp+rs8m://192.168.0.3:10001 \-r rs8m://192.168.0.3:10002 \e
340+
\-c rtcp://192.168.0.3:10003 \e
341+
\-s rtp+rs8m://198.214.0.7:10001 \-r rs8m://198.214.0.7:10002 \e
342+
\-c rtcp://198.214.0.7:10003
336343
.ft P
337344
.fi
338345
.UNINDENT
339346
.UNINDENT
347+
.SS I/O examples
340348
.sp
341-
Bind two sets of source, repair, and control endpoints:
349+
Output to the default device (omit \fB\-o\fP):
342350
.INDENT 0.0
343351
.INDENT 3.5
344352
.sp
345353
.nf
346354
.ft C
347-
$ roc\-recv \-vv \e
348-
\-s rtp+rs8m://192.168.0.3:10001 \-r rs8m://192.168.0.3:10002 \-c rtcp://192.168.0.3:10003 \e
349-
\-s rtp+rs8m://198.214.0.7:10001 \-r rs8m://198.214.0.7:10002 \-c rtcp://198.214.0.7:10003
355+
$ roc\-recv \-vv \-s rtp://0.0.0.0:10001
350356
.ft P
351357
.fi
352358
.UNINDENT
353359
.UNINDENT
354-
.SS I/O examples
355360
.sp
356361
Output to the default ALSA device:
357362
.INDENT 0.0
@@ -395,7 +400,7 @@ Output to a file in WAV format (specify format manually):
395400
.sp
396401
.nf
397402
.ft C
398-
$ roc\-recv \-vv \-s rtp://0.0.0.0:10001 \-o file:./output \-\-output\-format wav
403+
$ roc\-recv \-vv \-s rtp://0.0.0.0:10001 \-o file:./output.file \-\-output\-format wav
399404
.ft P
400405
.fi
401406
.UNINDENT
@@ -456,46 +461,73 @@ Select the LDPC\-Staircase FEC scheme:
456461
.sp
457462
.nf
458463
.ft C
459-
$ roc\-recv \-vv \-s rtp+ldpc://0.0.0.0:10001 \-r ldpc://0.0.0.0:10002
464+
$ roc\-recv \-vv \-s rtp+ldpc://0.0.0.0:10001 \-r ldpc://0.0.0.0:10002 \e
465+
\-c rtcp://0.0.0.0:10003
466+
.ft P
467+
.fi
468+
.UNINDENT
469+
.UNINDENT
470+
.sp
471+
Select lower session latency:
472+
.INDENT 0.0
473+
.INDENT 3.5
474+
.sp
475+
.nf
476+
.ft C
477+
$ roc\-recv \-vv \-s rtp://0.0.0.0:10001 \-\-sess\-latency=50ms
478+
.ft P
479+
.fi
480+
.UNINDENT
481+
.UNINDENT
482+
.sp
483+
Select lower I/O latency and frame length:
484+
.INDENT 0.0
485+
.INDENT 3.5
486+
.sp
487+
.nf
488+
.ft C
489+
$ roc\-recv \-vv \-s rtp://0.0.0.0:10001 \e
490+
\-\-io\-latency=20ms \-\-frame\-length 4ms
460491
.ft P
461492
.fi
462493
.UNINDENT
463494
.UNINDENT
464495
.sp
465-
Select higher session latency and timeouts:
496+
Manually specify thresholds and timeouts:
466497
.INDENT 0.0
467498
.INDENT 3.5
468499
.sp
469500
.nf
470501
.ft C
471502
$ roc\-recv \-vv \-s rtp://0.0.0.0:10001 \e
472-
\-\-sess\-latency=5s \-\-min\-latency=\-1s \-\-max\-latency=10s \-\-np\-timeout=10s \-\-bp\-timeout=10s
503+
\-\-sess\-latency=50ms \-\-latency\-tolerance=20ms \e
504+
\-\-no\-play\-timeout=200s \-\-choppy\-play\-timeout=500ms
473505
.ft P
474506
.fi
475507
.UNINDENT
476508
.UNINDENT
477509
.sp
478-
Select higher I/O latency:
510+
Manually specify resampling parameters:
479511
.INDENT 0.0
480512
.INDENT 3.5
481513
.sp
482514
.nf
483515
.ft C
484516
$ roc\-recv \-vv \-s rtp://0.0.0.0:10001 \e
485-
\-\-io\-latency=200ms
517+
\-\-resampler\-backend=speex \-\-resampler\-profile=high
486518
.ft P
487519
.fi
488520
.UNINDENT
489521
.UNINDENT
490522
.sp
491-
Select resampler profile:
523+
Manually specify clock synchronization parameters:
492524
.INDENT 0.0
493525
.INDENT 3.5
494526
.sp
495527
.nf
496528
.ft C
497529
$ roc\-recv \-vv \-s rtp://0.0.0.0:10001 \e
498-
\-\-resampler\-profile=high
530+
\-\-clock\-backend=niq \-\-clock\-profile=gradual
499531
.ft P
500532
.fi
501533
.UNINDENT

‎docs/man/roc-send.1‎

Lines changed: 56 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,6 @@ Duration of the internal frames, TIME units
9393
.BI \-\-rate\fB= INT
9494
Override input sample rate, Hz
9595
.TP
96-
.B \-\-no\-resampling
97-
Disable resampling (default=off)
98-
.TP
9996
.BI \-\-resampler\-backend\fB= ENUM
10097
Resampler backend (possible values=\(dqdefault\(dq, \(dqbuiltin\(dq, \(dqspeex\(dq, \(dqspeexdec\(dq default=\(gadefault\(aq)
10198
.TP
@@ -246,38 +243,27 @@ $ roc\-send \-vv \-i file:./input.wav \-s rtp://192.168.0.3:10001
246243
.UNINDENT
247244
.UNINDENT
248245
.sp
249-
Send file to receiver with two IPv4 source and repair endpoints:
250-
.INDENT 0.0
251-
.INDENT 3.5
252-
.sp
253-
.nf
254-
.ft C
255-
$ roc\-send \-vv \-i file:./input.wav \-s rtp+rs8m://192.168.0.3:10001 \-r rs8m://192.168.0.3:10002
256-
.ft P
257-
.fi
258-
.UNINDENT
259-
.UNINDENT
260-
.sp
261-
Send file to receiver with two IPv6 source and repair endpoints:
246+
Send file to receiver with IPv4 source, repair, and control endpoints:
262247
.INDENT 0.0
263248
.INDENT 3.5
264249
.sp
265250
.nf
266251
.ft C
267-
$ roc\-send \-vv \-i file:./input.wav \-s rtp+rs8m://[2001:db8::]:10001 \-r rs8m://[2001:db8::]:10002
252+
$ roc\-send \-vv \-i file:./input.wav \-s rtp+rs8m://192.168.0.3:10001 \e
253+
\-r rs8m://192.168.0.3:10002 \-c rtcp://192.168.0.3:10003
268254
.ft P
269255
.fi
270256
.UNINDENT
271257
.UNINDENT
272258
.sp
273-
Send file to receiver with three IPv4 source, repair, and control endpoints:
259+
Send file to receiver with IPv6 source, repair, and control endpoints:
274260
.INDENT 0.0
275261
.INDENT 3.5
276262
.sp
277263
.nf
278264
.ft C
279-
$ roc\-send \-vv \-i file:./input.wav \e
280-
\-s rtp+rs8m://192.168.0.3:10001 \-r rs8m://192.168.0.3:10002 \-c rtcp://192.168.0.3:10003
265+
$ roc\-send \-vv \-i file:./input.wav \-s rtp+rs8m://[2001:db8::]:10001 \e
266+
\-r rs8m://[2001:db8::]:10002 \-r rtcp://[2001:db8::]:10003
281267
.ft P
282268
.fi
283269
.UNINDENT
@@ -291,8 +277,10 @@ Send file to two receivers, each with three endpoints:
291277
.ft C
292278
$ roc\-send \-vv \e
293279
\-i file:./input.wav \e
294-
\-s rtp+rs8m://192.168.0.3:10001 \-r rs8m://192.168.0.3:10002 \-c rtcp://192.168.0.3:10003 \e
295-
\-s rtp+rs8m://198.214.0.7:10001 \-r rs8m://198.214.0.7:10002 \-c rtcp://198.214.0.7:10003
280+
\-s rtp+rs8m://192.168.0.3:10001 \-r rs8m://192.168.0.3:10002 \e
281+
\-c rtcp://192.168.0.3:10003 \e
282+
\-s rtp+rs8m://198.214.0.7:10001 \-r rs8m://198.214.0.7:10002 \e
283+
\-c rtcp://198.214.0.7:10003
296284
.ft P
297285
.fi
298286
.UNINDENT
@@ -335,13 +323,25 @@ $ roc\-send \-vv \-s rtp://192.168.0.3:10001 \-i pulse://alsa_input.pci\-0000_00
335323
.UNINDENT
336324
.UNINDENT
337325
.sp
338-
Send WAV file, specify format manually:
326+
Send WAV file (guess format by extension):
327+
.INDENT 0.0
328+
.INDENT 3.5
329+
.sp
330+
.nf
331+
.ft C
332+
$ roc\-send \-vv \-s rtp://192.168.0.3:10001 \-i file:./input.wav
333+
.ft P
334+
.fi
335+
.UNINDENT
336+
.UNINDENT
337+
.sp
338+
Send WAV file (specify format manually):
339339
.INDENT 0.0
340340
.INDENT 3.5
341341
.sp
342342
.nf
343343
.ft C
344-
$ roc\-send \-vv \-s rtp://192.168.0.3:10001 \-i file:./input \-\-input\-format wav
344+
$ roc\-send \-vv \-s rtp://192.168.0.3:10001 \-i file:./input.file \-\-input\-format wav
345345
.ft P
346346
.fi
347347
.UNINDENT
@@ -359,7 +359,7 @@ $ roc\-send \-vv \-s rtp://192.168.0.3:10001 \-i file:\- \-\-input\-format wav <
359359
.UNINDENT
360360
.UNINDENT
361361
.sp
362-
Send WAV file, specify full URI:
362+
Send WAV file (specify absolute path):
363363
.INDENT 0.0
364364
.INDENT 3.5
365365
.sp
@@ -390,21 +390,48 @@ Select the LDPC\-Staircase FEC scheme and a larger block size:
390390
.sp
391391
.nf
392392
.ft C
393-
$ roc\-send \-vv \-i file:./input.wav \e
394-
\-s rtp+ldpc://192.168.0.3:10001 \-r ldpc://192.168.0.3:10002 \e
393+
$ roc\-send \-vv \-i file:./input.wav \-s rtp+ldpc://192.168.0.3:10001 \e
394+
\-r ldpc://192.168.0.3:10002 \-c ldpc://192.168.0.3:10003 \e
395395
\-\-nbsrc=1000 \-\-nbrpr=500
396396
.ft P
397397
.fi
398398
.UNINDENT
399399
.UNINDENT
400400
.sp
401-
Select resampler profile:
401+
Select lower packet length:
402+
.INDENT 0.0
403+
.INDENT 3.5
404+
.sp
405+
.nf
406+
.ft C
407+
$ roc\-send \-vv \-i file:./input.wav \-s rtp+ldpc://192.168.0.3:10001 \e
408+
\-\-packet\-length 2500us
409+
.ft P
410+
.fi
411+
.UNINDENT
412+
.UNINDENT
413+
.sp
414+
Select lower I/O latency and frame length:
415+
.INDENT 0.0
416+
.INDENT 3.5
417+
.sp
418+
.nf
419+
.ft C
420+
$ roc\-send \-vv \-s rtp://192.168.0.3:10001 \e
421+
\-\-io\-latency=20ms \-\-frame\-length 4ms
422+
.ft P
423+
.fi
424+
.UNINDENT
425+
.UNINDENT
426+
.sp
427+
Manually specify resampling parameters:
402428
.INDENT 0.0
403429
.INDENT 3.5
404430
.sp
405431
.nf
406432
.ft C
407-
$ roc\-send \-vv \-s rtp://192.168.0.3:10001 \-\-resampler\-profile=high
433+
$ roc\-send \-vv \-s rtp://192.168.0.3:10001 \e
434+
\-\-resampler\-backend=speex \-\-resampler\-profile=high
408435
.ft P
409436
.fi
410437
.UNINDENT

‎docs/sphinx/manuals/roc_copy.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ Input from stdin, output to stdout:
7878

7979
.. code::
8080
81-
$ roc-copy -vv --input-format=wav -i file:- --output-format=wav -o file:- >./output.wav <./input.wav
81+
$ roc-copy -vv --input-format=wav -i file:- \
82+
--output-format=wav -o file:- >./output.wav <./input.wav
8283
8384
SEE ALSO
8485
========

0 commit comments

Comments
 (0)