@pexip/media-processor 20.3.4 → 20.3.5

package/api-docs/interfaces/Analyzer.mdx

@@ -0,0 +1,368 @@
+## Extends
+
+- [`BaseAudioNode`](../type-aliases/BaseAudioNode.mdx)
+
+## Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="node"></a> `node` | `readonly` | `AnalyserNode` |
+| <a id="frequencybincount"></a> `frequencyBinCount` | `readonly` | `number` |
+| <a id="fftsize"></a> `fftSize` | `public` | `number` |
+| <a id="mindecibels"></a> `minDecibels` | `public` | `number` |
+| <a id="maxdecibels"></a> `maxDecibels` | `public` | `number` |
+| <a id="smoothingtimeconstant"></a> `smoothingTimeConstant` | `public` | `number` |
+
+## Methods
+
+### getByteTimeDomainData()
+
+```ts
+getByteTimeDomainData(buffer): void;
+```
+
+Copies the current waveform, or time-domain, data into a Uint8Array
+(unsigned byte array) passed into it.
+
+If the array has fewer elements than the `AnalyserNode.fftSize`, excess
+elements are dropped.
+If it has more elements than needed, excess elements are ignored.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `Uint8Array` | Use provided buffer instead of creating a new one |
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+The bytes versions are not cheaper than the float version but provided
+for convenient: the byte version are computed from the float version,
+using simple quantization to 2^8 values
+ref. https://padenot.github.io/web-audio-perf/#analysernode
+
+***
+
+### getByteFrequencyData()
+
+```ts
+getByteFrequencyData(buffer): void;
+```
+
+Copies the current frequency data into a Uint8Array (unsigned byte array)
+passed into it.
+
+The frequency data is composed of integers on a scale from 0 to 255.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `Uint8Array` | Use provided buffer instead of creating a new one |
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+The bytes versions are not cheaper than the float version but provided
+for convenient: the byte version are computed from the float version,
+using simple quantization to 2^8 values
+ref. https://padenot.github.io/web-audio-perf/#analysernode
+
+***
+
+### getFloatTimeDomainData()
+
+```ts
+getFloatTimeDomainData(buffer): void;
+```
+
+Copies the current waveform, or time-domain, data into Float32Array
+passed into it
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `Float32Array` | Use provided buffer instead of creating a new one |
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+The buffer size should be the same as `AnalyserNode.fftSize`
+
+***
+
+### getFloatFrequencyData()
+
+```ts
+getFloatFrequencyData(buffer): void;
+```
+
+Copies the current waveform, or time-domain, data into Float32Array
+passed into it
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `Float32Array` | Use provided buffer instead of creating a new one |
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+The buffer size should be the same as `AnalyserNode.frequencyBinCount`
+
+***
+
+### getAverageVolume()
+
+```ts
+getAverageVolume(buffer): number;
+```
+
+Utility function to get the average volume from `getByteFrequencyData`
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `buffer` | `Float32Array` |
+
+#### Returns
+
+`number`
+
+#### Remarks
+
+This is a better option when you only need to get the volume in terms of
+performance and complexity.
+
+***
+
+### 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/AnalyzerSubscribableOptions.mdx

