@vonage/media-processor 1.2.7 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/dist/docs/assets/highlight.css +13 -27
  2. package/dist/docs/assets/main.js +2 -2
  3. package/dist/docs/assets/search.js +1 -1
  4. package/dist/docs/assets/style.css +3 -2
  5. package/dist/docs/classes/MediaProcessor.html +51 -43
  6. package/dist/docs/classes/MediaProcessorConnector.html +12 -12
  7. package/dist/docs/enums/ErrorFunction.html +9 -0
  8. package/dist/docs/enums/PipelineInfoData.html +19 -0
  9. package/dist/docs/enums/VonageSourceType.html +5 -0
  10. package/dist/docs/enums/WarningType.html +5 -0
  11. package/dist/docs/index.html +2 -2
  12. package/dist/docs/interfaces/MediaProcessorConnectorInterface.html +4 -10
  13. package/dist/docs/interfaces/MediaProcessorInterface.html +17 -7
  14. package/dist/docs/modules.html +42 -35
  15. package/dist/media-processor.es.js +684 -1943
  16. package/dist/media-processor.min.js +1 -0
  17. package/dist/media-processor.static.js +832 -0
  18. package/dist/media-processor.umd.js +2 -3
  19. package/dist/types/lib/main.d.ts +10 -0
  20. package/dist/types/{src → lib/src}/core/InsertableStreamHelper.d.ts +0 -0
  21. package/dist/types/{src → lib/src}/core/MediaProcessor.d.ts +20 -15
  22. package/dist/types/lib/src/core/MediaProcessorConnector.d.ts +39 -0
  23. package/dist/types/{src → lib/src}/core/MediaProcessorConnectorInterface.d.ts +4 -1
  24. package/dist/types/lib/src/core/MediaProcessorInterface.d.ts +23 -0
  25. package/dist/types/lib/src/core/pipeline.d.ts +166 -0
  26. package/dist/types/{src → lib/src}/telemetry/Key.d.ts +0 -0
  27. package/dist/types/lib/src/telemetry/QosReporter.d.ts +22 -0
  28. package/dist/types/{src → lib/src}/utils/Tools.d.ts +0 -0
  29. package/dist/types/{src → lib/src}/utils/package-json.d.ts +0 -0
  30. package/dist/types/{src → lib/src}/utils/utils.d.ts +0 -0
  31. package/package.json +72 -62
  32. package/dist/types/main.d.ts +0 -9
  33. package/dist/types/src/core/MediaProcessorConnector.d.ts +0 -79
  34. package/dist/types/src/core/MediaProcessorInterface.d.ts +0 -16
  35. package/dist/types/src/core/pipeline.d.ts +0 -116
  36. package/dist/types/src/telemetry/Reporter.d.ts +0 -80
