@vonage/ml-transformers 2.0.1 → 2.0.4
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.
- package/dist/docs/index.html +1 -1
- package/dist/docs/modules.html +3 -3
- package/dist/ml-transformers.es.js +20505 -43
- package/dist/ml-transformers.umd.js +106 -4
- package/dist/types/main.d.ts +2 -2
- package/dist/types/src/transformers/FaceDetectionHelper.d.ts +5 -0
- package/dist/types/src/transformers/FaceMashHelper.d.ts +5 -0
- package/dist/types/src/transformers/HandsHelper.d.ts +5 -0
- package/dist/types/src/transformers/HolisticHelper.d.ts +5 -0
- package/dist/types/src/transformers/MediapipeHelper.d.ts +6 -0
- package/dist/types/src/transformers/ObjectronHelper.d.ts +5 -0
- package/dist/types/src/transformers/SelfieSegmentationHelper.d.ts +5 -0
- package/dist/types/src/types.d.ts +2 -3
- package/dist/types/src/vonage/VonageMediaProcessorWorker.d.ts +1 -0
- package/package.json +2 -4
- package/dist/docs/interfaces/PoseOptions.html +0 -3
- package/dist/docs/interfaces/PoseResults.html +0 -3
package/dist/docs/index.html
CHANGED
|
@@ -13,4 +13,4 @@
|
|
|
13
13
|
</a>
|
|
14
14
|
<p>Docs: Check out <a href="https://vonage.github.io/ml-transformers-docs">https://vonage.github.io/ml-transformers-docs</a>.</p>
|
|
15
15
|
<p>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-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/
|
|
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/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/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>
|
package/dist/docs/modules.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/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/
|
|
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/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">"BackgroundBlur"</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>
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
*** WARNING *** - using this option moves the responsibility of the assets and the versioning to the user.
|
|
20
20
|
please keep in mind that the assets list can change between versions!
|
|
21
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">"face_mesh"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"face_detection"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hands"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"holistic"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"objectron"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"selfie_segmentation"</span
|
|
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">"face_mesh"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"face_detection"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hands"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"holistic"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"objectron"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"selfie_segmentation"</span></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
23
23
|
<p>MediaPipeModelType supported models types</p>
|
|
24
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
25
|
<p>MediaPipeResults types of results object of MediaPipe</p>
|
|
@@ -99,4 +99,4 @@ Video: 30 frames per second
|
|
|
99
99
|
Audio: 50 audio data per second for OPUS</p>
|
|
100
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">
|
|
101
101
|
<p>number holds the predicted track rate. -1 for disable this monitor.</p>
|
|
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/
|
|
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/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>
|