Skip to content

Commit

Permalink
Merge branch 'master' of github.com:yjs/y-webrtc
Browse files Browse the repository at this point in the history
  • Loading branch information
dmonad committed Jun 5, 2020
2 parents d520889 + f67d31e commit fea1e24
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const provider = new WebrtcProvider('your-room-name', ydoc, { maxConns: 70 + mat

### 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

Expand All @@ -79,7 +79,7 @@ The following default values of `opts` can be overwritten:
// Maximal number of WebRTC connections.
// A random factor is recommended, because it reduces the chance that n clients form a cluster.
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.
// WebRTC connections within the same browser are therefore only necessary if you want to share video information too.
filterBcConns: true,
Expand Down

0 comments on commit fea1e24

Please sign in to comment.