@pexip/media-processor 20.3.4 → 20.3.5

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 20.3.5
+
+### Patch Changes
+
+- 13e3722: Generate the package documentation in a folder called doc-dist
+- Updated dependencies [13e3722]
+  - @pexip/utils@17.1.3
+
 ## 20.3.4
 
 ### Patch Changes

package/api-docs/README.mdx

@@ -0,0 +1,411 @@
+# `@pexip/media-processor`
+
+An package for media data processing using Web API.
+
+## Install
+
+`npm install @pexip/media-processor`
+
+## Usages
+
+### Use Analyzer to get the MediaStream data
+
+```typescript
+const stream = await navigator.mediaDevices.getUserMedia({audio:true});
+
+const fftSize = 64;
+// Setup an Audio Graph with `source` -> `analyzer`
+const source = createStreamSourceGraphNode(stream);
+const analyzer = createAnalyzerGraphNode({fftSize});
+const audioGraph = createAudioGraph([[source, analyzer]]);
+
+// Grab the current time domain data in floating point representation
+const buffer = new Float32Array(fftSize);
+analyzer.node?.getFloatTimeDomainData(buffer);
+// Do some work with the buffer
+buffer.forEach(...);
+
+// Get the current volume, [0, 1]
+const volume = analyzer.getAverageVolume(buffer);
+
+// Release the resources when you have done with the analyzer
+await audioGraph.release();
+```
+
+### Use AudioGraph to control the audio gain to mute/unmute
+
+```typescript
+const stream = await navigator.mediaDevices.getUserMedia({
+  audio: true,
+  video: true,
+});
+
+const mute = !stream.getAudioTracks()[0]?.enabled;
+
+// Setup an Audio Graph with `source` -> `gain`
+const source = createStreamSourceGraphNode(stream);
+const gain = createGainGraphNode(mute);
+const destination = createStreamDestinationGraphNode();
+
+const audioGraph = createAudioGraph([[source, gain, destination]]);
+
+// Use the output MediaStream to for the altered AudioTrack
+const alteredStream = new MediaStream([
+  ...stream.getVideoTracks(),
+  ...destination.stream.getAudioTracks(),
+]);
+
+// Mute the audio
+if (gain.node) {
+  gain.node.mute = true;
+}
+
+// Check if the audio is muted
+gain.node.mute; // returns `true`, since we have just set the gain to 0
+
+// Release the resources when you have done with the analyzer
+await audioGraph.release();
+```
+
+### Use noise suppression
+
+```typescript
+const stream = await navigator.mediaDevices.getUserMedia({
+  audio: true,
+  video: true,
+});
+
+// Fetch denoise WebAssembly
+const response = await fetch(
+  new URL('@pexip/denoise/denoise_bg.wasm', import.meta.url).href,
+);
+const wasmBuffer = await response.arrayBuffer();
+
+// Setup an Audio Graph with `source` -> `gain`
+const source = createStreamSourceGraphNode(stream);
+const destination = createStreamDestinationGraphNode();
+
+const audioGraph = createAudioGraph([[source, destination]]);
+// Add worklet module
+await audioGraph.addWorklet(
+new URL(
+        '@pexip/media-processor/dist/worklets/denoise.worklet',
+        import.meta.url,
+      ).href
+);
+const denoise = createDenoiseWorkletGraphNode(wasmBuffer);
+// Route the source through the denoise node
+const audioGraph.connect([source, denoise, destination]);
+const audioGraph.disconnect([source, destination]);
+
+// Release the resources when you have done with the analyzer
+await audioGraph.release();
+```
+
+### Use background blur
+
+```typescript
+import {
+  createSegmenter,
+  createCanvasTransform,
+  createVideoTrackProcessor,
+  createVideoTrackProcessorWithFallback,
+} from '@pexip/media-processor';
+
+// Grab the user's camera stream
+const stream = await navigator.mediaDevices.getUserMedia({video: true});
+
+// Setting the path to that `@mediapipe/tasks-vision` assets
+// It will be passed direct to
+// [FilesetResolver.forVisionTasks()](https://ai.google.dev/edge/api/mediapipe/js/tasks-vision.filesetresolver#filesetresolverforvisiontasks)
+const tasksVisionBasePath =
+  'A base path to specify the directory the Wasm files should be loaded from';
+
+const modelAsset = {
+  /**
+   * Path to mediapipe selfie segmentation model asset
+   */
+  path: 'A path to selfie segmentation model',
+  modelName: 'selfie' as const,
+};
+
+const segmenter = createSegmenter(tasksVisionBasePath, {modelAssets});
+// Create a processing transformer and set the effects to `blur`
+const transformer = createCanvasTransform(segmenter, {effects: 'blur'});
+const processor = createVideoProcessor([transformer]);
+
+// Start the processor
+await videoProcessor.open();
+
+// Passing the raw MediaStream to apply the effects
+// Then, use the output stream for whatever purpose
+const processedStream = await videoProcessor.process(stream);
+```
+
+## Profiling Web Audio
+
+You can do it with chrome, [See here][profiling web audio].
+
+## How AudioWorkletNode and the AudioWorkletProcessor work together
+
+```
+┌─────────────────────────┐             ┌──────────────────────────┐
+│                         │             │                          │
+│    Main Global Scope    │             │  AudioWorkletGlobalScope │
+│                         │             │                          │
+│  ┌───────────────────┐  │             │  ┌────────────────────┐  │
+│  │                   │  │ MessagePort │  │                    │  │
+│  │   AudioWorklet    │◄─┼─────────────┼─►│    AudioWorklet    │  │
+│  │       Node        │  │             │  │      Processor     │  │
+│  │                   │  │             │  │                    │  │
+│  └───────────────────┘  │             │  └────────────────────┘  │
+│                         │             │                          │
+└─────────────────────────┘             └──────────────────────────┘
+       Main Thread                          WebAudio Render Thread
+```
+
+### Constraints when using the AudioWorklet
+
+- Each `BaseAudioContext` possesses exactly one `AudioWorklet`
+- 128 samples-frames
+- No `fetch` API in the `AudioWorkletGlobalScope`
+- No `TextEncoder/Decoder` APIs in the `AudioWorkletGlobalScope`
+
+## References
+
+- [MDN - Web Audio API][web audio api]
+- [Web Audio Spec][web audio spec]
+
+[web audio api]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API
+[web audio spec]: https://webaudio.github.io/web-audio-api
+[profiling web audio]: https://web.dev/profiling-web-audio-apps-in-chrome
+
+A library for media analysis using Web APIs.
+
+## Enumerations
+
+| Enumeration | Description |
+| ------ | ------ |
+| [AbortReason](enumerations/AbortReason.mdx) | - |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [Segmentation](interfaces/Segmentation.mdx) | - |
+| [VideoFrameLike](interfaces/VideoFrameLike.mdx) | - |
+| [ImageRecord](interfaces/ImageRecord.mdx) | - |
+| [Rect](interfaces/Rect.mdx) | - |
+| [ProcessEventOpen](interfaces/ProcessEventOpen.mdx) | Message event to initializing the Processor |
+| [ProcessEventProcess](interfaces/ProcessEventProcess.mdx) | Message event to process the video frame |
+| [ProcessEventUpdate](interfaces/ProcessEventUpdate.mdx) | Message event to update processor options |
+| [ProcessEventClose](interfaces/ProcessEventClose.mdx) | Message event to stop the processing |
+| [ProcessEventDestroy](interfaces/ProcessEventDestroy.mdx) | Message event to release all the resources |
+| [ProcessEventDebug](interfaces/ProcessEventDebug.mdx) | Message event for debugging |
+| [ProcessWorkerEventProcessed](interfaces/ProcessWorkerEventProcessed.mdx) | - |
+| [ProcessWorkerEventOpened](interfaces/ProcessWorkerEventOpened.mdx) | - |
+| [ProcessWorkerEventUpdated](interfaces/ProcessWorkerEventUpdated.mdx) | - |
+| [ProcessWorkerEvent](interfaces/ProcessWorkerEvent.mdx) | - |
+| [ProcessWorkerEventDebug](interfaces/ProcessWorkerEventDebug.mdx) | - |
+| [ProcessorOptions](interfaces/ProcessorOptions.mdx) | - |
+| [ProcessorProcessOptions](interfaces/ProcessorProcessOptions.mdx) | - |
+| [ProcessWorkerDebugMessage](interfaces/ProcessWorkerDebugMessage.mdx) | - |
+| [ProcessorEvent](interfaces/ProcessorEvent.mdx) | - |
+| [RendererOptions](interfaces/RendererOptions.mdx) | - |
+| [Renderer](interfaces/Renderer.mdx) | - |
+| [RenderEventHandlers](interfaces/RenderEventHandlers.mdx) | - |
+| [SegmentationModelAsset](interfaces/SegmentationModelAsset.mdx) | Segmentation model asset that can be used to load a segmentation model. |
+| [ImageSegmenterOptions](interfaces/ImageSegmenterOptions.mdx) | - |
+| [SegmenterOptions](interfaces/SegmenterOptions.mdx) | - |
+| [SegmentationSmoothingConfig](interfaces/SegmentationSmoothingConfig.mdx) | - |
+| [MPMask](interfaces/MPMask.mdx) | Wrapper for a mask produced by a Segmentation Task. |
+| [Benchmark](interfaces/Benchmark.mdx) | - |
+| [Point](interfaces/Point.mdx) | Interface for Point consist of coordinates x and y |
+| [Size](interfaces/Size.mdx) | - |
+| [Frame](interfaces/Frame.mdx) | - |
+| [AudioStats](interfaces/AudioStats.mdx) | Data structure for the audio statistics while processing |
+| [StatsOptions](interfaces/StatsOptions.mdx) | Stats options for calculating the audio stats |
+| [SubscribableOptions](interfaces/SubscribableOptions.mdx) | - |
+| [WorkletMessagePortOptions](interfaces/WorkletMessagePortOptions.mdx) | - |
+| [AnalyzerSubscribableOptions](interfaces/AnalyzerSubscribableOptions.mdx) | - |
+| [Denoise](interfaces/Denoise.mdx) | A wrapper for the Denoise wasm module |
+| [Gain](interfaces/Gain.mdx) | - |
+| [Analyzer](interfaces/Analyzer.mdx) | - |
+| [AudioNodeProps](interfaces/AudioNodeProps.mdx) | - |
+| [AudioNodeInit](interfaces/AudioNodeInit.mdx) | - |
+| [WorkletModule](interfaces/WorkletModule.mdx) | - |
+| [AudioGraphOptions](interfaces/AudioGraphOptions.mdx) | - |
+| [AudioGraph](interfaces/AudioGraph.mdx) | - |
+| [Clock](interfaces/Clock.mdx) | Clock interface to get the current time with now method, |
+| [ThrottleOptions](interfaces/ThrottleOptions.mdx) | Limit the rate of flow in terms of millisecond, and provided Clock |
+| [Runner](interfaces/Runner.mdx) | - |
+| [Transform](interfaces/Transform.mdx) | - |
+| [AsyncAssets](interfaces/AsyncAssets.mdx) | - |
+| [Process](interfaces/Process.mdx) | - |
+| [BackgroundImage](interfaces/BackgroundImage.mdx) | - |
+| [Segmenter](interfaces/Segmenter.mdx) | - |
+| [Detector](interfaces/Detector.mdx) | - |
+| [SegmentationParams](interfaces/SegmentationParams.mdx) | - |
+| [VideoProcessor](interfaces/VideoProcessor.mdx) | - |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [ProcessStatus](type-aliases/ProcessStatus.mdx) | - |
+| [RenderBackend](type-aliases/RenderBackend.mdx) | - |
+| [RenderEffects](type-aliases/RenderEffects.mdx) | - |
+| [RenderingEvents](type-aliases/RenderingEvents.mdx) | - |
+| [ProcessInputType](type-aliases/ProcessInputType.mdx) | - |
+| [ImageType](type-aliases/ImageType.mdx) | - |
+| [ImageMapIterable](type-aliases/ImageMapIterable.mdx) | - |
+| [ProcessEvents](type-aliases/ProcessEvents.mdx) | Message events to be sent to the Processor |
+| [ProcessWorkerEvents](type-aliases/ProcessWorkerEvents.mdx) | Message events returned from the processor |
+| [ProcessorEvents](type-aliases/ProcessorEvents.mdx) | - |
+| [ProcessorWorkerEvents](type-aliases/ProcessorWorkerEvents.mdx) | - |
+| [SegmentationModel](type-aliases/SegmentationModel.mdx) | - |
+| [Delegate](type-aliases/Delegate.mdx) | - |
+| [ExtractMessageEventType](type-aliases/ExtractMessageEventType.mdx) | - |
+| [IncludeMessageEventDataType](type-aliases/IncludeMessageEventDataType.mdx) | - |
+| [TupleOf](type-aliases/TupleOf.mdx) | From https://github.com/Microsoft/TypeScript/issues/26223#issuecomment-674500430 |
+| [Canvas](type-aliases/Canvas.mdx) | - |
+| [Unsubscribe](type-aliases/Unsubscribe.mdx) | Unsubscribe the subscription |
+| [AudioBufferFloats](type-aliases/AudioBufferFloats.mdx) | 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) |
+| [AudioBufferBytes](type-aliases/AudioBufferBytes.mdx) | Same as the return from [AnalyserNode.getByteFrequencyData()](https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData) |
+| [AudioSamples](type-aliases/AudioSamples.mdx) | Audio samples from each channel, either in float or bytes form |
+| [NodeConnectionAction](type-aliases/NodeConnectionAction.mdx) | - |
+| [BaseAudioNode](type-aliases/BaseAudioNode.mdx) | - |
+| [AudioNodeParam](type-aliases/AudioNodeParam.mdx) | - |
+| [Node](type-aliases/Node.mdx) | - |
+| [Nodes](type-aliases/Nodes.mdx) | - |
+| [ConnectParamBaseType](type-aliases/ConnectParamBaseType.mdx) | - |
+| [ConnectInitParamBaseType](type-aliases/ConnectInitParamBaseType.mdx) | - |
+| [ConnectParamType](type-aliases/ConnectParamType.mdx) | - |
+| [ConnectInitParamType](type-aliases/ConnectInitParamType.mdx) | - |
+| [ConnectParamBase](type-aliases/ConnectParamBase.mdx) | - |
+| [AudioNodeConnectParam](type-aliases/AudioNodeConnectParam.mdx) | - |
+| [AudioNodeInitConnectParam](type-aliases/AudioNodeInitConnectParam.mdx) | - |
+| [AudioNodeInitConnection](type-aliases/AudioNodeInitConnection.mdx) | - |
+| [AudioNodeInitConnections](type-aliases/AudioNodeInitConnections.mdx) | - |
+| [MediaStreamAudioSourceNodeInit](type-aliases/MediaStreamAudioSourceNodeInit.mdx) | - |
+| [MediaElementAudioSourceNodeInit](type-aliases/MediaElementAudioSourceNodeInit.mdx) | - |
+| [AnalyzerNodeInit](type-aliases/AnalyzerNodeInit.mdx) | - |
+| [DenoiseWorkletNodeInit](type-aliases/DenoiseWorkletNodeInit.mdx) | - |
+| [GainNodeInit](type-aliases/GainNodeInit.mdx) | - |
+| [MediaStreamAudioDestinationNodeInit](type-aliases/MediaStreamAudioDestinationNodeInit.mdx) | - |
+| [AudioDestinationNodeInit](type-aliases/AudioDestinationNodeInit.mdx) | - |
+| [DelayNodeInit](type-aliases/DelayNodeInit.mdx) | - |
+| [ChannelSplitterNodeInit](type-aliases/ChannelSplitterNodeInit.mdx) | - |
+| [UniversalAudioContextState](type-aliases/UniversalAudioContextState.mdx) | 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 |
+| [CanvasContext](type-aliases/CanvasContext.mdx) | - |
+| [IsVoice](type-aliases/IsVoice.mdx) | - |
+| [AsyncCallback](type-aliases/AsyncCallback.mdx) | - |
+| [Callback](type-aliases/Callback.mdx) | - |
+| [RunnerCreator](type-aliases/RunnerCreator.mdx) | - |
+| [WasmPaths](type-aliases/WasmPaths.mdx) | - |
+| [Color](type-aliases/Color.mdx) | - |
+| [InputFrame](type-aliases/InputFrame.mdx) | - |
+| [SegmentationTransform](type-aliases/SegmentationTransform.mdx) | - |
+| [ProcessVideoTrack](type-aliases/ProcessVideoTrack.mdx) | - |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [PROCESSING\_WIDTH](variables/PROCESSING_WIDTH.mdx) | - |
+| [PROCESSING\_HEIGHT](variables/PROCESSING_HEIGHT.mdx) | - |
+| [FOREGROUND\_THRESHOLD](variables/FOREGROUND_THRESHOLD.mdx) | - |
+| [BACKGROUND\_BLUR\_AMOUNT](variables/BACKGROUND_BLUR_AMOUNT.mdx) | - |
+| [EDGE\_BLUR\_AMOUNT](variables/EDGE_BLUR_AMOUNT.mdx) | - |
+| [MASK\_COMBINE\_RATIO](variables/MASK_COMBINE_RATIO.mdx) | - |
+| [PROCESS\_STATUS](variables/PROCESS_STATUS.mdx) | Process status |
+| [RENDER\_EFFECT](variables/RENDER_EFFECT.mdx) | - |
+| [RENDER\_BACKEND](variables/RENDER_BACKEND.mdx) | - |
+| [RENDERING\_EVENTS](variables/RENDERING_EVENTS.mdx) | - |
+| [SEGMENTATION\_MODELS](variables/SEGMENTATION_MODELS.mdx) | - |
+| [isSegmentationModel](variables/isSegmentationModel.mdx) | - |
+| [isRenderingEvents](variables/isRenderingEvents.mdx) | - |
+| [toRenderingEvents](variables/toRenderingEvents.mdx) | - |
+| [getErrorMessage](variables/getErrorMessage.mdx) | - |
+| [createObjectUpdater](variables/createObjectUpdater.mdx) | - |
+| [createRemoteImageBitmap](variables/createRemoteImageBitmap.mdx) | - |
+| [clamping](variables/clamping.mdx) | - |
+| [calculateMaxBlurPass](variables/calculateMaxBlurPass.mdx) | - |
+| [resize](variables/resize.mdx) | Calculate the coordinates and size of the source and destination to fit the target aspect ratio. |
+| [createLazyProps](variables/createLazyProps.mdx) | - |
+| [handleWebGLContextLoss](variables/handleWebGLContextLoss.mdx) | - |
+| [urls](variables/urls.mdx) | - |
+| [SILENT\_THRESHOLD](variables/SILENT_THRESHOLD.mdx) | Default silent threshold At least one LSB 16-bit data (compare is on absolute value). |
+| [MONO\_THRESHOLD](variables/MONO_THRESHOLD.mdx) | Default mono detection threshold Data must be identical within one LSB 16-bit to be identified as mono. |
+| [LOW\_VOLUME\_THRESHOLD](variables/LOW_VOLUME_THRESHOLD.mdx) | Default low volume detection threshold |
+| [CLIP\_THRESHOLD](variables/CLIP_THRESHOLD.mdx) | Default clipping detection threshold |
+| [VOICE\_PROBABILITY\_THRESHOLD](variables/VOICE_PROBABILITY_THRESHOLD.mdx) | Default Voice probability threshold |
+| [CLIP\_COUNT\_THRESHOLD](variables/CLIP_COUNT_THRESHOLD.mdx) | Default clipping count threshold Number of consecutive clipThreshold level samples that indicate clipping. |
+| [FRAME\_RATE](variables/FRAME_RATE.mdx) | - |
+| [PLAY\_VIDEO\_TIMEOUT](variables/PLAY_VIDEO_TIMEOUT.mdx) | - |
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [createAudioContext](functions/createAudioContext.mdx) | A function to create `AudioContext` using constructor or factory function depends on the browser supports |
+| [resumeAudioOnInterruption](functions/resumeAudioOnInterruption.mdx) | Resume the stream whenever interrupted |
+| [resumeAudioOnUnmute](functions/resumeAudioOnUnmute.mdx) | Resume the AudioContext whenever the source track is unmuted |
+| [subscribeWorkletNode](functions/subscribeWorkletNode.mdx) | Subscribe MessagePort message from an AudioWorkletNode |
+| [subscribeTimeoutAnalyzerNode](functions/subscribeTimeoutAnalyzerNode.mdx) | Subscribe to a timeout loop to get the data from Analyzer |
+| [createStreamSourceGraphNode](functions/createStreamSourceGraphNode.mdx) | Create a MediaStreamAudioSourceNodeInit |
+| [createMediaElementSourceGraphNode](functions/createMediaElementSourceGraphNode.mdx) | Create a MediaStreamAudioSourceNodeInit |
+| [createAnalyzerSubscribableGraphNode](functions/createAnalyzerSubscribableGraphNode.mdx) | Create an analyzer node with push-based subscription |
+| [createDenoiseWorkletGraphNode](functions/createDenoiseWorkletGraphNode.mdx) | Create a noise suppression node |
+| [createGainGraphNode](functions/createGainGraphNode.mdx) | Create a GainNodeInit |
+| [createAnalyzerGraphNode](functions/createAnalyzerGraphNode.mdx) | Create an AnalyzerNodeInit |
+| [createStreamDestinationGraphNode](functions/createStreamDestinationGraphNode.mdx) | Create a MediaStreamAudioDestinationNodeInit |
+| [createAudioDestinationGraphNode](functions/createAudioDestinationGraphNode.mdx) | Create an `AudioDestinationNode` |
+| [createDelayGraphNode](functions/createDelayGraphNode.mdx) | Create a `DelayNode` |
+| [createChannelSplitterGraphNode](functions/createChannelSplitterGraphNode.mdx) | Create a ChannelSplitterNode |
+| [createChannelMergerGraphNode](functions/createChannelMergerGraphNode.mdx) | Create a ChannelMergerNode |
+| [createAudioGraph](functions/createAudioGraph.mdx) | Accepts AudioNodeInitConnections to build the audio graph within a signal audio context |
+| [createAudioGraphProxy](functions/createAudioGraphProxy.mdx) | - |
+| [createBenchmark](functions/createBenchmark.mdx) | - |
+| [sum](functions/sum.mdx) | Sum an array of numbers |
+| [avg](functions/avg.mdx) | Average an array of numbers |
+| [pow](functions/pow.mdx) | pow function from Math in functional form `number -> number -> number` |
+| [rms](functions/rms.mdx) | Calculate the Root Mean Square from provided numbers |
+| [round](functions/round.mdx) | Round the floating point number away from zero, which is different from `Math.round` |
+| [createAudioStats](functions/createAudioStats.mdx) | AudioStats builder |
+| [fromByteToFloat](functions/fromByteToFloat.mdx) | Convert a byte to float, according to web audio spec |
+| [fromFloatToByte](functions/fromFloatToByte.mdx) | Convert a float to byte, according to web audio spec |
+| [copyByteBufferToFloatBuffer](functions/copyByteBufferToFloatBuffer.mdx) | Copy data from Uint8Array buffer to Float32Array buffer with byte to float conversion |
+| [toDecibel](functions/toDecibel.mdx) | Convert a floating point gain value into a dB representation without any reference, dBFS, https://en.wikipedia.org/wiki/DBFS |
+| [processAverageVolume](functions/processAverageVolume.mdx) | Calculate the averaged volume using Root Mean Square, assuming the data is in float form |
+| [isSilent](functions/isSilent.mdx) | Simple silent detection to only check the first and last bit from the sample |
+| [isLowVolume](functions/isLowVolume.mdx) | Check if the provided gain above the low volume threshold, which is considered as low volume. |
+| [isClipping](functions/isClipping.mdx) | Check if there is clipping |
+| [isMono](functions/isMono.mdx) | Check if provided channels are mono or stereo |
+| [getAudioStats](functions/getAudioStats.mdx) | Calculate the audio stats, expected the samples are in float form |
+| [isVoiceActivity](functions/isVoiceActivity.mdx) | A Naive Voice activity detection |
+| [isEqualSize](functions/isEqualSize.mdx) | Compare the provided width and height to see if they are the same |
+| [createVoiceDetectorFromTimeData](functions/createVoiceDetectorFromTimeData.mdx) | A function to check provided time series data is considered as voice activity |
+| [createVoiceDetectorFromProbability](functions/createVoiceDetectorFromProbability.mdx) | A function to check the provided probability is considered as voice activity |
+| [createVADetector](functions/createVADetector.mdx) | Create a voice detector based on provided params |
+| [createAudioSignalDetector](functions/createAudioSignalDetector.mdx) | Create a function to process the AudioStats and check if silent `onSignalDetected` callback is called under 2 situations: |
+| [isAudioNode](functions/isAudioNode.mdx) | - |
+| [isAudioParam](functions/isAudioParam.mdx) | - |
+| [isAudioNodeInit](functions/isAudioNodeInit.mdx) | - |
+| [isAnalyzerNodeInit](functions/isAnalyzerNodeInit.mdx) | - |
+| [createAsyncCallbackLoop](functions/createAsyncCallbackLoop.mdx) | Create an async callback loop to be called recursively with delay based on the `frameRate` |
+| [createCanvasTransform](functions/createCanvasTransform.mdx) | - |
+| [loadScript](functions/loadScript.mdx) | - |
+| [loadWasms](functions/loadWasms.mdx) | - |
+| [createSegmenter](functions/createSegmenter.mdx) | - |
+| [isRenderEffects](functions/isRenderEffects.mdx) | - |
+| [createCanvas](functions/createCanvas.mdx) | Create a Canvas element with provided width and height |
+| [createFrameCallbackRequest](functions/createFrameCallbackRequest.mdx) | Create a callback loop for video frame processing using `requestVideoFrameCallback` under-the-hood when available otherwise our fallback implementation based on `setTimeout`. |
+| [createVideoProcessor](functions/createVideoProcessor.mdx) | - |
+| [createVideoTrackProcessor](functions/createVideoTrackProcessor.mdx) | Video track processor using MediaStreamTrackProcessor API |
+| [createVideoTrackProcessorWithFallback](functions/createVideoTrackProcessorWithFallback.mdx) | Video track processor using Canvas[captureStream] API |
+| [calculateDistance](functions/calculateDistance.mdx) | Calculate the distance between two Points |
+| [getBezierCurveControlPoints](functions/getBezierCurveControlPoints.mdx) | Spline Interpolation for Bezier Curve |
+| [line](functions/line.mdx) | Create a straight line path command |
+| [curve](functions/curve.mdx) | Create a cubic Bezier curve path command |
+| [closedCurve](functions/closedCurve.mdx) | Create a cubic Bezier curve path then turning back to the starting point with provided point of reference |

