mirror of https://github.com/OpenVidu/openvidu.git
647 lines
34 KiB
HTML
647 lines
34 KiB
HTML
|
<!doctype html>
|
||
|
|
<html class="default no-js">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
|
<title>StreamManager | OpenVidu Browser</title>
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||
|
|
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<header>
|
||
|
|
<div class="tsd-page-toolbar">
|
||
|
|
<div class="container">
|
||
|
|
<div class="table-wrap">
|
||
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||
|
|
<div class="field">
|
||
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||
|
|
<input id="tsd-search-field" type="text" />
|
||
|
|
</div>
|
||
|
|
<ul class="results">
|
||
|
|
<li class="state loading">Preparing search index...</li>
|
||
|
|
<li class="state failure">The search index is not available</li>
|
||
|
|
</ul>
|
||
|
|
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||
|
|
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
<div class="table-cell" id="tsd-widgets">
|
||
|
|
<div id="tsd-filter">
|
||
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||
|
|
<div class="tsd-filter-group">
|
||
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
||
|
|
<span class="tsd-select-label">All</span>
|
||
|
|
<ul class="tsd-select-list">
|
||
|
|
<li data-value="public">Public</li>
|
||
|
|
<li data-value="protected">Public/Protected</li>
|
||
|
|
<li data-value="private" class="selected">All</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
||
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="tsd-page-title">
|
||
|
|
<div class="container">
|
||
|
|
<ul class="tsd-breadcrumb">
|
||
|
|
<li>
|
||
|
|
<a href="../index.html">Globals</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="streammanager.html">StreamManager</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h1>Class StreamManager</h1>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</header>
|
||
|
|
<div class="container container-main">
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-8 col-content">
|
||
|
|
<section class="tsd-panel tsd-comment">
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Interface in charge of displaying the media streams in the HTML DOM. This wraps any <a href="publisher.html">Publisher</a> and <a href="subscriber.html">Subscriber</a> object.
|
||
|
|
You can insert as many video players fo the same Stream as you want by calling <a href="streammanager.html#addvideoelement">StreamManager.addVideoElement</a> or
|
||
|
|
<a href="streammanager.html#createvideoelement">StreamManager.createVideoElement</a>.</p>
|
||
|
|
</div>
|
||
|
|
<p>The use of StreamManager wrapper is particularly useful when you don't need to differentiate between Publisher or Subscriber streams or just
|
||
|
|
want to directly manage your own video elements (even more than one video element per Stream). This scenario is pretty common in
|
||
|
|
declarative, MVC frontend frameworks such as Angular, React or Vue.js</p>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-hierarchy">
|
||
|
|
<h3>Hierarchy</h3>
|
||
|
|
<ul class="tsd-hierarchy">
|
||
|
|
<li>
|
||
|
|
<span class="target">StreamManager</span>
|
||
|
|
<ul class="tsd-hierarchy">
|
||
|
|
<li>
|
||
|
|
<a href="publisher.html" class="tsd-signature-type">Publisher</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="subscriber.html" class="tsd-signature-type">Subscriber</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel">
|
||
|
|
<h3>Implements</h3>
|
||
|
|
<ul class="tsd-hierarchy">
|
||
|
|
<li><a href="../interfaces/eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-index-group">
|
||
|
|
<h2>Index</h2>
|
||
|
|
<section class="tsd-panel tsd-index-panel">
|
||
|
|
<div class="tsd-index-content">
|
||
|
|
<section class="tsd-index-section ">
|
||
|
|
<h3>Properties</h3>
|
||
|
|
<ul class="tsd-index-list">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammanager.html#id" class="tsd-kind-icon">id</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammanager.html#remote" class="tsd-kind-icon">remote</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammanager.html#stream" class="tsd-kind-icon">stream</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammanager.html#targetelement" class="tsd-kind-icon">target<wbr>Element</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streammanager.html#videos" class="tsd-kind-icon">videos</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-index-section ">
|
||
|
|
<h3>Methods</h3>
|
||
|
|
<ul class="tsd-index-list">
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streammanager.html#addvideoelement" class="tsd-kind-icon">add<wbr>Video<wbr>Element</a></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streammanager.html#createvideoelement" class="tsd-kind-icon">create<wbr>Video<wbr>Element</a></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streammanager.html#off" class="tsd-kind-icon">off</a></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streammanager.html#on" class="tsd-kind-icon">on</a></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streammanager.html#once" class="tsd-kind-icon">once</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-member-group ">
|
||
|
|
<h2>Properties</h2>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="id" class="tsd-anchor"></a>
|
||
|
|
<h3>id</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L69">OpenVidu/StreamManager.ts:69</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p><code>id</code> attribute of the DOM video element displaying the Publisher/Subscriber's stream. This property is only defined if:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="publisher.html">Publisher</a> has been initialized by calling method <a href="openvidu.html#initpublisher">OpenVidu.initPublisher</a> with a valid <code>targetElement</code> parameter</li>
|
||
|
|
<li><a href="subscriber.html">Subscriber</a> has been initialized by calling method <a href="session.html#subscribe">Session.subscribe</a> with a valid <code>targetElement</code> parameter</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="remote" class="tsd-anchor"></a>
|
||
|
|
<h3>remote</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">remote<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L55">OpenVidu/StreamManager.ts:55</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Whether the Stream represented in the DOM is local or remote</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>false</code> for <a href="publisher.html">Publisher</a></li>
|
||
|
|
<li><code>true</code> for <a href="subscriber.html">Subscriber</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="stream" class="tsd-anchor"></a>
|
||
|
|
<h3>stream</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">stream<span class="tsd-signature-symbol">:</span> <a href="stream.html" class="tsd-signature-type">Stream</a></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L43">OpenVidu/StreamManager.ts:43</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>The Stream represented in the DOM by the Publisher/Subscriber</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="targetelement" class="tsd-anchor"></a>
|
||
|
|
<h3>target<wbr>Element</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">target<wbr>Element<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</span></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L62">OpenVidu/StreamManager.ts:62</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>The DOM HTMLElement assigned as target element when creating the video for the Publisher/Subscriber. This property is only defined if:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="publisher.html">Publisher</a> has been initialized by calling method <a href="openvidu.html#initpublisher">OpenVidu.initPublisher</a> with a valid <code>targetElement</code> parameter</li>
|
||
|
|
<li><a href="subscriber.html">Subscriber</a> has been initialized by calling method <a href="session.html#subscribe">Session.subscribe</a> with a valid <code>targetElement</code> parameter</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="videos" class="tsd-anchor"></a>
|
||
|
|
<h3>videos</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">videos<span class="tsd-signature-symbol">:</span> <a href="../interfaces/streammanagervideo.html" class="tsd-signature-type">StreamManagerVideo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L48">OpenVidu/StreamManager.ts:48</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>All the videos displaying the Stream of this Publisher/Subscriber</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-member-group ">
|
||
|
|
<h2>Methods</h2>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a name="addvideoelement" class="tsd-anchor"></a>
|
||
|
|
<h3>add<wbr>Video<wbr>Element</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Video<wbr>Element<span class="tsd-signature-symbol">(</span>video<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLVideoElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L220">OpenVidu/StreamManager.ts:220</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Makes <code>video</code> element parameter display this <a href="streammanager.html#stream">stream</a>. This is useful when you are
|
||
|
|
<a href="/docs/how-do-i/manage-videos/#you-take-care-of-the-video-players">managing the video elements on your own</a></p>
|
||
|
|
</div>
|
||
|
|
<p>Calling this method with a video already added to other Publisher/Subscriber will cause the video element to be
|
||
|
|
disassociated from that previous Publisher/Subscriber and to be associated to this one.</p>
|
||
|
|
</div>
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
|
<h5>video: <span class="tsd-signature-type">HTMLVideoElement</span></h5>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||
|
|
<p>1 if the video wasn't associated to any other Publisher/Subscriber and has been successfully added to this one.
|
||
|
|
0 if the video was already added to this Publisher/Subscriber. -1 if the video was previously associated to any other
|
||
|
|
Publisher/Subscriber and has been successfully disassociated from that one and properly added to this one.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a name="createvideoelement" class="tsd-anchor"></a>
|
||
|
|
<h3>create<wbr>Video<wbr>Element</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Video<wbr>Element<span class="tsd-signature-symbol">(</span>targetElement<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span>, insertMode<span class="tsd-signature-symbol">?: </span><a href="../enums/videoinsertmode.html" class="tsd-signature-type">VideoInsertMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLVideoElement</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L266">OpenVidu/StreamManager.ts:266</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Creates a new video element displaying this <a href="streammanager.html#stream">stream</a>. This allows you to have multiple video elements displaying the same media stream.</p>
|
||
|
|
</div>
|
||
|
|
<h4 id="events-dispatched">Events dispatched</h4>
|
||
|
|
<p>The Publisher/Subscriber object will dispatch a <code>videoElementCreated</code> event once the HTML video element has been added to DOM. See <a href="videoelementevent.html">VideoElementEvent</a></p>
|
||
|
|
</div>
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> targetElement: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></h5>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<p>HTML DOM element (or its <code>id</code> attribute) in which the video element of the Publisher/Subscriber will be inserted</p>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> insertMode: <a href="../enums/videoinsertmode.html" class="tsd-signature-type">VideoInsertMode</a></h5>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<p>How the video element will be inserted accordingly to <code>targetElemet</code></p>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLVideoElement</span></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a name="off" class="tsd-anchor"></a>
|
||
|
|
<h3>off</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="streammanager.html" class="tsd-signature-type">StreamManager</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L200">OpenVidu/StreamManager.ts:200</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>See <a href="../interfaces/eventdispatcher.html#off">EventDispatcher.off</a></p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handler: <span class="tsd-signature-type">function</span></h5>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li class="tsd-parameter-siganture">
|
||
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="event.html" class="tsd-signature-type">Event</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
|
<h5>event: <a href="event.html" class="tsd-signature-type">Event</a></h5>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h4 class="tsd-returns-title">Returns <a href="streammanager.html" class="tsd-signature-type">StreamManager</a></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a name="on" class="tsd-anchor"></a>
|
||
|
|
<h3>on</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L139">OpenVidu/StreamManager.ts:139</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>See <a href="../interfaces/eventdispatcher.html#on">EventDispatcher.on</a></p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li class="tsd-parameter-siganture">
|
||
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="event.html" class="tsd-signature-type">Event</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
|
<h5>event: <a href="event.html" class="tsd-signature-type">Event</a></h5>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a name="once" class="tsd-anchor"></a>
|
||
|
|
<h3>once</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="streammanager.html" class="tsd-signature-type">StreamManager</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L170">OpenVidu/StreamManager.ts:170</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>See <a href="../interfaces/eventdispatcher.html#once">EventDispatcher.once</a></p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<h5>handler: <span class="tsd-signature-type">function</span></h5>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li class="tsd-parameter-siganture">
|
||
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
|
||
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="event.html" class="tsd-signature-type">Event</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
|
<h5>event: <a href="event.html" class="tsd-signature-type">Event</a></h5>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h4 class="tsd-returns-title">Returns <a href="streammanager.html" class="tsd-signature-type">StreamManager</a></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
|
|
<nav class="tsd-navigation primary">
|
||
|
|
<ul>
|
||
|
|
<li class="globals ">
|
||
|
|
<a href="../index.html"><em>Globals</em></a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
||
|
|
<ul class="before-current">
|
||
|
|
<li class=" tsd-kind-enum">
|
||
|
|
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-enum">
|
||
|
|
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-enum">
|
||
|
|
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="current">
|
||
|
|
<li class="current tsd-kind-class">
|
||
|
|
<a href="streammanager.html" class="tsd-kind-icon">Stream<wbr>Manager</a>
|
||
|
|
<ul>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#id" class="tsd-kind-icon">id</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#remote" class="tsd-kind-icon">remote</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#stream" class="tsd-kind-icon">stream</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#targetelement" class="tsd-kind-icon">target<wbr>Element</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#videos" class="tsd-kind-icon">videos</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#addvideoelement" class="tsd-kind-icon">add<wbr>Video<wbr>Element</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#createvideoelement" class="tsd-kind-icon">create<wbr>Video<wbr>Element</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#off" class="tsd-kind-icon">off</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#on" class="tsd-kind-icon">on</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
|
|
<a href="streammanager.html#once" class="tsd-kind-icon">once</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="after-current">
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-class">
|
||
|
|
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-interface">
|
||
|
|
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-interface">
|
||
|
|
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-interface">
|
||
|
|
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-interface">
|
||
|
|
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-interface">
|
||
|
|
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-interface">
|
||
|
|
<a href="../interfaces/streammanagervideo.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Video</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-interface">
|
||
|
|
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer class="with-border-bottom">
|
||
|
|
<div class="container">
|
||
|
|
<h2>Legend</h2>
|
||
|
|
<div class="tsd-legend-group">
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||
|
|
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||
|
|
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||
|
|
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||
|
|
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||
|
|
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</footer>
|
||
|
|
<div class="container tsd-generator">
|
||
|
|
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||
|
|
</div>
|
||
|
|
<div class="overlay"></div>
|
||
|
|
<script src="../assets/js/main.js"></script>
|
||
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||
|
|
</body>
|
||
|
|
</html>
|