@vonage/ml-transformers 1.3.1 → 2.0.2

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 (41) hide show
  1. package/README.md +3 -1
  2. package/dist/docs/assets/highlight.css +11 -4
  3. package/dist/docs/assets/main.js +2 -2
  4. package/dist/docs/assets/search.js +1 -1
  5. package/dist/docs/assets/style.css +3 -2
  6. package/dist/docs/classes/MediapipeHelper.html +1 -0
  7. package/dist/docs/enums/BlurRadius.html +4 -4
  8. package/dist/docs/index.html +4 -3
  9. package/dist/docs/interfaces/FaceDetectionOptions.html +3 -0
  10. package/dist/docs/interfaces/FaceDetectionResults.html +3 -0
  11. package/dist/docs/interfaces/FaceMeshOptions.html +3 -0
  12. package/dist/docs/interfaces/FaceMeshResults.html +3 -0
  13. package/dist/docs/interfaces/HandsOptions.html +3 -0
  14. package/dist/docs/interfaces/HandsResults.html +3 -0
  15. package/dist/docs/interfaces/HolisticOptions.html +3 -0
  16. package/dist/docs/interfaces/HolisticResults.html +3 -0
  17. package/dist/docs/interfaces/ObjectronOptions.html +3 -0
  18. package/dist/docs/interfaces/ObjectronResults.html +3 -0
  19. package/dist/docs/interfaces/PoseOptions.html +3 -0
  20. package/dist/docs/interfaces/PoseResults.html +3 -0
  21. package/dist/docs/interfaces/SelfieSegmentationOptions.html +3 -0
  22. package/dist/docs/interfaces/SelfieSegmentationResults.html +3 -0
  23. package/dist/docs/modules.html +76 -12
  24. package/dist/ml-transformers.es.js +500 -82
  25. package/dist/ml-transformers.umd.js +4 -4
  26. package/dist/types/main.d.ts +28 -12
  27. package/dist/types/src/transformers/BackgroundTransformer.d.ts +19 -17
  28. package/dist/types/src/transformers/BlurPostProcess.d.ts +1 -0
  29. package/dist/types/src/transformers/MediapipeHelper.d.ts +12 -0
  30. package/dist/types/src/transformers/PostProcessInterface.d.ts +1 -0
  31. package/dist/types/src/transformers/SilueteBlurPostProcess.d.ts +1 -0
  32. package/dist/types/src/transformers/VideoPostProcess.d.ts +8 -5
  33. package/dist/types/src/transformers/VirtualPostProcess.d.ts +5 -5
  34. package/dist/types/src/types.d.ts +71 -17
  35. package/dist/types/src/vonage/VonageAssetsLoaderHelper.d.ts +5 -0
  36. package/dist/types/src/vonage/VonageMediaProcessorThread.d.ts +3 -2
  37. package/dist/types/src/vonage/VonageMediaProcessorWorker.d.ts +16 -5
  38. package/package.json +12 -4
  39. package/dist/models/selfie_segmentation_landscape.tflite +0 -0
  40. package/dist/tflite-simd.wasm +0 -0
  41. package/dist/types/src/transformers/VonageTFLite.d.ts +0 -28
