@pexip/media-processor 20.3.4 → 21.0.0

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;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type ChannelSplitterNodeInit = AudioNodeInit<ChannelSplitterNode, ChannelSplitterNode>;
+```

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

@@ -0,0 +1,12 @@
+```ts
+type Color = object;
+```
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="r"></a> `r` | `number` |
+| <a id="g"></a> `g` | `number` |
+| <a id="b"></a> `b` | `number` |
+| <a id="a"></a> `a` | `number` |

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

@@ -0,0 +1,3 @@
+```ts
+type ConnectInitParamBaseType = AudioParam | AudioNodeInit;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type ConnectInitParamType = ConnectInitParamBaseType | undefined;
+```

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

@@ -0,0 +1,11 @@
+```ts
+type ConnectParamBase<T> = 
+  | [T, T extends undefined ? undefined : AudioNodeOutputIndex, T extends undefined ? undefined : AudioNodeInputIndex]
+  | T;
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* \| [`ConnectParamType`](ConnectParamType.mdx) \| [`ConnectInitParamType`](ConnectInitParamType.mdx) |

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

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

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

@@ -0,0 +1,3 @@
+```ts
+type ConnectParamType = ConnectParamBaseType | undefined;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type DelayNodeInit = AudioNodeInit<DelayNode, DelayNode>;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type Delegate = "CPU" | "GPU" | undefined;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type DenoiseWorkletNodeInit = AudioNodeInit<AudioWorkletNode>;
+```

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

@@ -0,0 +1,9 @@
+```ts
+type ExtractMessageEventType<T> = T extends object ? O : never;
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* `object` |

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

@@ -0,0 +1,3 @@
+```ts
+type GainNodeInit = AudioNodeInit<GainNode, Gain>;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type ImageMapIterable = Iterable<readonly [string, ImageBitmap]>;
+```

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

@@ -0,0 +1,6 @@
+```ts
+type ImageType = 
+  | CanvasImageSource
+  | ProcessInputType
+  | VideoFrame;
+```

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

@@ -0,0 +1,10 @@
+```ts
+type IncludeMessageEventDataType<E, I> = E extends object ? A extends I ? D : never : E extends object ? B extends I ? void : never : never;
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `E` *extends* `object` |
+| `I` |

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

@@ -0,0 +1,3 @@
+```ts
+type InputFrame = HTMLCanvasElement | OffscreenCanvas | VideoFrame | ImageBitmap;
+```

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

@@ -0,0 +1,19 @@
+```ts
+type IsVoice<T> = (data) => boolean;
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `T` |
+
+## Returns
+
+`boolean`

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

@@ -0,0 +1,3 @@
+```ts
+type MediaElementAudioSourceNodeInit = AudioNodeInit<MediaElementAudioSourceNode, MediaElementAudioSourceNode>;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type MediaStreamAudioDestinationNodeInit = AudioNodeInit<MediaStreamAudioDestinationNode, MediaStreamAudioDestinationNode>;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type MediaStreamAudioSourceNodeInit = AudioNodeInit<MediaStreamAudioSourceNode, MediaStreamAudioSourceNode>;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type Node = AudioNode | AudioParam;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type NodeConnectionAction = "connect" | "disconnect";
+```

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

@@ -0,0 +1,3 @@
+```ts
+type Nodes = Node[];
+```

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

@@ -0,0 +1,10 @@
+```ts
+type OptionalKeys<T, K> = Omit<T, K> & Partial<Pick<T, K>>;
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+| `K` *extends* keyof `T` |

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

@@ -0,0 +1,17 @@
+```ts
+type ProcessEvents<T, I> = 
+  | ProcessEventOpen<T>
+  | ProcessEventProcess<I>
+  | ProcessEventUpdate<T>
+  | ProcessEventClose
+  | ProcessEventDestroy;
+```
+
+Message events to be sent to the Processor
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+| `I` |

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

@@ -0,0 +1,3 @@
+```ts
+type ProcessInputType = VideoFrame | ImageData | OffscreenCanvas | ImageBitmap;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type ProcessStatus = ExtractValueTypes<typeof PROCESS_STATUS>;
+```

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

