Browse Source

Updates the external api docs.

master
Boris Grozev 9 years ago
parent
commit
7b35dd89bb
1 changed files with 5 additions and 3 deletions
  1. 5
    3
      doc/api.md

+ 5
- 3
doc/api.md View File

29
 ``` 
29
 ``` 
30
 If you don't specify room the user will enter in new conference with random room name.
30
 If you don't specify room the user will enter in new conference with random room name.
31
 
31
 
32
-You can enable the "film strip only" mode(only the small videos are visible) by setting 6th parameter to ```true```:
32
+You can overwrite options set in config.js and interface_config.js. For example, to enable the film-strip-only interface mode and disable simulcast, you can use:
33
 ```javascript
33
 ```javascript
34
-    var api = new JitsiMeetExternalAPI(domain, room, width, height, htmlElement, true);
34
+    var configOverwrite = {enableSimulcast: false};
35
+    var interfaceConfigOverwrite = {filmStripOnly: true};
36
+    var api = new JitsiMeetExternalAPI(domain, room, width, height, htmlElement, true, configOverwrite, interfaceConfigOverwrite);
35
 ``` 
37
 ``` 
36
 
38
 
37
 Controlling embedded Jitsi Meet Conference
39
 Controlling embedded Jitsi Meet Conference
171
 api.dispose()
173
 api.dispose()
172
 ```
174
 ```
173
 
175
 
174
-It is a good practice to remove the conference before the page is unloaded. 
176
+It is a good practice to remove the conference before the page is unloaded. 

Loading…
Cancel
Save