@@ -1,30 +1,94 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@vonage/ml-transformers</title><meta name="description" content="Documentation for @vonage/ml-transformers"/><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/ml-transformers</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/ml-transformers</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 "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum"><a href="enums/BlurRadius.html" class="tsd-kind-icon">Blur<wbr/>Radius</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#AssetBackgroundConfig" class="tsd-kind-icon">Asset<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BackgroundBlurConfig" class="tsd-kind-icon">Background<wbr/>Blur<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaProcessorBaseConfig" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Base<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaProcessorConfig" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SilueteBlurConfig" class="tsd-kind-icon">Siluete<wbr/>Blur<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VideoBackgroundConfig" class="tsd-kind-icon">Video<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VirtualBackgroundConfig" class="tsd-kind-icon">Virtual<wbr/>Background<wbr/>Config</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#createVonageMediaProcessorConnector" class="tsd-kind-icon">create<wbr/>Vonage<wbr/>Media<wbr/>Processor<wbr/>Connector</a></li><li class="tsd-kind-function"><a href="modules.html#getVonageEventEmitter" class="tsd-kind-icon">get<wbr/>Vonage<wbr/>Event<wbr/>Emitter</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#setTrackExpectedRate" class="tsd-kind-icon">set<wbr/>Track<wbr/>Expected<wbr/>Rate</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="AssetBackgroundConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Asset<wbr/>Background<wbr/>Config<a href="#AssetBackgroundConfig" 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">Asset<wbr/>Background<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>backgroundAssetUri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@vonage/ml-transformers</title><meta name="description" content="Documentation for @vonage/ml-transformers"/><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/ml-transformers</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/ml-transformers </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 "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum"><a href="enums/BlurRadius.html" class="tsd-kind-icon">Blur<wbr/>Radius</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/MediapipeHelper.html" class="tsd-kind-icon">Mediapipe<wbr/>Helper</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/FaceDetectionOptions.html" class="tsd-kind-icon">Face<wbr/>Detection<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/FaceDetectionResults.html" class="tsd-kind-icon">Face<wbr/>Detection<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/FaceMeshOptions.html" class="tsd-kind-icon">Face<wbr/>Mesh<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/FaceMeshResults.html" class="tsd-kind-icon">Face<wbr/>Mesh<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/HandsOptions.html" class="tsd-kind-icon">Hands<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/HandsResults.html" class="tsd-kind-icon">Hands<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/HolisticOptions.html" class="tsd-kind-icon">Holistic<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/HolisticResults.html" class="tsd-kind-icon">Holistic<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/ObjectronOptions.html" class="tsd-kind-icon">Objectron<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/ObjectronResults.html" class="tsd-kind-icon">Objectron<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/PoseOptions.html" class="tsd-kind-icon">Pose<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/PoseResults.html" class="tsd-kind-icon">Pose<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/SelfieSegmentationOptions.html" class="tsd-kind-icon">Selfie<wbr/>Segmentation<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/SelfieSegmentationResults.html" class="tsd-kind-icon">Selfie<wbr/>Segmentation<wbr/>Results</a></li></ul></section><section class="tsd-index-section "><h3>Type Aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#AssetBackgroundConfig" class="tsd-kind-icon">Asset<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BackgroundBlurConfig" class="tsd-kind-icon">Background<wbr/>Blur<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BackgroundOptions" class="tsd-kind-icon">Background<wbr/>Options</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaPipeModelConfig" class="tsd-kind-icon">Media<wbr/>Pipe<wbr/>Model<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaPipeModelType" class="tsd-kind-icon">Media<wbr/>Pipe<wbr/>Model<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaPipeResults" class="tsd-kind-icon">Media<wbr/>Pipe<wbr/>Results</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaPipeResultsListener" class="tsd-kind-icon">Media<wbr/>Pipe<wbr/>Results<wbr/>Listener</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaProcessorBaseConfig" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Base<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaProcessorConfig" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediapipeConfig" class="tsd-kind-icon">Mediapipe<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SilueteBlurConfig" class="tsd-kind-icon">Siluete<wbr/>Blur<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VideoBackgroundConfig" class="tsd-kind-icon">Video<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VirtualBackgroundConfig" class="tsd-kind-icon">Virtual<wbr/>Background<wbr/>Config</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#createVonageMediaProcessorConnector" class="tsd-kind-icon">create<wbr/>Vonage<wbr/>Media<wbr/>Processor<wbr/>Connector</a></li><li class="tsd-kind-function"><a href="modules.html#getVonageEventEmitter" class="tsd-kind-icon">get<wbr/>Vonage<wbr/>Event<wbr/>Emitter</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#setBackgroundOptions" class="tsd-kind-icon">set<wbr/>Background<wbr/>Options</a></li><li class="tsd-kind-function"><a href="modules.html#setTrackExpectedRate" class="tsd-kind-icon">set<wbr/>Track<wbr/>Expected<wbr/>Rate</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type Aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="AssetBackgroundConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Asset<wbr/>Background<wbr/>Config<a href="#AssetBackgroundConfig" 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">Asset<wbr/>Background<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>backgroundAssetUri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>AssetBackgroundConfig specifies the absolute URL to the image or video file used for background replacement.</p>
3
3
  </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>background<wbr/>Asset<wbr/>Uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="BackgroundBlurConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Background<wbr/>Blur<wbr/>Config<a href="#BackgroundBlurConfig" 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">Background<wbr/>Blur<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>radius<span class="tsd-signature-symbol">?: </span><a href="enums/BlurRadius.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BlurRadius</a><span class="tsd-signature-symbol">; </span>transformerType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;BackgroundBlur&quot;</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
4
4
  <p>BackgroundBlurConfig specifies the configuration for a transformer logic that performs background blurring.</p>