@@ -0,0 +1,15 @@
+```ts
+type ProcessVideoTrack = (track, transformers, options?) => Promise<Track>;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `track` | `MediaStreamVideoTrack` |
+| `transformers` | `Transformer`\<[`InputFrame`](InputFrame.mdx), [`InputFrame`](InputFrame.mdx)\>[] |
+| `options?` | `Options` |
+
+## Returns
+
+`Promise`\<`Track`\>

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

@@ -0,0 +1,18 @@
+```ts
+type ProcessWorkerEvents<T, E, D> = 
+  | ProcessWorkerEventProcessed<T>
+  | ProcessWorkerEventOpened
+  | ProcessWorkerEventUpdated
+  | ProcessWorkerEvent<E>
+| ProcessWorkerEventDebug<D>;
+```
+
+Message events returned from the processor
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+| `E` |
+| `D` |

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

@@ -0,0 +1,3 @@
+```ts
+type ProcessorEvents = ProcessEvents<ProcessorOptions, ProcessorProcessOptions>;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type ProcessorWorkerEvents = ProcessWorkerEvents<VideoFrameLike, ProcessorEvent, ProcessWorkerDebugMessage>;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type RenderBackend = ExtractValueTypes<typeof RENDER_BACKEND>;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type RenderEffects = ExtractValueTypes<typeof RENDER_EFFECT>;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type RenderingEvents = ExtractValueTypes<typeof RENDERING_EVENTS>;
+```

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

@@ -0,0 +1,21 @@
+```ts
+type RunnerCreator<P, R> = (callback, frameRate) => Runner<P>;
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `P` *extends* `unknown`[] |
+| `R` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | [`Callback`](Callback.mdx)\<`R`, `P`\> |
+| `frameRate` | `number` |
+
+## Returns
+
+[`Runner`](../interfaces/Runner.mdx)\<`P`\>

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

@@ -0,0 +1,3 @@
+```ts
+type SegmentationModel = typeof SEGMENTATION_MODELS[keyof typeof SEGMENTATION_MODELS];
+```

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

@@ -0,0 +1,3 @@
+```ts
+type SegmentationTransform = Transform<InputFrame, InputFrame> & SegmentationParams & Pick<Segmenter, "update"> & Omit<Process, "open">;
+```

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

@@ -0,0 +1,12 @@
+```ts
+type TupleOf<T, N> = N extends N ? number extends N ? T[] : _TupleOf<T, N, []> : never;
+```
+
+From https://github.com/Microsoft/TypeScript/issues/26223#issuecomment-674500430
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+| `N` *extends* `number` |

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

@@ -0,0 +1,6 @@
+```ts
+type UniversalAudioContextState = AudioContextState | "interrupted";
+```
+
+We need to add the missing type def to work with AudioContextState in Safari
+See https://developer.mozilla.org/en-US/docs/Web/API/BaseAudioContext/state#resuming_interrupted_play_states_in_ios_safari

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

@@ -0,0 +1,9 @@
+```ts
+type Unsubscribe = () => void;
+```
+
+Unsubscribe the subscription
+
+## Returns
+
+`void`

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

@@ -0,0 +1,3 @@
+```ts
+type WasmPaths = [string, string | undefined];
+```

package/api-docs/variables/BACKGROUND_BLUR_AMOUNT.mdx

@@ -0,0 +1,3 @@
+```ts
+const BACKGROUND_BLUR_AMOUNT: 3 = 3;
+```

package/api-docs/variables/BACKGROUND_THRESHOLD.mdx

@@ -0,0 +1,3 @@
+```ts
+const BACKGROUND_THRESHOLD: 0.35 = 0.35;
+```

package/api-docs/variables/CLIP_COUNT_THRESHOLD.mdx

@@ -0,0 +1,6 @@
+```ts
+const CLIP_COUNT_THRESHOLD: 6 = 6.0;
+```
+
+Default clipping count threshold
+Number of consecutive clipThreshold level samples that indicate clipping.

package/api-docs/variables/CLIP_THRESHOLD.mdx

@@ -0,0 +1,5 @@
+```ts
+const CLIP_THRESHOLD: 0.98 = 0.98;
+```
+
+Default clipping detection threshold

package/api-docs/variables/DOWN_SAMPLE_FACTOR.mdx

@@ -0,0 +1,3 @@
+```ts
+const DOWN_SAMPLE_FACTOR: 2 = 2;
+```

package/api-docs/variables/EDGE_BLUR_AMOUNT.mdx

@@ -0,0 +1,3 @@
+```ts
+const EDGE_BLUR_AMOUNT: 4 = 4;
+```

package/api-docs/variables/EXCLUDE_BYSTANDERS.mdx

@@ -0,0 +1,3 @@
+```ts
+const EXCLUDE_BYSTANDERS: false = false;
+```

package/api-docs/variables/FOREGROUND_THRESHOLD.mdx

@@ -0,0 +1,3 @@
+```ts
+const FOREGROUND_THRESHOLD: 0.85 = 0.85;
+```

package/api-docs/variables/FRAME_RATE.mdx

@@ -0,0 +1,3 @@
+```ts
+const FRAME_RATE: 20 = 20;
+```

package/api-docs/variables/LIGHT_WRAP_BLUR_AMOUNT.mdx

@@ -0,0 +1,3 @@
+```ts
+const LIGHT_WRAP_BLUR_AMOUNT: 1 = 1;
+```

package/api-docs/variables/LIGHT_WRAP_EDGE_BAND.mdx

@@ -0,0 +1,3 @@
+```ts
+const LIGHT_WRAP_EDGE_BAND: 0.25 = 0.25;
+```

package/api-docs/variables/LIGHT_WRAP_INTENSITY.mdx

@@ -0,0 +1,3 @@
+```ts
+const LIGHT_WRAP_INTENSITY: 0.8 = 0.8;
+```

