@pexip/media-processor 20.3.4 → 20.3.5

package/api-docs/functions/createAudioSignalDetector.mdx

@@ -0,0 +1,51 @@
+```ts
+function createAudioSignalDetector(shouldDetect, onDetected): (buffer, threshold?) => (samples) => void;
+```
+
+Create a function to process the AudioStats and check if silent
+`onSignalDetected` callback is called under 2 situations:
+
+```
+Logic
+lastCheck | silent | should call onSignalDetected
+0         | 0      | 0
+0         | 1      | 1
+1         | 0      | 1
+1         | 1      | 0
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `shouldDetect` | () => `boolean` |
+| `onDetected` | (`silent`) => `void` |
+
+## Returns
+
+```ts
+(buffer, threshold?): (samples) => void;
+```
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `buffer` | `Queue`\<`number`[]\> |
+| `threshold?` | `number` |
+
+### Returns
+
+```ts
+(samples): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `samples` | `number`[] |
+
+#### Returns
+
+`void`

package/api-docs/functions/createAudioStats.mdx

@@ -0,0 +1,19 @@
+```ts
+function createAudioStats(stats, options): AudioStats;
+```
+
+AudioStats builder
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `stats` | `Partial`\<[`AudioStats`](../interfaces/AudioStats.mdx)\> | overwrite the default attributes |
+| `options` | \{ `silentThreshold?`: `number`; `lowVolumeThreshold?`: `number`; `clipCountThreshold?`: `number`; \} | `silentThreshold`, `lowVolumeThreshold` and `clipCountThreshold` |
+| `options.silentThreshold?` | `number` | - |
+| `options.lowVolumeThreshold?` | `number` | - |
+| `options.clipCountThreshold?` | `number` | - |
+
+## Returns
+
+[`AudioStats`](../interfaces/AudioStats.mdx)

package/api-docs/functions/createBenchmark.mdx

@@ -0,0 +1,14 @@
+```ts
+function createBenchmark(clock, __namedParameters): Benchmark;
+```
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `clock` | [`Clock`](../interfaces/Clock.mdx) | `performance` |
+| `__namedParameters` | `BenchmarkOptions` | `{}` |
+
+## Returns
+
+[`Benchmark`](../interfaces/Benchmark.mdx)

package/api-docs/functions/createCanvas.mdx

@@ -0,0 +1,16 @@
+```ts
+function createCanvas(width, height): HTMLCanvasElement;
+```
+
+Create a Canvas element with provided width and height
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `width` | `number` | canvas.width |
+| `height` | `number` | canvas.height |
+
+## Returns
+
+`HTMLCanvasElement`

package/api-docs/functions/createCanvasTransform.mdx

