Skip to content

Commit a3310f5

Browse files
committed
update readme
1 parent 09b31e8 commit a3310f5

File tree

1 file changed

+43
-28
lines changed

1 file changed

+43
-28
lines changed

README.md

Lines changed: 43 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -31,31 +31,46 @@ Experimentation to stream WebRTC media sources like capture devices, screen capt
3131
## Usage
3232

3333
```roff
34-
./webrtc-streamer [-H http port] [-S[embeded stun address]] -[v[v]] [urls...]
35-
./webrtc-streamer [-H http port] [-s[external stun address]] -[v[v]] [urls...]
36-
./webrtc-streamer -V
37-
-v[v[v]] : verbosity
38-
-V : print version
39-
-C config.json : load urls from JSON config file
40-
-n name -u videourl -U audiourl : register a name for a video url and an audio url
41-
[url] : url to register in the source list
42-
43-
-H [hostname:]port : HTTP server binding (default 0.0.0.0:8000)
44-
-w webroot : path to get files
45-
-c sslkeycert : path to private key and certificate for HTTPS
46-
-N nbthreads : number of threads for HTTP server
47-
-A passwd : password file for HTTP server access
48-
-D authDomain : authentication domain for HTTP server access (default:mydomain.com)
49-
50-
-S[stun_address] : start embeded STUN server bind to address (default 0.0.0.0:3478)
51-
-s[stun_address] : use an external STUN server (default:stun.l.google.com:19302 , -:means no STUN)
52-
-T[username:password@]turn_address : start embeded TURN server (default:disabled)
53-
-t[username:password@]turn_address : use an external TURN relay server (default:disabled)
54-
-R [Udp port range min:max] : Set the webrtc udp port range (default 0:65535)
55-
-W webrtc_trials_fields : Set the webrtc trials fields (default:WebRTC-FrameDropper/Disabled/)
56-
-a[audio layer] : spefify audio capture layer to use (default:0)
57-
-q[filter] : spefify publish filter (default:.*)
58-
-o : use null codec (keep frame encoded)
34+
Usage:
35+
./webrtc-streamer [OPTION...] [urls...]
36+
37+
General options:
38+
-h, --help Print help
39+
-V, --version Print version
40+
-v, --verbose Verbosity level (use multiple times for more verbosity)
41+
-C, --config arg Load urls from JSON config file
42+
-n, --name arg Register a stream with name
43+
-u, --video arg Video URL for the named stream
44+
-U, --audio arg Audio URL for the named stream
45+
46+
HTTP options:
47+
-H, --http arg HTTP server binding (default 0.0.0.0:8000)
48+
-w, --webroot arg Path to get static files
49+
-c, --cert arg Path to private key and certificate for HTTPS
50+
-N, --threads arg Number of threads for HTTP server
51+
-A, --passwd arg Password file for HTTP server access
52+
-D, --domain arg Authentication domain for HTTP server access
53+
(default:mydomain.com)
54+
-X, --disable-xframe Disable X-Frame-Options header
55+
-B, --base-path arg Base path for HTTP server
56+
57+
WebRTC options:
58+
-m, --maxpc arg Maximum number of peer connections
59+
-I, --ice-transport arg Set ice transport type
60+
-T, --turn-server [=arg(=turn:turn@0.0.0.0:3478)]
61+
Start embedded TURN server
62+
-t, --turn arg Use an external TURN relay server
63+
-S, --stun-server [=arg(=0.0.0.0:3478)]
64+
Start embedded STUN server bind to address
65+
-s, --stun [=arg(=0.0.0.0:3478)]
66+
Use an external STUN server
67+
-R, --udp-range arg Set the webrtc udp port range
68+
-W, --trials arg Set the webrtc trials fields
69+
-a, --audio-layer [=arg(=)] Specify audio capture layer to use (omit
70+
value for dummy audio)
71+
-q, --publish-filter arg Specify publish filter
72+
-o, --null-codec Use null codec (keep frame encoded)
73+
-b, --plan-b Use sdp plan-B (default use unifiedPlan)
5974
```
6075

6176
Arguments of '-H' are forwarded to option
@@ -155,9 +170,9 @@ and [TURN](https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT)
155170
server and publish its URL:
156171

157172
```sh
158-
./webrtc-streamer -S0.0.0.0:3478 -s$(curl -s ifconfig.me):3478
159-
./webrtc-streamer -s- -T0.0.0.0:3478 -tturn:turn@$(curl -s ifconfig.me):3478
160-
./webrtc-streamer -S0.0.0.0:3478 -s$(curl -s ifconfig.me):3478 -T0.0.0.0:3479 -tturn:turn@$(curl -s ifconfig.me):3479
173+
./webrtc-streamer --stun-server=0.0.0.0:3478 --stun=$(curl -s ifconfig.me):3478
174+
./webrtc-streamer --stun=- --turn-server=0.0.0.0:3478 -tturn:turn@$(curl -s ifconfig.me):3478
175+
./webrtc-streamer --stun-server=0.0.0.0:3478 --stun=$(curl -s ifconfig.me):3478 --turn-server=0.0.0.0:3479 --turn=turn:turn@$(curl -s ifconfig.me):3479
161176
```
162177

163178
The command `curl -s ifconfig.me` is getting the public IP, it could also given

0 commit comments

Comments
 (0)