5
- </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> radius<span class="tsd-signature-symbol">?: </span><a href="enums/BlurRadius.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BlurRadius</a></h5></li><li class="tsd-parameter"><h5>transformer<wbr/>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;BackgroundBlur&quot;</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MediaProcessorBaseConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Media<wbr/>Processor<wbr/>Base<wbr/>Config<a href="#MediaProcessorBaseConfig" 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">Media<wbr/>Processor<wbr/>Base<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>tfliteAssetUriPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>wasmAssetUriPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>MediaProcessorBaseConfig specifies the absolute URL for the path where the Wasm modules used by the transformers from this library are stored.</p>
7
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0">{</span><br/><span class="hl-0"> </span><span class="hl-1">wasmAssetUriPath</span><span class="hl-0">: </span><span class="hl-2">&#39;http://localhost:8080/assets&#39;</span><br/><span class="hl-0"> </span><span class="hl-1">tfliteAssetUriPath</span><span class="hl-0">: </span><span class="hl-2">&#39;http://localhost:8080/assets&#39;</span><br/><span class="hl-0">}</span>
5
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> radius<span class="tsd-signature-symbol">?: </span><a href="enums/BlurRadius.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BlurRadius</a></h5></li><li class="tsd-parameter"><h5>transformer<wbr/>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;BackgroundBlur&quot;</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="BackgroundOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Background<wbr/>Options<a href="#BackgroundOptions" 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">Background<wbr/>Options<span class="tsd-signature-symbol">:</span> <a href="modules.html#BackgroundBlurConfig" class="tsd-signature-type" data-tsd-kind="Type alias">BackgroundBlurConfig</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><a href="modules.html#VirtualBackgroundConfig" class="tsd-signature-type" data-tsd-kind="Type alias">VirtualBackgroundConfig</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#VideoBackgroundConfig" class="tsd-signature-type" data-tsd-kind="Type alias">VideoBackgroundConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><a href="modules.html#AssetBackgroundConfig" class="tsd-signature-type" data-tsd-kind="Type alias">AssetBackgroundConfig</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#SilueteBlurConfig" class="tsd-signature-type" data-tsd-kind="Type alias">SilueteBlurConfig</a></div><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>BackgroundOptions background options</p>
7
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MediaPipeModelConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Media<wbr/>Pipe<wbr/>Model<wbr/>Config<a href="#MediaPipeModelConfig" 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">Media<wbr/>Pipe<wbr/>Model<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>assetsUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>listener<span class="tsd-signature-symbol">: </span><a href="modules.html#MediaPipeResultsListener" class="tsd-signature-type" data-tsd-kind="Type alias">MediaPipeResultsListener</a><span class="tsd-signature-symbol">; </span>modelType<span class="tsd-signature-symbol">: </span><a href="modules.html#MediaPipeModelType" class="tsd-signature-type" data-tsd-kind="Type alias">MediaPipeModelType</a><span class="tsd-signature-symbol">; </span>options<span class="tsd-signature-symbol">: </span><a href="interfaces/FaceDetectionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FaceDetectionOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/FaceMeshOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FaceMeshOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/HandsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">HandsOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/HolisticOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">HolisticOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ObjectronOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ObjectronOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SelfieSegmentationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SelfieSegmentationOptions</a><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>defines one mediapipe model config</p>
9
+ </div><dl class="tsd-comment-tags"><dt>modeltype</dt><dd><ul>
10
+ <li>which model is required</li>
11
+ </ul>
12
+ </dd><dt>listener</dt><dd><ul>
13
+ <li>callback function from the model</li>
14
+ </ul>
15
+ </dd><dt>options</dt><dd><ul>
16
+ <li>define options for the mediapipe model that is used. for more info check <a href="https://google.github.io/mediapipe/getting_started/javascript.html">https://google.github.io/mediapipe/getting_started/javascript.html</a></li>
17
+ </ul>
18
+ </dd><dt>assetsuri</dt><dd><p>(optional) - can be set to get wasm/tflite/js/binarypb assets. Vonage provides static assets.
19
+ *** WARNING *** - using this option moves the responsibility of the assets and the versioning to the user.
20
+ please keep in mind that the assets list can change between versions!
21
+ assets are different between mediapipe models.</p>
22
+ </dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> assets<wbr/>Uri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>listener<span class="tsd-signature-symbol">: </span><a href="modules.html#MediaPipeResultsListener" class="tsd-signature-type" data-tsd-kind="Type alias">MediaPipeResultsListener</a></h5></li><li class="tsd-parameter"><h5>model<wbr/>Type<span class="tsd-signature-symbol">: </span><a href="modules.html#MediaPipeModelType" class="tsd-signature-type" data-tsd-kind="Type alias">MediaPipeModelType</a></h5></li><li class="tsd-parameter"><h5>options<span class="tsd-signature-symbol">: </span><a href="interfaces/FaceDetectionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FaceDetectionOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/FaceMeshOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FaceMeshOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/HandsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">HandsOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/HolisticOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">HolisticOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ObjectronOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ObjectronOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SelfieSegmentationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SelfieSegmentationOptions</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MediaPipeModelType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Media<wbr/>Pipe<wbr/>Model<wbr/>Type<a href="#MediaPipeModelType" 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">Media<wbr/>Pipe<wbr/>Model<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;face_mesh&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;face_detection&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;hands&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;holistic&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;objectron&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;selfie_segmentation&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;pose&quot;</span></div><div class="tsd-comment tsd-typography"><div class="lead">
23
+ <p>MediaPipeModelType supported models types</p>
24
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MediaPipeResults" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Media<wbr/>Pipe<wbr/>Results<a href="#MediaPipeResults" 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">Media<wbr/>Pipe<wbr/>Results<span class="tsd-signature-symbol">:</span> <a href="interfaces/FaceDetectionResults.html" class="tsd-signature-type" data-tsd-kind="Interface">FaceDetectionResults</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/FaceMeshResults.html" class="tsd-signature-type" data-tsd-kind="Interface">FaceMeshResults</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/HandsResults.html" class="tsd-signature-type" data-tsd-kind="Interface">HandsResults</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/HolisticResults.html" class="tsd-signature-type" data-tsd-kind="Interface">HolisticResults</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ObjectronResults.html" class="tsd-signature-type" data-tsd-kind="Interface">ObjectronResults</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SelfieSegmentationResults.html" class="tsd-signature-type" data-tsd-kind="Interface">SelfieSegmentationResults</a></div><div class="tsd-comment tsd-typography"><div class="lead">
25
+ <p>MediaPipeResults types of results object of MediaPipe</p>
26
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MediaPipeResultsListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Media<wbr/>Pipe<wbr/>Results<wbr/>Listener<a href="#MediaPipeResultsListener" 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">Media<wbr/>Pipe<wbr/>Results<wbr/>Listener<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>results<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>results<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
27
+ <p>ResultsListener callback function from MediaPipe process</p>
28
+ </div><dl class="tsd-comment-tags"><dt>results</dt><dd><ul>
29
+ <li>The results object from MediaPipe</li>
30
+ </ul>
31
+ </dd></dl></div><h4 class="tsd-type-parameters-title">Type Parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol"> extends </span><a href="modules.html#MediaPipeResults" class="tsd-signature-type" data-tsd-kind="Type alias">MediaPipeResults</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>results: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></h4><div><ul>
32
+ <li>can return a promise of void</li>
33
+ </ul>
34
+ </div></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MediaProcessorBaseConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Media<wbr/>Processor<wbr/>Base<wbr/>Config<a href="#MediaProcessorBaseConfig" 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">Media<wbr/>Processor<wbr/>Base<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>mediapipeBaseAssetsUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
35
+ <p>MediaProcessorBaseConfig specifies the absolute URL for the path where the mediapipe assets used by the transformers from this library are stored.
36
+ Vonage hosts static assets of mediapipe that will be used in case this property is not set.
37
+ Vonage promises to take care of maintaining all versioning.</p>
38
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0">{</span><br/><span class="hl-0"> </span><span class="hl-1">mediapipeBaseAssetsUri</span><span class="hl-0">: </span><span class="hl-2">&#39;http://localhost:8080/assets&#39;</span><span class="hl-0"> | </span><span class="hl-3">undeifined</span><br/><span class="hl-0">}</span>
8
39
  </code></pre>
