haskal
/
jiti-meet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1850 from jitsi/iframe_api_doc 

doc(iframe_api): Fix the names of the properties in the options object.
This commit is contained in:
bgrozev 2017-08-01 00:51:44 -05:00 committed by GitHub
parent c04ef05058 4dcbe5c6a0
commit d778b716be
2 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api.md
View File

@ -19,11 +19,11 @@ Its constructor gets a number of options:
* **domain**: domain used to build the conference URL, "meet.jit.si" for * **domain**: domain used to build the conference URL, "meet.jit.si" for
example. example.
* **options**: object with properties - the optional arguments: * **options**: object with properties - the optional arguments:
* **room**: (optional) name of the room to join. * **roomName**: (optional) name of the room to join.
* **width**: (optional) width for the iframe which will be created. If a number is specified it's treated as pixel units. If a string is specified the format is number followed by 'px', 'em', 'pt' or '%'. * **width**: (optional) width for the iframe which will be created. If a number is specified it's treated as pixel units. If a string is specified the format is number followed by 'px', 'em', 'pt' or '%'.
* **height**: (optional) height for the iframe which will be created. If a number is specified it's treated as pixel units. If a string is specified the format is number followed by 'px', 'em', 'pt' or '%'. * **height**: (optional) height for the iframe which will be created. If a number is specified it's treated as pixel units. If a string is specified the format is number followed by 'px', 'em', 'pt' or '%'.
* **htmlElement**: (optional) HTL DOM Element where the iframe will be added as a child. * **parentNode**: (optional) HTML DOM Element where the iframe will be added as a child.
* **configOverwite**: (optional) JS object with overrides for options defined in [config.js]. * **configOverwrite**: (optional) JS object with overrides for options defined in [config.js].
* **interfaceConfigOverwrite**: (optional) JS object with overrides for options defined in [interface_config.js]. * **interfaceConfigOverwrite**: (optional) JS object with overrides for options defined in [interface_config.js].
* **noSsl**: (optional, defaults to true) Boolean indicating if the server should be contacted using HTTP or HTTPS. * **noSsl**: (optional, defaults to true) Boolean indicating if the server should be contacted using HTTP or HTTPS.
* **jwt**: (optional) [JWT](https://jwt.io/) token. * **jwt**: (optional) [JWT](https://jwt.io/) token.
@ -31,12 +31,12 @@ Its constructor gets a number of options:
Example: Example:
```javascript ```javascript
var domain = "meet.jit.si";
var options = { var options = {
domain: "meet.jit.si", roomName: "JitsiMeetAPIExample",
room: "JitsiMeetAPIExample",
width: 700, width: 700,
height: 700, height: 700,
htmlElement: document.querySelector('#meet') parentNode: document.querySelector('#meet')
} }
var api = new JitsiMeetExternalAPI(domain, options); var api = new JitsiMeetExternalAPI(domain, options);
``` ```

21
doc/examples/api.html
View File

@ -7,16 +7,17 @@
<script src="https://meet.jit.si/external_api.js"></script> <script src="https://meet.jit.si/external_api.js"></script>
<script> <script>
var domain = "meet.jit.si"; var domain = "meet.jit.si";
var room = "JitsiMeetAPIExample"; var options = {
var width = 700; roomName: "JitsiMeetAPIExample",
var height = 180; width: 700,
var htmlElement = undefined; height: 180,
var configOverwrite = {}; parent: undefined,
var interfaceConfigOverwrite = { configOverwrite: {},
filmStripOnly: true interfaceConfigOverwrite: {
}; filmStripOnly: true
var api = new JitsiMeetExternalAPI(domain, room, width, height, }
htmlElement, configOverwrite, interfaceConfigOverwrite); }
var api = new JitsiMeetExternalAPI(domain, options);
</script> </script>
</body> </body>
</html> </html>