@pexip/media-processor 20.3.4 → 20.3.5

package/api-docs/interfaces/Denoise.mdx

@@ -0,0 +1,50 @@
+A wrapper for the Denoise wasm module
+
+## Methods
+
+### vad()
+
+```ts
+vad(channel): number;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `channel` | `number` |
+
+#### Returns
+
+`number`
+
+***
+
+### free()
+
+```ts
+free(): void;
+```
+
+#### Returns
+
+`void`
+
+***
+
+### pipe()
+
+```ts
+pipe(inputs, outputs): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `inputs` | `Float32Array`\<`ArrayBufferLike`\>[][] |
+| `outputs` | `Float32Array`\<`ArrayBufferLike`\>[][] |
+
+#### Returns
+
+`void`

package/api-docs/interfaces/Detector.mdx

@@ -0,0 +1,81 @@
+## Extends
+
+- [`Process`](Process.mdx)
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Properties
+
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="status"></a> `status` | \| `"closed"` \| `"closing"` \| `"Error"` \| `"destroyed"` \| `"destroying"` \| `"idle"` \| `"new"` \| `"opened"` \| `"opening"` \| `"processing"` \| `"updated"` \| `"updating"` | [`Process`](Process.mdx).[`status`](Process.mdx#status) |
+
+## Methods
+
+### open()
+
+```ts
+open(): Promise<void>;
+```
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`Process`](Process.mdx).[`open`](Process.mdx#open)
+
+***
+
+### close()
+
+```ts
+close(): void;
+```
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`Process`](Process.mdx).[`close`](Process.mdx#close)
+
+***
+
+### destroy()
+
+```ts
+destroy(): Promise<void>;
+```
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`Process`](Process.mdx).[`destroy`](Process.mdx#destroy)
+
+***
+
+### detect()
+
+```ts
+detect(input): Promise<T>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `input` | [`ProcessInputType`](../type-aliases/ProcessInputType.mdx) |
+
+#### Returns
+
+`Promise`\<`T`\>

package/api-docs/interfaces/Frame.mdx

@@ -0,0 +1,11 @@
+## Extends
+
+- [`Size`](Size.mdx)
+
+## Properties
+
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="width"></a> `width` | `number` | [`Size`](Size.mdx).[`width`](Size.mdx#width) |
+| <a id="height"></a> `height` | `number` | [`Size`](Size.mdx).[`height`](Size.mdx#height) |
+| <a id="source"></a> `source` | \| [`Canvas`](../type-aliases/Canvas.mdx) \| `HTMLVideoElement` \| `HTMLImageElement` | - |

package/api-docs/interfaces/Gain.mdx

@@ -0,0 +1,227 @@
+## Extends
+
+- [`BaseAudioNode`](../type-aliases/BaseAudioNode.mdx)
+
+## Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="node"></a> `node` | `readonly` | `GainNode` |
+| <a id="mute"></a> `mute` | `public` | `boolean` |
+
+## Methods
+
+### connect()
+
+#### Call Signature
+
+```ts
+connect(
+   destinationNode, 
+   output?, 
+   input?): AudioNode;
+```
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/connect)
+
+##### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `destinationNode` | `AudioNode` |
+| `output?` | `number` |
+| `input?` | `number` |
+
+##### Returns
+
+`AudioNode`
+
+##### Inherited from
+
+```ts
+BaseAudioNode.connect
+```
+
+#### Call Signature
+
+```ts
+connect(destinationParam, output?): void;
+```
+
+##### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `destinationParam` | `AudioParam` |
+| `output?` | `number` |
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+```ts
+BaseAudioNode.connect
+```
+
+***
+
+### disconnect()
+
+#### Call Signature
+
+```ts
+disconnect(): void;
+```
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioNode/disconnect)
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+```ts
+BaseAudioNode.disconnect
+```
+
+#### Call Signature
+
+```ts
+disconnect(output): void;
+```
+
+##### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `output` | `number` |
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+```ts
+BaseAudioNode.disconnect
+```
+
+#### Call Signature
+
+```ts
+disconnect(destinationNode): void;
+```
+
+##### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `destinationNode` | `AudioNode` |
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+```ts
+BaseAudioNode.disconnect
+```
+
+#### Call Signature
+
+```ts
+disconnect(destinationNode, output): void;
+```
+
+##### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `destinationNode` | `AudioNode` |
+| `output` | `number` |
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+```ts
+BaseAudioNode.disconnect
+```
+
+#### Call Signature
+
+```ts
+disconnect(
+   destinationNode, 
+   output, 
+   input): void;
+```
+
+##### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `destinationNode` | `AudioNode` |
+| `output` | `number` |
+| `input` | `number` |
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+```ts
+BaseAudioNode.disconnect
+```
+
+#### Call Signature
+
+```ts
+disconnect(destinationParam): void;
+```
+
+##### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `destinationParam` | `AudioParam` |
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+```ts
+BaseAudioNode.disconnect
+```
+
+#### Call Signature
+
+```ts
+disconnect(destinationParam, output): void;
+```
+
+##### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `destinationParam` | `AudioParam` |
+| `output` | `number` |
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+```ts
+BaseAudioNode.disconnect
+```

package/api-docs/interfaces/ImageRecord.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="key"></a> `key` | `string` |
+| <a id="image"></a> `image` | `ImageBitmap` |

package/api-docs/interfaces/ImageSegmenterOptions.mdx

@@ -0,0 +1,8 @@
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="canvas"></a> `canvas?` | `OffscreenCanvas` | The canvas element to bind textures to. This has to be set for GPU processing. The task will initialize a WebGL or WebGPU context and throw an error if this fails (e.g. if you have already initialized a different type of context). |
+| <a id="segmentercanvas"></a> `segmenterCanvas?` | `OffscreenCanvas` | The Google TaskVision segmentation model only works with WebGl so we need a separate canvas for this. |
+| <a id="modelasset"></a> `modelAsset?` | [`SegmentationModelAsset`](SegmentationModelAsset.mdx) | - |
+| <a id="delegate"></a> `delegate?` | [`Delegate`](../type-aliases/Delegate.mdx) | Overrides the default backend to use for the provided model. |

package/api-docs/interfaces/MPMask.mdx

@@ -0,0 +1,145 @@
+Wrapper for a mask produced by a Segmentation Task.
+
+## Properties
+
+| Property | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="canvas"></a> `canvas` | `readonly` | `OffscreenCanvas` \| `undefined` | Returns the canvas element that the mask is bound to. |
+| <a id="width"></a> `width` | `readonly` | `number` | Returns the width of the mask. |
+| <a id="height"></a> `height` | `readonly` | `number` | Returns the height of the mask. |
+
+## Methods
+
+### hasUint8Array()
+
+```ts
+hasUint8Array(): boolean;
+```
+
+Returns whether this `MPMask` contains a mask of type `Uint8Array`.
+
+#### Returns
+
+`boolean`
+
+***
+
+### hasFloat32Array()
+
+```ts
+hasFloat32Array(): boolean;
+```
+
+Returns whether this `MPMask` contains a mask of type `Float32Array`.
+
+#### Returns
+
+`boolean`
+
+***
+
+### hasWebGLTexture()
+
+```ts
+hasWebGLTexture(): boolean;
+```
+
+Returns whether this `MPMask` contains a mask of type `WebGLTexture`.
+
+#### Returns
+
+`boolean`
+
+***
+
+### getAsUint8Array()
+
+```ts
+getAsUint8Array(): Uint8Array;
+```
+
+Returns the underlying mask as a Uint8Array`. Note that this involves an
+expensive GPU to CPU transfer if the current mask is only available as a
+`WebGLTexture`.
+
+#### Returns
+
+`Uint8Array`
+
+The current data as a Uint8Array.
+
+***
+
+### getAsFloat32Array()
+
+```ts
+getAsFloat32Array(): Float32Array;
+```
+
+Returns the underlying mask as a single channel `Float32Array`. Note that
+this involves an expensive GPU to CPU transfer if the current mask is
+only available as a `WebGLTexture`.
+
+#### Returns
+
+`Float32Array`
+
+The current mask as a Float32Array.
+
+***
+
+### getAsWebGLTexture()
+
+```ts
+getAsWebGLTexture(): WebGLTexture;
+```
+
+Returns the underlying mask as a `WebGLTexture` object. Note that this
+involves a CPU to GPU transfer if the current mask is only available as
+a CPU array. The returned texture is bound to the current canvas (see
+`.canvas`).
+
+#### Returns
+
+`WebGLTexture`
+
+The current mask as a WebGLTexture.
+
+***
+
+### clone()
+
+```ts
+clone(): MPMask;
+```
+
+Creates a copy of the resources stored in this `MPMask`. You can
+invoke this method to extend the lifetime of a mask returned by a
+MediaPipe Task. Note that performance critical applications should aim to
+only use the `MPMask` within the MediaPipe Task callback so that
+copies can be avoided.
+
+#### Returns
+
+`MPMask`
+
+***
+
+### close()
+
+```ts
+close(): void;
+```
+
+Frees up any resources owned by this `MPMask` instance.
+
+Note that this method does not free masks that are owned by the C++
+Task, as these are freed automatically once you leave the MediaPipe
+callback. Additionally, some shared state is freed only once you invoke
+the Task's `close()` method.
+
+#### Returns
+
+`void`
+
+#### Export

package/api-docs/interfaces/Point.mdx

@@ -0,0 +1,10 @@
+**`Alpha`**
+
+Interface for Point consist of coordinates x and y
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="x"></a> `x` | `number` | **`Alpha`** |
+| <a id="y"></a> `y` | `number` | **`Alpha`** |

package/api-docs/interfaces/Process.mdx

@@ -0,0 +1,46 @@
+## Extended by
+
+- [`Segmenter`](Segmenter.mdx)
+- [`Detector`](Detector.mdx)
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="status"></a> `status` | \| `"closed"` \| `"closing"` \| `"Error"` \| `"destroyed"` \| `"destroying"` \| `"idle"` \| `"new"` \| `"opened"` \| `"opening"` \| `"processing"` \| `"updated"` \| `"updating"` |
+
+## Methods
+
+### open()
+
+```ts
+open(): Promise<void>;
+```
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### close()
+
+```ts
+close(): void;
+```
+
+#### Returns
+
+`void`
+
+***
+
+### destroy()
+
+```ts
+destroy(): Promise<void>;
+```
+
+#### Returns
+
+`Promise`\<`void`\>

package/api-docs/interfaces/ProcessEventClose.mdx

@@ -0,0 +1,7 @@
+Message event to stop the processing
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"close"` |

package/api-docs/interfaces/ProcessEventDebug.mdx

@@ -0,0 +1,14 @@
+Message event for debugging
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"debug"` |
+| <a id="data"></a> `data` | `T` |

package/api-docs/interfaces/ProcessEventDestroy.mdx

@@ -0,0 +1,7 @@
+Message event to release all the resources
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"destroy"` |

package/api-docs/interfaces/ProcessEventOpen.mdx

@@ -0,0 +1,14 @@
+Message event to initializing the Processor
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"open"` |
+| <a id="data"></a> `data` | `T` |

package/api-docs/interfaces/ProcessEventProcess.mdx

@@ -0,0 +1,14 @@
+Message event to process the video frame
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"process"` |
+| <a id="data"></a> `data` | `T` |

package/api-docs/interfaces/ProcessEventUpdate.mdx

@@ -0,0 +1,14 @@
+Message event to update processor options
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"update"` |
+| <a id="data"></a> `data` | `T` |

package/api-docs/interfaces/ProcessWorkerDebugMessage.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="context"></a> `context?` | `Record`\<`string`, `unknown`\> |
+| <a id="message"></a> `message` | `string` |

package/api-docs/interfaces/ProcessWorkerEvent.mdx

@@ -0,0 +1,12 @@
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"event"` |
+| <a id="data"></a> `data` | `T` |

package/api-docs/interfaces/ProcessWorkerEventDebug.mdx

@@ -0,0 +1,12 @@
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"debug"` |
+| <a id="data"></a> `data` | `T` |

package/api-docs/interfaces/ProcessWorkerEventOpened.mdx

@@ -0,0 +1,5 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"opened"` |