@@ -0,0 +1,14 @@
+```ts
+function createCanvasTransform(segmenter, __namedParameters): Transform<InputFrame, InputFrame> & SegmentationParams & Pick<Segmenter, "update"> & Omit<Process, "open"> & object;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `segmenter` | [`Segmenter`](../interfaces/Segmenter.mdx) |
+| `__namedParameters` | `Partial`\<`Options`\> |
+
+## Returns
+
+[`Transform`](../interfaces/Transform.mdx)\<[`InputFrame`](../type-aliases/InputFrame.mdx), [`InputFrame`](../type-aliases/InputFrame.mdx)\> & [`SegmentationParams`](../interfaces/SegmentationParams.mdx) & `Pick`\<[`Segmenter`](../interfaces/Segmenter.mdx), `"update"`\> & `Omit`\<[`Process`](../interfaces/Process.mdx), `"open"`\> & `object`

package/api-docs/functions/createChannelMergerGraphNode.mdx

@@ -0,0 +1,19 @@
+```ts
+function createChannelMergerGraphNode(options?): AudioNodeInit<ChannelMergerNode, ChannelMergerNode>;
+```
+
+Create a ChannelMergerNode
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | `ChannelMergerOptions` |  |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`ChannelMergerNode`, `ChannelMergerNode`\>
+
+## See
+
+ChannelMergerOptions

package/api-docs/functions/createChannelSplitterGraphNode.mdx

@@ -0,0 +1,19 @@
+```ts
+function createChannelSplitterGraphNode(options?): AudioNodeInit<ChannelSplitterNode, ChannelSplitterNode>;
+```
+
+Create a ChannelSplitterNode
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | `ChannelSplitterOptions` |  |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`ChannelSplitterNode`, `ChannelSplitterNode`\>
+
+## See
+
+ChannelSplitterOptions

package/api-docs/functions/createDelayGraphNode.mdx

@@ -0,0 +1,19 @@
+```ts
+function createDelayGraphNode(options?): AudioNodeInit<DelayNode, DelayNode>;
+```
+
+Create a `DelayNode`
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | `DelayOptions` |  |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`DelayNode`, `DelayNode`\>
+
+## See
+
+DelayOptions

package/api-docs/functions/createDenoiseWorkletGraphNode.mdx

@@ -0,0 +1,16 @@
+```ts
+function createDenoiseWorkletGraphNode(data, messageHandler?): AudioNodeInit<AudioWorkletNode, AudioWorkletNode>;
+```
+
+Create a noise suppression node
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | `BufferSource` | WebAssembly source |
+| `messageHandler?` | (`vads`) => `void` | - |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`AudioWorkletNode`, `AudioWorkletNode`\>

package/api-docs/functions/createFrameCallbackRequest.mdx

@@ -0,0 +1,29 @@
+```ts
+function createFrameCallbackRequest(
+   callback, 
+   frameRate, 
+   __namedParameters): object;
+```
+
+Create a callback loop for video frame processing using
+`requestVideoFrameCallback` under-the-hood when available otherwise our
+fallback implementation based on `setTimeout`.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback` | [`Callback`](../type-aliases/Callback.mdx)\<`Promise`\<`void`\>, \[[`ProcessInputType`](../type-aliases/ProcessInputType.mdx)\]\> | To be called by the loop |
+| `frameRate` | `number` | A fallback frame rate when we are not able to get the rate from API |
+| `__namedParameters` | `FrameCallbackRequestOptions` | - |
+
+## Returns
+
+`object`
+
+| Name | Type |
+| ------ | ------ |
+| `start()` | (`input`) => `Promise`\<`void`\> |
+| `stop()` | () => `void` |
+| `get frameRate` | `number` |
+| `set frameRate` | `void` |

package/api-docs/functions/createGainGraphNode.mdx

@@ -0,0 +1,15 @@
+```ts
+function createGainGraphNode(mute): AudioNodeInit<GainNode, Gain>;
+```
+
+Create a GainNodeInit
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `mute` | `boolean` | initial mute state |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`GainNode`, [`Gain`](../interfaces/Gain.mdx)\>

package/api-docs/functions/createMediaElementSourceGraphNode.mdx

@@ -0,0 +1,15 @@
+```ts
+function createMediaElementSourceGraphNode(mediaElement): AudioNodeInit<MediaElementAudioSourceNode, MediaElementAudioSourceNode>;
+```
+
+Create a MediaStreamAudioSourceNodeInit
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `mediaElement` | `HTMLMediaElement` |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`MediaElementAudioSourceNode`, `MediaElementAudioSourceNode`\>

package/api-docs/functions/createSegmenter.mdx

@@ -0,0 +1,14 @@
+```ts
+function createSegmenter(basePath, __namedParameters): Segmenter;
+```
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `basePath` | `string` \| `undefined` | `'/'` | A base path to specify the directory the Wasm files should be loaded from. If not provided, it will be loaded from the host's root directory. **See** [FileResolver](https://ai.google.dev/edge/api/mediapipe/js/tasks-vision.filesetresolver#filesetresolverforvisiontasks) |
+| `__namedParameters` | `Options` | `...` | - |
+
+## Returns
+
+[`Segmenter`](../interfaces/Segmenter.mdx)

package/api-docs/functions/createStreamDestinationGraphNode.mdx

@@ -0,0 +1,15 @@
+```ts
+function createStreamDestinationGraphNode(options?): AudioNodeInit<MediaStreamAudioDestinationNode, MediaStreamAudioDestinationNode>;
+```
+
+Create a MediaStreamAudioDestinationNodeInit
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | `AudioNodeOptions` |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`MediaStreamAudioDestinationNode`, `MediaStreamAudioDestinationNode`\>

package/api-docs/functions/createStreamSourceGraphNode.mdx

@@ -0,0 +1,16 @@
+```ts
+function createStreamSourceGraphNode(mediaStream, shouldResetEnabled): AudioNodeInit<MediaStreamAudioSourceNode, MediaStreamAudioSourceNode>;
+```
+
+Create a MediaStreamAudioSourceNodeInit
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `mediaStream` | `MediaStream` | `undefined` | Source MediaStream |
+| `shouldResetEnabled` | `boolean` | `true` | Whether or not to enable the cloned track |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`MediaStreamAudioSourceNode`, `MediaStreamAudioSourceNode`\>

