cv-dialog-sdk
Version:
Catavolt Dialog Javascript API
409 lines • 22.4 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Stream | cv-dialog-sdk</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">cv-dialog-sdk</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="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_models_stream_.html">"models/Stream"</a>
</li>
<li>
<a href="_models_stream_.stream.html">Stream</a>
</li>
</ul>
<h1>Class Stream</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="_models_view_.view.html" class="tsd-signature-type">View</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">Stream</span>
</li>
</ul>
</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 tsd-is-inherited"><a href="_models_stream_.stream.html#alias" class="tsd-kind-icon">alias</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_stream_.stream.html#buffersize" class="tsd-kind-icon">buffer<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_stream_.stream.html#defaultactionid" class="tsd-kind-icon">default<wbr>Action<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_stream_.stream.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_stream_.stream.html#menu" class="tsd-kind-icon">menu</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_stream_.stream.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_stream_.stream.html#title" class="tsd-kind-icon">title</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_stream_.stream.html#topic" class="tsd-kind-icon">topic</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_models_stream_.stream.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_models_stream_.stream.html#view" class="tsd-kind-icon">view</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_stream_.stream.html#findmenuat" class="tsd-kind-icon">find<wbr>Menu<wbr>At</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_models_stream_.stream.html#findtitle" class="tsd-kind-icon">find<wbr>Title</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 tsd-is-inherited">
<a name="alias" class="tsd-anchor"></a>
<h3>alias</h3>
<div class="tsd-signature tsd-kind-icon">alias<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_models_view_.view.html">View</a>.<a href="_models_view_.view.html#alias">alias</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/View.ts#L12">models/View.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="buffersize" class="tsd-anchor"></a>
<h3>buffer<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">buffer<wbr>Size<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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Stream.ts#L5">models/Stream.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="defaultactionid" class="tsd-anchor"></a>
<h3>default<wbr>Action<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Action<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_models_view_.view.html">View</a>.<a href="_models_view_.view.html#defaultactionid">defaultActionId</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/View.ts#L13">models/View.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<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">
<p>Inherited from <a href="_models_view_.view.html">View</a>.<a href="_models_view_.view.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/View.ts#L14">models/View.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="menu" class="tsd-anchor"></a>
<h3>menu</h3>
<div class="tsd-signature tsd-kind-icon">menu<span class="tsd-signature-symbol">:</span> <a href="_models_menu_.menu.html" class="tsd-signature-type">Menu</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_models_view_.view.html">View</a>.<a href="_models_view_.view.html#menu">menu</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/View.ts#L16">models/View.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_models_view_.view.html">View</a>.<a href="_models_view_.view.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/View.ts#L15">models/View.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="title" class="tsd-anchor"></a>
<h3>title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_models_view_.view.html">View</a>.<a href="_models_view_.view.html#title">title</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/View.ts#L17">models/View.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="topic" class="tsd-anchor"></a>
<h3>topic</h3>
<div class="tsd-signature tsd-kind-icon">topic<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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Stream.ts#L4">models/Stream.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules/_models_types_.html#viewtype" class="tsd-signature-type">ViewType</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_models_view_.view.html">View</a>.<a href="_models_view_.view.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/View.ts#L18">models/View.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="view" class="tsd-anchor"></a>
<h3>view</h3>
<div class="tsd-signature tsd-kind-icon">view<span class="tsd-signature-symbol">:</span> <a href="_models_view_.view.html" class="tsd-signature-type">View</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Stream.ts#L6">models/Stream.ts:6</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="findmenuat" class="tsd-anchor"></a>
<h3>find<wbr>Menu<wbr>At</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">find<wbr>Menu<wbr>At<span class="tsd-signature-symbol">(</span>actionId<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><a href="_models_menu_.menu.html" class="tsd-signature-type">Menu</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_models_view_.view.html">View</a>.<a href="_models_view_.view.html#findmenuat">findMenuAt</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/View.ts#L49">models/View.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Find a menu def on this View with the given actionId</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>actionId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_models_menu_.menu.html" class="tsd-signature-type">Menu</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="findtitle" class="tsd-anchor"></a>
<h3>find<wbr>Title</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">find<wbr>Title<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="_models_view_.view.html">View</a>.<a href="_models_view_.view.html#findtitle">findTitle</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/View.ts#L34">models/View.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Find the title for this Pane</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></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="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_models_stream_.html">"models/<wbr>Stream"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_models_stream_.stream.html" class="tsd-kind-icon">Stream</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_models_stream_.stream.html#alias" class="tsd-kind-icon">alias</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_models_stream_.stream.html#buffersize" class="tsd-kind-icon">buffer<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_models_stream_.stream.html#defaultactionid" class="tsd-kind-icon">default<wbr>Action<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_models_stream_.stream.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_models_stream_.stream.html#menu" class="tsd-kind-icon">menu</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_models_stream_.stream.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_models_stream_.stream.html#title" class="tsd-kind-icon">title</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_models_stream_.stream.html#topic" class="tsd-kind-icon">topic</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_models_stream_.stream.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_models_stream_.stream.html#view" class="tsd-kind-icon">view</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_models_stream_.stream.html#findmenuat" class="tsd-kind-icon">find<wbr>Menu<wbr>At</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_models_stream_.stream.html#findtitle" class="tsd-kind-icon">find<wbr>Title</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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>