@pexip/media-processor 20.3.4 → 21.0.0

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,32 @@
+Options controlling the rendering and effects for person/background segmentation.
+All values are stable per-frame and can be safely updated in real-time.
+
+## Extended by
+
+- [`SegmentationParams`](SegmentationParams.mdx)
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="backgroundimageurl"></a> `backgroundImageUrl` | `string` | URL or Data URI for the virtual background image (used in "overlay" effect). |
+| <a id="backgroundbluramount"></a> `backgroundBlurAmount` | `number` | Amount of background blur (radius in px): [0,9]. Recommend: 3–6 for portraits. Higher may be slow and over-blurred. **Default** `3` |
+| <a id="edgebluramount"></a> `edgeBlurAmount` | `number` | Edge blur for mask boundary antialiasing (radius in px): [0,9]. Small values (1–5) smooth mask stair-steps; large values soften edges more visibly. **Default** `4` |
+| <a id="effects"></a> `effects` | `"blur"` \| `"none"` \| `"overlay"` | Effects to apply: "none", "blur", or "overlay". "blur" = background blur. "overlay" = replace BG with backgroundImageUrl. |
+| <a id="backend"></a> `backend` | `"webgl"` \| `"webgpu"` | Backend to render background effects |
+| <a id="foregroundthreshold"></a> `foregroundThreshold` | `number` | [0,1] Upper mask confidence: all mask pixels >= this are considered definite foreground. Adjust to make mask edges tighter or more permissive for foreground inclusion. Example: 0.8 ("mask > 0.8 = sure foreground"). Must always be >= backgroundThreshold. **Default** `0.85` |
+| <a id="backgroundthreshold"></a> `backgroundThreshold` | `number` | [0,1] Lower mask confidence: all mask pixels <= this are considered definite background. Adjust to make mask edges tighter or more permissive for background inclusion. Example: 0.3 ("mask < 0.3 = sure background"). **Default** `0.35` |
+| <a id="sigmaspace"></a> `sigmaSpace` | `number` | Bilateral filter: sigma in pixel space for mask edge snapping. Controls the neighborhood/pixel distance—higher is larger window (5–10 typical). **Default** `5` |
+| <a id="sigmarangelo"></a> `sigmaRangeLo` | `number` | Bilateral filter: minimum sigma in color/luma (for mask interiors), [0,1]. Controls how little color difference is needed to cross-mask regions away from edge. Lower = sharper edge preservation in mask interiors. Example: 0.2 **Default** `0.2` |
+| <a id="sigmarangehi"></a> `sigmaRangeHi` | `number` | Bilateral filter: maximum sigma in color/luma (for mask uncertain zones), [0,1]. Controls how much color similarity is required at uncertain/edge mask locations. Higher = more mask smoothing at edges. Example: 0.8 **Default** `0.8` |
+| <a id="maskcombineratio"></a> `maskCombineRatio` | `number` | Ratio for mask smoothing (how much uncertainty enables temporal blend), [0,1]. Higher = more frame-to-frame blending, more stability but more trailing ghosts. Typical: 0.6–0.85. **Default** `0.8` |
+| <a id="excludebystanders"></a> `excludeBystanders` | `boolean` | **`Experimental`** Whether to exclude bystanders/connected people from the output mask. The main person instance (closest to personCenter OR largest blob) is kept in the output mask. All other bystanders/connected people are suppressed (bystander removal). **Default** `false (no bystander removal, all detected people are included in the mask). @experimental This feature is experimental and only works in WebGL backend.` |
+| <a id="personcenter"></a> `personCenter` | \[`number`, `number`\] | **`Experimental`** Person center: normalized (x, y) in [0,1] image coordinates for main subject selection. Used by the CCL/bias filter to select the main person blob. **Default** `[0.5, 0.42] (= center, slightly above vertical midpoint). @experimental This feature is experimental and only works in WebGL backend.` |
+| <a id="morpheroderadiuspx"></a> `morphErodeRadiusPx` | `number` | **`Experimental`** Morphological erosion: radius in pixels [1,12]. Sets kernel size for bridge-breaking. Larger values break thicker bridges but may erode fine details. **Default** `5 @experimental This feature is experimental and only works in WebGL backend.` |
+| <a id="morphpass"></a> `morphPass` | `number` | **`Experimental`** Morphological pass: number of separable passes [1,10]. More passes increase the effective span. **Default** `4 @experimental This feature is experimental and only works in WebGL backend.` |
+| <a id="morphdilateradiuspx"></a> `morphDilateRadiusPx` | `number` | **`Experimental`** Geodesic dilation: radius in pixels [1,12]. Must match erosion for good reconstruction. **Default** `6 @experimental This feature is experimental and only works in WebGL backend.` |
+| <a id="lightwrapintensity"></a> `lightWrapIntensity` | `number` | [0,1] Light wrap amount (halo intensity) at mask edge. Wraps blurred background color just outside the subject edge onto the subject boundary for realism. **Default** `0.8` |
+| <a id="lightwraptightness"></a> `lightWrapTightness` | `number` | [0.5,4.0] Controls power/tightness of the wrap band falloff. Higher = tighter/narrower wrap. **Default** `1.2` |
+| <a id="lightwrapedgeband"></a> `lightWrapEdgeBand` | `number` | Width of the wrap band (feather size, in normalized mask units) between the backgroundThreshold and foregroundThreshold in [0.0, (foregroundThreshold - backgroundThreshold) / 2] Higher = wider soft halo. **Default** `0.25` |
+| <a id="lightwrapbluramount"></a> `lightWrapBlurAmount` | `number` | Blur amount used for background color in the wrap band (units=blur passes). **Default** `1` |
+| <a id="downsamplefactor"></a> `downSampleFactor` | `number` | Downsampling factor for mask/blurring, must be [2,4]. 2 = half resolution, 4 = quarter resolution for faster filtering. Use for performance tuning vs. quality. **Default** `2` |

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,35 @@
+Options controlling the rendering and effects for person/background segmentation.
+All values are stable per-frame and can be safely updated in real-time.
+
+## Extends
+
+- [`RendererOptions`](RendererOptions.mdx)
+
+## Properties
+
+| Property | Type | Description | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="backgroundimageurl"></a> `backgroundImageUrl` | `string` | URL or Data URI for the virtual background image (used in "overlay" effect). | [`RendererOptions`](RendererOptions.mdx).[`backgroundImageUrl`](RendererOptions.mdx#backgroundimageurl) |
+| <a id="backgroundbluramount"></a> `backgroundBlurAmount` | `number` | Amount of background blur (radius in px): [0,9]. Recommend: 3–6 for portraits. Higher may be slow and over-blurred. **Default** `3` | [`RendererOptions`](RendererOptions.mdx).[`backgroundBlurAmount`](RendererOptions.mdx#backgroundbluramount) |
+| <a id="edgebluramount"></a> `edgeBlurAmount` | `number` | Edge blur for mask boundary antialiasing (radius in px): [0,9]. Small values (1–5) smooth mask stair-steps; large values soften edges more visibly. **Default** `4` | [`RendererOptions`](RendererOptions.mdx).[`edgeBlurAmount`](RendererOptions.mdx#edgebluramount) |
+| <a id="effects"></a> `effects` | `"blur"` \| `"none"` \| `"overlay"` | Effects to apply: "none", "blur", or "overlay". "blur" = background blur. "overlay" = replace BG with backgroundImageUrl. | [`RendererOptions`](RendererOptions.mdx).[`effects`](RendererOptions.mdx#effects) |
+| <a id="backend"></a> `backend` | `"webgl"` \| `"webgpu"` | Backend to render background effects | [`RendererOptions`](RendererOptions.mdx).[`backend`](RendererOptions.mdx#backend) |
+| <a id="foregroundthreshold"></a> `foregroundThreshold` | `number` | [0,1] Upper mask confidence: all mask pixels >= this are considered definite foreground. Adjust to make mask edges tighter or more permissive for foreground inclusion. Example: 0.8 ("mask > 0.8 = sure foreground"). Must always be >= backgroundThreshold. **Default** `0.85` | [`RendererOptions`](RendererOptions.mdx).[`foregroundThreshold`](RendererOptions.mdx#foregroundthreshold) |
+| <a id="backgroundthreshold"></a> `backgroundThreshold` | `number` | [0,1] Lower mask confidence: all mask pixels <= this are considered definite background. Adjust to make mask edges tighter or more permissive for background inclusion. Example: 0.3 ("mask < 0.3 = sure background"). **Default** `0.35` | [`RendererOptions`](RendererOptions.mdx).[`backgroundThreshold`](RendererOptions.mdx#backgroundthreshold) |
+| <a id="sigmaspace"></a> `sigmaSpace` | `number` | Bilateral filter: sigma in pixel space for mask edge snapping. Controls the neighborhood/pixel distance—higher is larger window (5–10 typical). **Default** `5` | [`RendererOptions`](RendererOptions.mdx).[`sigmaSpace`](RendererOptions.mdx#sigmaspace) |
+| <a id="sigmarangelo"></a> `sigmaRangeLo` | `number` | Bilateral filter: minimum sigma in color/luma (for mask interiors), [0,1]. Controls how little color difference is needed to cross-mask regions away from edge. Lower = sharper edge preservation in mask interiors. Example: 0.2 **Default** `0.2` | [`RendererOptions`](RendererOptions.mdx).[`sigmaRangeLo`](RendererOptions.mdx#sigmarangelo) |
+| <a id="sigmarangehi"></a> `sigmaRangeHi` | `number` | Bilateral filter: maximum sigma in color/luma (for mask uncertain zones), [0,1]. Controls how much color similarity is required at uncertain/edge mask locations. Higher = more mask smoothing at edges. Example: 0.8 **Default** `0.8` | [`RendererOptions`](RendererOptions.mdx).[`sigmaRangeHi`](RendererOptions.mdx#sigmarangehi) |
+| <a id="maskcombineratio"></a> `maskCombineRatio` | `number` | Ratio for mask smoothing (how much uncertainty enables temporal blend), [0,1]. Higher = more frame-to-frame blending, more stability but more trailing ghosts. Typical: 0.6–0.85. **Default** `0.8` | [`RendererOptions`](RendererOptions.mdx).[`maskCombineRatio`](RendererOptions.mdx#maskcombineratio) |
+| <a id="excludebystanders"></a> `excludeBystanders` | `boolean` | **`Experimental`** Whether to exclude bystanders/connected people from the output mask. The main person instance (closest to personCenter OR largest blob) is kept in the output mask. All other bystanders/connected people are suppressed (bystander removal). **Default** `false (no bystander removal, all detected people are included in the mask). @experimental This feature is experimental and only works in WebGL backend.` | [`RendererOptions`](RendererOptions.mdx).[`excludeBystanders`](RendererOptions.mdx#excludebystanders) |
+| <a id="personcenter"></a> `personCenter` | \[`number`, `number`\] | **`Experimental`** Person center: normalized (x, y) in [0,1] image coordinates for main subject selection. Used by the CCL/bias filter to select the main person blob. **Default** `[0.5, 0.42] (= center, slightly above vertical midpoint). @experimental This feature is experimental and only works in WebGL backend.` | [`RendererOptions`](RendererOptions.mdx).[`personCenter`](RendererOptions.mdx#personcenter) |
+| <a id="morpheroderadiuspx"></a> `morphErodeRadiusPx` | `number` | **`Experimental`** Morphological erosion: radius in pixels [1,12]. Sets kernel size for bridge-breaking. Larger values break thicker bridges but may erode fine details. **Default** `5 @experimental This feature is experimental and only works in WebGL backend.` | [`RendererOptions`](RendererOptions.mdx).[`morphErodeRadiusPx`](RendererOptions.mdx#morpheroderadiuspx) |
+| <a id="morphpass"></a> `morphPass` | `number` | **`Experimental`** Morphological pass: number of separable passes [1,10]. More passes increase the effective span. **Default** `4 @experimental This feature is experimental and only works in WebGL backend.` | [`RendererOptions`](RendererOptions.mdx).[`morphPass`](RendererOptions.mdx#morphpass) |
+| <a id="morphdilateradiuspx"></a> `morphDilateRadiusPx` | `number` | **`Experimental`** Geodesic dilation: radius in pixels [1,12]. Must match erosion for good reconstruction. **Default** `6 @experimental This feature is experimental and only works in WebGL backend.` | [`RendererOptions`](RendererOptions.mdx).[`morphDilateRadiusPx`](RendererOptions.mdx#morphdilateradiuspx) |
+| <a id="lightwrapintensity"></a> `lightWrapIntensity` | `number` | [0,1] Light wrap amount (halo intensity) at mask edge. Wraps blurred background color just outside the subject edge onto the subject boundary for realism. **Default** `0.8` | [`RendererOptions`](RendererOptions.mdx).[`lightWrapIntensity`](RendererOptions.mdx#lightwrapintensity) |
+| <a id="lightwraptightness"></a> `lightWrapTightness` | `number` | [0.5,4.0] Controls power/tightness of the wrap band falloff. Higher = tighter/narrower wrap. **Default** `1.2` | [`RendererOptions`](RendererOptions.mdx).[`lightWrapTightness`](RendererOptions.mdx#lightwraptightness) |
+| <a id="lightwrapedgeband"></a> `lightWrapEdgeBand` | `number` | Width of the wrap band (feather size, in normalized mask units) between the backgroundThreshold and foregroundThreshold in [0.0, (foregroundThreshold - backgroundThreshold) / 2] Higher = wider soft halo. **Default** `0.25` | [`RendererOptions`](RendererOptions.mdx).[`lightWrapEdgeBand`](RendererOptions.mdx#lightwrapedgeband) |
+| <a id="lightwrapbluramount"></a> `lightWrapBlurAmount` | `number` | Blur amount used for background color in the wrap band (units=blur passes). **Default** `1` | [`RendererOptions`](RendererOptions.mdx).[`lightWrapBlurAmount`](RendererOptions.mdx#lightwrapbluramount) |
+| <a id="downsamplefactor"></a> `downSampleFactor` | `number` | Downsampling factor for mask/blurring, must be [2,4]. 2 = half resolution, 4 = quarter resolution for faster filtering. Use for performance tuning vs. quality. **Default** `2` | [`RendererOptions`](RendererOptions.mdx).[`downSampleFactor`](RendererOptions.mdx#downsamplefactor) |
+| <a id="segmenter"></a> `segmenter` | [`Segmenter`](Segmenter.mdx) | - | - |
+| <a id="width"></a> `width` | `number` | - | - |
+| <a id="height"></a> `height` | `number` | - | - |

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/SelectionOptions.mdx

@@ -0,0 +1,15 @@
+## Extends
+
+- [`Weights`](Weights.mdx)
+
+## Properties
+
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="iou"></a> `iou` | `number` | [`Weights`](Weights.mdx).[`iou`](Weights.mdx#iou) |
+| <a id="area"></a> `area` | `number` | [`Weights`](Weights.mdx).[`area`](Weights.mdx#area) |
+| <a id="height"></a> `height` | `number` | [`Weights`](Weights.mdx).[`height`](Weights.mdx#height) |
+| <a id="center"></a> `center` | `number` | [`Weights`](Weights.mdx).[`center`](Weights.mdx#center) |
+| <a id="centerx"></a> `centerX` | `number` | - |
+| <a id="centery"></a> `centerY` | `number` | - |
+| <a id="decay"></a> `decay` | `number` | - |

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/Stats.mdx

@@ -0,0 +1,11 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="sumx"></a> `sumX` | `number` |
+| <a id="sumy"></a> `sumY` | `number` |
+| <a id="count"></a> `count` | `number` |
+| <a id="minx"></a> `minX` | `number` |
+| <a id="maxx"></a> `maxX` | `number` |
+| <a id="miny"></a> `minY` | `number` |
+| <a id="maxy"></a> `maxY` | `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/Weights.mdx

@@ -0,0 +1,12 @@
+## Extended by
+
+- [`SelectionOptions`](SelectionOptions.mdx)
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="iou"></a> `iou` | `number` |
+| <a id="area"></a> `area` | `number` |
+| <a id="height"></a> `height` | `number` |
+| <a id="center"></a> `center` | `number` |

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`\>