<!DOCTYPE html>
|
<html lang="en">
|
<head>
|
<meta charset="utf-8">
|
<title>JSDoc: Class: XMPPVideoRoom</title>
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
<script src="scripts/prettify/lang-css.js"> </script>
|
<!--[if lt IE 9]>
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
<![endif]-->
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
</head>
|
|
<body>
|
|
<div id="main">
|
|
<h1 class="page-title">Class: XMPPVideoRoom</h1>
|
|
|
|
|
|
|
<section>
|
|
<header>
|
|
<h2>XMPPVideoRoom</h2>
|
|
|
</header>
|
|
<article>
|
<div class="container-overview">
|
|
|
|
|
|
<h4 class="name" id="XMPPVideoRoom"><span class="type-signature"></span>new XMPPVideoRoom<span class="signature">(xmppUrl, srvurl)</span><span class="type-signature"></span></h4>
|
|
|
|
|
|
<div class="description">
|
Interface with Jitsi Video Room and WebRTC-streamer API
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>xmppUrl</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">url of XMPP server</td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>srvurl</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">url of WebRTC-streamer</td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="tag-source">Source:</dt>
|
<dd class="tag-source"><ul class="dummy"><li>
|
<a href="xmppvideoroom.js.html">xmppvideoroom.js</a>, <a href="xmppvideoroom.js.html#line10">line 10</a>
|
</li></ul></dd>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="subsection-title">Methods</h3>
|
|
|
|
|
|
|
<h4 class="name" id="join"><span class="type-signature"></span>join<span class="signature">(roomid, url, name)</span><span class="type-signature"></span></h4>
|
|
|
|
|
|
<div class="description">
|
Ask to publish a stream from WebRTC-streamer in a XMPP Video Room user
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>roomid</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">id of the XMPP Video Room to join</td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>url</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">WebRTC stream to publish</td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>name</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">name in Video Room</td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="tag-source">Source:</dt>
|
<dd class="tag-source"><ul class="dummy"><li>
|
<a href="xmppvideoroom.js.html">xmppvideoroom.js</a>, <a href="xmppvideoroom.js.html#line24">line 24</a>
|
</li></ul></dd>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="name" id="leave"><span class="type-signature"></span>leave<span class="signature">(roomid, name)</span><span class="type-signature"></span></h4>
|
|
|
|
|
|
<div class="description">
|
Ask to leave a XMPP Video Room user
|
</div>
|
|
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>roomid</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">id of the XMPP Video Room to leave</td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>name</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">name in Video Room</td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="tag-source">Source:</dt>
|
<dd class="tag-source"><ul class="dummy"><li>
|
<a href="xmppvideoroom.js.html">xmppvideoroom.js</a>, <a href="xmppvideoroom.js.html#line54">line 54</a>
|
</li></ul></dd>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="name" id="leaveAll"><span class="type-signature"></span>leaveAll<span class="signature">()</span><span class="type-signature"></span></h4>
|
|
|
|
|
|
<div class="description">
|
Ask to leave all XMPP Video Room
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="tag-source">Source:</dt>
|
<dd class="tag-source"><ul class="dummy"><li>
|
<a href="xmppvideoroom.js.html">xmppvideoroom.js</a>, <a href="xmppvideoroom.js.html#line65">line 65</a>
|
</li></ul></dd>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
</div>
|
|
<nav>
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="JanusVideoRoom.html">JanusVideoRoom</a></li><li><a href="WebRtcStreamer.html">WebRtcStreamer</a></li><li><a href="XMPPVideoRoom.html">XMPPVideoRoom</a></li></ul>
|
</nav>
|
|
<br class="clear">
|
|
<footer>
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Aug 25 2018 15:00:27 GMT+0200 (CEST)
|
</footer>
|
|
<script> prettyPrint(); </script>
|
<script src="scripts/linenumber.js"> </script>
|
</body>
|
</html>
|