9
- <p>wasmAssetUriPath - should be the uri path to <code>tflite-simd.wasm</code> which included in the package under ./dist
10
- tfliteAssetUriPath - should be the uri path to <code>selfie_segmentation_landscape.tflite</code> which included in the package under ./dist/models
11
- the libary will load this files while starting the transformer process. the load will be on web worker.</p>
12
- </dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>tflite<wbr/>Asset<wbr/>Uri<wbr/>Path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>wasm<wbr/>Asset<wbr/>Uri<wbr/>Path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MediaProcessorConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Media<wbr/>Processor<wbr/>Config<a href="#MediaProcessorConfig" 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">Media<wbr/>Processor<wbr/>Config<span class="tsd-signature-symbol">:</span> <a href="modules.html#MediaProcessorBaseConfig" class="tsd-signature-type" data-tsd-kind="Type alias">MediaProcessorBaseConfig</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="modules.html#BackgroundBlurConfig" class="tsd-signature-type" data-tsd-kind="Type alias">BackgroundBlurConfig</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><a href="modules.html#VirtualBackgroundConfig" class="tsd-signature-type" data-tsd-kind="Type alias">VirtualBackgroundConfig</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#VideoBackgroundConfig" class="tsd-signature-type" data-tsd-kind="Type alias">VideoBackgroundConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><a href="modules.html#AssetBackgroundConfig" class="tsd-signature-type" data-tsd-kind="Type alias">AssetBackgroundConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><a href="modules.html#SilueteBlurConfig" class="tsd-signature-type" data-tsd-kind="Type alias">SilueteBlurConfig</a><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><div class="lead">
40
+ <p>mediapipeBaseAssetsUri - should be the uri path to mediapipe assets.
41
+ *** WARNING *** - using this option moves the responsibility of the assets and the versioning to the user.
42
+ mediapipe selfie segmintaion got those assets:
43
+ selfie_segmentation_landscape.tflite
44
+ selfie_segmentation_solution_simd_wasm_bin.js
45
+ selfie_segmentation_solution_simd_wasm_bin.wasm
46
+ selfie_segmentation_solution_wasm_bin.js
47
+ selfie_segmentation_solution_wasm_bin.wasm
48
+ selfie_segmentation.binarypb
49
+ selfie_segmentation.tflite
50
+ please keep in mind that the assets list can change between versions!
51
+ all assets can be taken from <code>node_modules/@mediapipe/selfie_segmentation</code></p>
52
+ </dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> mediapipe<wbr/>Base<wbr/>Assets<wbr/>Uri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MediaProcessorConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Media<wbr/>Processor<wbr/>Config<a href="#MediaProcessorConfig" 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">Media<wbr/>Processor<wbr/>Config<span class="tsd-signature-symbol">:</span> <a href="modules.html#MediaProcessorBaseConfig" class="tsd-signature-type" data-tsd-kind="Type alias">MediaProcessorBaseConfig</a><span class="tsd-signature-symbol"> &amp; </span><a href="modules.html#BackgroundOptions" class="tsd-signature-type" data-tsd-kind="Type alias">BackgroundOptions</a></div><div class="tsd-comment tsd-typography"><div class="lead">
13
53
  <p>MediaProcessorConfig specifies the transformer logic to be performed.</p>