@@ -0,0 +1,11 @@
+## Extends
+
+- [`SubscribableOptions`](SubscribableOptions.mdx).[`WorkletMessagePortOptions`](WorkletMessagePortOptions.mdx)\<[`Analyzer`](Analyzer.mdx)\>
+
+## Properties
+
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="updatefrequency"></a> `updateFrequency?` | `number` | [`SubscribableOptions`](SubscribableOptions.mdx).[`updateFrequency`](SubscribableOptions.mdx#updatefrequency) |
+| <a id="messagehandler"></a> `messageHandler` | (`message`) => `void` | [`WorkletMessagePortOptions`](WorkletMessagePortOptions.mdx).[`messageHandler`](WorkletMessagePortOptions.mdx#messagehandler) |
+| <a id="errorhandler"></a> `errorHandler?` | (`event`) => `void` | [`WorkletMessagePortOptions`](WorkletMessagePortOptions.mdx).[`errorHandler`](WorkletMessagePortOptions.mdx#errorhandler) |

package/api-docs/interfaces/AsyncAssets.mdx

@@ -0,0 +1,7 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="tfjscoreloaded"></a> `tfjsCoreLoaded` | `boolean` |
+| <a id="tfjsbackendloaded"></a> `tfjsBackendLoaded` | `boolean` |
+| <a id="glueloaded"></a> `glueLoaded` | `boolean` |

package/api-docs/interfaces/AudioGraph.mdx

@@ -0,0 +1,92 @@
+## Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="context"></a> `context` | `readonly` | `AudioContext` |
+| <a id="inits"></a> `inits` | `readonly` | [`AudioNodeInit`](AudioNodeInit.mdx)\<`AudioNode`, [`BaseAudioNode`](../type-aliases/BaseAudioNode.mdx)\>[] |
+| <a id="state"></a> `state` | `readonly` | `AudioGraphState` |
+
+## Methods
+
+### connect()
+
+```ts
+connect(sequence): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `sequence` | [`AudioNodeInitConnection`](../type-aliases/AudioNodeInitConnection.mdx) |
+
+#### Returns
+
+`void`
+
+***
+
+### disconnect()
+
+```ts
+disconnect(sequence): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `sequence` | [`AudioNodeInitConnection`](../type-aliases/AudioNodeInitConnection.mdx) |
+
+#### Returns
+
+`void`
+
+***
+
+### addWorklet()
+
+```ts
+addWorklet(moduleURL, options?): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `moduleURL` | `string` |
+| `options?` | `WorkletOptions` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### releaseInit()
+
+```ts
+releaseInit(init): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `init` | [`AudioNodeInit`](AudioNodeInit.mdx) |
+
+#### Returns
+
+`void`
+
+***
+
+### release()
+
+```ts
+release(): Promise<void>;
+```
+
+#### Returns
+
+`Promise`\<`void`\>

package/api-docs/interfaces/AudioGraphOptions.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="context"></a> `context?` | `AudioContext` |
+| <a id="contextoptions"></a> `contextOptions?` | `AudioContextOptions` |

package/api-docs/interfaces/AudioNodeInit.mdx

@@ -0,0 +1,127 @@
+## Extends
+
+- `Readonly`\<[`AudioNodeProps`](AudioNodeProps.mdx)\<`T`, `R`\>\>
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `AudioNode` | `AudioNode` |
+| `R` *extends* [`BaseAudioNode`](../type-aliases/BaseAudioNode.mdx) | [`BaseAudioNode`](../type-aliases/BaseAudioNode.mdx) |
+
+## Properties
+
+| Property | Modifier | Type | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="name"></a> `name` | `readonly` | `string` | `Readonly.name` |
+| <a id="node"></a> `node` | `readonly` | `R` \| `undefined` | `Readonly.node` |
+| <a id="audionode"></a> `audioNode` | `readonly` | `T` \| `undefined` | `Readonly.audioNode` |
+| <a id="outputs"></a> `outputs` | `readonly` | `WeakSet`\< \| `AudioNodeInit`\<`AudioNode`, [`BaseAudioNode`](../type-aliases/BaseAudioNode.mdx)\> \| `AudioParam`\> | `Readonly.outputs` |
+| <a id="tojson"></a> `toJSON?` | `public` | () => `unknown` | - |
+
+## Methods
+
+### create()
+
+```ts
+create(context, prevNode?): [T, R];
+```
+
+**`Internal`**
+
+Internal function to create the actual AudioNode.
+Should ONLY be CALLED inside an AudioGraph
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | `AudioContext` | Audio Context to use |
+| `prevNode?` | `AudioNode` | The input AudioNode for connection |
+
+#### Returns
+
+\[`T`, `R`\]
+
+***
+
+### connect()
+
+```ts
+connect(param): void;
+```
+
+**`Internal`**
+
+Internal function to connect a signal output
+Should ONLY be CALLED inside an AudioGraph
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `param` | [`AudioNodeInitConnectParam`](../type-aliases/AudioNodeInitConnectParam.mdx) | The init to connect |
+
+#### Returns
+
+`void`
+
+***
+
+### disconnect()
+
+```ts
+disconnect(param): void;
+```
+
+**`Internal`**
+
+Internal function to disconnect a signal output
+Should ONLY be CALLED inside an AudioGraph
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `param` | [`AudioNodeInitConnectParam`](../type-aliases/AudioNodeInitConnectParam.mdx) | The init to disconnect |
+
+#### Returns
+
+`void`
+
+***
+
+### hasConnectedTo()
+
+```ts
+hasConnectedTo(init): boolean;
+```
+
+Check if there is a connection to the provided init
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `init` | \| `AudioNodeInit`\<`AudioNode`, [`BaseAudioNode`](../type-aliases/BaseAudioNode.mdx)\> \| `AudioParam` | AudioNodeInit |
+
+#### Returns
+
+`boolean`
+
+***
+
+### release()
+
+```ts
+release(): void;
+```
+
+**`Internal`**
+
+Internal function to release the node init resources
+Should ONLY be CALLED inside an AudioGraph
+
+#### Returns
+
+`void`

package/api-docs/interfaces/AudioNodeProps.mdx

@@ -0,0 +1,15 @@
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* `AudioNode` |
+| `R` *extends* [`BaseAudioNode`](../type-aliases/BaseAudioNode.mdx) |
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="name"></a> `name` | `string` |
+| <a id="node"></a> `node` | `R` \| `undefined` |
+| <a id="audionode"></a> `audioNode` | `T` \| `undefined` |
+| <a id="outputs"></a> `outputs` | `WeakSet`\< \| [`AudioNodeInit`](AudioNodeInit.mdx)\<`AudioNode`, [`BaseAudioNode`](../type-aliases/BaseAudioNode.mdx)\> \| `AudioParam`\> |

package/api-docs/interfaces/AudioStats.mdx

@@ -0,0 +1,16 @@
+Data structure for the audio statistics while processing
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="silent"></a> `silent` | `boolean` | Indicating the audio is silent when it is set to `true` |
+| <a id="mono"></a> `mono?` | `boolean` | Indicating the audio is mono when it is set to `true` `undefined` means cannot-not-tell. |
+| <a id="lowvolume"></a> `lowVolume` | `boolean` | Indicating the audio is low volume when it is set to `true` |
+| <a id="clipping"></a> `clipping` | `boolean` | Indicating the audio is clipping when it is set to `true` |
+| <a id="peak"></a> `peak` | `number` | Peak gain value |
+| <a id="rms"></a> `rms` | `number` | Global rms |
+| <a id="maxrms"></a> `maxRms` | `number` | Maximum running RMS value |
+| <a id="maxclipcount"></a> `maxClipCount` | `number` | Maximum Clip count |
+| <a id="sumsquare"></a> `sumSquare` | `number` | Value of sum squared sample used for RMS calculation |
+| <a id="sumlength"></a> `sumLength` | `number` | Value of sum number of sample used for RMS calculation |

package/api-docs/interfaces/BackgroundImage.mdx

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

package/api-docs/interfaces/Benchmark.mdx

@@ -0,0 +1,35 @@
+## Methods
+
+### begin()
+
+```ts
+begin(): void;
+```
+
+#### Returns
+
+`void`
+
+***
+
+### end()
+
+```ts
+end(): void;
+```
+
+#### Returns
+
+`void`
+
+***
+
+### calculateFps()
+
+```ts
+calculateFps(): [number, number];
+```
+
+#### Returns
+
+\[`number`, `number`\]

package/api-docs/interfaces/Clock.mdx

@@ -0,0 +1,11 @@
+Clock interface to get the current time with now method,
+
+## See
+
+Performance['now']
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="now"></a> `now` | () => `number` |