## Revision a83b3717

View differences:

mainpage.dox
194 194
 * automatic for fallback/failover during setup;

195 195
 * - \c iceServers: a list of STUN/TURN servers to use (a default STUN server

196 196
 * will be used if you skip this property);

197
 * - \c ipv6: whether IPv6 candidates should ge gathered or not;

198
 * - \c withCredentials: whether the \c withCredentials property of XHR requests

199
 * should be enabled or not (false by default, and only valid when using HTTP

200
 * as a transport, ignored for WebSockets);

201
 * - \c max_poll_events: the number of events that should be returned when polling;

202
 * the default is 1 (polling returns an object), passing a higher number will

203
 * have the backend return an array of objects instead (again, only valid for

204
 HTTP usage as this is strictly related to long polling, ignored for WebSockets);

205
 * - \c destroyOnUnload: whether we should destroy automatically try and

206
 * destroy this session via Janus API when \c onbeforeunload is called (true by default);

207
 * - \c token , \c apisecret: optional parameters only needed in case you're \ref auth ;

197 208
 * - a set of callbacks to be notified about events, namely:

198 209
 * 		- \c success: the session was successfully created and is ready to be used;

199 210
 * 		- \c error: the session was NOT successfully created;

......
271 282
 *

272 283
 * - \c plugin: the unique package name of the plugin (e.g., \c janus.plugin.echotest );

273 284
 * - \c opaqueId: an optional opaque string meaningful to your application (e.g., to map all the handles of the same user);

274
 * - \c token , \c apisecret: optional parameters only needed in case you're \ref auth ;

275 285
 * - a set of callbacks to be notified about events, namely:

276 286
 * 		- \c success: the handle was successfully created and is ready to be used;

277 287
 * 		- \c error: the handle was NOT successfully created;


Also available in: Unified diff