@pexip/media 20.3.4 → 20.3.5

package/CHANGELOG.md

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

package/api-docs/README.mdx

@@ -0,0 +1,404 @@
+# `@pexip/media`
+
+A package to connect `@pexip/media-control` and `@pexip/media-processor` to
+create a streamlined media process
+
+## Install
+
+`npm install @pexip/media`
+
+## Overview
+
+### `createMedia`
+
+It create's an object to interact with the media stream, which is usually used
+for our main stream.
+
+Its major features:
+
+- Create a media pipeline to get and process the `MediaStream`, see
+  `createMediaPipeline`. It also provides some media features including:
+
+  - Video Processing - background blur
+  - Audio Processing - Noise Suppression
+  - Audio Signal Detection - To detect if the active audio input device is
+    capturing any audio
+  - Voice Activity Detection - To detect if there is any voice activity
+
+- Provide media input related information
+- Verify if we need to request a new `MediaStream`, see `updateMedia`
+- Subscribe events from `@pexip/media-control` and update the state accordingly
+
+### `createAudioStreamProcess`
+
+A processor to process audio from the stream to be used together with
+`createMedia` as one of the media processor of the pipeline.
+
+### `createVideoStreamProcess`
+
+A processor to process video from the stream to be used together with
+`createMedia` as one of the media processor of the pipeline.
+
+### `createPreviewController`
+
+It creates an object to control the provided media stream, e.g. change the
+audio/video input device and apply changes to the main stream when necessary.
+
+## Usage
+
+The package tries to follow the
+[MediaStream API's Constraints pattern](https://developer.mozilla.org/en-US/docs/Web/API/Media_Streams_API/Constraints).
+Beside the
+[MediaTrackConstraintSet](https://w3c.github.io/mediacapture-main/#dictionary-mediatrackconstraints-members)
+that's specified from the
+[Media Capture and Streams](https://w3c.github.io/mediacapture-main) spec, we
+have extended some additional media features as the following:
+
+```typescript
+export interface InputConstraintSet extends MediaTrackConstraints {
+  /**
+   * Same purpose as `deviceId` but it gives more information about the device
+   * so that we can have extra tolerance on device selection
+   */
+  device?: DeviceConstraint | ConstraintDeviceParameters;
+  /**
+   * Whether or not using video segmentation, e.g. background
+   * blur/replacement, to specify the effects, intended to be applied to the
+   * segment. Available effects are `none`, `blur`, `overlay` or `remove`
+   */
+  videoSegmentation?: ConstrainDOMString;
+  /**
+   * Segmentation model to be used for video segmentation, currently only
+   * supports `mediapipeSelfie` and `personify`
+   */
+  videoSegmentationModel?: ConstrainDOMString;
+  /**
+   * Whether or not using our own noise suppression
+   */
+  denoise?: ConstrainBoolean;
+  /**
+   * Voice Activity Detection
+   */
+  vad?: ConstrainBoolean;
+  /**
+   * Audio Signal Detection for the purpose of checking if the audio input is
+   * hardware muted or unusable
+   */
+  asd?: ConstrainBoolean;
+  /**
+   * Audio Signal Detection for the purpose of checking if the audio input is
+   * hardware muted or unusable
+   */
+  mixWithAdditionalMedia?: ConstrainBoolean;
+  /**
+   * Blur size/level parameter when using video segmentation with `blur`
+   * effects
+   */
+  backgroundBlurAmount?: ConstrainULong;
+  /**
+   * Blur amount applied to the segmented person's edge
+   */
+  edgeBlurAmount?: ConstrainULong;
+  /**
+   * Erode level for edge smoothing when using video segmentation
+   */
+  foregroundThreshold?: ConstrainDouble;
+  /**
+   * Image Url that is being used for video overlay effects
+   */
+  backgroundImageUrl?: ConstrainDOMString;
+  /**
+   * The ratio to be used for smoothing segmentation mask
+   */
+  maskCombineRatio?: ConstrainDouble;
+  /**
+   * Image Url that is being used for video overlay effects
+   */
+  resizeMode?: ConstrainDOMString;
+  /**
+   * Current pan, tilt and zoom level for a PTZ controllable camera on web
+   */
+  pan?: boolean;
+  tilt?: boolean;
+  zoom?: boolean;
+
+  /**
+   * Content Hint for the track to apply
+   */
+  contentHint?: ConstrainDOMString;
+}
+```
+
+### `createMedia`
+
+```typescript
+import {createMedia, createMediaSignals, UserMediaStatus} from '@pexip/media';
+import type {RenderEffects, Segmenters, Media} from '@pexip/media';
+import {
+  createSegmenter,
+  createCanvasTransform,
+  createVideoProcessor,
+} from '@pexip/media-processor';
+
+// App states
+const states: {
+  muted: {video: boolean; audio: boolean};
+  effects: RenderEffects;
+  foregroundThreshold: number;
+  backgroundBlurAmount: number;
+  maskCombineRatio: number;
+  backgroundImageUrl: string;
+  media?: Media;
+  status: UserMediaStatus;
+} = {
+  muted: {
+    audio: false,
+    video: false,
+  },
+  // Could be `none`, `blur` or `overlay`
+  effects: 'none',
+  foregroundThreshold: 0.5, // 0.0 - 1.0
+  backgroundBlurAmount: 30, // 0 - 100
+  maskCombineRatio: 0.5, // 0.0 - 1.0
+  backgroundImageUrl: '/some/path/to/an/image/for/background/replacement.png',
+  status: UserMediaStatus.Initial,
+};
+
+// Create required signals with additional `onDevicesChanged`,
+// `onStatusChanged` and `onStreamTrackEnabled` signals
+export const signals = createMediaSignals('demo', [
+  'onDevicesChanged',
+  'onStatusChanged',
+  'onStreamTrackEnabled',
+]);
+
+// 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: states.effects,
+  foregroundThreshold: states.foregroundThreshold,
+  backgroundBlurAmount: states.backgroundBlurAmount,
+  maskCombineRatio: states.maskCombineRatio,
+  backgroundImageUrl: states.backgroundImageUrl,
+});
+
+const selfie = createSegmenter(taskVisionBasePath, {
+  modelAsset,
+  delegate: () => 'GPU', // Use GPU
+});
+
+export const segmenters: Partial<Segmenters> = {
+  selfie,
+};
+
+const videoProcessor = createVideoProcessor([transformer]);
+
+const videoStreamProcessor = createVideoStreamProcess({
+  shouldEnable: () => true, // Always Process Video Track
+  segmenters,
+  transformer,
+  videoProcessor,
+});
+
+// Instantiate the media object
+export const mediaController = createMedia({
+  getMuteState: () => states.muted,
+  signals,
+  audioProcessors: [], // No audio processor
+  videoProcessors: [videoStreamProcessor],
+});
+
+// Hook-up the signals to get the update
+// Subscribe the onMediaChanged signal to get the latest Media object change event
+signals.onMediaChanged.add(media => {
+  states.media = media;
+}); // Assume there is a local function `setLocalMedia`
+// Subscribe the onStatusChanged signal to get the latest Media status change event
+signals.onStatusChanged.add(media => setMediaStatus(media)); // Assume there is a local function `setMediaStatus`
+// Subscribe onStreamTrackEnabled signal to get the MediaStreamTrack['enabled'] change event
+signals.onStreamTrackEnabled.add(track => {
+  console.log(track);
+});
+
+// Later we can initialize a gUM to get a MediaStream
+mediaController.getUserMedia({
+  audio: true,
+  video: {
+    videoSegmentation: 'blur', // Use background blur
+    foregroundThreshold: states.foregroundThreshold,
+    backgroundBlurAmount: states.backgroundBlurAmount,
+    maskCombineRatio: states.maskCombineRatio,
+    backgroundImageUrl: states.backgroundImageUrl,
+  },
+});
+
+// Access the current `MediaStream`
+mediaController.media.stream;
+// Get audio mute state
+mediaController.media.audioMuted;
+// Mute audio
+mediaController.media.muteAudio(true);
+// Get video mute state
+mediaController.media.videoMuted;
+// Mute video
+mediaController.media.muteVideo(true);
+// Get the status
+mediaController.media.status;
+// Update the status
+mediaController.media.status = UserMediaStatus.Initial;
+// Stop the `MediaStream`
+await mediaController.media.release();
+
+// Later we can make changes to the media on-demand without initiating a new gUM call
+
+// Turn off background blur
+await mediaController.media.applyConstraints({
+  video: {videoSegmentation: 'none'},
+});
+// Turn on background blur
+await mediaController.media.applyConstraints({
+  video: {videoSegmentation: 'blur'},
+});
+// Use our own noise suppression
+await mediaController.media.applyConstraints({
+  audio: {denoise: true, noiseSuppression: false},
+});
+// Use built-in noise suppression
+await mediaController.media.applyConstraints({
+  audio: {denoise: false, noiseSuppression: true},
+});
+```
+
+## Enumerations
+
+| Enumeration | Description |
+| ------ | ------ |
+| [UserMediaStatus](enumerations/UserMediaStatus.mdx) | - |
+| [DeniedDevices](enumerations/DeniedDevices.mdx) | - |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [PreviewEventHandler](interfaces/PreviewEventHandler.mdx) | - |
+| [PreviewStreamParams](interfaces/PreviewStreamParams.mdx) | - |
+| [PreviewControllerProps](interfaces/PreviewControllerProps.mdx) | - |
+| [PreviewStreamController](interfaces/PreviewStreamController.mdx) | - |
+| [ExtendedMediaTrackSettings](interfaces/ExtendedMediaTrackSettings.mdx) | - |
+| [MediaSettings](interfaces/MediaSettings.mdx) | - |
+| [DenoiseParams](interfaces/DenoiseParams.mdx) | URL links needed for creating a denoise node for audio processing |
+| [MediaAttributes](interfaces/MediaAttributes.mdx) | - |
+| [Media](interfaces/Media.mdx) | - |
+| [MediaInit](interfaces/MediaInit.mdx) | - |
+| [MediaTrack](interfaces/MediaTrack.mdx) | - |
+| [MediaTrackInit](interfaces/MediaTrackInit.mdx) | - |
+| [AudioSignalDetectionOptions](interfaces/AudioSignalDetectionOptions.mdx) | - |
+| [VoiceActivityDetectionOptions](interfaces/VoiceActivityDetectionOptions.mdx) | - |
+| [MediaOptions](interfaces/MediaOptions.mdx) | - |
+| [MediaProps](interfaces/MediaProps.mdx) | - |
+| [MediaController](interfaces/MediaController.mdx) | - |
+| [MediaChangesSignals](interfaces/MediaChangesSignals.mdx) | - |
+| [AudioDetectionSignals](interfaces/AudioDetectionSignals.mdx) | - |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [GetDisplayMedia](type-aliases/GetDisplayMedia.mdx) | - |
+| [PreviewInput](type-aliases/PreviewInput.mdx) | - |
+| [CreatePreviewStreamController](type-aliases/CreatePreviewStreamController.mdx) | - |
+| [GeneratedMediaSignals](type-aliases/GeneratedMediaSignals.mdx) | - |
+| [UserMediaValidator](type-aliases/UserMediaValidator.mdx) | - |
+| [Unsubscribe](type-aliases/Unsubscribe.mdx) | - |
+| [ExtendedMediaTrackSettingsKey](type-aliases/ExtendedMediaTrackSettingsKey.mdx) | - |
+| [Process](type-aliases/Process.mdx) | - |
+| [TrackProcessor](type-aliases/TrackProcessor.mdx) | - |
+| [GetUserMediaProcess](type-aliases/GetUserMediaProcess.mdx) | - |
+| [VideoStreamTrackProcessorAPIs](type-aliases/VideoStreamTrackProcessorAPIs.mdx) | Use which processor API to process the stream track `stream` - Use `MediaStreamTrackProcessor`, when available `canvas` - Use Canvas |
+| [VideoRenderParams](type-aliases/VideoRenderParams.mdx) | - |
+| [MediaSignalsOptional](type-aliases/MediaSignalsOptional.mdx) | - |
+| [MediaSignalsRequired](type-aliases/MediaSignalsRequired.mdx) | - |
+| [MediaSignals](type-aliases/MediaSignals.mdx) | - |
+| [Segmenters](type-aliases/Segmenters.mdx) | - |
+| [AudioContentHint](type-aliases/AudioContentHint.mdx) | - |
+| [VideoContentHint](type-aliases/VideoContentHint.mdx) | - |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [REQUIRED\_SIGNAL\_KEYS](variables/REQUIRED_SIGNAL_KEYS.mdx) | - |
+| [internalSignals](variables/internalSignals.mdx) | Internal signals |
+| [isFallbackVideo](variables/isFallbackVideo.mdx) | - |
+| [isFallbackAudio](variables/isFallbackAudio.mdx) | - |
+| [isFallback](variables/isFallback.mdx) | - |
+| [hasNoDevice](variables/hasNoDevice.mdx) | - |
+| [hasNoAudioDevices](variables/hasNoAudioDevices.mdx) | - |
+| [hasNoVideoDevices](variables/hasNoVideoDevices.mdx) | - |
+| [isGrantedOnlyVideoNoAudioDevices](variables/isGrantedOnlyVideoNoAudioDevices.mdx) | - |
+| [isPromptAudio](variables/isPromptAudio.mdx) | - |
+| [isGrantedOnlyVideo](variables/isGrantedOnlyVideo.mdx) | - |
+| [isGrantedOnlyAudioNoVideoDevices](variables/isGrantedOnlyAudioNoVideoDevices.mdx) | - |
+| [isPromptVideo](variables/isPromptVideo.mdx) | - |
+| [isGrantedOnlyAudio](variables/isGrantedOnlyAudio.mdx) | - |
+| [areBothGranted](variables/areBothGranted.mdx) | - |
+| [isGrantedVideo](variables/isGrantedVideo.mdx) | - |
+| [isGrantedAudio](variables/isGrantedAudio.mdx) | - |
+| [isGranted](variables/isGranted.mdx) | - |
+| [isOnlyAudioError](variables/isOnlyAudioError.mdx) | - |
+| [isOnlyVideoError](variables/isOnlyVideoError.mdx) | - |
+| [isRejected](variables/isRejected.mdx) | - |
+| [isRejectedOnlyAudio](variables/isRejectedOnlyAudio.mdx) | - |
+| [isRejectedOnlyVideo](variables/isRejectedOnlyVideo.mdx) | - |
+| [isOverConstrained](variables/isOverConstrained.mdx) | - |
+| [isUnknownError](variables/isUnknownError.mdx) | - |
+| [isInitial](variables/isInitial.mdx) | - |
+| [isInitialPermissions](variables/isInitialPermissions.mdx) | - |
+| [isInitialPermissionsNotGranted](variables/isInitialPermissionsNotGranted.mdx) | - |
+| [isRequestPermissionNeeded](variables/isRequestPermissionNeeded.mdx) | - |
+| [isInitialPermissionsGranted](variables/isInitialPermissionsGranted.mdx) | - |
+| [isAudioDeviceInUse](variables/isAudioDeviceInUse.mdx) | - |
+| [isDeviceInUse](variables/isDeviceInUse.mdx) | - |
+| [isDevicesInUse](variables/isDevicesInUse.mdx) | - |
+| [isVideoDeviceInUse](variables/isVideoDeviceInUse.mdx) | - |
+| [AUDIO\_CONTENT\_HINTS](variables/AUDIO_CONTENT_HINTS.mdx) | Audio content hints are only applicable when the MediaStreamTrack contains an audio track |
+| [VIDEO\_CONTENT\_HINTS](variables/VIDEO_CONTENT_HINTS.mdx) | Video content hints are only applicable when the MediaStreamTrack contains a video track. |
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [createAudioMixingProcess](functions/createAudioMixingProcess.mdx) | Create an Audio Mixing Processor and will own the stream passed-in |
+| [createAudioStreamProcess](functions/createAudioStreamProcess.mdx) | Create an Audio Stream Processor and will own the stream passed-in |
+| [createGetDisplayMedia](functions/createGetDisplayMedia.mdx) | - |
+| [setLogger](functions/setLogger.mdx) | - |
+| [createMedia](functions/createMedia.mdx) | Create an object to interact with the media scream, which is usually used for our main stream. |
+| [createPreviewStreamController](functions/createPreviewStreamController.mdx) | - |
+| [createMediaSignal](functions/createMediaSignal.mdx) | Create a general signal with consistent scoped name |
+| [createMediaSignals](functions/createMediaSignals.mdx) | Create and return all required and optional (if specified with `more`), signals for media to work |
+| [toDeniedDevices](functions/toDeniedDevices.mdx) | - |
+| [getPermissionStatus](functions/getPermissionStatus.mdx) | - |
+| [deriveInitialPermissionStatus](functions/deriveInitialPermissionStatus.mdx) | - |
+| [isNonNullObject](functions/isNonNullObject.mdx) | - |
+| [isUserMediaStatus](functions/isUserMediaStatus.mdx) | - |
+| [isMedia](functions/isMedia.mdx) | - |
+| [isAnalyzerNodeInitProp](functions/isAnalyzerNodeInitProp.mdx) | - |
+| [isAudioContentHint](functions/isAudioContentHint.mdx) | - |
+| [isVideoContentHint](functions/isVideoContentHint.mdx) | - |
+| [isVideoStreamTrackProcessorAPIs](functions/isVideoStreamTrackProcessorAPIs.mdx) | - |
+| [applyContentHint](functions/applyContentHint.mdx) | Apply the content hint to the track |
+| [createVideoStreamProcess](functions/createVideoStreamProcess.mdx) | - |

package/api-docs/enumerations/DeniedDevices.mdx

@@ -0,0 +1,7 @@
+## Enumeration Members
+
+| Enumeration Member | Value |
+| ------ | ------ |
+| <a id="microphone"></a> `Microphone` | `"microphone"` |
+| <a id="camera"></a> `Camera` | `"camera"` |
+| <a id="both"></a> `Both` | `"microphone-and-camera"` |

package/api-docs/enumerations/UserMediaStatus.mdx

@@ -0,0 +1,49 @@
+## Enumeration Members
+
+| Enumeration Member | Value | Description |
+| ------ | ------ | ------ |
+| <a id="initial"></a> `Initial` | `"initial"` | The initial status |
+| <a id="initialpermissionsgranted"></a> `InitialPermissionsGranted` | `"initial-permissions-granted"` | When we know the permissions were already granted from permission API |
+| <a id="initialpermissionsnotgranted"></a> `InitialPermissionsNotGranted` | `"initial-permissions-not-granted"` | When we do not know the permissions from permission API |
+| <a id="initialpermissionsvideoinputdenied"></a> `InitialPermissionsVideoInputDenied` | `"initial-permissions-videoinput-denied"` | When video input permissions are initially denied in the browser and audio input permissions are unknown |
+| <a id="initialpermissionsaudioinputdenied"></a> `InitialPermissionsAudioInputDenied` | `"initial-permissions-audioinput-denied"` | When audio input permissions are initially denied in the browser and video input permissions are unknown |
+| <a id="initialpermissionsvideoinputgranted"></a> `InitialPermissionsVideoInputGranted` | `"initial-permissions-videoinput-granted"` | When video input permissions are granted in the browser and audio input permissions are unknown |
+| <a id="initialpermissionsaudioinputgranted"></a> `InitialPermissionsAudioInputGranted` | `"initial-permissions-audioinput-granted"` | When audio input permissions are granted in the browser and video input permissions are unknown |
+| <a id="initialpermissionsgrantedvideoinputdenied"></a> `InitialPermissionsGrantedVideoInputDenied` | `"initial-permissions-audioinput-granted-videoinput-denied"` | When audio input permissions are granted but video input permissions are initially denied |
+| <a id="initialpermissionsgrantedaudioinputdenied"></a> `InitialPermissionsGrantedAudioInputDenied` | `"initial-permissions-videoinput-granted-audioinput-denied"` | When video input permissions are granted but audio input permissions are initially denied |
+| <a id="nodevicesfound"></a> `NoDevicesFound` | `"no-devices-found"` | When there is no any kind of input devices |
+| <a id="novideodevicesfound"></a> `NoVideoDevicesFound` | `"no-video-devices-found"` | When there is no any video input devices |
+| <a id="noaudiodevicesfound"></a> `NoAudioDevicesFound` | `"no-audio-devices-found"` | When there is no any audio input devices |
+| <a id="audiodevicenotfound"></a> `AudioDeviceNotFound` | `"audio-device-not-found"` | Derived from `MediaDeviceFailure.AudioInputDeviceNotFoundError` |
+| <a id="videodevicenotfound"></a> `VideoDeviceNotFound` | `"video-device-not-found"` | Derived from `MediaDeviceFailure.VideoInputDeviceNotFoundError` |
+| <a id="audiovideodevicesnotfound"></a> `AudioVideoDevicesNotFound` | `"audio-video-devices-not-found"` | Derived from `MediaDeviceFailure.AudioAndVideoDeviceNotFoundError` |
+| <a id="permissionsgranted"></a> `PermissionsGranted` | `"permissions-granted"` | When Permission is granted by user for both video and audio, and both devices are exactly matched with the request constraints |
+| <a id="permissionsgrantedfallback"></a> `PermissionsGrantedFallback` | `"permissions-granted-fallback-devices"` | When Permission is granted by user for both video and audio, and both devices are NOT exactly matched with the request constraints |
+| <a id="permissionsgrantedfallbackaudioinput"></a> `PermissionsGrantedFallbackAudioinput` | `"permissions-granted-fallback-audioinput"` | When Permission is granted by user for both video and audio, and audio input is NOT exactly matched with the request constraints |
+| <a id="permissionsgrantedfallbackvideoinput"></a> `PermissionsGrantedFallbackVideoinput` | `"permissions-granted-fallback-videoinput"` | When Permission is granted by user for both video and audio, and video input is NOT exactly matched with the request constraints |
+| <a id="permissionsrejected"></a> `PermissionsRejected` | `"permissions-rejected"` | When Permission for using both audio and video devices are rejected by the user from `PermissionDeniedError` |
+| <a id="permissionsrejectedaudioinput"></a> `PermissionsRejectedAudioInput` | `"permissions-rejected-audioinput"` | When Permission for using the audio device is rejected by the user from `PermissionDeniedError` |
+| <a id="permissionsrejectedvideoinput"></a> `PermissionsRejectedVideoInput` | `"permissions-rejected-videoinput"` | When Permission for using the video device is rejected by the user from `PermissionDeniedError` |
+| <a id="permissionsonlyaudioinput"></a> `PermissionsOnlyAudioinput` | `"permissions-only-audioinput"` | When only request and return exact audio input device |
+| <a id="permissionsonlyaudioinputnovideodevices"></a> `PermissionsOnlyAudioinputNoVideoDevices` | `"permissions-only-audioinput-no-video-devices"` | When only request audio input device because of no video devices available and returned exact audio input device |
+| <a id="permissionsonlyaudioinputfallback"></a> `PermissionsOnlyAudioinputFallback` | `"permissions-only-fallback-audioinput"` | When only request and returned NOT exact audio input device |
+| <a id="permissionsonlyaudioinputfallbacknovideodevices"></a> `PermissionsOnlyAudioinputFallbackNoVideoDevices` | `"permissions-only-fallback-audioinput-no-video-devices"` | When only request audio input device because of no video devices available and returned NOT exact audio input device |
+| <a id="permissionsonlyvideoinput"></a> `PermissionsOnlyVideoinput` | `"permissions-only-videoinput"` | When only request and return exact video input device |
+| <a id="permissionsonlyvideoinputnoaudiodevices"></a> `PermissionsOnlyVideoinputNoAudioDevices` | `"permissions-only-videoinput-no-audio-devices"` | When only request video input device because of no audio devices available and returned exact video input device |
+| <a id="permissionsonlyvideoinputfallback"></a> `PermissionsOnlyVideoinputFallback` | `"permissions-only-fallback-videoinput"` | When only request and returned NOT exact video input device |
+| <a id="permissionsonlyvideoinputfallbacknoaudiodevices"></a> `PermissionsOnlyVideoinputFallbackNoAudioDevices` | `"permissions-only-fallback-videoinput-no-audio-devices"` | When only request video input device because of no video devices available and returned NOT exact video input device |
+| <a id="audiodeviceinuse"></a> `AudioDeviceInUse` | `"audio-device-in-use"` | When requesting the audio device is used by other application |
+| <a id="videodeviceinuse"></a> `VideoDeviceInUse` | `"video-device-in-use"` | When requesting the video device is used by other application |
+| <a id="devicesinuse"></a> `DevicesInUse` | `"devices-in-use"` | When requesting both audio and video devices are used by other application |
+| <a id="overconstrained"></a> `Overconstrained` | `"overconstrained"` | When requesting both audio and video with over-constrained |
+| <a id="videooverconstrained"></a> `VideoOverconstrained` | `"video-overconstrained"` | When requesting video with over-constrained |
+| <a id="audiooverconstrained"></a> `AudioOverconstrained` | `"audio-overconstrained"` | When requesting audio with over-constrained |
+| <a id="invalidconstraints"></a> `InvalidConstraints` | `"invalid-constraints"` | When requesting both audio and video with invalid constraints |
+| <a id="invalidvideoconstraints"></a> `InvalidVideoConstraints` | `"invalid-video-constraints"` | When requesting video with invalid constraints |
+| <a id="invalidaudioconstraints"></a> `InvalidAudioConstraints` | `"invalid-audio-constraints"` | When requesting audio with invalid constraints |
+| <a id="notsupportederror"></a> `NotSupportedError` | `"not-supported-error"` | When requesting both audio and video with NotSupportedError |
+| <a id="notsupportederroronlyvideoinput"></a> `NotSupportedErrorOnlyVideoInput` | `"not-supported-error-only-video"` | When requesting video with NotSupportedError |
+| <a id="notsupportederroronlyaudioinput"></a> `NotSupportedErrorOnlyAudioInput` | `"not-supported-error-only-audio"` | When requesting audio with NotSupportedError |
+| <a id="unknownerror"></a> `UnknownError` | `"unknown-error"` | Unknown error from both video and audio |
+| <a id="unknownerroronlyaudioinput"></a> `UnknownErrorOnlyAudioinput` | `"unknown-error-only-audioinput"` | Unknown error from audio device |
+| <a id="unknownerroronlyvideoinput"></a> `UnknownErrorOnlyVideoinput` | `"unknown-error-only-videoinput"` | Unknown error from video device |

package/api-docs/functions/applyContentHint.mdx

@@ -0,0 +1,33 @@
+```ts
+function applyContentHint<T>(hint?): (track) => void;
+```
+
+Apply the content hint to the track
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* \| `""` \| `"speech"` \| `"speech-recognition"` \| `"music"` \| `"motion"` \| `"detail"` \| `"text"` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `hint?` | `T` | Content hint |
+
+## Returns
+
+```ts
+(track): void;
+```
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `track` | `MediaStreamTrack` |
+
+### Returns
+
+`void`

package/api-docs/functions/createAudioMixingProcess.mdx

@@ -0,0 +1,20 @@
+```ts
+function createAudioMixingProcess(
+   getCurrentMedia, 
+   signals?, 
+   label?): TrackProcessor;
+```
+
+Create an Audio Mixing Processor and will own the stream passed-in
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `getCurrentMedia` | () => `MediaStream` \| `undefined` | `undefined` |
+| `signals?` | [`MediaSignals`](../type-aliases/MediaSignals.mdx) | `undefined` |
+| `label?` | `"AudioMixingProcessor"` | `PROCESSOR_LABELS.AudioMixingProcessor` |
+
+## Returns
+
+[`TrackProcessor`](../type-aliases/TrackProcessor.mdx)

package/api-docs/functions/createAudioStreamProcess.mdx

@@ -0,0 +1,15 @@
+```ts
+function createAudioStreamProcess(__namedParameters): TrackProcessor;
+```
+
+Create an Audio Stream Processor and will own the stream passed-in
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | `AudioProcessOptions` & `ThrottleOptions` |
+
+## Returns
+
+[`TrackProcessor`](../type-aliases/TrackProcessor.mdx)

package/api-docs/functions/createGetDisplayMedia.mdx

@@ -0,0 +1,26 @@
+```ts
+function createGetDisplayMedia(getDefaultConstraints, getDisplayMedia): (constraints?) => Promise<MediaStream | undefined>;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `getDefaultConstraints` | () => `DisplayMediaOptions` |
+| `getDisplayMedia` | (`options?`) => `Promise`\<`MediaStream`\> |
+
+## Returns
+
+```ts
+(constraints?): Promise<MediaStream | undefined>;
+```
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `constraints?` | `DisplayMediaOptions` |
+
+### Returns
+
+`Promise`\<`MediaStream` \| `undefined`\>

package/api-docs/functions/createMedia.mdx

@@ -0,0 +1,20 @@
+```ts
+function createMedia(options): MediaController;
+```
+
+Create an object to interact with the media scream, which is usually used for
+our main stream.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`MediaOptions`](../interfaces/MediaOptions.mdx) |  |
+
+## Returns
+
+[`MediaController`](../interfaces/MediaController.mdx)
+
+## See
+
+MediaOptions

package/api-docs/functions/createMediaSignal.mdx

@@ -0,0 +1,42 @@
+```ts
+function createMediaSignal<T>(
+   name, 
+   crucial, 
+variant): Signal<T, T>;
+```
+
+Create a general signal with consistent scoped name
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` | `undefined` |
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `name` | `string` | `undefined` | Signal name |
+| `crucial` | `boolean` | `true` | Signify if the signal is unmissable. |
+| `variant` | `"generic"` \| `"behavior"` \| `"replay"` | `'generic'` | The variant of the signal |
+
+## Returns
+
+`Signal`\<`T`, `T`\>
+
+## Default Value
+
+```ts
+true
+```
+
+## See
+
+Signal
+
+## Default Value
+
+```ts
+'generic'
+```