package/api-docs/functions/createVADetector.mdx

@@ -0,0 +1,54 @@
+```ts
+function createVADetector(
+   onDetected, 
+   shouldDetect, 
+   options?): <T>(isVoice) => (data) => void;
+```
+
+Create a voice detector based on provided params
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `onDetected` | () => `void` | When there is voice activity, this callback will be called |
+| `shouldDetect` | () => `boolean` | When return `true`, voice activity will function, otherwise, not function |
+| `options?` | [`ThrottleOptions`](../interfaces/ThrottleOptions.mdx) |  |
+
+## Returns
+
+```ts
+<T>(isVoice): (data) => void;
+```
+
+### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `isVoice` | [`IsVoice`](../type-aliases/IsVoice.mdx)\<`T`\> |
+
+### Returns
+
+```ts
+(data): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `T` |
+
+#### Returns
+
+`void`
+
+## See
+
+ThrottleOptions

package/api-docs/functions/createVideoProcessor.mdx

@@ -0,0 +1,14 @@
+```ts
+function createVideoProcessor(transformers, processTrack): VideoProcessor;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `transformers` | [`Transform`](../interfaces/Transform.mdx)\<[`InputFrame`](../type-aliases/InputFrame.mdx), [`InputFrame`](../type-aliases/InputFrame.mdx)\>[] |
+| `processTrack` | [`ProcessVideoTrack`](../type-aliases/ProcessVideoTrack.mdx) |
+
+## Returns
+
+[`VideoProcessor`](../interfaces/VideoProcessor.mdx)

package/api-docs/functions/createVideoTrackProcessor.mdx

@@ -0,0 +1,9 @@
+```ts
+function createVideoTrackProcessor(): ProcessVideoTrack;
+```
+
+Video track processor using MediaStreamTrackProcessor API
+
+## Returns
+
+[`ProcessVideoTrack`](../type-aliases/ProcessVideoTrack.mdx)

package/api-docs/functions/createVideoTrackProcessorWithFallback.mdx

@@ -0,0 +1,15 @@
+```ts
+function createVideoTrackProcessorWithFallback(__namedParameters): ProcessVideoTrack;
+```
+
+Video track processor using Canvas[captureStream] API
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | `FallbackOptions` |
+
+## Returns
+
+[`ProcessVideoTrack`](../type-aliases/ProcessVideoTrack.mdx)

package/api-docs/functions/createVoiceDetectorFromProbability.mdx

@@ -0,0 +1,15 @@
+```ts
+function createVoiceDetectorFromProbability(voiceThreshold): IsVoice<number>;
+```
+
+A function to check the provided probability is considered as voice activity
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `voiceThreshold` | `number` | `VOICE_PROBABILITY_THRESHOLD` | A threshold of the probability to be considered as voice activity |
+
+## Returns
+
+[`IsVoice`](../type-aliases/IsVoice.mdx)\<`number`\>

package/api-docs/functions/createVoiceDetectorFromTimeData.mdx

@@ -0,0 +1,19 @@
+```ts
+function createVoiceDetectorFromTimeData(options): IsVoice<number[]>;
+```
+
+A function to check provided time series data is considered as voice activity
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | `VAOptions` |  |
+
+## Returns
+
+[`IsVoice`](../type-aliases/IsVoice.mdx)\<`number`[]\>
+
+## See
+
+VAOptions

package/api-docs/functions/curve.mdx

@@ -0,0 +1,15 @@
+```ts
+function curve(data): string;
+```
+
+**`Alpha`**
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | [`Point`](../interfaces/Point.mdx)[] |
+
+## Returns
+
+`string`

package/api-docs/functions/fromByteToFloat.mdx

