857 lines
49 KiB
HTML
857 lines
49 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>SoundChannel | openfl</title>
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</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 href="../index.html" class="title">openfl</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-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</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">openfl</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/openfl.media.html">media</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.media.soundchannel.html">SoundChannel</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class SoundChannel</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>The SoundChannel class controls a sound in an application. Every sound is
|
|
assigned to a sound channel, and the application can have multiple sound
|
|
channels that are mixed together. The SoundChannel class contains a
|
|
<code>stop()</code> method, properties for monitoring the amplitude
|
|
(volume) of the channel, and a property for assigning a SoundTransform
|
|
object to the channel.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>:event</dt>
|
|
<dd><p>soundComplete Dispatched when a sound has finished playing.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="openfl.events.eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">SoundChannel</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="openfl.events.ieventdispatcher.html" class="tsd-signature-type">IEventDispatcher</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 tsd-is-inherited tsd-is-external">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.media.soundchannel.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.media.soundchannel.html#leftpeak" class="tsd-kind-icon">left<wbr>Peak</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.media.soundchannel.html#position" class="tsd-kind-icon">position</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.media.soundchannel.html#rightpeak" class="tsd-kind-icon">right<wbr>Peak</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.media.soundchannel.html#soundtransform" class="tsd-kind-icon">sound<wbr>Transform</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-external">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.media.soundchannel.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.media.soundchannel.html#dispatchevent" class="tsd-kind-icon">dispatch<wbr>Event</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.media.soundchannel.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.media.soundchannel.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.media.soundchannel.html#stop" class="tsd-kind-icon">stop</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.media.soundchannel.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.media.soundchannel.html#willtrigger" class="tsd-kind-icon">will<wbr>Trigger</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Sound<wbr>Channel<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">?: </span><a href="openfl.events.ieventdispatcher.html" class="tsd-signature-type">IEventDispatcher</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.media.soundchannel.html" class="tsd-signature-type">SoundChannel</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#constructor">constructor</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L50">lib/openfl/events/EventDispatcher.d.ts:50</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Aggregates an instance of the EventDispatcher class.</p>
|
|
</div>
|
|
<p>The EventDispatcher class is generally used as a base class, which
|
|
means that most developers do not need to use this constructor function.
|
|
However, advanced developers who are implementing the IEventDispatcher
|
|
interface need to use this constructor. If you are unable to extend the
|
|
EventDispatcher class and must instead implement the IEventDispatcher
|
|
interface, use this constructor to aggregate an instance of the
|
|
EventDispatcher class.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> target: <a href="openfl.events.ieventdispatcher.html" class="tsd-signature-type">IEventDispatcher</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The target object for events dispatched to the
|
|
EventDispatcher object. This parameter is used when the
|
|
EventDispatcher instance is aggregated by a class that
|
|
implements IEventDispatcher; it is necessary so that the
|
|
containing object can be the target for events. Do not use
|
|
this parameter in simple cases in which a class extends
|
|
EventDispatcher.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="openfl.media.soundchannel.html" class="tsd-signature-type">SoundChannel</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="leftpeak" class="tsd-anchor"></a>
|
|
<h3>left<wbr>Peak</h3>
|
|
<div class="tsd-signature tsd-kind-icon">left<wbr>Peak<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/openfl/openfl/blob/9921d3bf/lib/openfl/media/SoundChannel.d.ts#L25">lib/openfl/media/SoundChannel.d.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The current amplitude(volume) of the left channel, from 0(silent) to 1
|
|
(full amplitude).</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="position" class="tsd-anchor"></a>
|
|
<h3>position</h3>
|
|
<div class="tsd-signature tsd-kind-icon">position<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/openfl/openfl/blob/9921d3bf/lib/openfl/media/SoundChannel.d.ts#L40">lib/openfl/media/SoundChannel.d.ts:40</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>When the sound is playing, the <code>position</code> property indicates in
|
|
milliseconds the current point that is being played in the sound file.
|
|
When the sound is stopped or paused, the <code>position</code> property
|
|
indicates the last point that was played in the sound file.</p>
|
|
</div>
|
|
<p>A common use case is to save the value of the <code>position</code>
|
|
property when the sound is stopped. You can resume the sound later by
|
|
restarting it from that saved position.</p>
|
|
<p>If the sound is looped, <code>position</code> is reset to 0 at the
|
|
beginning of each loop.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="rightpeak" class="tsd-anchor"></a>
|
|
<h3>right<wbr>Peak</h3>
|
|
<div class="tsd-signature tsd-kind-icon">right<wbr>Peak<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/openfl/openfl/blob/9921d3bf/lib/openfl/media/SoundChannel.d.ts#L46">lib/openfl/media/SoundChannel.d.ts:46</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The current amplitude(volume) of the right channel, from 0(silent) to 1
|
|
(full amplitude).</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="soundtransform" class="tsd-anchor"></a>
|
|
<h3>sound<wbr>Transform</h3>
|
|
<div class="tsd-signature tsd-kind-icon">sound<wbr>Transform<span class="tsd-signature-symbol">:</span> <a href="openfl.media.soundtransform.html" class="tsd-signature-type">SoundTransform</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/media/SoundChannel.d.ts#L53">lib/openfl/media/SoundChannel.d.ts:53</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The SoundTransform object assigned to the sound channel. A SoundTransform
|
|
object includes properties for setting volume, panning, left speaker
|
|
assignment, and right speaker assignment.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="addeventlistener" class="tsd-anchor"></a>
|
|
<h3>add<wbr>Event<wbr>Listener</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, useCapture<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, priority<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, useWeakReference<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><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">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#addeventlistener">addEventListener</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L168">lib/openfl/events/EventDispatcher.d.ts:168</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Registers an event listener object with an EventDispatcher object so that
|
|
the listener receives notification of an event. You can register event
|
|
listeners on all nodes in the display list for a specific type of event,
|
|
phase, and priority.</p>
|
|
</div>
|
|
<p>After you successfully register an event listener, you cannot change
|
|
its priority through additional calls to <code>addEventListener()</code>.
|
|
To change a listener's priority, you must first call
|
|
<code>removeListener()</code>. Then you can register the listener again
|
|
with the new priority level.</p>
|
|
<p>Keep in mind that after the listener is registered, subsequent calls to
|
|
<code>addEventListener()</code> with a different <code>type</code> or
|
|
<code>useCapture</code> value result in the creation of a separate
|
|
listener registration. For example, if you first register a listener with
|
|
<code>useCapture</code> set to <code>true</code>, it listens only during
|
|
the capture phase. If you call <code>addEventListener()</code> again using
|
|
the same listener object, but with <code>useCapture</code> set to
|
|
<code>false</code>, you have two separate listeners: one that listens
|
|
during the capture phase and another that listens during the target and
|
|
bubbling phases.</p>
|
|
<p>You cannot register an event listener for only the target phase or the
|
|
bubbling phase. Those phases are coupled during registration because
|
|
bubbling applies only to the ancestors of the target node.</p>
|
|
<p>If you no longer need an event listener, remove it by calling
|
|
<code>removeEventListener()</code>, or memory problems could result. Event
|
|
listeners are not automatically removed from memory because the garbage
|
|
collector does not remove the listener as long as the dispatching object
|
|
exists(unless the <code>useWeakReference</code> parameter is set to
|
|
<code>true</code>).</p>
|
|
<p>Copying an EventDispatcher instance does not copy the event listeners
|
|
attached to it.(If your newly created node needs an event listener, you
|
|
must attach the listener after creating the node.) However, if you move an
|
|
EventDispatcher instance, the event listeners attached to it move along
|
|
with it.</p>
|
|
<p>If the event listener is being registered on a node while an event is
|
|
being processed on this node, the event listener is not triggered during
|
|
the current phase but can be triggered during a later phase in the event
|
|
flow, such as the bubbling phase.</p>
|
|
<p>If an event listener is removed from a node while an event is being
|
|
processed on the node, it is still triggered by the current actions. After
|
|
it is removed, the event listener is never invoked again(unless
|
|
registered again for future processing).</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>ArgumentError The <code>listener</code> specified is not a
|
|
function.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>listener: <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">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><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: <span class="tsd-signature-type">object</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useCapture: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Determines whether the listener works in the
|
|
capture phase or the target and bubbling phases.
|
|
If <code>useCapture</code> is set to
|
|
<code>true</code>, the listener processes the
|
|
event only during the capture phase and not in the
|
|
target or bubbling phase. If
|
|
<code>useCapture</code> is <code>false</code>, the
|
|
listener processes the event only during the
|
|
target or bubbling phase. To listen for the event
|
|
in all three phases, call
|
|
<code>addEventListener</code> twice, once with
|
|
<code>useCapture</code> set to <code>true</code>,
|
|
then again with <code>useCapture</code> set to
|
|
<code>false</code>.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> priority: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The priority level of the event listener. The
|
|
priority is designated by a signed 32-bit integer.
|
|
The higher the number, the higher the priority.
|
|
All listeners with priority <em>n</em> are processed
|
|
before listeners of priority <em>n</em>-1. If two or
|
|
more listeners share the same priority, they are
|
|
processed in the order in which they were added.
|
|
The default priority is 0.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useWeakReference: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Determines whether the reference to the listener
|
|
is strong or weak. A strong reference(the
|
|
default) prevents your listener from being
|
|
garbage-collected. A weak reference does not.</p>
|
|
<pre><code> Class-level member functions are not subject to
|
|
garbage collection, so you can <span class="hljs-keyword">set</span>
|
|
<span class="hljs-string">`useWeakReference`</span> <span class="hljs-keyword">to</span> <span class="hljs-string">`true`</span>
|
|
<span class="hljs-keyword">for</span> <span class="hljs-keyword">class</span>-<span class="hljs-keyword">level</span> <span class="hljs-keyword">member</span> functions <span class="hljs-keyword">without</span>
|
|
subjecting them <span class="hljs-keyword">to</span> garbage collection. <span class="hljs-keyword">If</span> you <span class="hljs-keyword">set</span>
|
|
<span class="hljs-string">`useWeakReference`</span> <span class="hljs-keyword">to</span> <span class="hljs-string">`true`</span>
|
|
<span class="hljs-keyword">for</span> a listener that <span class="hljs-keyword">is</span> a <span class="hljs-keyword">nested</span> <span class="hljs-keyword">inner</span> <span class="hljs-keyword">function</span>,
|
|
the <span class="hljs-keyword">function</span> will be garbage-collected <span class="hljs-keyword">and</span> <span class="hljs-keyword">no</span>
|
|
longer persistent. <span class="hljs-keyword">If</span> you <span class="hljs-keyword">create</span> <span class="hljs-keyword">references</span> <span class="hljs-keyword">to</span> the
|
|
<span class="hljs-keyword">inner</span> <span class="hljs-keyword">function</span>(<span class="hljs-keyword">save</span> it <span class="hljs-keyword">in</span> another <span class="hljs-keyword">variable</span>) <span class="hljs-keyword">then</span>
|
|
it <span class="hljs-keyword">is</span> <span class="hljs-keyword">not</span> garbage-collected <span class="hljs-keyword">and</span> stays
|
|
persistent.
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="dispatchevent" class="tsd-anchor"></a>
|
|
<h3>dispatch<wbr>Event</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">dispatch<wbr>Event<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="openfl.events.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">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#dispatchevent">dispatchEvent</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L186">lib/openfl/events/EventDispatcher.d.ts:186</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Dispatches an event into the event flow. The event target is the
|
|
EventDispatcher object upon which the <code>dispatchEvent()</code> method
|
|
is called.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error The event dispatch recursion limit has been reached.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <a href="openfl.events.event.html" class="tsd-signature-type">Event</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The Event object that is dispatched into the event flow. If
|
|
the event is being redispatched, a clone of the event is
|
|
created automatically. After an event is dispatched, its
|
|
<code>target</code> property cannot be changed, so you must
|
|
create a new copy of the event for redispatching to work.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>A value of <code>true</code> if the event was successfully
|
|
dispatched. A value of <code>false</code> indicates failure or
|
|
that <code>preventDefault()</code> was called on the event.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="haseventlistener" class="tsd-anchor"></a>
|
|
<h3>has<wbr>Event<wbr>Listener</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">has<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#haseventlistener">hasEventListener</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L209">lib/openfl/events/EventDispatcher.d.ts:209</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks whether the EventDispatcher object has any listeners registered for
|
|
a specific type of event. This allows you to determine where an
|
|
EventDispatcher object has altered handling of an event type in the event
|
|
flow hierarchy. To determine whether a specific event type actually
|
|
triggers an event listener, use <code>willTrigger()</code>.</p>
|
|
</div>
|
|
<p>The difference between <code>hasEventListener()</code> and
|
|
<code>willTrigger()</code> is that <code>hasEventListener()</code>
|
|
examines only the object to which it belongs, whereas
|
|
<code>willTrigger()</code> examines the entire event flow for the event
|
|
specified by the <code>type</code> parameter.</p>
|
|
<p>When <code>hasEventListener()</code> is called from a LoaderInfo
|
|
object, only the listeners that the caller can access are considered.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>A value of <code>true</code> if a listener of the specified type
|
|
is registered; <code>false</code> otherwise.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="removeeventlistener" class="tsd-anchor"></a>
|
|
<h3>remove<wbr>Event<wbr>Listener</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">remove<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, useCapture<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><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">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#removeeventlistener">removeEventListener</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L227">lib/openfl/events/EventDispatcher.d.ts:227</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Removes a listener from the EventDispatcher object. If there is no
|
|
matching listener registered with the EventDispatcher object, a call to
|
|
this method has no effect.</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>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>listener: <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">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><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: <span class="tsd-signature-type">object</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useCapture: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Specifies whether the listener was registered for the
|
|
capture phase or the target and bubbling phases. If the
|
|
listener was registered for both the capture phase and
|
|
the target and bubbling phases, two calls to
|
|
<code>removeEventListener()</code> are required to
|
|
remove both, one call with <code>useCapture()</code> set
|
|
to <code>true</code>, and another call with
|
|
<code>useCapture()</code> set to <code>false</code>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="stop" class="tsd-anchor"></a>
|
|
<h3>stop</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span><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">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/media/SoundChannel.d.ts#L65">lib/openfl/media/SoundChannel.d.ts:65</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Stops the sound playing in the channel.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="tostring" class="tsd-anchor"></a>
|
|
<h3>to<wbr>String</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#tostring">toString</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L230">lib/openfl/events/EventDispatcher.d.ts:230</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="willtrigger" class="tsd-anchor"></a>
|
|
<h3>will<wbr>Trigger</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">will<wbr>Trigger<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#willtrigger">willTrigger</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L253">lib/openfl/events/EventDispatcher.d.ts:253</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks whether an event listener is registered with this EventDispatcher
|
|
object or any of its ancestors for the specified event type. This method
|
|
returns <code>true</code> if an event listener is triggered during any
|
|
phase of the event flow when an event of the specified type is dispatched
|
|
to this EventDispatcher object or any of its descendants.</p>
|
|
</div>
|
|
<p>The difference between the <code>hasEventListener()</code> and the
|
|
<code>willTrigger()</code> methods is that <code>hasEventListener()</code>
|
|
examines only the object to which it belongs, whereas the
|
|
<code>willTrigger()</code> method examines the entire event flow for the
|
|
event specified by the <code>type</code> parameter.</p>
|
|
<p>When <code>willTrigger()</code> is called from a LoaderInfo object,
|
|
only the listeners that the caller can access are considered.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>A value of <code>true</code> if a listener of the specified type
|
|
will be triggered; <code>false</code> otherwise.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="label tsd-is-external">
|
|
<span>Externals</span>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.desktop.html">openfl.desktop</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display.html">openfl.display</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display3d.html">openfl.display3D</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.errors.html">openfl.errors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.events.html">openfl.events</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.external.html">openfl.external</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.filters.html">openfl.filters</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.geom.html">openfl.geom</a>
|
|
</li>
|
|
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.media.html">openfl.media</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.net.html">openfl.net</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.profiler.html">openfl.profiler</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.sensors.html">openfl.sensors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.system.html">openfl.system</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.text.html">openfl.text</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.ui.html">openfl.ui</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.utils.html">openfl.utils</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.media.id3info.html" class="tsd-kind-icon">ID3<wbr>Info</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.media.sound.html" class="tsd-kind-icon">Sound</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html" class="tsd-kind-icon">Sound<wbr>Channel</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#leftpeak" class="tsd-kind-icon">left<wbr>Peak</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#position" class="tsd-kind-icon">position</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#rightpeak" class="tsd-kind-icon">right<wbr>Peak</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#soundtransform" class="tsd-kind-icon">sound<wbr>Transform</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#dispatchevent" class="tsd-kind-icon">dispatch<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#stop" class="tsd-kind-icon">stop</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.media.soundchannel.html#willtrigger" class="tsd-kind-icon">will<wbr>Trigger</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.media.soundloadercontext.html" class="tsd-kind-icon">Sound<wbr>Loader<wbr>Context</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.media.soundtransform.html" class="tsd-kind-icon">Sound<wbr>Transform</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.media.video.html" class="tsd-kind-icon">Video</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>
|
|
</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> |