openvidu/openvidu-browser/docs/interfaces/publisherproperties.html

485 lines
26 KiB
HTML
Raw Normal View History

2018-04-26 15:33:47 +02:00
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PublisherProperties | 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">
2018-04-26 17:47:10 +02:00
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
2018-04-26 15:33:47 +02:00
</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>
2018-04-26 17:47:10 +02:00
<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>
2018-04-26 15:33:47 +02:00
</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="publisherproperties.html">PublisherProperties</a>
</li>
</ul>
<h1>Interface PublisherProperties</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>See <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">PublisherProperties</span>
</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-interface"><a href="publisherproperties.html#audiosource" class="tsd-kind-icon">audio<wbr>Source</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="publisherproperties.html#framerate" class="tsd-kind-icon">frame<wbr>Rate</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="publisherproperties.html#insertmode" class="tsd-kind-icon">insert<wbr>Mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="publisherproperties.html#mirror" class="tsd-kind-icon">mirror</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="publisherproperties.html#publishaudio" class="tsd-kind-icon">publish<wbr>Audio</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="publisherproperties.html#publishvideo" class="tsd-kind-icon">publish<wbr>Video</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="publisherproperties.html#resolution" class="tsd-kind-icon">resolution</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="publisherproperties.html#videosource" class="tsd-kind-icon">video<wbr>Source</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-interface">
<a name="audiosource" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> audio<wbr>Source</h3>
<div class="tsd-signature tsd-kind-icon">audio<wbr>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MediaStreamTrack</span><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/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L32">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Which device should provide the audio source. Can be:</p>
<ul>
<li>Property <code>deviceId</code> of a <a href="device.html">Device</a></li>
<li>A MediaStreamTrack obtained from a MediaStream object with <a href="../classes/openvidu.html#getusermedia">OpenVidu.getUserMedia</a></li>
<li><code>false</code> or null to have a video-only publisher</li>
</ul>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p><em>Default microphone</em></p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="framerate" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> frame<wbr>Rate</h3>
<div class="tsd-signature tsd-kind-icon">frame<wbr>Rate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L39">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:39</a></li>
2018-04-26 15:33:47 +02:00
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Desired framerate of the video in frames per second.
Limiting the framerate has always effect on browsers Chrome and Opera. Firefox requires that the input device explicitly supports the desired framerate.</p>
2018-04-26 15:33:47 +02:00
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>undefined</p>
</dd>
</dl>
2018-04-26 15:33:47 +02:00
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="insertmode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> insert<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">insert<wbr>Mode<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-type">string</span></div>
2018-04-26 15:33:47 +02:00
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L45">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:45</a></li>
2018-04-26 15:33:47 +02:00
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>How the video element of the publisher should be inserted in the DOM</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>VideoInsertMode.APPEND</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="mirror" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> mirror</h3>
<div class="tsd-signature tsd-kind-icon">mirror<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/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L51">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:51</a></li>
2018-04-26 15:33:47 +02:00
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether the publisher&#39;s video will be mirrored in the page or not. Only affects the local view of the publisher in the browser (remote streams will not be mirrored). If <code>videoSource</code> is set to &quot;screen&quot; this property is fixed to <code>false</code></p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="publishaudio" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> publish<wbr>Audio</h3>
<div class="tsd-signature tsd-kind-icon">publish<wbr>Audio<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/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L57">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:57</a></li>
2018-04-26 15:33:47 +02:00
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
2018-06-01 14:39:38 +02:00
<p>Whether to initially publish to the session with the audio unmuted or muted. Only makes sense if property <code>audioSource</code> is NOT set to <em>false</em> or <em>null</em>. You can change the audio state later during the session with <a href="../classes/publisher.html#publishaudio">Publisher.publishAudio</a></p>
2018-04-26 15:33:47 +02:00
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="publishvideo" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> publish<wbr>Video</h3>
<div class="tsd-signature tsd-kind-icon">publish<wbr>Video<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/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L63">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:63</a></li>
2018-04-26 15:33:47 +02:00
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
2018-06-01 14:39:38 +02:00
<p>Whether to initially publish to the session with the video enabled or disabled. Only makes sense if property <code>videoSource</code> is NOT set to <em>false</em> or <em>null</em>. You can change the video state later during the session with <a href="../classes/publisher.html#publishvideo">Publisher.publishVideo</a></p>
2018-04-26 15:33:47 +02:00
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="resolution" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> resolution</h3>
<div class="tsd-signature tsd-kind-icon">resolution<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/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L69">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:69</a></li>
2018-04-26 15:33:47 +02:00
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Resolution of the video: <code>&quot;320x240&quot;</code>, <code>&quot;640x480&quot;</code>, <code>&quot;1280x720&quot;</code> (low, medium and high quality respectively)</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>&quot;640x480&quot;</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="videosource" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> video<wbr>Source</h3>
<div class="tsd-signature tsd-kind-icon">video<wbr>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MediaStreamTrack</span><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/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L81">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:81</a></li>
2018-04-26 15:33:47 +02:00
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Which device should provide the video source. Can be:</p>
<ul>
<li>Property <code>deviceId</code> of a <a href="device.html">Device</a></li>
<li><code>&quot;screen&quot;</code> to screen-share. We provide a default screen-shraring extension for Chrome that can run in any domain, but you can customize it so it has your own icon, your own name, etc. Visit this
<a href="https://github.com/OpenVidu/openvidu-screen-sharing-chrome-extension/">GitHub repository</a> to learn how. Once you have uploaded your own extension to Chrome Web Store,
simply call <code>OpenVidu.setAdvancedConfiguration({screenShareChromeExtension : &quot;https://chrome.google.com/webstore/detail/YOUR_EXTENSION_NAME/YOUR_EXTENSION_ID&quot;})</code> before calling <code>OpenVidu.initPublisher(targetElement, {videoSource: &quot;screen&quot;})</code>.</li>
<li>A MediaStreamTrack obtained from a MediaStream object with <a href="../classes/openvidu.html#getusermedia">OpenVidu.getUserMedia</a></li>
<li><code>false</code> or null to have an audio-only publisher</li>
</ul>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p><em>Default camera</em></p>
</dd>
</dl>
</div>
</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>
2018-04-26 15:33:47 +02:00
</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="../classes/connection.html" class="tsd-kind-icon">Connection</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/event.html" class="tsd-kind-icon">Event</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/publisher.html" class="tsd-kind-icon">Publisher</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/stream.html" class="tsd-kind-icon">Stream</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
</li>
2018-06-01 14:39:38 +02:00
<li class=" tsd-kind-class">
<a href="../classes/streammanager.html" class="tsd-kind-icon">Stream<wbr>Manager</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
</li>
2018-04-26 15:33:47 +02:00
<li class=" tsd-kind-class">
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="capabilities.html" class="tsd-kind-icon">Capabilities</a>
</li>
2018-04-26 15:33:47 +02:00
<li class=" tsd-kind-interface">
<a href="device.html" class="tsd-kind-icon">Device</a>
</li>
<li class=" tsd-kind-interface">
<a href="eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
</li>
<li class=" tsd-kind-interface">
<a href="openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="publisherproperties.html#audiosource" class="tsd-kind-icon">audio<wbr>Source</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="publisherproperties.html#framerate" class="tsd-kind-icon">frame<wbr>Rate</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="publisherproperties.html#insertmode" class="tsd-kind-icon">insert<wbr>Mode</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="publisherproperties.html#mirror" class="tsd-kind-icon">mirror</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="publisherproperties.html#publishaudio" class="tsd-kind-icon">publish<wbr>Audio</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="publisherproperties.html#publishvideo" class="tsd-kind-icon">publish<wbr>Video</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="publisherproperties.html#resolution" class="tsd-kind-icon">resolution</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="publisherproperties.html#videosource" class="tsd-kind-icon">video<wbr>Source</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
</li>
2018-06-01 14:39:38 +02:00
<li class=" tsd-kind-interface">
<a href="streammanagervideo.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Video</a>
</li>
2018-04-26 15:33:47 +02:00
<li class=" tsd-kind-interface">
<a href="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>