@@ -0,0 +1,27 @@
+```ts
+function fromByteToFloat(value): number;
+```
+
+Convert a byte to float, according to web audio spec
+
+Floating point audio sample number is defined as: non-interleaved IEEE754
+32-bit linear PCM with a nominal range between -1 and +1, that is, 32bits
+floating point buffer, with each samples between -1.0 and 1.0
+https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer
+
+Byte samples are represented as follows:
+128 is silence, 0 is negative max, 256 is positive max
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` | The byte value to convert to float |
+
+## Returns
+
+`number`
+
+## Remarks
+
+Ref. https://www.w3.org/TR/webaudio/#dom-analysernode-getbytetimedomaindata

package/api-docs/functions/fromFloatToByte.mdx

@@ -0,0 +1,27 @@
+```ts
+function fromFloatToByte(value): number;
+```
+
+Convert a float to byte, according to web audio spec
+
+Floating point audio sample number is defined as: non-interleaved IEEE754
+32-bit linear PCM with a nominal range between -1 and +1, that is, 32bits
+floating point buffer, with each samples between -1.0 and 1.0
+https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer
+
+Byte samples are represented as follows:
+128 is silence, 0 is negative max, 256 is positive max
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` | The float value to convert to byte |
+
+## Returns
+
+`number`
+
+## Remarks
+
+Ref. https://www.w3.org/TR/webaudio/#dom-analysernode-getbytetimedomaindata

package/api-docs/functions/getAudioStats.mdx

@@ -0,0 +1,19 @@
+```ts
+function getAudioStats(options): AudioStats;
+```
+
+Calculate the audio stats, expected the samples are in float form
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`StatsOptions`](../interfaces/StatsOptions.mdx) | See StatsOptions |
+
+## Returns
+
+[`AudioStats`](../interfaces/AudioStats.mdx)
+
+## Remarks
+
+http://www.rossbencina.com/code/real-time-audio-programming-101-time-waits-for-nothing

package/api-docs/functions/getBezierCurveControlPoints.mdx

@@ -0,0 +1,26 @@
+```ts
+function getBezierCurveControlPoints(p1): [Point, Point];
+```
+
+**`Internal`**
+
+Spline Interpolation for Bezier Curve
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `p1` | \{ `p1`: [`Point`](../interfaces/Point.mdx); `p2`: [`Point`](../interfaces/Point.mdx); `p3`: [`Point`](../interfaces/Point.mdx); `t`: `number`; \} | Starting point |
+| `p1.p1` | [`Point`](../interfaces/Point.mdx) | - |
+| `p1.p2` | [`Point`](../interfaces/Point.mdx) | - |
+| `p1.p3` | [`Point`](../interfaces/Point.mdx) | - |
+| `p1.t` | `number` | - |
+
+## Returns
+
+\[[`Point`](../interfaces/Point.mdx), [`Point`](../interfaces/Point.mdx)\]
+
+## Remarks
+
+Ref. http://scaledinnovation.com/analytics/splines/aboutSplines.html
+Alt. https://www.particleincell.com/2012/bezier-splines/

package/api-docs/functions/isAnalyzerNodeInit.mdx

@@ -0,0 +1,13 @@
+```ts
+function isAnalyzerNodeInit(t): t is AnalyzerNodeInit;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `t` | `unknown` |
+
+## Returns
+
+`t is AnalyzerNodeInit`

package/api-docs/functions/isAudioNode.mdx

@@ -0,0 +1,13 @@
+```ts
+function isAudioNode(t): t is AudioNode;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `t` | `unknown` |
+
+## Returns
+
+`t is AudioNode`

package/api-docs/functions/isAudioNodeInit.mdx

@@ -0,0 +1,13 @@
+```ts
+function isAudioNodeInit(t): t is AudioNodeInit<AudioNode, BaseAudioNode>;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `t` | `unknown` |
+
+## Returns
+
+`t is AudioNodeInit<AudioNode, BaseAudioNode>`

package/api-docs/functions/isAudioParam.mdx

@@ -0,0 +1,13 @@
+```ts
+function isAudioParam(t): t is AudioParam;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `t` | `unknown` |
+
+## Returns
+
+`t is AudioParam`

package/api-docs/functions/isClipping.mdx

@@ -0,0 +1,18 @@
+```ts
+function isClipping(clipCount, threshold): boolean;
+```
+
+Check if there is clipping
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `clipCount` | `number` | `undefined` | Number of consecutive clip |
+| `threshold` | `number` | `CLIP_COUNT_THRESHOLD` | - |
+
+## Returns
+
+`boolean`
+
+`true` if the `clipCount` is above the threshold, aka clipping

package/api-docs/functions/isEqualSize.mdx

@@ -0,0 +1,22 @@
+```ts
+function isEqualSize(
+   widthA, 
+   heightA, 
+   widthB, 
+   heightB): boolean;
+```
+
+Compare the provided width and height to see if they are the same
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `widthA` | `number` | The width of A |
+| `heightA` | `number` | The height of A |
+| `widthB` | `number` | The width of B |
+| `heightB` | `number` | The height of B |
+
+## Returns
+
+`boolean`