1USTREAMER-DUMP(1)           General Commands Manual          USTREAMER-DUMP(1)
2
3
4

NAME

6       ustreamer-dump - Dump uStreamer's memory sink to file
7
8

SYNOPSIS

10       ustreamer-dump [OPTIONS]
11
12

DESCRIPTION

14       µStreamer-dump (ustreamer-dump) writes a local stream from ustreamer to
15       a file or redirect it to other utilities (such as ffmpeg).
16
17

USAGE

19       ustreamer requires at least the --sink option to operate.
20
21       To output ustreamers sink "test" to ffmpeg,  and  into  a  file  called
22       test.mp4:
23
24       ustreamer-dump \
25              --sink=test \ # Use ustreamer sink "test"
26              --output - \ # Output to stdout
27              | ffmpeg -use_wallclock_as_timestamps 1 -i pipe: -c:v libx264 test.mp4
28
29

OPTIONS

31   Sink options
32       -s, --sink name
33              Memory sink ID. No default.
34
35       -t, --sink-timeout sec
36              Timeout for the upcoming frame. Default: 1.
37
38       -o, --output filename
39              Filename  to  dump  output to. Use '-' for stdout. Default: just
40              consume the sink.
41
42       -j, --output-json
43              Format output as JSON. Required option --output.  Default:  dis‐
44              abled.
45
46       -c, --count N
47              Limit the number of frames. Default: 0 (infinite).
48
49       -i, --interval sec
50              Delay between reading frames (float). Default: 0.
51
52       -k, --key-required
53              Request keyframe from the sink. Default: disabled.
54
55
56   Logging options
57       --log-level N
58              Verbosity level of messages from 0 (info) to 3 (debug). Enabling
59              debugging messages can slow down the program.  Available levels:
60              0 (info), 1 (performance), 2 (verbose), 3 (debug).  Default: 0.
61
62       --perf Enable  performance  messages  (same as --log-level=1). Default:
63              disabled.
64
65       --verbose
66              Enable verbose messages and lower (same as  --log-level=2).  De‐
67              fault: disabled.
68
69       --debug
70              Enable  debug  messages  and  lower (same as --log-level=3). De‐
71              fault: disabled.
72
73       --force-log-colors
74              Force color logging. Default: colored if stderr is a TTY.
75
76       --no-log-colors
77              Disable color logging. Default: ditto.
78
79
80   Help options
81       -h, --help
82              Print this text and exit.
83
84       -v, --version
85              Print version and exit.
86
87

SEE ALSO

89       ustreamer(1)
90
91

BUGS

93       Please  file  any  bugs  and  issues  at   https://github.com/pikvm/us‐
94       treamer/issues
95
96

AUTHOR

98       Maxim Devaev <mdevaev@gmail.com>
99
100

HOMEPAGE

102       https://pikvm.org/
103
104

106       GNU General Public License v3.0
107
108
109
110January 2021                     version 5.37                USTREAMER-DUMP(1)
Impressum