package/dist/docs/classes/MediaProcessorConnector.html CHANGED
@@ -1,12 +1,12 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MediaProcessorConnector | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="MediaProcessorConnector.html">MediaProcessorConnector</a></li></ul><h1>Class MediaProcessorConnector</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">
2
- <p>Helper class implementing the media processor connector interface.</p>
3
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0"> </span><span class="hl-6">let</span><span class="hl-0"> </span><span class="hl-5">mediaProcessor</span><span class="hl-0">: </span><span class="hl-8">MediaProcessor</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">MediaProcessor</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-6">let</span><span class="hl-0"> </span><span class="hl-5">transformers</span><span class="hl-0">: </span><span class="hl-8">Array</span><span class="hl-0">&lt;</span><span class="hl-8">Transformer</span><span class="hl-0">&gt; = [];</span><br/><span class="hl-0"> </span><span class="hl-5">transformers</span><span class="hl-0">.</span><span class="hl-4">push</span><span class="hl-0">(</span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">CanvasTransform</span><span class="hl-0">());</span><br/><span class="hl-0"> </span><span class="hl-5">mediaProcessor</span><span class="hl-0">.</span><span class="hl-4">setTransformers</span><span class="hl-0">(</span><span class="hl-5">transformers</span><span class="hl-0">);</span><br/><br/><span class="hl-0"> </span><span class="hl-6">let</span><span class="hl-0"> </span><span class="hl-5">connector</span><span class="hl-0">: </span><span class="hl-8">MediaProcessorConnector</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">MediaProcessorConnector</span><span class="hl-0">(</span><span class="hl-5">mediaProcessor</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">source_</span><span class="hl-0">.</span><span class="hl-4">setMediaProcessorConnector</span><span class="hl-0">(</span><span class="hl-5">connector</span><span class="hl-0">);</span><br/><br/><span class="hl-0"> </span><span class="hl-10">// ...</span><br/><br/><span class="hl-0"> </span><span class="hl-4">setMediaProcessorConnector</span><span class="hl-0">(</span><span class="hl-5">mediaProcessorConnector</span><span class="hl-0">: </span><span class="hl-5">MediaProcessorConnectorInterface</span><span class="hl-0">): </span><span class="hl-8">Promise</span><span class="hl-0">&lt;</span><span class="hl-6">void</span><span class="hl-0">&gt; {</span><br/><span class="hl-0"> return new </span><span class="hl-4">Promise</span><span class="hl-0">&lt;</span><span class="hl-8">void</span><span class="hl-0">&gt;(</span><span class="hl-5">async</span><span class="hl-0"> (</span><span class="hl-5">resolve</span><span class="hl-0">, </span><span class="hl-5">reject</span><span class="hl-0">) </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-8">this</span><span class="hl-0">.</span><span class="hl-5">mediaProcessorConnector_</span><span class="hl-0"> = </span><span class="hl-5">mediaProcessorConnector</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-4">if</span><span class="hl-0"> (!this.stream_)</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-8">console</span><span class="hl-0">.</span><span class="hl-8">log</span><span class="hl-0">(</span><span class="hl-3">&#39;[CameraSource] Requesting camera.&#39;</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-4">reject</span><span class="hl-0">(</span><span class="hl-3">&quot;no stream&quot;</span><span class="hl-0">)</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-8">this</span><span class="hl-0">.</span><span class="hl-8">mediaProcessorConnector_</span><span class="hl-0">.</span><span class="hl-8">setTrack</span><span class="hl-0">(</span><span class="hl-8">this</span><span class="hl-0">.</span><span class="hl-8">videoTrack_</span><span class="hl-0">).</span><span class="hl-8">then</span><span class="hl-0">(</span><span class="hl-5">newTrack</span><span class="hl-0"> =&gt; {</span><br/><span class="hl-0"> let </span><span class="hl-5">processedStream</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">MediaStream</span><span class="hl-0">();</span><br/><span class="hl-0"> processedStream.addTrack(newTrack);</span><br/><span class="hl-0"> this.sink_.setMediaStream(processedStream);</span><br/><span class="hl-0"> </span><span class="hl-4">resolve</span><span class="hl-0">();</span><br/><span class="hl-0"> })</span><br/><span class="hl-0"> .</span><span class="hl-8">catch</span><span class="hl-0">(</span><span class="hl-5">e</span><span class="hl-0"> =&gt; {</span><br/><span class="hl-0"> </span><span class="hl-4">reject</span><span class="hl-0">(</span><span class="hl-5">e</span><span class="hl-0">)</span><br/><span class="hl-0"> })</span><br/><span class="hl-0"> });</span><br/><span class="hl-0"> }</span><br/><br/><span class="hl-0"> </span><span class="hl-10">// ...</span><br/><br/><span class="hl-0"> </span><span class="hl-5">async</span><span class="hl-0"> </span><span class="hl-4">stopMediaProcessorConnector</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0">(</span><span class="hl-6">this</span><span class="hl-0">.</span><span class="hl-5">mediaProcessorConnector_</span><span class="hl-0">){</span><br/><span class="hl-0"> </span><span class="hl-6">this</span><span class="hl-0">.</span><span class="hl-5">mediaProcessorConnector_</span><span class="hl-0">.</span><span class="hl-4">destroy</span><span class="hl-0">().</span><span class="hl-4">then</span><span class="hl-0">(() </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-6">let</span><span class="hl-0"> </span><span class="hl-5">processedStream</span><span class="hl-0"> = </span><span class="hl-6">new</span><span class="hl-0"> </span><span class="hl-4">MediaStream</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-5">processedStream</span><span class="hl-0">.</span><span class="hl-4">addTrack</span><span class="hl-0">(</span><span class="hl-6">this</span><span class="hl-0">.</span><span class="hl-5">videoTrack_</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-6">this</span><span class="hl-0">.</span><span class="hl-5">sink_</span><span class="hl-0">.</span><span class="hl-4">setMediaStream</span><span class="hl-0">(</span><span class="hl-5">processedStream</span><span class="hl-0">);</span><br/><span class="hl-0"> })</span><br/><span class="hl-0"> .</span><span class="hl-4">catch</span><span class="hl-0">(</span><span class="hl-5">e</span><span class="hl-0"> </span><span class="hl-6">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">error</span><span class="hl-0">(</span><span class="hl-5">e</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> }</span>
4
- </code></pre>
5
- </dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MediaProcessorConnector</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/MediaProcessorConnectorInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">MediaProcessorConnectorInterface</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MediaProcessorConnector.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessorConnector.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessorConnector.html#setTrack" class="tsd-kind-icon">set<wbr/>Track</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Media<wbr/>Processor<wbr/>Connector<span class="tsd-signature-symbol">(</span>vonageMediaProcessor<span class="tsd-signature-symbol">: </span><a href="../interfaces/MediaProcessorInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">MediaProcessorInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MediaProcessorConnector.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessorConnector</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vonageMediaProcessor: <a href="../interfaces/MediaProcessorInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">MediaProcessorInterface</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="MediaProcessorConnector.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessorConnector</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">destroy<a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/MediaProcessorConnectorInterface.html">MediaProcessorConnectorInterface</a>.<a href="../interfaces/MediaProcessorConnectorInterface.html#destroy">destroy</a></p></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>Stops the media processing being performed.</p>
7
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setTrack" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Track<a href="#setTrack" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Track<span class="tsd-signature-symbol">(</span>track<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/MediaProcessorConnectorInterface.html">MediaProcessorConnectorInterface</a>.<a href="../interfaces/MediaProcessorConnectorInterface.html#setTrack">setTrack</a></p></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
- <p>Sets the media stream track instance to be processed.</p>
9
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
10
- <p>MeadiaStreamTrack (audio or video) to be processed.</p>
11
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>Promise<MediaStreamTrack> MeadiaStreamTrack instance already processed.</p>
12
- </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="MediaProcessorConnector.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MediaProcessorConnector.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessorConnector.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MediaProcessorConnector.html#setTrack" class="tsd-kind-icon">set<wbr/>Track</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MediaProcessorConnector | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="MediaProcessorConnector.html">MediaProcessorConnector</a></li></ul><h1>Class MediaProcessorConnector </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">
2
+ <p>Helper class implementing the media Media Processor Connector Interface.
3
+ This class should always be created on the application main thread and it should be used by Vonage SDKs.
4
+ An example can be found <a href="/docs/intro.md#using-the-transformer-on-main-process">here</a>.</p>
5
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MediaProcessorConnector</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/MediaProcessorConnectorInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">MediaProcessorConnectorInterface</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MediaProcessorConnector.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Media<wbr/>Processor<wbr/>Connector<span class="tsd-signature-symbol">(</span>vonageMediaProcessor<span class="tsd-signature-symbol">: </span><a href="../interfaces/MediaProcessorInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">MediaProcessorInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MediaProcessorConnector.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessorConnector</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <ul>
7
+ <li>When running insertable streams on the main <code>MediaProcessorInterface</code> should be instance of <code>MediaProcessor</code> class.</li>
8
+ <li>When running insertable streams on WebWorker <code>MediaProcessorInterface</code> should be instance of bridge calss created by the user. Example can be found <a href="/docs/intro.md#using-the-transformer-on-webworker">here</a></li>
9
+ </ul>
10
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vonageMediaProcessor: <a href="../interfaces/MediaProcessorInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">MediaProcessorInterface</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>MediaProcessorInterface.</p>
12
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="MediaProcessorConnector.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessorConnector</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="MediaProcessorConnector.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MediaProcessorConnector.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/enums/ErrorFunction.html ADDED
@@ -0,0 +1,9 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ErrorFunction | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="ErrorFunction.html">ErrorFunction</a></li></ul><h1>Enumeration ErrorFunction </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">
2
+ <p>ErrorFunction. It specifies the transformer function in which the error occurred.</p>
3
+ </div></div></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>Enumeration Members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ErrorFunction.html#flush" class="tsd-kind-icon">flush</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ErrorFunction.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ErrorFunction.html#transform" class="tsd-kind-icon">transform</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration Members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="flush" class="tsd-anchor"></a><h3 class="tsd-anchor-link">flush<a href="#flush" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">flush<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;flush&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>flush function exception.</p>
5
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link">start<a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;start&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>start function exception.</p>
7
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="transform" class="tsd-anchor"></a><h3 class="tsd-anchor-link">transform<a href="#transform" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">transform<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;transform&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>transform function exception.</p>
9
+ </div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="ErrorFunction.html" class="tsd-kind-icon">Error<wbr/>Function</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ErrorFunction.html#flush" class="tsd-kind-icon">flush</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ErrorFunction.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="ErrorFunction.html#transform" class="tsd-kind-icon">transform</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/enums/PipelineInfoData.html ADDED
@@ -0,0 +1,19 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PipelineInfoData | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="PipelineInfoData.html">PipelineInfoData</a></li></ul><h1>Enumeration PipelineInfoData </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">
2
+ <p>PipelineInfolData. Life cycle information of insertable streams pipeline.</p>
3
+ </div></div></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>Enumeration Members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_ended" class="tsd-kind-icon">pipeline_<wbr/>ended</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_ended_with_error" class="tsd-kind-icon">pipeline_<wbr/>ended_<wbr/>with_<wbr/>error</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_restarted" class="tsd-kind-icon">pipeline_<wbr/>restarted</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_restarted_with_error" class="tsd-kind-icon">pipeline_<wbr/>restarted_<wbr/>with_<wbr/>error</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_started" class="tsd-kind-icon">pipeline_<wbr/>started</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_started_with_error" class="tsd-kind-icon">pipeline_<wbr/>started_<wbr/>with_<wbr/>error</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration Members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="pipeline_ended" class="tsd-anchor"></a><h3 class="tsd-anchor-link">pipeline_<wbr/>ended<a href="#pipeline_ended" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">pipeline_<wbr/>ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pipeline_ended&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>Notify the app that the pipeline has ended.</p>
5
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="pipeline_ended_with_error" class="tsd-anchor"></a><h3 class="tsd-anchor-link">pipeline_<wbr/>ended_<wbr/>with_<wbr/>error<a href="#pipeline_ended_with_error" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">pipeline_<wbr/>ended_<wbr/>with_<wbr/>error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pipeline_ended_with_error&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>Notify the app that the pipeline has ended with an error.</p>
7
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="pipeline_restarted" class="tsd-anchor"></a><h3 class="tsd-anchor-link">pipeline_<wbr/>restarted<a href="#pipeline_restarted" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">pipeline_<wbr/>restarted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pipeline_restarted&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>Notify the app that the pipeline has restarted.
9
+ This message is fired after changing track in the middle of the process.
10
+ For example switching camera source.</p>
11
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="pipeline_restarted_with_error" class="tsd-anchor"></a><h3 class="tsd-anchor-link">pipeline_<wbr/>restarted_<wbr/>with_<wbr/>error<a href="#pipeline_restarted_with_error" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">pipeline_<wbr/>restarted_<wbr/>with_<wbr/>error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pipeline_restarted_with_error&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
12
+ <p>Notify the app that the pipeline has restarted with an error.
13
+ This message is fired after changing track in the middle of the process.
14
+ For example switching camera source.</p>
15
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="pipeline_started" class="tsd-anchor"></a><h3 class="tsd-anchor-link">pipeline_<wbr/>started<a href="#pipeline_started" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">pipeline_<wbr/>started<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pipeline_started&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
16
+ <p>Notify the app that the pipeline has started.</p>
17
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="pipeline_started_with_error" class="tsd-anchor"></a><h3 class="tsd-anchor-link">pipeline_<wbr/>started_<wbr/>with_<wbr/>error<a href="#pipeline_started_with_error" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">pipeline_<wbr/>started_<wbr/>with_<wbr/>error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;pipeline_started_with_error&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
18
+ <p>Notify the app that the pipeline has started with an error.</p>
19
+ </div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="PipelineInfoData.html" class="tsd-kind-icon">Pipeline<wbr/>Info<wbr/>Data</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_ended" class="tsd-kind-icon">pipeline_<wbr/>ended</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_ended_with_error" class="tsd-kind-icon">pipeline_<wbr/>ended_<wbr/>with_<wbr/>error</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_restarted" class="tsd-kind-icon">pipeline_<wbr/>restarted</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_restarted_with_error" class="tsd-kind-icon">pipeline_<wbr/>restarted_<wbr/>with_<wbr/>error</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_started" class="tsd-kind-icon">pipeline_<wbr/>started</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PipelineInfoData.html#pipeline_started_with_error" class="tsd-kind-icon">pipeline_<wbr/>started_<wbr/>with_<wbr/>error</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/enums/VonageSourceType.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VonageSourceType | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="VonageSourceType.html">VonageSourceType</a></li></ul><h1>Enumeration VonageSourceType </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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-external"><h3>Enumeration Members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="VonageSourceType.html#video" class="tsd-kind-icon">video</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="VonageSourceType.html#voice" class="tsd-kind-icon">voice</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a id="video" class="tsd-anchor"></a><h3 class="tsd-anchor-link">video<a href="#video" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">video<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;video&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>For Vonage Video SDK users.</p>
3
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a id="voice" class="tsd-anchor"></a><h3 class="tsd-anchor-link">voice<a href="#voice" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">voice<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;voice&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>For Vonage Voice SDK users.</p>
5
+ </div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-is-external"><a href="VonageSourceType.html" class="tsd-kind-icon">Vonage<wbr/>Source<wbr/>Type</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="VonageSourceType.html#video" class="tsd-kind-icon">video</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="VonageSourceType.html#voice" class="tsd-kind-icon">voice</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/enums/WarningType.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WarningType | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="WarningType.html">WarningType</a></li></ul><h1>Enumeration WarningType </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">
2
+ <p>WarningType specifies the type of warning from the transformer</p>
3
+ </div></div></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>Enumeration Members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="WarningType.html#FPS_DROP" class="tsd-kind-icon">FPS_<wbr/>DROP</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration Members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FPS_DROP" class="tsd-anchor"></a><h3 class="tsd-anchor-link">FPS_<wbr/>DROP<a href="#FPS_DROP" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">FPS_<wbr/>DROP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fps_drop&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>Warning about change in process rate</p>
5
+ </div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="WarningType.html" class="tsd-kind-icon">Warning<wbr/>Type</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="WarningType.html#FPS_DROP" class="tsd-kind-icon">FPS_<wbr/>DROP</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/index.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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"><h1>@vonage/media-processor</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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"><h1>@vonage/media-processor </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
2
2
  <a href="#vonage-media-processor" id="vonage-media-processor" style="color: inherit; text-decoration: none;">
3
3
  <h1>Vonage Media Processor</h1>
4
4
  </a>
@@ -13,4 +13,4 @@
13
13
  </a>
14
14
  <p>Docs: Check out <a href="https://vonage.github.io/media-processor-docs">https://vonage.github.io/media-processor-docs</a>
15
15
  Examples: Check out <a href="https://github.com/Vonage/vonage-media-transformers-samples">https://github.com/Vonage/vonage-media-transformers-samples</a></p>
16
- </div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/MediaProcessor.html" class="tsd-kind-icon">Media<wbr/>Processor</a></li><li class="tsd-kind-class"><a href="classes/MediaProcessorConnector.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector</a></li><li class="tsd-kind-interface"><a href="interfaces/MediaProcessorConnectorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/MediaProcessorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Interface</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ErrorData" class="tsd-kind-icon">Error<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ErrorFunction" class="tsd-kind-icon">Error<wbr/>Function</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventDataMap" class="tsd-kind-icon">Event<wbr/>Data<wbr/>Map</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventMetaData" class="tsd-kind-icon">Event<wbr/>Meta<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PipelineInfoData" class="tsd-kind-icon">Pipeline<wbr/>Info<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VonageMetadata" class="tsd-kind-icon">Vonage<wbr/>Metadata</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VonageSourceType" class="tsd-kind-icon">Vonage<wbr/>Source<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WarnData" class="tsd-kind-icon">Warn<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getVonageMetadata" class="tsd-kind-icon">get<wbr/>Vonage<wbr/>Metadata</a></li><li class="tsd-kind-function"><a href="modules.html#isSupported" class="tsd-kind-icon">is<wbr/>Supported</a></li><li class="tsd-kind-function"><a href="modules.html#setVonageMetadata" class="tsd-kind-icon">set<wbr/>Vonage<wbr/>Metadata</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
16
+ </div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum"><a href="enums/ErrorFunction.html" class="tsd-kind-icon">Error<wbr/>Function</a></li><li class="tsd-kind-enum"><a href="enums/PipelineInfoData.html" class="tsd-kind-icon">Pipeline<wbr/>Info<wbr/>Data</a></li><li class="tsd-kind-enum tsd-is-external"><a href="enums/VonageSourceType.html" class="tsd-kind-icon">Vonage<wbr/>Source<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/WarningType.html" class="tsd-kind-icon">Warning<wbr/>Type</a></li><li class="tsd-kind-class"><a href="classes/MediaProcessor.html" class="tsd-kind-icon">Media<wbr/>Processor</a></li><li class="tsd-kind-class"><a href="classes/MediaProcessorConnector.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector</a></li><li class="tsd-kind-interface"><a href="interfaces/MediaProcessorConnectorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/MediaProcessorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Interface</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DropInfo" class="tsd-kind-icon">Drop<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ErrorData" class="tsd-kind-icon">Error<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventDataMap" class="tsd-kind-icon">Event<wbr/>Data<wbr/>Map</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventMetaData" class="tsd-kind-icon">Event<wbr/>Meta<wbr/>Data</a></li><li class="tsd-kind-type-alias tsd-is-external"><a href="modules.html#VonageMetadata" class="tsd-kind-icon">Vonage<wbr/>Metadata</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WarnData" class="tsd-kind-icon">Warn<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#isSupported" class="tsd-kind-icon">is<wbr/>Supported</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#setVonageMetadata" class="tsd-kind-icon">set<wbr/>Vonage<wbr/>Metadata</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
package/dist/docs/interfaces/MediaProcessorConnectorInterface.html CHANGED
@@ -1,10 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MediaProcessorConnectorInterface | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="MediaProcessorConnectorInterface.html">MediaProcessorConnectorInterface</a></li></ul><h1>Interface MediaProcessorConnectorInterface</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">
2
- <p>Interface definition for media processor connector instances.</p>
3
- </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MediaProcessorConnectorInterface</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/MediaProcessorConnector.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessorConnector</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorConnectorInterface.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorConnectorInterface.html#setTrack" class="tsd-kind-icon">set<wbr/>Track</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">destroy<a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
4
- <p>Stops the media processing being performed.</p>
5
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="setTrack" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Track<a href="#setTrack" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Track<span class="tsd-signature-symbol">(</span>track<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>Sets the media stream track instance to be processed.</p>
7
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>track: <span class="tsd-signature-type">MediaStreamTrack</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
8
- <p>MeadiaStreamTrack (audio or video) to be processed.</p>
9
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>Promise<MediaStreamTrack> MeadiaStreamTrack instance already processed.</p>
10
- </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="MediaProcessorConnectorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector<wbr/>Interface</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorConnectorInterface.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorConnectorInterface.html#setTrack" class="tsd-kind-icon">set<wbr/>Track</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MediaProcessorConnectorInterface | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="MediaProcessorConnectorInterface.html">MediaProcessorConnectorInterface</a></li></ul><h1>Interface MediaProcessorConnectorInterface </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">
2
+ <p>Interface definition for media processor connector instances.
3
+ This interface is used for the integration for this library with the Vonage SDKs.</p>
4
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MediaProcessorConnectorInterface</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/MediaProcessorConnector.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessorConnector</a></li></ul></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="MediaProcessorConnectorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector<wbr/>Interface</a><ul></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/interfaces/MediaProcessorInterface.html CHANGED
@@ -1,11 +1,21 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MediaProcessorInterface | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="MediaProcessorInterface.html">MediaProcessorInterface</a></li></ul><h1>Interface MediaProcessorInterface</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">
2
- <p>Interface definition for media processor instances.</p>
3
- </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MediaProcessorInterface</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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorInterface.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorInterface.html#transform" class="tsd-kind-icon">transform</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">destroy<a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
4
- <p>Stops running the tranformation logic performed by the media processor instance.</p>
5
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="transform" class="tsd-anchor"></a><h3 class="tsd-anchor-link">transform<a href="#transform" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">transform<span class="tsd-signature-symbol">(</span>readable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>, writable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">WritableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>Starts running the tranformation logic performed by the media processor instance.</p>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MediaProcessorInterface | @vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vonage/media-processor</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></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="../modules.html">@vonage/media-processor</a></li><li><a href="MediaProcessorInterface.html">MediaProcessorInterface</a></li></ul><h1>Interface MediaProcessorInterface </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">
2
+ <p>Interface definition for media processor instances.
3
+ When using Web workers the application should define and use a bridge class that implements this interface.
4
+ See an example of using the library this way <a href="/docs/intro.md#library-usage">here</a>.</p>
5
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MediaProcessorInterface</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/MediaProcessor.html" class="tsd-signature-type" data-tsd-kind="Class">MediaProcessor</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorInterface.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorInterface.html#transform" class="tsd-kind-icon">transform</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">destroy<a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>Stops running the tranformation logic performed by the media processor instance.
7
+ In case of using a Web worker the method should post a message to the Worker with the destroy message.</p>
8
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div><ul>
9
+ <li>In case of using a Web worker the promise should be completed only after the worker was completed.</li>
10
+ </ul>
11
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="transform" class="tsd-anchor"></a><h3 class="tsd-anchor-link">transform<a href="#transform" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">transform<span class="tsd-signature-symbol">(</span>readable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>, writable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">WritableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
12
+ <p>Starts running the tranformation logic performed by the media processor instance.
13
+ In case of bridging to WebWorker the function should post message to the Worker with the <code>readable</code> and <code>writable</code>.</p>
7
14
  </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>readable: <span class="tsd-signature-type">ReadableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
8
15
  <p>Readable stream associated to the media source being processed.</p>
9
16
  </div></div></li><li><h5>writable: <span class="tsd-signature-type">WritableStream</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
10
17
  <p>Writable stream associated to the resulting media once processed.</p>
11
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="MediaProcessorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Interface</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorInterface.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorInterface.html#transform" class="tsd-kind-icon">transform</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
18
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div><ul>
19
+ <li>In case of using a Web worker the promise should be completed only after the worker was completed.</li>
20
+ </ul>
21
+ </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="MediaProcessorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Interface</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorInterface.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="MediaProcessorInterface.html#transform" class="tsd-kind-icon">transform</a></li></ul></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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>