README.md
1mjpg-streamer
2=============
3
4Currently no issues are known, but since this software is quite young and not used widely it may cause problems. You must really know what you are doing, if you use this software. If you want to use the software you are obliged to check if the sourcecode does what you expect it to do and take the risk yourself to use it.
5
6
7Usage
8=====
9
10When launching mjpg-streamer, you specify one or more input plugins and an output plugin. For example, to stream a V4L compatible webcam via an HTTP server (the most common use case), you
11can do something like this:
12
13 mjpg_streamer -i input_uvc.so -o output_http.so
14
15Each plugin supports various options, you can view the plugin's options via its `--help` option:
16
17 mjpg_streamer -i 'input_uvc.so --help'
18
19
20More examples can be found in the start.sh bash script.
21
22Plugin documentation
23====================
24
25Input plugins:
26
27* input_file
28* input_http
29* input_opencv ([documentation](plugins/input_opencv/README.md))
30* input_ptp2
31* input_raspicam ([documentation](plugins/input_raspicam/README.md))
32* input_uvc ([documentation](plugins/input_uvc/README.md))
33
34Output plugins:
35
36* output_file
37* output_http ([documentation](plugins/output_http/README.md))
38* ~output_rtsp~ (not functional)
39* ~output_udp~ (not functional)
40* output_viewer ([documentation](plugins/output_viewer/README.md))
41
42