@pexip/media-processor 20.3.4 → 21.0.0

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

@@ -0,0 +1,19 @@
+```ts
+function iou(a, b): number;
+```
+
+Intersection over Union (IoU), how much two masks overlap as a fraction of either's total.
+1.0 = perfect match, 0 = no overlap.
+Used for stable, robust tracking of the main person between frames,
+especially with bystander removal and temporal instance switching.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `a` | `Uint8Array` |
+| `b` | `Uint8Array` |
+
+## Returns
+
+`number`

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`

package/api-docs/functions/isLowVolume.mdx

@@ -0,0 +1,19 @@
+```ts
+function isLowVolume(gain, threshold): boolean;
+```
+
+Check if the provided gain above the low volume threshold, which is
+considered as low volume.
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `gain` | `number` | `undefined` | Floating point representation of the gain number |
+| `threshold` | `number` | `LOW_VOLUME_THRESHOLD` | - |
+
+## Returns
+
+`boolean`
+
+`true` if the `gain` is lower than the threshold

package/api-docs/functions/isMono.mdx

@@ -0,0 +1,22 @@
+```ts
+function isMono(channels, threshold): boolean;
+```
+
+Check if provided channels are mono or stereo
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `channels` | [`AudioSamples`](../type-aliases/AudioSamples.mdx)[] | `undefined` | Audio channels and assuming the inputs are in floating point form |
+| `threshold` | `number` | `MONO_THRESHOLD` | Mono detection threshold, default to floating point form |
+
+## Returns
+
+`boolean`
+
+`true` if they are mono, otherwise stereo
+
+## Default Value
+
+`1.0 / 32767`

package/api-docs/functions/isRenderEffects.mdx

@@ -0,0 +1,13 @@
+```ts
+function isRenderEffects(t): t is "blur" | "none" | "overlay";
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `t` | `unknown` |
+
+## Returns
+
+t is "blur" \| "none" \| "overlay"

package/api-docs/functions/isSilent.mdx

@@ -0,0 +1,22 @@
+```ts
+function isSilent(samples, threshold): boolean;
+```
+
+Simple silent detection to only check the first and last bit from the sample
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `samples` | [`AudioSamples`](../type-aliases/AudioSamples.mdx) | `undefined` | Audio sample data, this could be in a form of floating number of a byte number as long as the `threshold` value is given accordingly. |
+| `threshold` | `number` | `SILENT_THRESHOLD` | Silent threshold |
+
+## Returns
+
+`boolean`
+
+`true` when it is silent
+
+## Default Value
+
+`1.0 / 32767` assuming the sample is float value

package/api-docs/functions/isVoiceActivity.mdx

@@ -0,0 +1,29 @@
+```ts
+function isVoiceActivity(options): (volume) => boolean;
+```
+
+A Naive Voice activity detection
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | `VAOptions` | See `VAOptions` |
+
+## Returns
+
+`(volume: number) => boolean`, `true` if there is voice
+
+```ts
+(volume): boolean;
+```
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `volume` | `number` |
+
+### Returns
+
+`boolean`

package/api-docs/functions/labelComponents.mdx

@@ -0,0 +1,20 @@
+```ts
+function labelComponents(
+   input, 
+   labels, 
+   width, 
+height): Map<number, Stats>;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `input` | `Uint8Array` |
+| `labels` | `Int32Array` |
+| `width` | `number` |
+| `height` | `number` |
+
+## Returns
+
+`Map`\<`number`, [`Stats`](../interfaces/Stats.mdx)\>

package/api-docs/functions/line.mdx

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

package/api-docs/functions/loadScript.mdx

@@ -0,0 +1,14 @@
+```ts
+function loadScript(path, id): Promise<void>;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+| `id` | `string` |
+
+## Returns
+
+`Promise`\<`void`\>

package/api-docs/functions/loadWasms.mdx

@@ -0,0 +1,13 @@
+```ts
+function loadWasms(paths): Promise<void>;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `paths` | [`WasmPaths`](../type-aliases/WasmPaths.mdx)[] |
+
+## Returns
+
+`Promise`\<`void`\>

package/api-docs/functions/nearestPowerOfTwo.mdx

@@ -0,0 +1,21 @@
+```ts
+function nearestPowerOfTwo(
+   n, 
+   minPow?, 
+   maxPow?): number;
+```
+
+Coerce any positive number to the nearest power of two within [minPow, maxPow]
+Example: nearestPowerOfTwo(13) => 16; nearestPowerOfTwo(3.2) => 4
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `n` | `number` |
+| `minPow?` | `number` |
+| `maxPow?` | `number` |
+
+## Returns
+
+`number`

package/api-docs/functions/playVideo.mdx

@@ -0,0 +1,16 @@
+```ts
+function playVideo(video, __namedParameters): Promise<void>;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `video` | `HTMLVideoElement` |
+| `__namedParameters` | \{ `setTimeout?`: (`handler`, `timeout?`, ...`arguments`) => `number` & (`handler`, `timeout?`, ...`arguments`) => `number`; `clearTimeout?`: (`id`) => `void` & (`id`) => `void`; \} |
+| `__namedParameters.setTimeout?` | (`handler`, `timeout?`, ...`arguments`) => `number` & (`handler`, `timeout?`, ...`arguments`) => `number` |
+| `__namedParameters.clearTimeout?` | (`id`) => `void` & (`id`) => `void` |
+
+## Returns
+
+`Promise`\<`void`\>