package/api-docs/enumerations/AbortReason.mdx

@@ -0,0 +1,5 @@
+## Enumeration Members
+
+| Enumeration Member | Value |
+| ------ | ------ |
+| <a id="close"></a> `Close` | `"close"` |

package/api-docs/functions/avg.mdx

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

package/api-docs/functions/calculateDistance.mdx

@@ -0,0 +1,18 @@
+```ts
+function calculateDistance(p1, p2): number;
+```
+
+**`Internal`**
+
+Calculate the distance between two Points
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `p1` | [`Point`](../interfaces/Point.mdx) | Point 1 |
+| `p2` | [`Point`](../interfaces/Point.mdx) | Point 2 |
+
+## Returns
+
+`number`

package/api-docs/functions/closedCurve.mdx

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

package/api-docs/functions/copyByteBufferToFloatBuffer.mdx

@@ -0,0 +1,16 @@
+```ts
+function copyByteBufferToFloatBuffer(bytes, floats): void;
+```
+
+Copy data from Uint8Array buffer to Float32Array buffer with byte to float conversion
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `bytes` | `Uint8Array` | The source Byte buffer |
+| `floats` | `Float32Array` | The destination buffer |
+
+## Returns
+
+`void`

package/api-docs/functions/createAnalyzerGraphNode.mdx

