streamplugin.html 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. <!doctype html>
  2. <html class="default no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <title>StreamPlugin | @urtc/sdk-web</title>
  7. <meta name="description" content="Documentation for @urtc/sdk-web">
  8. <meta name="viewport" content="width=device-width, initial-scale=1">
  9. <link rel="stylesheet" href="../assets/css/main.css">
  10. </head>
  11. <body>
  12. <header>
  13. <div class="tsd-page-toolbar">
  14. <div class="container">
  15. <div class="table-wrap">
  16. <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
  17. <div class="field">
  18. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  19. <input id="tsd-search-field" type="text" />
  20. </div>
  21. <ul class="results">
  22. <li class="state loading">Preparing search index...</li>
  23. <li class="state failure">The search index is not available</li>
  24. </ul>
  25. <a href="../index.html" class="title">@urtc/sdk-web</a>
  26. </div>
  27. <div class="table-cell" id="tsd-widgets">
  28. <div id="tsd-filter">
  29. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  30. <div class="tsd-filter-group">
  31. <div class="tsd-select" id="tsd-filter-visibility">
  32. <span class="tsd-select-label">All</span>
  33. <ul class="tsd-select-list">
  34. <li data-value="public">Public</li>
  35. <li data-value="protected">Public/Protected</li>
  36. <li data-value="private" class="selected">All</li>
  37. </ul>
  38. </div>
  39. <input type="checkbox" id="tsd-filter-inherited" checked />
  40. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  41. <input type="checkbox" id="tsd-filter-externals" checked />
  42. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  43. </div>
  44. </div>
  45. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  46. </div>
  47. </div>
  48. </div>
  49. </div>
  50. <div class="tsd-page-title">
  51. <div class="container">
  52. <ul class="tsd-breadcrumb">
  53. <li>
  54. <a href="../index.html">Globals</a>
  55. </li>
  56. <li>
  57. <a href="streamplugin.html">StreamPlugin</a>
  58. </li>
  59. </ul>
  60. <h1>Interface StreamPlugin</h1>
  61. </div>
  62. </div>
  63. </header>
  64. <div class="container container-main">
  65. <div class="row">
  66. <div class="col-8 col-content">
  67. <section class="tsd-panel tsd-comment">
  68. <div class="tsd-comment tsd-typography">
  69. </div>
  70. </section>
  71. <section class="tsd-panel tsd-hierarchy">
  72. <h3>Hierarchy</h3>
  73. <ul class="tsd-hierarchy">
  74. <li>
  75. <span class="target">StreamPlugin</span>
  76. </li>
  77. </ul>
  78. </section>
  79. <section class="tsd-panel-group tsd-index-group">
  80. <h2>Index</h2>
  81. <section class="tsd-panel tsd-index-panel">
  82. <div class="tsd-index-content">
  83. <section class="tsd-index-section tsd-is-external">
  84. <h3>Properties</h3>
  85. <ul class="tsd-index-list">
  86. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="streamplugin.html#name" class="tsd-kind-icon">name</a></li>
  87. </ul>
  88. </section>
  89. <section class="tsd-index-section tsd-is-external">
  90. <h3>Methods</h3>
  91. <ul class="tsd-index-list">
  92. <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="streamplugin.html#init" class="tsd-kind-icon">init</a></li>
  93. </ul>
  94. </section>
  95. </div>
  96. </section>
  97. </section>
  98. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  99. <h2>Properties</h2>
  100. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
  101. <a name="name" class="tsd-anchor"></a>
  102. <h3>name</h3>
  103. <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  104. <aside class="tsd-sources">
  105. </aside>
  106. </section>
  107. </section>
  108. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  109. <h2>Methods</h2>
  110. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external">
  111. <a name="init" class="tsd-anchor"></a>
  112. <h3>init</h3>
  113. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
  114. <li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="../classes/stream.html" class="tsd-signature-type">Stream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
  115. </ul>
  116. <ul class="tsd-descriptions">
  117. <li class="tsd-description">
  118. <aside class="tsd-sources">
  119. </aside>
  120. <h4 class="tsd-parameters-title">Parameters</h4>
  121. <ul class="tsd-parameters">
  122. <li>
  123. <h5>stream: <a href="../classes/stream.html" class="tsd-signature-type">Stream</a></h5>
  124. </li>
  125. </ul>
  126. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
  127. </li>
  128. </ul>
  129. </section>
  130. </section>
  131. </div>
  132. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  133. <nav class="tsd-navigation primary">
  134. <ul>
  135. <li class="globals ">
  136. <a href="../index.html"><em>Globals</em></a>
  137. </li>
  138. </ul>
  139. </nav>
  140. <nav class="tsd-navigation secondary menu-sticky">
  141. <ul class="before-current">
  142. </ul>
  143. <ul class="current">
  144. <li class="current tsd-kind-interface tsd-is-external">
  145. <a href="streamplugin.html" class="tsd-kind-icon">Stream<wbr>Plugin</a>
  146. <ul>
  147. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
  148. <a href="streamplugin.html#name" class="tsd-kind-icon">name</a>
  149. </li>
  150. <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
  151. <a href="streamplugin.html#init" class="tsd-kind-icon">init</a>
  152. </li>
  153. </ul>
  154. </li>
  155. </ul>
  156. <ul class="after-current">
  157. </ul>
  158. </nav>
  159. </div>
  160. </div>
  161. </div>
  162. <footer class="with-border-bottom">
  163. <div class="container">
  164. <h2>Legend</h2>
  165. <div class="tsd-legend-group">
  166. </div>
  167. </div>
  168. </footer>
  169. <div class="container tsd-generator">
  170. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  171. </div>
  172. <div class="overlay"></div>
  173. <script src="../assets/js/main.js"></script>
  174. </body>
  175. </html>