package/api-docs/variables/LIGHT_WRAP_TIGHTNESS.mdx

@@ -0,0 +1,3 @@
+```ts
+const LIGHT_WRAP_TIGHTNESS: 1 = 1;
+```

package/api-docs/variables/LOW_VOLUME_THRESHOLD.mdx

@@ -0,0 +1,5 @@
+```ts
+const LOW_VOLUME_THRESHOLD: -60 = -60;
+```
+
+Default low volume detection threshold

package/api-docs/variables/MASK_COMBINE_RATIO.mdx

@@ -0,0 +1,3 @@
+```ts
+const MASK_COMBINE_RATIO: 0.8 = 0.8;
+```

package/api-docs/variables/MONO_THRESHOLD.mdx

@@ -0,0 +1,6 @@
+```ts
+const MONO_THRESHOLD: number;
+```
+
+Default mono detection threshold
+Data must be identical within one LSB 16-bit to be identified as mono.

package/api-docs/variables/MORPH_DILATE_RADIUS_PX.mdx

@@ -0,0 +1,3 @@
+```ts
+const MORPH_DILATE_RADIUS_PX: 6 = 6;
+```

package/api-docs/variables/MORPH_ERODE_RADIUS_PX.mdx

@@ -0,0 +1,3 @@
+```ts
+const MORPH_ERODE_RADIUS_PX: 5 = 5;
+```

package/api-docs/variables/MORPH_PASS.mdx

@@ -0,0 +1,3 @@
+```ts
+const MORPH_PASS: 4 = 4;
+```

package/api-docs/variables/PERSON_CENTER.mdx

@@ -0,0 +1,3 @@
+```ts
+const PERSON_CENTER: [number, number];
+```

package/api-docs/variables/PLAY_VIDEO_TIMEOUT.mdx

@@ -0,0 +1,3 @@
+```ts
+const PLAY_VIDEO_TIMEOUT: 6000 = 6000;
+```

package/api-docs/variables/PROCESSING_HEIGHT.mdx

@@ -0,0 +1,3 @@
+```ts
+const PROCESSING_HEIGHT: 432 = 432;
+```

package/api-docs/variables/PROCESSING_WIDTH.mdx

@@ -0,0 +1,3 @@
+```ts
+const PROCESSING_WIDTH: 768 = 768;
+```

package/api-docs/variables/PROCESS_STATUS.mdx

@@ -0,0 +1,22 @@
+```ts
+const PROCESS_STATUS: object;
+```
+
+Process status
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| <a id="closed"></a> `Closed` | `"closed"` |
+| <a id="closing"></a> `Closing` | `"closing"` |
+| <a id="destroyed"></a> `Destroyed` | `"destroyed"` |
+| <a id="destroying"></a> `Destroying` | `"destroying"` |
+| <a id="error"></a> `Error` | `"Error"` |
+| <a id="idle"></a> `Idle` | `"idle"` |
+| <a id="new"></a> `New` | `"new"` |
+| <a id="opened"></a> `Opened` | `"opened"` |
+| <a id="opening"></a> `Opening` | `"opening"` |
+| <a id="processing"></a> `Processing` | `"processing"` |
+| <a id="updated"></a> `Updated` | `"updated"` |
+| <a id="updating"></a> `Updating` | `"updating"` |

package/api-docs/variables/RENDERING_EVENTS.mdx

@@ -0,0 +1,14 @@
+```ts
+const RENDERING_EVENTS: object;
+```
+
+## Type Declaration
+
+| Name | Type | Description |
+| ------ | ------ | ------ |
+| <a id="contextcreationerror"></a> `ContextCreationError` | `"ContextCreationError"` | Triggered when failed to create a context |
+| <a id="contextlost"></a> `ContextLost` | `"ContextLost"` | Triggered when context is lost |
+| <a id="contextrestored"></a> `ContextRestored` | `"ContextRestored"` | Triggered when context is restored |
+| <a id="error"></a> `Error` | `"Error"` | Triggered when there is unknown error |
+| <a id="processorrestarted"></a> `ProcessorRestarted` | `"ProcessorRestarted"` | Triggered when the processor is restarted |
+| <a id="samplingerror"></a> `SamplingError` | `"SamplingError"` | Triggered when sampling error occurs |

package/api-docs/variables/RENDER_BACKEND.mdx

@@ -0,0 +1,10 @@
+```ts
+const RENDER_BACKEND: object;
+```
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| <a id="webgl"></a> `WebGL` | `"webgl"` |
+| <a id="webgpu"></a> `WebGPU` | `"webgpu"` |

package/api-docs/variables/RENDER_EFFECT.mdx

@@ -0,0 +1,11 @@
+```ts
+const RENDER_EFFECT: object;
+```
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| <a id="none"></a> `None` | `"none"` |
+| <a id="blur"></a> `Blur` | `"blur"` |
+| <a id="overlay"></a> `Overlay` | `"overlay"` |