14
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0"> </span><span class="hl-3">let</span><span class="hl-0"> </span><span class="hl-4">config</span><span class="hl-0">: </span><span class="hl-5">MediaProcessorConfig</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-6">if</span><span class="hl-0">(</span><span class="hl-4">typeType</span><span class="hl-0"> === </span><span class="hl-2">&#39;blur&#39;</span><span class="hl-0">){</span><br/><span class="hl-0"> </span><span class="hl-4">config</span><span class="hl-0"> = {</span><br/><span class="hl-0"> </span><span class="hl-4">wasmAssetUriPath:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">tfliteAssetUriPath:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">transformerType:</span><span class="hl-0"> </span><span class="hl-2">&#39;BackgroundBlur&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">radius:</span><span class="hl-0"> </span><span class="hl-4">blurLevelType</span><span class="hl-0"> === </span><span class="hl-2">&#39;low&#39;</span><span class="hl-0"> ? </span><span class="hl-4">BlurRadius</span><span class="hl-0">.</span><span class="hl-4">Low</span><span class="hl-0"> : </span><span class="hl-4">BlurRadius</span><span class="hl-0">.</span><span class="hl-4">High</span><span class="hl-0">,</span><br/><span class="hl-0"> };</span><br/><span class="hl-0"> } </span><span class="hl-6">else</span><span class="hl-0"> </span><span class="hl-6">if</span><span class="hl-0">(</span><span class="hl-4">typeType</span><span class="hl-0"> === </span><span class="hl-2">&#39;virtual&#39;</span><span class="hl-0">){</span><br/><span class="hl-0"> </span><span class="hl-4">config</span><span class="hl-0"> = {</span><br/><span class="hl-0"> </span><span class="hl-4">wasmAssetUriPath:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">tfliteAssetUriPath:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">transformerType:</span><span class="hl-0"> </span><span class="hl-2">&#39;VirtualBackground&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">backgroundAssetUri:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0"> + </span><span class="hl-2">&quot;images/vonage.jpeg&quot;</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> } </span><span class="hl-6">else</span><span class="hl-0"> </span><span class="hl-6">if</span><span class="hl-0">(</span><span class="hl-4">typeType</span><span class="hl-0"> === </span><span class="hl-2">&#39;video&#39;</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-4">config</span><span class="hl-0"> = {</span><br/><span class="hl-0"> </span><span class="hl-4">wasmAssetUriPath:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">tfliteAssetUriPath:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">transformerType:</span><span class="hl-0"> </span><span class="hl-2">&#39;VideoBackground&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">backgroundAssetUri:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0"> + </span><span class="hl-2">&#39;videos/bbb.mp4&#39;</span><br/><span class="hl-0"> };</span><br/><span class="hl-0"> } </span><span class="hl-6">else</span><span class="hl-0"> </span><span class="hl-6">if</span><span class="hl-0">(</span><span class="hl-4">typeType</span><span class="hl-0"> === </span><span class="hl-2">&#39;siluete&#39;</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-4">config</span><span class="hl-0"> = {</span><br/><span class="hl-0"> </span><span class="hl-4">wasmAssetUriPath:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">tfliteAssetUriPath:</span><span class="hl-0"> </span><span class="hl-4">location</span><span class="hl-0">.</span><span class="hl-4">href</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">transformerType:</span><span class="hl-0"> </span><span class="hl-2">&#39;SilueteBlur&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">radius:</span><span class="hl-0"> </span><span class="hl-4">blurLevelType</span><span class="hl-0"> === </span><span class="hl-2">&#39;low&#39;</span><span class="hl-0"> ? </span><span class="hl-4">BlurRadius</span><span class="hl-0">.</span><span class="hl-4">Low</span><span class="hl-0"> : </span><span class="hl-4">BlurRadius</span><span class="hl-0">.</span><span class="hl-4">High</span><span class="hl-0">,</span><br/><span class="hl-0"> };</span><br/><span class="hl-0"> }</span>
54
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0"> </span><span class="hl-4">let</span><span class="hl-0"> </span><span class="hl-3">config</span><span class="hl-0">: </span><span class="hl-5">MediaProcessorConfig</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-6">if</span><span class="hl-0">(</span><span class="hl-3">typeType</span><span class="hl-0"> === </span><span class="hl-2">&#39;blur&#39;</span><span class="hl-0">){</span><br/><span class="hl-0"> </span><span class="hl-3">config</span><span class="hl-0"> = {</span><br/><span class="hl-0"> </span><span class="hl-3">mediapipeBaseAssetsUri:</span><span class="hl-0"> </span><span class="hl-2">&#39;https://example.com&#39;</span><span class="hl-0">, </span><span class="hl-7">// mediapipeBaseAssetsUri is optional we provide static assets for it</span><br/><span class="hl-0"> </span><span class="hl-3">transformerType:</span><span class="hl-0"> </span><span class="hl-2">&#39;BackgroundBlur&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">radius:</span><span class="hl-0"> </span><span class="hl-3">blurLevelType</span><span class="hl-0"> === </span><span class="hl-2">&#39;low&#39;</span><span class="hl-0"> ? </span><span class="hl-3">BlurRadius</span><span class="hl-0">.</span><span class="hl-3">Low</span><span class="hl-0"> : </span><span class="hl-3">BlurRadius</span><span class="hl-0">.</span><span class="hl-3">High</span><span class="hl-0">,</span><br/><span class="hl-0"> };</span><br/><span class="hl-0"> } </span><span class="hl-6">else</span><span class="hl-0"> </span><span class="hl-6">if</span><span class="hl-0">(</span><span class="hl-3">typeType</span><span class="hl-0"> === </span><span class="hl-2">&#39;virtual&#39;</span><span class="hl-0">){</span><br/><span class="hl-0"> </span><span class="hl-3">config</span><span class="hl-0"> = {</span><br/><span class="hl-0"> </span><span class="hl-3">mediapipeBaseAssetsUri:</span><span class="hl-0"> </span><span class="hl-2">&#39;https://example.com&#39;</span><span class="hl-0">, </span><span class="hl-7">// mediapipeBaseAssetsUri is optional we provide static assets for it</span><br/><span class="hl-0"> </span><span class="hl-3">transformerType:</span><span class="hl-0"> </span><span class="hl-2">&#39;VirtualBackground&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">backgroundAssetUri:</span><span class="hl-0"> </span><span class="hl-3">location</span><span class="hl-0">.</span><span class="hl-3">href</span><span class="hl-0"> + </span><span class="hl-2">&quot;images/vonage.jpeg&quot;</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> } </span><span class="hl-6">else</span><span class="hl-0"> </span><span class="hl-6">if</span><span class="hl-0">(</span><span class="hl-3">typeType</span><span class="hl-0"> === </span><span class="hl-2">&#39;video&#39;</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-3">config</span><span class="hl-0"> = {</span><br/><span class="hl-0"> </span><span class="hl-3">mediapipeBaseAssetsUri:</span><span class="hl-0"> </span><span class="hl-2">&#39;https://example.com&#39;</span><span class="hl-0">, </span><span class="hl-7">// mediapipeBaseAssetsUri is optional we provide static assets for it</span><br/><span class="hl-0"> </span><span class="hl-3">transformerType:</span><span class="hl-0"> </span><span class="hl-2">&#39;VideoBackground&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">backgroundAssetUri:</span><span class="hl-0"> </span><span class="hl-3">location</span><span class="hl-0">.</span><span class="hl-3">href</span><span class="hl-0"> + </span><span class="hl-2">&#39;videos/bbb.mp4&#39;</span><br/><span class="hl-0"> };</span><br/><span class="hl-0"> } </span><span class="hl-6">else</span><span class="hl-0"> </span><span class="hl-6">if</span><span class="hl-0">(</span><span class="hl-3">typeType</span><span class="hl-0"> === </span><span class="hl-2">&#39;siluete&#39;</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-3">config</span><span class="hl-0"> = {</span><br/><span class="hl-0"> </span><span class="hl-3">mediapipeBaseAssetsUri:</span><span class="hl-0"> </span><span class="hl-2">&#39;https://example.com&#39;</span><span class="hl-0">, </span><span class="hl-7">// mediapipeBaseAssetsUri is optional we provide static assets for it</span><br/><span class="hl-0"> </span><span class="hl-3">transformerType:</span><span class="hl-0"> </span><span class="hl-2">&#39;SilueteBlur&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">radius:</span><span class="hl-0"> </span><span class="hl-3">blurLevelType</span><span class="hl-0"> === </span><span class="hl-2">&#39;low&#39;</span><span class="hl-0"> ? </span><span class="hl-3">BlurRadius</span><span class="hl-0">.</span><span class="hl-3">Low</span><span class="hl-0"> : </span><span class="hl-3">BlurRadius</span><span class="hl-0">.</span><span class="hl-3">High</span><span class="hl-0">,</span><br/><span class="hl-0"> };</span><br/><span class="hl-0"> }</span>
15
55
  </code></pre>
16
- </dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SilueteBlurConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Siluete<wbr/>Blur<wbr/>Config<a href="#SilueteBlurConfig" 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">Siluete<wbr/>Blur<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>radius<span class="tsd-signature-symbol">?: </span><a href="enums/BlurRadius.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BlurRadius</a><span class="tsd-signature-symbol">; </span>transformerType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;SilueteBlur&quot;</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
56
+ </dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MediapipeConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Mediapipe<wbr/>Config<a href="#MediapipeConfig" 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">Mediapipe<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>mediaPipeModelConfigArray<span class="tsd-signature-symbol">: </span><a href="modules.html#MediaPipeModelConfig" class="tsd-signature-type" data-tsd-kind="Type alias">MediaPipeModelConfig</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
57
+ <p>MediapipeConfig specified config of mediapipe helper:
58
+ this structure allows the user to create few mediapipe models that will run in parallel.</p>
59
+ </div><dl class="tsd-comment-tags"><dt>modeltypesarray</dt><dd><ul>
60
+ <li>array of mediapipe models to be loaded and called.</li>
61
+ </ul>
62
+ </dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>media<wbr/>Pipe<wbr/>Model<wbr/>Config<wbr/>Array<span class="tsd-signature-symbol">: </span><a href="modules.html#MediaPipeModelConfig" class="tsd-signature-type" data-tsd-kind="Type alias">MediaPipeModelConfig</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SilueteBlurConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Siluete<wbr/>Blur<wbr/>Config<a href="#SilueteBlurConfig" 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">Siluete<wbr/>Blur<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>radius<span class="tsd-signature-symbol">?: </span><a href="enums/BlurRadius.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BlurRadius</a><span class="tsd-signature-symbol">; </span>transformerType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;SilueteBlur&quot;</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
17
63
  <p>BackgroundBlurConfig specifies the configuration for a transformer logic that performs siluete blurring.</p>
18
64
  </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> radius<span class="tsd-signature-symbol">?: </span><a href="enums/BlurRadius.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BlurRadius</a></h5></li><li class="tsd-parameter"><h5>transformer<wbr/>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;SilueteBlur&quot;</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="VideoBackgroundConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Video<wbr/>Background<wbr/>Config<a href="#VideoBackgroundConfig" 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<wbr/>Background<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>transformerType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;VideoBackground&quot;</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
19
65
  <p>VirtualBackgroundConfig specifies the configuration for a transformer logic that performs background replacement with a given video.</p>
20
66
  </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>transformer<wbr/>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;VideoBackground&quot;</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="VirtualBackgroundConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Virtual<wbr/>Background<wbr/>Config<a href="#VirtualBackgroundConfig" 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">Virtual<wbr/>Background<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>transformerType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;VirtualBackground&quot;</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
21
67
  <p>VirtualBackgroundConfig specifies the configuration for a transformer logic that performs background replacement with a given image.</p>
22
- </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>transformer<wbr/>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;VirtualBackground&quot;</span></h5></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a id="createVonageMediaProcessorConnector" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Vonage<wbr/>Media<wbr/>Processor<wbr/>Connector<a href="#createVonageMediaProcessorConnector" 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-function"><li class="tsd-signature tsd-kind-icon">create<wbr/>Vonage<wbr/>Media<wbr/>Processor<wbr/>Connector<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="modules.html#MediaProcessorConfig" class="tsd-signature-type" data-tsd-kind="Type alias">MediaProcessorConfig</a><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">MediaProcessorConnectorInterface</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>config: <a href="modules.html#MediaProcessorConfig" class="tsd-signature-type" data-tsd-kind="Type alias">MediaProcessorConfig</a></h5></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">MediaProcessorConnectorInterface</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getVonageEventEmitter" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Vonage<wbr/>Event<wbr/>Emitter<a href="#getVonageEventEmitter" 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-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Vonage<wbr/>Event<wbr/>Emitter<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Emittery</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">EventDataMap</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">
68
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>transformer<wbr/>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;VirtualBackground&quot;</span></h5></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a id="createVonageMediaProcessorConnector" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Vonage<wbr/>Media<wbr/>Processor<wbr/>Connector<a href="#createVonageMediaProcessorConnector" 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-function"><li class="tsd-signature tsd-kind-icon">create<wbr/>Vonage<wbr/>Media<wbr/>Processor<wbr/>Connector<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="modules.html#MediaProcessorConfig" class="tsd-signature-type" data-tsd-kind="Type alias">MediaProcessorConfig</a><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">MediaProcessorConnectorInterface</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">
69
+ <p>builder function to create MediaProcessorConnectorInterface
70
+ This function hides all the functionality of the @vonage/media-processor library.
71
+ using this create function promises the user the best performance of background operations.</p>
72
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>config: <a href="modules.html#MediaProcessorConfig" class="tsd-signature-type" data-tsd-kind="Type alias">MediaProcessorConfig</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
73
+ <p>see <code>MediaProcessorConfig</code> definition</p>
74
+ </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">MediaProcessorConnectorInterface</span><span class="tsd-signature-symbol">&gt;</span></h4><div><ul>
75
+ <li><code>MediaProcessorConnectorInterface</code> feed this return value to any vonage SDK that supports this API</li>
76
+ </ul>
77
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getVonageEventEmitter" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Vonage<wbr/>Event<wbr/>Emitter<a href="#getVonageEventEmitter" 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-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Vonage<wbr/>Event<wbr/>Emitter<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Emittery</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">EventDataMap</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">
23
78
  <p>Registers for error and warn events that come from the library on run time.
24
79
  see @EventDataMap for more info.</p>
25
80
  </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Emittery</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">EventDataMap</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="isSupported" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Supported<a href="#isSupported" 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-function"><li class="tsd-signature tsd-kind-icon">is<wbr/>Supported<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">
26
81
  <p>Check if the current browser is officially supported by the library.</p>
27
82
  </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><p>The promise will resolve or reject depending whether the browser is supported or not.</p>
83
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="setBackgroundOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Background<wbr/>Options<a href="#setBackgroundOptions" 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-function"><li class="tsd-signature tsd-kind-icon">set<wbr/>Background<wbr/>Options<span class="tsd-signature-symbol">(</span>backgroundOptions<span class="tsd-signature-symbol">: </span><a href="modules.html#BackgroundOptions" class="tsd-signature-type" data-tsd-kind="Type alias">BackgroundOptions</a><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">
84
+ <p>change the background option during run time using this function.
85
+ while using this function the media-processor will not be destroyed.
86
+ while using this function the library promise a full resource cleanup.</p>
87
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>backgroundOptions: <a href="modules.html#BackgroundOptions" class="tsd-signature-type" data-tsd-kind="Type alias">BackgroundOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
88
+ <p>see <code>BackgroundOptions</code> definition</p>
89
+ </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>
90
+ <li>Promise<void></li>
91
+ </ul>
28
92
  </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="setTrackExpectedRate" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Track<wbr/>Expected<wbr/>Rate<a href="#setTrackExpectedRate" 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-function"><li class="tsd-signature tsd-kind-icon">set<wbr/>Track<wbr/>Expected<wbr/>Rate<span class="tsd-signature-symbol">(</span>trackExpectedRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
29
93
  <p>Sets the expected rate of the track per second.
30
94
  The media processor will use this number for calculating drops in the rate.
@@ -35,4 +99,4 @@ Video: 30 frames per second
35
99
  Audio: 50 audio data per second for OPUS</p>
36
100
  </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>trackExpectedRate: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
37
101
  <p>number holds the predicted track rate. -1 for disable this monitor.</p>
38
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="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/BlurRadius.html" class="tsd-kind-icon">Blur<wbr/>Radius</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AssetBackgroundConfig" class="tsd-kind-icon">Asset<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BackgroundBlurConfig" class="tsd-kind-icon">Background<wbr/>Blur<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaProcessorBaseConfig" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Base<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaProcessorConfig" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SilueteBlurConfig" class="tsd-kind-icon">Siluete<wbr/>Blur<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VideoBackgroundConfig" class="tsd-kind-icon">Video<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VirtualBackgroundConfig" class="tsd-kind-icon">Virtual<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-function"><a href="modules.html#createVonageMediaProcessorConnector" class="tsd-kind-icon">create<wbr/>Vonage<wbr/>Media<wbr/>Processor<wbr/>Connector</a></li><li class="tsd-kind-function"><a href="modules.html#getVonageEventEmitter" class="tsd-kind-icon">get<wbr/>Vonage<wbr/>Event<wbr/>Emitter</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#setTrackExpectedRate" class="tsd-kind-icon">set<wbr/>Track<wbr/>Expected<wbr/>Rate</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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>
102
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="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/BlurRadius.html" class="tsd-kind-icon">Blur<wbr/>Radius</a></li><li class="tsd-kind-class"><a href="classes/MediapipeHelper.html" class="tsd-kind-icon">Mediapipe<wbr/>Helper</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/FaceDetectionOptions.html" class="tsd-kind-icon">Face<wbr/>Detection<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/FaceDetectionResults.html" class="tsd-kind-icon">Face<wbr/>Detection<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/FaceMeshOptions.html" class="tsd-kind-icon">Face<wbr/>Mesh<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/FaceMeshResults.html" class="tsd-kind-icon">Face<wbr/>Mesh<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/HandsOptions.html" class="tsd-kind-icon">Hands<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/HandsResults.html" class="tsd-kind-icon">Hands<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/HolisticOptions.html" class="tsd-kind-icon">Holistic<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/HolisticResults.html" class="tsd-kind-icon">Holistic<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/ObjectronOptions.html" class="tsd-kind-icon">Objectron<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/ObjectronResults.html" class="tsd-kind-icon">Objectron<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/PoseOptions.html" class="tsd-kind-icon">Pose<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/PoseResults.html" class="tsd-kind-icon">Pose<wbr/>Results</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/SelfieSegmentationOptions.html" class="tsd-kind-icon">Selfie<wbr/>Segmentation<wbr/>Options</a></li><li class="tsd-kind-interface tsd-is-external"><a href="interfaces/SelfieSegmentationResults.html" class="tsd-kind-icon">Selfie<wbr/>Segmentation<wbr/>Results</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AssetBackgroundConfig" class="tsd-kind-icon">Asset<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BackgroundBlurConfig" class="tsd-kind-icon">Background<wbr/>Blur<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BackgroundOptions" class="tsd-kind-icon">Background<wbr/>Options</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaPipeModelConfig" class="tsd-kind-icon">Media<wbr/>Pipe<wbr/>Model<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaPipeModelType" class="tsd-kind-icon">Media<wbr/>Pipe<wbr/>Model<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaPipeResults" class="tsd-kind-icon">Media<wbr/>Pipe<wbr/>Results</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaPipeResultsListener" class="tsd-kind-icon">Media<wbr/>Pipe<wbr/>Results<wbr/>Listener</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaProcessorBaseConfig" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Base<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediaProcessorConfig" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MediapipeConfig" class="tsd-kind-icon">Mediapipe<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SilueteBlurConfig" class="tsd-kind-icon">Siluete<wbr/>Blur<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VideoBackgroundConfig" class="tsd-kind-icon">Video<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VirtualBackgroundConfig" class="tsd-kind-icon">Virtual<wbr/>Background<wbr/>Config</a></li><li class="tsd-kind-function"><a href="modules.html#createVonageMediaProcessorConnector" class="tsd-kind-icon">create<wbr/>Vonage<wbr/>Media<wbr/>Processor<wbr/>Connector</a></li><li class="tsd-kind-function"><a href="modules.html#getVonageEventEmitter" class="tsd-kind-icon">get<wbr/>Vonage<wbr/>Event<wbr/>Emitter</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#setBackgroundOptions" class="tsd-kind-icon">set<wbr/>Background<wbr/>Options</a></li><li class="tsd-kind-function"><a href="modules.html#setTrackExpectedRate" class="tsd-kind-icon">set<wbr/>Track<wbr/>Expected<wbr/>Rate</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></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>