@vonage/media-processor 1.2.7 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/assets/highlight.css +13 -27
- package/dist/docs/assets/main.js +2 -2
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/assets/style.css +3 -2
- package/dist/docs/classes/MediaProcessor.html +51 -43
- package/dist/docs/classes/MediaProcessorConnector.html +12 -12
- package/dist/docs/enums/ErrorFunction.html +9 -0
- package/dist/docs/enums/PipelineInfoData.html +19 -0
- package/dist/docs/enums/VonageSourceType.html +5 -0
- package/dist/docs/enums/WarningType.html +5 -0
- package/dist/docs/index.html +2 -2
- package/dist/docs/interfaces/MediaProcessorConnectorInterface.html +4 -10
- package/dist/docs/interfaces/MediaProcessorInterface.html +17 -7
- package/dist/docs/modules.html +42 -35
- package/dist/media-processor.es.js +684 -1943
- package/dist/media-processor.min.js +1 -0
- package/dist/media-processor.static.js +832 -0
- package/dist/media-processor.umd.js +2 -3
- package/dist/types/lib/main.d.ts +10 -0
- package/dist/types/{src → lib/src}/core/InsertableStreamHelper.d.ts +0 -0
- package/dist/types/{src → lib/src}/core/MediaProcessor.d.ts +20 -15
- package/dist/types/lib/src/core/MediaProcessorConnector.d.ts +39 -0
- package/dist/types/{src → lib/src}/core/MediaProcessorConnectorInterface.d.ts +4 -1
- package/dist/types/lib/src/core/MediaProcessorInterface.d.ts +23 -0
- package/dist/types/lib/src/core/pipeline.d.ts +166 -0
- package/dist/types/{src → lib/src}/telemetry/Key.d.ts +0 -0
- package/dist/types/lib/src/telemetry/QosReporter.d.ts +22 -0
- package/dist/types/{src → lib/src}/utils/Tools.d.ts +0 -0
- package/dist/types/{src → lib/src}/utils/package-json.d.ts +0 -0
- package/dist/types/{src → lib/src}/utils/utils.d.ts +0 -0
- package/package.json +72 -62
- package/dist/types/main.d.ts +0 -9
- package/dist/types/src/core/MediaProcessorConnector.d.ts +0 -79
- package/dist/types/src/core/MediaProcessorInterface.d.ts +0 -16
- package/dist/types/src/core/pipeline.d.ts +0 -116
- package/dist/types/src/telemetry/Reporter.d.ts +0 -80
package/dist/docs/modules.html
CHANGED
|
@@ -1,46 +1,53 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@vonage/media-processor</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>@vonage/media-processor</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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>
|
|
2
|
-
<p>
|
|
3
|
-
|
|
4
|
-
</
|
|
5
|
-
</div></div
|
|
6
|
-
<p>
|
|
7
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="
|
|
8
|
-
<p>
|
|
9
|
-
</div><
|
|
10
|
-
<
|
|
11
|
-
</
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
</
|
|
16
|
-
<
|
|
17
|
-
|
|
18
|
-
</
|
|
19
|
-
<p>
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@vonage/media-processor</title><meta name="description" content="Documentation for @vonage/media-processor"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@vonage/media-processor</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>@vonage/media-processor </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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/ErrorFunction.html" class="tsd-kind-icon">Error<wbr/>Function</a></li><li class="tsd-kind-enum"><a href="enums/PipelineInfoData.html" class="tsd-kind-icon">Pipeline<wbr/>Info<wbr/>Data</a></li><li class="tsd-kind-enum tsd-is-external"><a href="enums/VonageSourceType.html" class="tsd-kind-icon">Vonage<wbr/>Source<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/WarningType.html" class="tsd-kind-icon">Warning<wbr/>Type</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/MediaProcessor.html" class="tsd-kind-icon">Media<wbr/>Processor</a></li><li class="tsd-kind-class"><a href="classes/MediaProcessorConnector.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/MediaProcessorConnectorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/MediaProcessorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Interface</a></li></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#DropInfo" class="tsd-kind-icon">Drop<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ErrorData" class="tsd-kind-icon">Error<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventDataMap" class="tsd-kind-icon">Event<wbr/>Data<wbr/>Map</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventMetaData" class="tsd-kind-icon">Event<wbr/>Meta<wbr/>Data</a></li><li class="tsd-kind-type-alias tsd-is-external"><a href="modules.html#VonageMetadata" class="tsd-kind-icon">Vonage<wbr/>Metadata</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WarnData" class="tsd-kind-icon">Warn<wbr/>Data</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#isSupported" class="tsd-kind-icon">is<wbr/>Supported</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#setVonageMetadata" class="tsd-kind-icon">set<wbr/>Vonage<wbr/>Metadata</a></li></ul></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="DropInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Drop<wbr/>Info<a href="#DropInfo" 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">Drop<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>current<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>requested<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
+
<p>DropInfo gives info about the frame rate of the transformer</p>
|
|
3
|
+
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>current<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
|
+
<p>The actual rate of the track</p>
|
|
5
|
+
</div></div></li><li class="tsd-parameter"><h5>requested<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
|
+
<p>The rate predicted rate of the track</p>
|
|
7
|
+
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ErrorData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Error<wbr/>Data<a href="#ErrorData" 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">Error<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>eventMetaData<span class="tsd-signature-symbol">: </span><a href="modules.html#EventMetaData" class="tsd-signature-type" data-tsd-kind="Type alias">EventMetaData</a><span class="tsd-signature-symbol">; </span>function<span class="tsd-signature-symbol">: </span><a href="enums/ErrorFunction.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ErrorFunction</a><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
|
+
<p>ErrorData. MediaProcessor error data definition.</p>
|
|
9
|
+
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
|
+
<p>Type of unknown but moslty will be string</p>
|
|
11
|
+
</div></div></li><li class="tsd-parameter"><h5>event<wbr/>Meta<wbr/>Data<span class="tsd-signature-symbol">: </span><a href="modules.html#EventMetaData" class="tsd-signature-type" data-tsd-kind="Type alias">EventMetaData</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
|
+
<p>Metadata of the event.</p>
|
|
13
|
+
</div></div></li><li class="tsd-parameter"><h5>function<span class="tsd-signature-symbol">: </span><a href="enums/ErrorFunction.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ErrorFunction</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
14
|
+
<p>The function in which the error occurred.</p>
|
|
15
|
+
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="EventDataMap" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Event<wbr/>Data<wbr/>Map<a href="#EventDataMap" 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">Event<wbr/>Data<wbr/>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>error<span class="tsd-signature-symbol">: </span><a href="modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a><span class="tsd-signature-symbol">; </span>pipelineInfo<span class="tsd-signature-symbol">: </span><a href="enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</a><span class="tsd-signature-symbol">; </span>warn<span class="tsd-signature-symbol">: </span><a href="modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
16
|
+
<p>EventDataMap. A map type for all event options from MediaProcessor.
|
|
17
|
+
Each event will include only one type.</p>
|
|
18
|
+
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>error<span class="tsd-signature-symbol">: </span><a href="modules.html#ErrorData" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorData</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
19
|
+
<p>Errors from the insertable streams pipeline.</p>
|
|
20
|
+
</div></div></li><li class="tsd-parameter"><h5>pipeline<wbr/>Info<span class="tsd-signature-symbol">: </span><a href="enums/PipelineInfoData.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PipelineInfoData</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
21
|
+
<p>Info from the insertable streams pipeline life cycle.</p>
|
|
22
|
+
</div></div></li><li class="tsd-parameter"><h5>warn<span class="tsd-signature-symbol">: </span><a href="modules.html#WarnData" class="tsd-signature-type" data-tsd-kind="Type alias">WarnData</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
23
|
+
<p>Warnings from the insertable streams pipeline.</p>
|
|
24
|
+
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="EventMetaData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Event<wbr/>Meta<wbr/>Data<a href="#EventMetaData" 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">Event<wbr/>Meta<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>transformerIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
25
|
+
<p>EventMetaData. Some metadata of the event.</p>
|
|
20
26
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>transformer<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
21
27
|
<p>The transformer index in the array of transformers.</p>
|
|
22
|
-
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="
|
|
23
|
-
<p>PipelineInfolData - life cycle information of pipeline</p>
|
|
24
|
-
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pipeline_ended"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pipeline_ended_with_error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pipeline_started"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pipeline_started_with_error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pipeline_restarted"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pipeline_restarted_with_error"</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="VonageMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Vonage<wbr/>Metadata<a href="#VonageMetadata" 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">Vonage<wbr/>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>appId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>proxyUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sourceType<span class="tsd-signature-symbol">: </span><a href="modules.html#VonageSourceType" class="tsd-signature-type" data-tsd-kind="Type alias">VonageSourceType</a><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
28
|
+
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-is-external"><a id="VonageMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Vonage<wbr/>Metadata<a href="#VonageMetadata" 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">Vonage<wbr/>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>appId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>proxyUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sourceType<span class="tsd-signature-symbol">: </span><a href="enums/VonageSourceType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">VonageSourceType</a><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
25
29
|
<p>Specifies the addional information being sent with the telemetry collected by the library.</p>
|
|
26
30
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>app<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
27
31
|
<p>Some string identifier identifying the application using the library.</p>
|
|
28
32
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> proxy<wbr/>Url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
29
|
-
<p>The proxy URL to route all internet traffic generated by this library.</p>
|
|
30
|
-
</div></div></li><li class="tsd-parameter"><h5>source<wbr/>Type<span class="tsd-signature-symbol">: </span><a href="
|
|
33
|
+
<p>The proxy URL to route all internet traffic generated by this library. This field is optional.</p>
|
|
34
|
+
</div></div></li><li class="tsd-parameter"><h5>source<wbr/>Type<span class="tsd-signature-symbol">: </span><a href="enums/VonageSourceType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">VonageSourceType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
31
35
|
<p>Type of source using the library.</p>
|
|
32
|
-
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="
|
|
33
|
-
<p>WarnData
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
</div></div
|
|
36
|
+
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WarnData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Warn<wbr/>Data<a href="#WarnData" 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">Warn<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>dropInfo<span class="tsd-signature-symbol">?: </span><a href="modules.html#DropInfo" class="tsd-signature-type" data-tsd-kind="Type alias">DropInfo</a><span class="tsd-signature-symbol">; </span>eventMetaData<span class="tsd-signature-symbol">: </span><a href="modules.html#EventMetaData" class="tsd-signature-type" data-tsd-kind="Type alias">EventMetaData</a><span class="tsd-signature-symbol">; </span>warningType<span class="tsd-signature-symbol">: </span><a href="enums/WarningType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WarningType</a><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
37
|
+
<p>WarnData - MediaProcessor warning event defintion</p>
|
|
38
|
+
</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> drop<wbr/>Info<span class="tsd-signature-symbol">?: </span><a href="modules.html#DropInfo" class="tsd-signature-type" data-tsd-kind="Type alias">DropInfo</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
39
|
+
<p> Optional - FPS drop info.</p>
|
|
40
|
+
</div></div></li><li class="tsd-parameter"><h5>event<wbr/>Meta<wbr/>Data<span class="tsd-signature-symbol">: </span><a href="modules.html#EventMetaData" class="tsd-signature-type" data-tsd-kind="Type alias">EventMetaData</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
41
|
+
<p>Meta data of the event</p>
|
|
42
|
+
</div></div></li><li class="tsd-parameter"><h5>warning<wbr/>Type<span class="tsd-signature-symbol">: </span><a href="enums/WarningType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WarningType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
43
|
+
<p> The waring type</p>
|
|
44
|
+
</div></div></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="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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
37
45
|
<p>Check if the current browser is officially supported by the library.</p>
|
|
38
46
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div><p>The promise will resolve or reject depending whether the browser is supported or not.</p>
|
|
39
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="setVonageMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Vonage<wbr/>Metadata<a href="#setVonageMetadata" 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/>Vonage<wbr/>Metadata<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="modules.html#VonageMetadata" class="tsd-signature-type" data-tsd-kind="Type alias">VonageMetadata</a><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">
|
|
40
|
-
<p>Sets some metadata for telemetry
|
|
41
|
-
|
|
42
|
-
</
|
|
43
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>metadata: <a href="modules.html#VonageMetadata" class="tsd-signature-type" data-tsd-kind="Type alias">VonageMetadata</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
47
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-is-external"><a id="setVonageMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Vonage<wbr/>Metadata<a href="#setVonageMetadata" 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 tsd-is-external"><li class="tsd-signature tsd-kind-icon">set<wbr/>Vonage<wbr/>Metadata<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="modules.html#VonageMetadata" class="tsd-signature-type" data-tsd-kind="Type alias">VonageMetadata</a><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">
|
|
48
|
+
<p>Sets some metadata for telemetry.
|
|
49
|
+
An example can be found <a href="/docs/intro.md#statistics">here</a>.</p>
|
|
50
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>metadata: <a href="modules.html#VonageMetadata" class="tsd-signature-type" data-tsd-kind="Type alias">VonageMetadata</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
44
51
|
<p>Specifies the addional information being sent with the telemetry collected by the library.
|
|
45
52
|
If metadata is either undefined or not set the library will not collect/send any telemetry.</p>
|
|
46
|
-
</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-
|
|
53
|
+
</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/ErrorFunction.html" class="tsd-kind-icon">Error<wbr/>Function</a></li><li class="tsd-kind-enum"><a href="enums/PipelineInfoData.html" class="tsd-kind-icon">Pipeline<wbr/>Info<wbr/>Data</a></li><li class="tsd-kind-enum tsd-is-external"><a href="enums/VonageSourceType.html" class="tsd-kind-icon">Vonage<wbr/>Source<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/WarningType.html" class="tsd-kind-icon">Warning<wbr/>Type</a></li><li class="tsd-kind-class"><a href="classes/MediaProcessor.html" class="tsd-kind-icon">Media<wbr/>Processor</a></li><li class="tsd-kind-class"><a href="classes/MediaProcessorConnector.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector</a></li><li class="tsd-kind-interface"><a href="interfaces/MediaProcessorConnectorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Connector<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/MediaProcessorInterface.html" class="tsd-kind-icon">Media<wbr/>Processor<wbr/>Interface</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DropInfo" class="tsd-kind-icon">Drop<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ErrorData" class="tsd-kind-icon">Error<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventDataMap" class="tsd-kind-icon">Event<wbr/>Data<wbr/>Map</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EventMetaData" class="tsd-kind-icon">Event<wbr/>Meta<wbr/>Data</a></li><li class="tsd-kind-type-alias tsd-is-external"><a href="modules.html#VonageMetadata" class="tsd-kind-icon">Vonage<wbr/>Metadata</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WarnData" class="tsd-kind-icon">Warn<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#isSupported" class="tsd-kind-icon">is<wbr/>Supported</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#setVonageMetadata" class="tsd-kind-icon">set<wbr/>Vonage<wbr/>Metadata</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|