<!DOCTYPE html>
|
<html lang="en">
|
<head>
|
<meta charset="utf-8">
|
<title>JSDoc: Class: WebRtcStreamer</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: WebRtcStreamer</h1>
|
|
|
|
|
|
|
<section>
|
|
<header>
|
|
<h2>WebRtcStreamer</h2>
|
|
|
</header>
|
|
<article>
|
<div class="container-overview">
|
|
|
|
|
|
<h4 class="name" id="WebRtcStreamer"><span class="type-signature"></span>new WebRtcStreamer<span class="signature">(videoElement, srvurl)</span><span class="type-signature"></span></h4>
|
|
|
|
|
|
<div class="description">
|
Interface with 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>videoElement</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">id of the video element tag</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 (default is current location)</td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="tag-source">Source:</dt>
|
<dd class="tag-source"><ul class="dummy"><li>
|
<a href="webrtcstreamer.js.html">webrtcstreamer.js</a>, <a href="webrtcstreamer.js.html#line8">line 8</a>
|
</li></ul></dd>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="subsection-title">Methods</h3>
|
|
|
|
|
|
|
<h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(videourl, audiourl, options, stream)</span><span class="type-signature"></span></h4>
|
|
|
|
|
|
<div class="description">
|
Connect a WebRTC Stream to videoElement
|
</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>videourl</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">id of WebRTC video stream</td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>audiourl</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">id of WebRTC audio stream</td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>options</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">options of WebRTC call</td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>stream</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">string</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last">local stream to send</td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="tag-source">Source:</dt>
|
<dd class="tag-source"><ul class="dummy"><li>
|
<a href="webrtcstreamer.js.html">webrtcstreamer.js</a>, <a href="webrtcstreamer.js.html#line28">line 28</a>
|
</li></ul></dd>
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect<span class="signature">()</span><span class="type-signature"></span></h4>
|
|
|
|
|
|
<div class="description">
|
Disconnect a WebRTC Stream and clear videoElement source
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="tag-source">Source:</dt>
|
<dd class="tag-source"><ul class="dummy"><li>
|
<a href="webrtcstreamer.js.html">webrtcstreamer.js</a>, <a href="webrtcstreamer.js.html#line54">line 54</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>
|
