@pexip/media-processor 20.3.4 → 20.3.5

package/api-docs/interfaces/ProcessWorkerEventProcessed.mdx

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

package/api-docs/interfaces/ProcessWorkerEventUpdated.mdx

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

package/api-docs/interfaces/ProcessorEvent.mdx

@@ -0,0 +1,7 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | \| `"Error"` \| `"ContextCreationError"` \| `"ContextLost"` \| `"ContextRestored"` \| `"ProcessorRestarted"` \| `"SamplingError"` |
+| <a id="message"></a> `message?` | `string` |
+| <a id="frame"></a> `frame?` | [`VideoFrameLike`](VideoFrameLike.mdx) |

package/api-docs/interfaces/ProcessorOptions.mdx

@@ -0,0 +1,16 @@
+## Extends
+
+- [`SegmenterOptions`](SegmenterOptions.mdx)
+
+## Properties
+
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="renderoptions"></a> `renderOptions?` | [`RendererOptions`](RendererOptions.mdx) | - |
+| <a id="backgroundimage"></a> `backgroundImage?` | [`ImageRecord`](ImageRecord.mdx) | - |
+| <a id="restart"></a> `restart?` | `boolean` | - |
+| <a id="basepath"></a> `basePath?` | `string` | [`SegmenterOptions`](SegmenterOptions.mdx).[`basePath`](SegmenterOptions.mdx#basepath) |
+| <a id="output"></a> `output?` | `OffscreenCanvas` \| `null` | [`SegmenterOptions`](SegmenterOptions.mdx).[`output`](SegmenterOptions.mdx#output) |
+| <a id="processingwidth"></a> `processingWidth?` | `number` | [`SegmenterOptions`](SegmenterOptions.mdx).[`processingWidth`](SegmenterOptions.mdx#processingwidth) |
+| <a id="processingheight"></a> `processingHeight?` | `number` | [`SegmenterOptions`](SegmenterOptions.mdx).[`processingHeight`](SegmenterOptions.mdx#processingheight) |
+| <a id="imagesegmenteroptions"></a> `imageSegmenterOptions?` | [`ImageSegmenterOptions`](ImageSegmenterOptions.mdx) | [`SegmenterOptions`](SegmenterOptions.mdx).[`imageSegmenterOptions`](SegmenterOptions.mdx#imagesegmenteroptions) |

package/api-docs/interfaces/ProcessorProcessOptions.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="videoframe"></a> `videoFrame` | [`VideoFrameLike`](VideoFrameLike.mdx) |
+| <a id="renderoptions"></a> `renderOptions?` | [`RendererOptions`](RendererOptions.mdx) |

package/api-docs/interfaces/Rect.mdx

@@ -0,0 +1,8 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="x"></a> `x` | `number` |
+| <a id="y"></a> `y` | `number` |
+| <a id="width"></a> `width` | `number` |
+| <a id="height"></a> `height` | `number` |

package/api-docs/interfaces/RenderEventHandlers.mdx

@@ -0,0 +1,7 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="contextlost"></a> `contextLost` | (`message`) => `void` |
+| <a id="contextrestored"></a> `contextRestored` | (`message`) => `void` |
+| <a id="contextcreationerror"></a> `contextCreationError` | (`message`) => `void` |

package/api-docs/interfaces/Renderer.mdx

@@ -0,0 +1,64 @@
+## Methods
+
+### init()
+
+```ts
+init(options?): void | Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | `Options` |
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### render()
+
+```ts
+render(
+   mask, 
+   frame, 
+   options): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `mask` | `ImageBitmap` |
+| `frame` | [`VideoFrameLike`](VideoFrameLike.mdx) |
+| `options` | `Options` |
+
+#### Returns
+
+`void`
+
+***
+
+### isContextLost()
+
+```ts
+isContextLost(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+***
+
+### release()
+
+```ts
+release(): void;
+```
+
+#### Returns
+
+`void`

package/api-docs/interfaces/RendererOptions.mdx

@@ -0,0 +1,15 @@
+## Extended by
+
+- [`SegmentationParams`](SegmentationParams.mdx)
+
+## Properties
+
+| Property | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="backgroundimageurl"></a> `backgroundImageUrl` | `string` | `undefined` | - |
+| <a id="foregroundthreshold"></a> `foregroundThreshold` | `number` | `undefined` | Confident score threshold to be considered as the foreground between 0 and 1 |
+| <a id="backgroundbluramount"></a> `backgroundBlurAmount` | `number` | `undefined` | Between 0 and 10 |
+| <a id="edgebluramount"></a> `edgeBlurAmount` | `number` | `3` | Range in between 0 and 20 |
+| <a id="maskcombineratio"></a> `maskCombineRatio` | `number` | `undefined` | The ratio used for smoothing the mask between 0 and 1 |
+| <a id="effects"></a> `effects` | `"blur"` \| `"none"` \| `"overlay"` | `undefined` | Effects |
+| <a id="backend"></a> `backend` | `"webgl"` \| `"webgpu"` | `undefined` | Backend to render background effects |

package/api-docs/interfaces/Runner.mdx

@@ -0,0 +1,41 @@
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `P` *extends* `unknown`[] |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="framerate"></a> `frameRate` | `number` |
+
+## Methods
+
+### start()
+
+```ts
+start(...params): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`params` | `P` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### stop()
+
+```ts
+stop(): void;
+```
+
+#### Returns
+
+`void`

package/api-docs/interfaces/Segmentation.mdx

@@ -0,0 +1,5 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="canvas"></a> `canvas` | `OffscreenCanvas` \| `undefined` |

package/api-docs/interfaces/SegmentationModelAsset.mdx

@@ -0,0 +1,8 @@
+Segmentation model asset that can be used to load a segmentation model.
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="path"></a> `path` | `string` |
+| <a id="modelname"></a> `modelName` | [`SegmentationModel`](../type-aliases/SegmentationModel.mdx) |

package/api-docs/interfaces/SegmentationParams.mdx

@@ -0,0 +1,18 @@
+## Extends
+
+- [`RendererOptions`](RendererOptions.mdx)
+
+## Properties
+
+| Property | Type | Default value | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="backgroundimageurl"></a> `backgroundImageUrl` | `string` | `undefined` | - | [`RendererOptions`](RendererOptions.mdx).[`backgroundImageUrl`](RendererOptions.mdx#backgroundimageurl) |
+| <a id="foregroundthreshold"></a> `foregroundThreshold` | `number` | `undefined` | Confident score threshold to be considered as the foreground between 0 and 1 | [`RendererOptions`](RendererOptions.mdx).[`foregroundThreshold`](RendererOptions.mdx#foregroundthreshold) |
+| <a id="backgroundbluramount"></a> `backgroundBlurAmount` | `number` | `undefined` | Between 0 and 10 | [`RendererOptions`](RendererOptions.mdx).[`backgroundBlurAmount`](RendererOptions.mdx#backgroundbluramount) |
+| <a id="edgebluramount"></a> `edgeBlurAmount` | `number` | `3` | Range in between 0 and 20 | [`RendererOptions`](RendererOptions.mdx).[`edgeBlurAmount`](RendererOptions.mdx#edgebluramount) |
+| <a id="maskcombineratio"></a> `maskCombineRatio` | `number` | `undefined` | The ratio used for smoothing the mask between 0 and 1 | [`RendererOptions`](RendererOptions.mdx).[`maskCombineRatio`](RendererOptions.mdx#maskcombineratio) |
+| <a id="effects"></a> `effects` | `"blur"` \| `"none"` \| `"overlay"` | `undefined` | Effects | [`RendererOptions`](RendererOptions.mdx).[`effects`](RendererOptions.mdx#effects) |
+| <a id="backend"></a> `backend` | `"webgl"` \| `"webgpu"` | `undefined` | Backend to render background effects | [`RendererOptions`](RendererOptions.mdx).[`backend`](RendererOptions.mdx#backend) |
+| <a id="segmenter"></a> `segmenter` | [`Segmenter`](Segmenter.mdx) | `undefined` | - | - |
+| <a id="width"></a> `width` | `number` | `undefined` | - | - |
+| <a id="height"></a> `height` | `number` | `undefined` | - | - |

package/api-docs/interfaces/SegmentationSmoothingConfig.mdx

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

package/api-docs/interfaces/Segmenter.mdx

@@ -0,0 +1,121 @@
+## Extends
+
+- [`Process`](Process.mdx)
+
+## 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) |
+| <a id="modelasset"></a> `modelAsset` | [`SegmentationModelAsset`](SegmentationModelAsset.mdx) | - |
+| <a id="backgroundimage"></a> `backgroundImage?` | [`BackgroundImage`](BackgroundImage.mdx) | - |
+
+## Methods
+
+### 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)
+
+***
+
+### open()
+
+```ts
+open(options?): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`ProcessorOptions`](ProcessorOptions.mdx) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+[`Process`](Process.mdx).[`open`](Process.mdx#open)
+
+***
+
+### update()
+
+```ts
+update(options): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options` | [`ProcessorOptions`](ProcessorOptions.mdx) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### process()
+
+```ts
+process(input, options?): Promise<VideoFrameLike | undefined>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `input` | [`VideoFrameLike`](VideoFrameLike.mdx) |
+| `options?` | [`RendererOptions`](RendererOptions.mdx) |
+
+#### Returns
+
+`Promise`\<[`VideoFrameLike`](VideoFrameLike.mdx) \| `undefined`\>
+
+***
+
+### subscribe()
+
+```ts
+subscribe(event, callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | \| `"Error"` \| `"ContextCreationError"` \| `"ContextLost"` \| `"ContextRestored"` \| `"ProcessorRestarted"` \| `"SamplingError"` |
+| `callback` | `Callback`\<`void`\> |
+
+#### Returns
+
+`Unsubscribe`

package/api-docs/interfaces/SegmenterOptions.mdx

@@ -0,0 +1,13 @@
+## Extended by
+
+- [`ProcessorOptions`](ProcessorOptions.mdx)
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="basepath"></a> `basePath?` | `string` |
+| <a id="output"></a> `output?` | `OffscreenCanvas` \| `null` |
+| <a id="processingwidth"></a> `processingWidth?` | `number` |
+| <a id="processingheight"></a> `processingHeight?` | `number` |
+| <a id="imagesegmenteroptions"></a> `imageSegmenterOptions?` | [`ImageSegmenterOptions`](ImageSegmenterOptions.mdx) |

package/api-docs/interfaces/Size.mdx

@@ -0,0 +1,10 @@
+## Extended by
+
+- [`Frame`](Frame.mdx)
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="width"></a> `width` | `number` |
+| <a id="height"></a> `height` | `number` |

package/api-docs/interfaces/StatsOptions.mdx

@@ -0,0 +1,10 @@
+Stats options for calculating the audio stats
+
+## Properties
+
+| Property | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="samples"></a> `samples` | [`AudioSamples`](../type-aliases/AudioSamples.mdx) | `undefined` | Used for the analysis |
+| <a id="basestats"></a> `baseStats?` | [`AudioStats`](AudioStats.mdx) | `undefined` | this will be used for accumulation |
+| <a id="clipthreshold"></a> `clipThreshold?` | `number` | `1.0` as assuming it is float value | Threshold for clipping |
+| <a id="silentthreshold"></a> `silentThreshold?` | `number` | `1.0 / 32767` | Threshold for silent |

package/api-docs/interfaces/SubscribableOptions.mdx

@@ -0,0 +1,9 @@
+## Extended by
+
+- [`AnalyzerSubscribableOptions`](AnalyzerSubscribableOptions.mdx)
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="updatefrequency"></a> `updateFrequency?` | `number` |

package/api-docs/interfaces/ThrottleOptions.mdx

@@ -0,0 +1,8 @@
+Limit the rate of flow in terms of millisecond, and provided Clock
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="throttlems"></a> `throttleMs?` | `number` |
+| <a id="clock"></a> `clock?` | [`Clock`](Clock.mdx) |

package/api-docs/interfaces/Transform.mdx

@@ -0,0 +1,62 @@
+## Extends
+
+- `Transformer`\<`I`, `O`\>
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `I` |
+| `O` |
+
+## Properties
+
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="flush"></a> `flush?` | `TransformerFlushCallback`\<`O`\> | `Transformer.flush` |
+| <a id="readabletype"></a> `readableType?` | `undefined` | `Transformer.readableType` |
+| <a id="start"></a> `start?` | `TransformerStartCallback`\<`O`\> | `Transformer.start` |
+| <a id="transform"></a> `transform?` | `TransformerTransformCallback`\<`I`, `O`\> | `Transformer.transform` |
+| <a id="writabletype"></a> `writableType?` | `undefined` | `Transformer.writableType` |
+
+## Methods
+
+### init()
+
+```ts
+init(options?): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`ProcessorOptions`](ProcessorOptions.mdx) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### close()
+
+```ts
+close(): void;
+```
+
+#### Returns
+
+`void`
+
+***
+
+### destroy()
+
+```ts
+destroy(): Promise<void>;
+```
+
+#### Returns
+
+`Promise`\<`void`\>

package/api-docs/interfaces/VideoFrameLike.mdx

@@ -0,0 +1,8 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="frame"></a> `frame` | `ImageBitmap` \| `VideoFrame` |
+| <a id="timestamp"></a> `timestamp` | `number` |
+| <a id="width"></a> `width` | `number` |
+| <a id="height"></a> `height` | `number` |

package/api-docs/interfaces/VideoProcessor.mdx

@@ -0,0 +1,38 @@
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="process"></a> `process` | (`source`) => `Promise`\<`MediaStream`\> | Process the video and return a MediaStream |
+| <a id="destroy"></a> `destroy` | () => `Promise`\<`void`\> | Destroy the segmentation wasm instance |
+
+## Methods
+
+### open()
+
+```ts
+open(options?): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`ProcessorOptions`](ProcessorOptions.mdx) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### close()
+
+```ts
+close(): void;
+```
+
+Stop the process of video segmentation
+
+#### Returns
+
+`void`

package/api-docs/interfaces/WorkletMessagePortOptions.mdx

@@ -0,0 +1,16 @@
+## Extended by
+
+- [`AnalyzerSubscribableOptions`](AnalyzerSubscribableOptions.mdx)
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="messagehandler"></a> `messageHandler` | (`message`) => `void` |
+| <a id="errorhandler"></a> `errorHandler?` | (`event`) => `void` |

package/api-docs/interfaces/WorkletModule.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="moduleurl"></a> `moduleURL` | `string` |
+| <a id="options"></a> `options?` | `WorkletOptions` |

package/api-docs/type-aliases/AnalyzerNodeInit.mdx

@@ -0,0 +1,3 @@
+```ts
+type AnalyzerNodeInit = AudioNodeInit<AnalyserNode, Analyzer>;
+```

package/api-docs/type-aliases/AsyncCallback.mdx

@@ -0,0 +1,7 @@
+```ts
+type AsyncCallback = () => Promise<void>;
+```
+
+## Returns
+
+`Promise`\<`void`\>

package/api-docs/type-aliases/AudioBufferBytes.mdx

@@ -0,0 +1,5 @@
+```ts
+type AudioBufferBytes = Uint8Array;
+```
+
+Same as the return from [AnalyserNode.getByteFrequencyData()](https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData)

package/api-docs/type-aliases/AudioBufferFloats.mdx

@@ -0,0 +1,6 @@
+```ts
+type AudioBufferFloats = Float32Array;
+```
+
+Same as [AudioBuffer](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer)
+Or the return from [AnalyserNode.getFloatFrequencyData()](https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getFloatFrequencyData)

package/api-docs/type-aliases/AudioDestinationNodeInit.mdx

@@ -0,0 +1,3 @@
+```ts
+type AudioDestinationNodeInit = AudioNodeInit<AudioDestinationNode, AudioDestinationNode>;
+```

package/api-docs/type-aliases/AudioNodeConnectParam.mdx

@@ -0,0 +1,3 @@
+```ts
+type AudioNodeConnectParam = ConnectParamBase<ConnectParamType>;
+```

package/api-docs/type-aliases/AudioNodeInitConnectParam.mdx

@@ -0,0 +1,3 @@
+```ts
+type AudioNodeInitConnectParam = ConnectParamBase<ConnectInitParamType>;
+```

package/api-docs/type-aliases/AudioNodeInitConnection.mdx

@@ -0,0 +1,3 @@
+```ts
+type AudioNodeInitConnection = AudioNodeInitConnectParam[];
+```

package/api-docs/type-aliases/AudioNodeInitConnections.mdx

@@ -0,0 +1,3 @@
+```ts
+type AudioNodeInitConnections = AudioNodeInitConnection[];
+```

package/api-docs/type-aliases/AudioNodeParam.mdx

@@ -0,0 +1,3 @@
+```ts
+type AudioNodeParam = BaseAudioNode | AudioParam;
+```

package/api-docs/type-aliases/AudioSamples.mdx

@@ -0,0 +1,17 @@
+```ts
+type AudioSamples = 
+  | number[]
+  | AudioBufferFloats
+  | AudioBufferBytes;
+```
+
+Audio samples from each channel, either in float or bytes form
+
+## Example
+
+```
+|       |            | Sample Frame 1 | Sample Frame 2 | Sample Frame 3 |
+| Input | Channel L: | sample 1       | sample 2       | sample 3       |
+|       | Channel R: | sample 1       | sample 2       | sample 3       |
+```
+We can get 2 `AudioSamples` from "Channel L" and "Channel R" from "Input"

package/api-docs/type-aliases/BaseAudioNode.mdx

@@ -0,0 +1,3 @@
+```ts
+type BaseAudioNode = Pick<AudioNode, NodeConnectionAction>;
+```

package/api-docs/type-aliases/Callback.mdx

@@ -0,0 +1,20 @@
+```ts
+type Callback<R, T> = (...params) => R;
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `R` |
+| `T` *extends* `unknown`[] |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`params` | `T` |
+
+## Returns
+
+`R`

package/api-docs/type-aliases/Canvas.mdx

@@ -0,0 +1,3 @@
+```ts
+type Canvas = HTMLCanvasElement | OffscreenCanvas;
+```

package/api-docs/type-aliases/CanvasContext.mdx

@@ -0,0 +1,3 @@
+```ts
+type CanvasContext = CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D;
+```