Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #82

Merged
merged 3 commits into from
Oct 2, 2018
Merged

Improve readme #82

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3558abd
Added options documentation for issue #46
Sep 15, 2016
3a91c68
Improve display of last committed fixes.
Sep 15, 2016
559c6c3
Adding SDP munging example also to address issue #18
Sep 15, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ quickconnect('https://switchboard.rtc.io/', { room: 'qc-simple-demo' })

```

The first argument to quickconnect is the URL of the signalling server, the second is a set of options given as a JSON object.
Valid options are described [below](#valid-quick-connect-options).


## Events

The following events are emitted from the signalling object created by calling `quickconnect()`. Additionally, any of the underlying [signaller events](https://github.com/rtc-io/rtc-signaller#signaller-events) can also be used.
Expand Down Expand Up @@ -242,6 +246,12 @@ Listed below are some of the commonly used options:

- `debug` (default: false)

- `plugins` (default: '')

An optional array of rtc-plugins to add, e.g. add Temasys plugin as list
item `plugins = [ require('rtc-plugin-temasys')];`


Write rtc.io suite debug output to the browser console.

- `expectedLocalStreams` (default: not specified) _added 3.0_
Expand All @@ -265,8 +275,20 @@ function:

- `iceServers`

This provides a list of ice servers that can be used to help negotiate a
connection between peers.
This provides a list of ice servers that can be used to help negotiate a
connection between peers.

- `constraints` (default: '')

An optional RTCConstraints object that is handed to the RTCPeerConnection call, e.g.
`constraints: {"optional": [ {'googIPv6': 'false'} ] }` or
`constraints: {"optional": [ {RtpDataChannels: true} ] }`

- `sdpfilter` (default '')

An optional function to provide for sdp munging, e.g.
`sdpfilter: function(sdp) { console.log('filtering sdp'); return limitBandwidthSDP(sdp);}`


#### Options for P2P negotiation

Expand Down