@@ -0,0 +1,19 @@
+```ts
+function createAnalyzerGraphNode(options?): AudioNodeInit<AnalyserNode, Analyzer>;
+```
+
+Create an AnalyzerNodeInit
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | `AnalyserOptions` |  |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`AnalyserNode`, [`Analyzer`](../interfaces/Analyzer.mdx)\>
+
+## See
+
+AnalyserOptions

package/api-docs/functions/createAnalyzerSubscribableGraphNode.mdx

@@ -0,0 +1,15 @@
+```ts
+function createAnalyzerSubscribableGraphNode(__namedParameters): AudioNodeInit<AnalyserNode, Analyzer>;
+```
+
+Create an analyzer node with push-based subscription
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | [`AnalyzerSubscribableOptions`](../interfaces/AnalyzerSubscribableOptions.mdx) & `AnalyserOptions` |
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`AnalyserNode`, [`Analyzer`](../interfaces/Analyzer.mdx)\>

package/api-docs/functions/createAsyncCallbackLoop.mdx

@@ -0,0 +1,35 @@
+```ts
+function createAsyncCallbackLoop<P, R>(
+   callback, 
+   frameRate, 
+   __namedParameters): object;
+```
+
+Create an async callback loop to be called recursively with delay based on
+the `frameRate`
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `P` *extends* `unknown`[] |
+| `R` *extends* `Promise`\<`unknown`\> |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback` | [`Callback`](../type-aliases/Callback.mdx)\<`R`, `P`\> | The callback to be invoked |
+| `frameRate` | `number` | The rate to be expected to invoke the `callback` |
+| `__namedParameters` | `Partial`\<`AsyncCallbackLoopOptions`\> | - |
+
+## Returns
+
+`object`
+
+| Name | Type |
+| ------ | ------ |
+| `start()` | (...`params`) => `Promise`\<`void`\> |
+| `stop()` | () => `void` |
+| `get frameRate` | `number` |
+| `set frameRate` | `void` |

package/api-docs/functions/createAudioContext.mdx

@@ -0,0 +1,22 @@
+```ts
+function createAudioContext(options?): AudioContext;
+```
+
+**`Internal`**
+
+A function to create `AudioContext` using constructor or factory function
+depends on the browser supports
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | `AudioContextOptions` |  |
+
+## Returns
+
+`AudioContext`
+
+## See
+
+AudioContextOptions

package/api-docs/functions/createAudioDestinationGraphNode.mdx

@@ -0,0 +1,9 @@
+```ts
+function createAudioDestinationGraphNode(): AudioNodeInit<AudioDestinationNode, AudioDestinationNode>;
+```
+
+Create an `AudioDestinationNode`
+
+## Returns
+
+[`AudioNodeInit`](../interfaces/AudioNodeInit.mdx)\<`AudioDestinationNode`, `AudioDestinationNode`\>

package/api-docs/functions/createAudioGraph.mdx

@@ -0,0 +1,28 @@
+```ts
+function createAudioGraph(initialConnections, options): AudioGraph;
+```
+
+Accepts AudioNodeInitConnections to build the audio graph within a signal audio context
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `initialConnections` | [`AudioNodeInitConnections`](../type-aliases/AudioNodeInitConnections.mdx) | A list of AudioNodeInit to build the graph in a linear fashion |
+| `options` | [`AudioGraphOptions`](../interfaces/AudioGraphOptions.mdx) |  |
+
+## Returns
+
+[`AudioGraph`](../interfaces/AudioGraph.mdx)
+
+## See
+
+[AudioGraphOptions](../interfaces/AudioGraphOptions.mdx)
+
+## Example
+
+```typescript
+const source = createStreamSourceGraphNode(stream);
+const analyzer = createAnalyzerGraphNode({fftSize});
+const audioGraph = createAudioGraph([[source, analyzer]]);
+```

package/api-docs/functions/createAudioGraphProxy.mdx

@@ -0,0 +1,14 @@
+```ts
+function createAudioGraphProxy(audioGraph, handlers): AudioGraph;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `audioGraph` | [`AudioGraph`](../interfaces/AudioGraph.mdx) |
+| `handlers` | `AudioGraphProxyHandlers` |
+
+## Returns
+
+[`AudioGraph`](../interfaces/AudioGraph.mdx)