Nulo/y-webrtc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update filterBcConns docs. Fixes #10

Browse source
This commit is contained in:
Kevin Jahns 2020-05-31 21:43:32 +02:00 committed by GitHub
parent 5fffe6b74b
commit f67d31e091
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -56,7 +56,7 @@ const provider = new WebrtcProvider('your-room-name', ydoc, { maxConns: 70 + mat
### Use y-webrtc for conferencing solutions ### Use y-webrtc for conferencing solutions
Just listen to the "peers" event from the provider to listen for more incoming WebRTC connections and use the simple-peer API to share streams. More help on this would be welcome. By default, browser windows share data using BroadcastChannel without WebRTC. In order to connect all peers and browser windows with each other, set `maxConns = Number.POSITIVE_INFINITY` and `filterBcConns = true`. Just listen to the "peers" event from the provider to listen for more incoming WebRTC connections and use the simple-peer API to share streams. More help on this would be welcome. By default, browser windows share data using BroadcastChannel without WebRTC. In order to connect all peers and browser windows with each other, set `maxConns = Number.POSITIVE_INFINITY` and `filterBcConns = false`.
## API ## API
@ -79,7 +79,7 @@ The following default values of `opts` can be overwritten:
// Maximal number of WebRTC connections. // Maximal number of WebRTC connections.
// A random factor is recommended, because it reduces the chance that n clients form a cluster. // A random factor is recommended, because it reduces the chance that n clients form a cluster.
maxConns: 20 + math.floor(random.rand() * 15), maxConns: 20 + math.floor(random.rand() * 15),
// Whether to create WebRTC connections to other tabs in the same browser. // Whether to disable WebRTC connections to other tabs in the same browser.
// Tabs within the same browser share document updates using BroadcastChannels. // Tabs within the same browser share document updates using BroadcastChannels.
// WebRTC connections within the same browser are therefore only necessary if you want to share video information too. // WebRTC connections within the same browser are therefore only necessary if you want to share video information too.
filterBcConns: true, filterBcConns: true,