package/api-docs/functions/pow.mdx

@@ -0,0 +1,29 @@
+```ts
+function pow(exponent): (base) => number;
+```
+
+pow function from Math in functional form `number -> number -> number`
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `exponent` | `number` | The exponent used for the expression |
+
+## Returns
+
+Math.pow(base, exponent)
+
+```ts
+(base): number;
+```
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `base` | `number` |
+
+### Returns
+
+`number`

package/api-docs/functions/processAverageVolume.mdx

@@ -0,0 +1,15 @@
+```ts
+function processAverageVolume(data): number;
+```
+
+**`Alpha`**
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `number`[] |
+
+## Returns
+
+`number`

package/api-docs/functions/resumeAudioOnInterruption.mdx

@@ -0,0 +1,23 @@
+```ts
+function resumeAudioOnInterruption(audioContext): () => void;
+```
+
+**`Alpha`**
+
+Resume the stream whenever interrupted
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `audioContext` | `AudioContext` | AudioContext |
+
+## Returns
+
+```ts
+(): void;
+```
+
+### Returns
+
+`void`

package/api-docs/functions/resumeAudioOnUnmute.mdx

@@ -0,0 +1,27 @@
+```ts
+function resumeAudioOnUnmute(context): (track) => Unsubscribe;
+```
+
+**`Alpha`**
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `context` | `AudioContext` |
+
+## Returns
+
+```ts
+(track): Unsubscribe;
+```
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `track` | `MediaStreamTrack` | The source track to listen on the `unmute` event |
+
+### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)

package/api-docs/functions/rms.mdx

@@ -0,0 +1,15 @@
+```ts
+function rms(nums): number;
+```
+
+Calculate the Root Mean Square from provided numbers
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nums` | `number`[] | An array of numbers |
+
+## Returns
+
+`number`

package/api-docs/functions/round.mdx

@@ -0,0 +1,23 @@
+```ts
+function round(num): number;
+```
+
+Round the floating point number away from zero, which is different from
+`Math.round`
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `num` | `number` | The number to round |
+
+## Returns
+
+`number`
+
+## Example
+
+```typescript
+round(0.5) // 1
+round(-0.5) // -1
+```

package/api-docs/functions/scoreComponent.mdx

@@ -0,0 +1,22 @@
+```ts
+function scoreComponent(
+   stats, 
+   overlap, 
+   weights, 
+   width, 
+   height): number;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `stats` | [`Stats`](../interfaces/Stats.mdx) |
+| `overlap` | `number` |
+| `weights` | [`SelectionOptions`](../interfaces/SelectionOptions.mdx) |
+| `width` | `number` |
+| `height` | `number` |
+
+## Returns
+
+`number`

package/api-docs/functions/setVideoElementSrc.mdx

@@ -0,0 +1,14 @@
+```ts
+function setVideoElementSrc(video, src): void;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `video` | `HTMLVideoElement` |
+| `src` | `MediaProvider` |
+
+## Returns
+
+`void`

package/api-docs/functions/subscribeTimeoutAnalyzerNode.mdx

@@ -0,0 +1,22 @@
+```ts
+function subscribeTimeoutAnalyzerNode(analyzer, options): () => void;
+```
+
+Subscribe to a timeout loop to get the data from Analyzer
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `analyzer` | [`Analyzer`](../interfaces/Analyzer.mdx) | the analyzer to subscribe |
+| `options` | [`AnalyzerSubscribableOptions`](../interfaces/AnalyzerSubscribableOptions.mdx) | message handler, etc. |
+
+## Returns
+
+```ts
+(): void;
+```
+
+### Returns
+
+`void`

package/api-docs/functions/subscribeWorkletNode.mdx

@@ -0,0 +1,28 @@
+```ts
+function subscribeWorkletNode<T>(workletNode, options): () => void;
+```
+
+Subscribe MessagePort message from an AudioWorkletNode
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `workletNode` | `AudioWorkletNode` | the node to subscribe |
+| `options` | `Partial`\<[`WorkletMessagePortOptions`](../interfaces/WorkletMessagePortOptions.mdx)\<`T`\>\> | can pass a message handler here to handle the message |
+
+## Returns
+
+```ts
+(): void;
+```
+
+### Returns
+
+`void`

package/api-docs/functions/sum.mdx

@@ -0,0 +1,15 @@
+```ts
+function sum(nums): number;
+```
+
+Sum an array of numbers
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nums` | `number`[] | An array of numbers |
+
+## Returns
+
+`number`

package/api-docs/functions/toDecibel.mdx

@@ -0,0 +1,18 @@
+```ts
+function toDecibel(gain): number;
+```
+
+Convert a floating point gain value into a dB representation without any
+reference, dBFS, https://en.wikipedia.org/wiki/DBFS
+
+See https://www.w3.org/TR/webaudio#conversion-to-db
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `gain` | `number` |
+
+## Returns
+
+`number`