Skip to content

Commit 3558abd

Browse files
author
Silvia Pfeiffer
committed
Added options documentation for issue #46
1 parent ea89401 commit 3558abd

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

Diff for: README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ quickconnect('https://switchboard.rtc.io/', { room: 'qc-simple-demo' })
3030

3131
```
3232

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

3539
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.
@@ -242,6 +246,12 @@ Listed below are some of the commonly used options:
242246

243247
- `debug` (default: false)
244248

249+
- `plugins` (default: '')
250+
251+
An optional array of rtc-plugins to add, e.g. add Temasys plugin as list
252+
item `plugins = [ require('rtc-plugin-temasys')];`
253+
254+
245255
Write rtc.io suite debug output to the browser console.
246256

247257
- `expectedLocalStreams` (default: not specified) _added 3.0_
@@ -265,8 +275,15 @@ function:
265275

266276
- `iceServers`
267277

268-
This provides a list of ice servers that can be used to help negotiate a
269-
connection between peers.
278+
This provides a list of ice servers that can be used to help negotiate a
279+
connection between peers.
280+
281+
- `constraints` (default: '')
282+
283+
An optional RTCConstraints object that is handed to the , e.g.
284+
constraints: {"optional": [ {'googIPv6': 'false'} ] } or
285+
constraints: {"optional": [ {RtpDataChannels: true} ] }
286+
270287

271288
#### Options for P2P negotiation
272289

0 commit comments

Comments
 (0)