@pexip/media-control 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,374 @@
+# `@pexip/media-control`
+
+Abstract away all the quirks of handling media devices
+
+A library that will handle media by wrapping
+[`enumerateDevices`][enumeratedevices] and [`getUserMedia`][getusermedia]
+extending both functions with additional logic.
+
+## Install
+
+`npm install @pexip/media-control`
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+
+## Introduction
+
+This library is meant to extend the [`mediaDevices`][mediadevices] api methods
+such as [`getUserMedia`][getusermedia], [`enumerateDevices`][enumeratedevices]
+and events on media streams and tracks.
+
+The final goal is to have a library that gives a stable and robust way to use
+these methods while guaranteeing that the developer has better control over
+which devices are delivered, fail, or exist.
+
+## Installation
+
+The package is published to Github registry scoped with @pexip. _Access right to
+@pexip is needed in order to install the package._
+
+Here is the steps to setup Github Personal Access Token for `npm`/`yarn` in
+order to add the package.
+
+1. A Github Personal Access Token is needed to be setup in order to get the
+   @pexip/media-control package. Follow [Github's doc][github package pat] to
+   create a Personal Access Token.
+
+2. When the Personal Access Token is ready, you can set it up for `npm` or
+   `yarn` via `.npmrc`. By adding your personal access token to your `~/.npmrc`
+   file, edit the `~/.npmrc` file for your project to include the following
+   line, replacing TOKEN with your personal access token. Create a new
+   `~/.npmrc` file if one doesn't exist.
+
+   ```config
+   //npm.pkg.github.com/:_authToken=TOKEN
+   ```
+
+3. Add a local `.npmrc` file to your repository with the following lines to tell
+   the package manager, `npm` or `yarn` where the registry is for `@pexip`
+   scoped packages.
+
+   ```config
+   @pexip:registry=https://npm.pkg.github.com
+   ```
+
+4. Now it is ready to add any `@pexip/PACKAGE_NAME` package to your repository.
+
+   ```sh
+   # Use yarn
+   yarn add @pexip/media-control
+
+   # Or use npm
+   npm install @pexip/media-control
+   ```
+
+**P.S.:** _there is no polyfill added to this package, the user needs to add
+polyfill to the application, i.e. `core-js`. We leverage on
+`@babel/plugin-transform-runtime` and `@babel/runtime` to accomplish this._
+
+## Usage
+
+### Get user media
+
+Get stream with audio and video without specifying devices, let the browser
+choose the right devices.
+
+```typescript
+import {getUserMedia} from '@pexip/media-control';
+
+const stream = await getUserMedia({audio: true, video: true});
+```
+
+Only get stream with video
+
+```typescript
+import {getUserMedia} from '@pexip/media-control';
+
+// neglecting audioInput is the same as setting it explicitly to false
+const stream = await getUserMedia({video: true});
+```
+
+Get stream with the specific device only but any for audio.
+
+```typescript
+import {getUserMedia} from 'media-control';
+
+const videoInputWanted = {
+  deviceId: '0abbc454-71e5-4f7e-9c8b-9de36f1334c3',
+  kind: 'videoinput',
+  label: 'Camera',
+};
+
+const stream = await getUserMedia({
+  audio: true,
+  video: {device: {exact: videoInputWanted}},
+});
+```
+
+Get stream with specific video input and fallback if it's not available and the
+specific audio input only, no fallback
+
+```typescript
+import {getUserMedia} from 'media-control';
+
+const audioInput = {
+  deviceId: 'a373b235-3ebf-40c7-b619-a491e05e35e6',
+  label: "Rick's Microphone",
+  kind: 'audioinput',
+};
+const videoInput = {
+  deviceId: '0abbc454-71e5-4f7e-9c8b-9de36f1334c3',
+  label: "Morty's Camera",
+  kind: 'videoinput',
+};
+
+const stream = await getUserMedia({
+  audio: {device: {exact: audioInput}},
+  video: videoInput,
+});
+```
+
+Get stream with specific devices and fallback when they are not available
+
+```typescript
+import {getUserMedia} from 'media-control';
+
+const audioInput = {
+  deviceId: 'a373b235-3ebf-40c7-b619-a491e05e35e6',
+  label: "Rick's Microphone",
+  kind: 'audioinput',
+};
+const videoInput = {
+  deviceId: '0abbc454-71e5-4f7e-9c8b-9de36f1334c3',
+  label: "Morty's Camera",
+  kind: 'videoinput',
+};
+
+const stream = await getUserMedia({
+  audio: audioInput,
+  video: videoInput,
+});
+```
+
+The following requests both audio and video without any specific requirements:
+
+```typescript
+import {getUserMedia} from 'media-control';
+
+const stream = await getUserMedia({audio: true, video: true});
+```
+
+The following expresses a preference for 1280x720 camera resolution:
+
+```typescript
+import {getUserMedia} from 'media-control';
+
+const stream = await getUserMedia({
+  audio: true,
+  video: {
+    width: 1280,
+    height: 720,
+  },
+});
+```
+
+The following expresses a preference for user facing camera:
+
+```typescript
+import {getUserMedia} from 'media-control';
+
+const stream = await getUserMedia({
+  audio: true,
+  video: {facingMode: 'user'},
+});
+```
+
+### Subscribe media events
+
+```typescript
+import {MediaEventType, subscribe} from 'media-control';
+
+subscribe((event: MediaEvent) => {
+  switch (event.detail.type) {
+    case MediaEventType.Mute: // {id: string}
+      // id of the device that was muted
+      const id = event.detail.id;
+      break;
+    case MediaEventType.Unmute: // {id: string}
+      // id of the device that was unmuted
+      const id = event.detail.id;
+      break;
+    case MediaEventType.Ended: // {id: string}
+      // id of the device that ended
+      const id = event.detail.id;
+      break;
+    case MediaEventType.DevicesChanged: // {devices: MediaDeviceInfo[]}
+      // devices currently available through enumerateDevices
+      const devices = event.detail.devices;
+      break;
+    case MediaEventType.DevicesFound: // {devices: MediaDeviceInfo[], authorizedDevices: MediaDeviceInfo[]}
+      // new devices connected
+      const devices = event.detail.devices;
+      break;
+    case MediaEventType.DevicesLost: // {devices: MediaDeviceInfo[], authorizedDevices: MediaDeviceInfo[]}
+      // devices lost from the enumerateDevices list
+      const devices = event.detail.devices;
+      break;
+    case MediaEventType.DeviceLost: // {device: MediaDeviceInfo}
+      // device currently in use that was lost from the enumerateDevices list
+      const device = event.detail.device;
+      break;
+    case MediaEventType.DevicesUnauthorized: // {devices: MediaDeviceInfo[], authorizedDevices: MediaDeviceInfo[]}
+      // Unauthorized list of devices
+      const device = event.detail.devices;
+      break;
+    case MediaEventType.NoInputDevices:
+      // Indicate that there is no input devices from the machine
+      break;
+    case MediaEventType.Error: // {error: Error}
+      const error = event.detail.error;
+      break;
+  }
+});
+```
+
+[mediadevices]: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices
+[enumeratedevices]:
+  https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices
+[getusermedia]:
+  https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia
+[mediadeviceinfo]:
+  https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo
+[github package pat]:
+  https://help.github.com/en/github/managing-packages-with-github-packages/about-github-packages#about-tokens
+[parcel]: https://parceljs.org
+
+media-control is meant to extend the mediaDevices api methods such as
+`getUserMedia`, `enumerateDevices` and events on media streams and tracks.
+The final goal is to have a library that gives a stable and robust way to use
+these methods while guaranteeing that the developer has better control over
+which devices are delivered, fail, or exist.
+
+## Enumerations
+
+| Enumeration | Description |
+| ------ | ------ |
+| [MediaEventType](enumerations/MediaEventType.mdx) | MediaStreamTrack Events |
+| [MediaDeviceKinds](enumerations/MediaDeviceKinds.mdx) | an enum of MediaDeviceKind which can be reused |
+| [MediaDeviceFailure](enumerations/MediaDeviceFailure.mdx) | An enum of failure events for media device |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [MediaControl](interfaces/MediaControl.mdx) | MediaControl Interface |
+| [IndexedDevices](interfaces/IndexedDevices.mdx) | - |
+| [InputConstraintSet](interfaces/InputConstraintSet.mdx) | - |
+| [MediaDeviceRequest](interfaces/MediaDeviceRequest.mdx) | The request constraints that applies to `getMediaStream` |
+| [MediaInput](interfaces/MediaInput.mdx) | Holds user media input devices |
+| [StreamTrackEventHandlers](interfaces/StreamTrackEventHandlers.mdx) | An object contains the event handlers |
+| [InputDevicePermission](interfaces/InputDevicePermission.mdx) | - |
+| [DisplayMediaOptions](interfaces/DisplayMediaOptions.mdx) | The `DisplayMediaStreamOptions` dictionary is used to instruct the user agent what sort of `MediaStreamTracks` may be included in the `MediaStream` returned by `getDisplayMedia`. |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [DisplayCaptureSurfaceType](type-aliases/DisplayCaptureSurfaceType.mdx) | The `DisplayCaptureSurfaceType` enumeration describes the different types of display surface |
+| [CursorCaptureConstraint](type-aliases/CursorCaptureConstraint.mdx) | The `CursorCaptureConstraint` enumerates the conditions under which the cursor is captured. |
+| [IncludeExcludeConstraint](type-aliases/IncludeExcludeConstraint.mdx) | - |
+| [DeviceChangedChanges](type-aliases/DeviceChangedChanges.mdx) | DeviceChange Event |
+| [Events](type-aliases/Events.mdx) | Event object by MediaEventType |
+| [MediaEvent](type-aliases/MediaEvent.mdx) | Custom Media Event |
+| [MediaDeviceInfoLike](type-aliases/MediaDeviceInfoLike.mdx) | A striped version of MediaDeviceInfo |
+| [InputDeviceConstraint](type-aliases/InputDeviceConstraint.mdx) | - |
+| [FacingMode](type-aliases/FacingMode.mdx) | - |
+| [MediaStreamTrackLike](type-aliases/MediaStreamTrackLike.mdx) | Lesser strict type of `MediaStreamTrack` |
+| [Unsubscribe](type-aliases/Unsubscribe.mdx) | - |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [DISPLAY\_CAPTURE\_SURFACE\_TYPE](variables/DISPLAY_CAPTURE_SURFACE_TYPE.mdx) | The `DisplayCaptureSurfaceType` enumeration describes the different types of display surface |
+| [CURSOR\_CAPTURE\_CONSTRAINT](variables/CURSOR_CAPTURE_CONSTRAINT.mdx) | The `CursorCaptureConstraint` enumerates the conditions under which the cursor is captured. |
+| [INCLUDE\_EXCLUDE\_CONSTRAINT](variables/INCLUDE_EXCLUDE_CONSTRAINT.mdx) | - |
+| [DEVICE\_ID\_SEPARATOR](variables/DEVICE_ID_SEPARATOR.mdx) | - |
+| [findAudioInputDevices](variables/findAudioInputDevices.mdx) | Find in the list of devices only the audio input ones |
+| [findVideoInputDevices](variables/findVideoInputDevices.mdx) | Find in the list of devices only the video input ones |
+| [findAudioOutputDevices](variables/findAudioOutputDevices.mdx) | Find in the list of devices only the audio output ones |
+| [getUserMedia](variables/getUserMedia.mdx) | Get MediaStream with provided [input constraints](interfaces/MediaDeviceRequest.mdx) |
+| [setDefaultConstraints](variables/setDefaultConstraints.mdx) | Set default media stream constraints |
+| [subscribe](variables/subscribe.mdx) | Subscribe media events |
+| [isAudioInput](variables/isAudioInput.mdx) | - |
+| [isVideoInput](variables/isVideoInput.mdx) | - |
+| [isAudioOutput](variables/isAudioOutput.mdx) | - |
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [isExactDeviceConstraint](functions/isExactDeviceConstraint.mdx) | Check if provided constraint is an `exact` device constraint |
+| [mergeConstraints](functions/mergeConstraints.mdx) | Merge base constraints with provided base constraints and another constraints |
+| [extractConstrainDevice](functions/extractConstrainDevice.mdx) | - |
+| [getValueFromConstrainNumber](functions/getValueFromConstrainNumber.mdx) | - |
+| [getFacingModeFromConstraintString](functions/getFacingModeFromConstraintString.mdx) | - |
+| [resolveMediaDeviceConstraints](functions/resolveMediaDeviceConstraints.mdx) | Resolve *constraints* and mediaTrackConstraints by checking the type and try to return the best possible from mediaTrackConstraints. |
+| [applyConstraints](functions/applyConstraints.mdx) | Call applyConstraints foreach track accordingly |
+| [extractConstraintsWithKeys](functions/extractConstraintsWithKeys.mdx) | Extract the constraints with provided keys |
+| [findDeviceFromConstraints](functions/findDeviceFromConstraints.mdx) | Find device from the device list with provided constraints |
+| [relaxInputConstraint](functions/relaxInputConstraint.mdx) | Relax input constraints to enable looking up the device by `deviceId` as well as `label` as a fallback as a best effort to get a similar device when possible. If the the device is found we will use the `exact` constraint otherwise we will use the `ideal`. |
+| [toKey](functions/toKey.mdx) | Convert provided info to key for Map |
+| [toMediaDeviceInputKind](functions/toMediaDeviceInputKind.mdx) | - |
+| [getDevices](functions/getDevices.mdx) | Future proofing: in case we want to alter the values or type returned by [enumerateDevices](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices) |
+| [createTrackDevicesChanges](functions/createTrackDevicesChanges.mdx) | - |
+| [deviceChanged](functions/deviceChanged.mdx) | Unified interface for subscribing [DeviceChangedChanges](type-aliases/DeviceChangedChanges.mdx) Event |
+| [toMediaDeviceInfoLike](functions/toMediaDeviceInfoLike.mdx) | Convert `MediaStreamTrack` to `MediaDeviceInfoLike` |
+| [toMediaDeviceInfo](functions/toMediaDeviceInfo.mdx) | - |
+| [findMediaInputFromMediaStreamTrack](functions/findMediaInputFromMediaStreamTrack.mdx) | Find the MediaDeviceInfo from provided MediaDeviceInfo[] by comparing with provided MediaStreamTrack |
+| [findMediaInputFromStream](functions/findMediaInputFromStream.mdx) | Find media input from media stream |
+| [isRequestedResolution](functions/isRequestedResolution.mdx) | - |
+| [isRequestedInputDevice](functions/isRequestedInputDevice.mdx) | - |
+| [isRequestedInputTrack](functions/isRequestedInputTrack.mdx) | Compare request and the input to see if the request has been fulfilled |
+| [hasRequestingDevice](functions/hasRequestingDevice.mdx) | Check if there is a requesting device with respecting to the current devices |
+| [isTrackMutedOrEnded](functions/isTrackMutedOrEnded.mdx) | Check if the track is muted or 'ended' |
+| [shouldRequestDevice](functions/shouldRequestDevice.mdx) | Decide if we should send a new gUM request |
+| [isStreamingRequestingDevice](functions/isStreamingRequestingDevice.mdx) | - |
+| [isStreamingRequestedDevicesBase](functions/isStreamingRequestedDevicesBase.mdx) | - |
+| [isStreamingRequestedDevices](functions/isStreamingRequestedDevices.mdx) | Check if provided request has already been fulfilled |
+| [findPermissionGrantedDevices](functions/findPermissionGrantedDevices.mdx) | Find in the list of devices which has permissions granted |
+| [getInputDevicePermissionState](functions/getInputDevicePermissionState.mdx) | A wrapper for `navigator.permissions.query` with fallback to use `navigator.mediaDevices.enumerateDevices` to guess the `PermissionState` |
+| [findCurrentAudioOutputId](functions/findCurrentAudioOutputId.mdx) | Find current audio output id to be used to set as sinkId |
+| [findCurrentVideoInputDeviceIdFromStream](functions/findCurrentVideoInputDeviceIdFromStream.mdx) | Find videoinput device id in the stream |
+| [findDeviceWithDeviceId](functions/findDeviceWithDeviceId.mdx) | Finds device with given deviceId |
+| [findDevicesByKind](functions/findDevicesByKind.mdx) | Find in the list of devices with given MediaDeviceKind |
+| [muteStreamTrack](functions/muteStreamTrack.mdx) | Set `MediaStreamTrack['enabled']` according to `mute` param for the provided `stream` |
+| [stopMediaStream](functions/stopMediaStream.mdx) | Stops all tracks in the given stream |
+| [areTracksEnabled](functions/areTracksEnabled.mdx) | Checks that tracks with a given type are enabled in the stream |
+| [hasAudioOrVideoInputs](functions/hasAudioOrVideoInputs.mdx) | Check if list contains media inputs |
+| [hasAudioInputs](functions/hasAudioInputs.mdx) | Check if list contains audio inputs |
+| [hasVideoInputs](functions/hasVideoInputs.mdx) | Check if list contains video inputs |
+| [hasAnyGrantedInput](functions/hasAnyGrantedInput.mdx) | Check if provided devices have any granted input device |
+| [hasAnyInputs](functions/hasAnyInputs.mdx) | Check if provided devices have any video and audio inputs |
+| [hasChangedInput](functions/hasChangedInput.mdx) | An utility function to check the input device has been changed |
+| [areMultipleFacingModeSupported](functions/areMultipleFacingModeSupported.mdx) | An utility function to check if facing mode is supported by interpreting the device label and the API `getSupportedConstraints` |
+| [interpretCurrentFacingMode](functions/interpretCurrentFacingMode.mdx) | Interpret the current facing mode from the provided track, and try to get the mode from settings, or use the label to guess the facing mode when facingMode is not supported from settings |
+| [limitSharingMonitorInterface](functions/limitSharingMonitorInterface.mdx) | A fallback implementation of `monitorTypeSurfaces` limitation when it is not supported by the current browser and the source of the `displaySurface` is available. |
+| [setLogger](functions/setLogger.mdx) | - |
+| [createStreamTrackEventSubscriptions](functions/createStreamTrackEventSubscriptions.mdx) | Create a MediaStreamTrack's native events subscription |
+| [isMediaDeviceInfo](functions/isMediaDeviceInfo.mdx) | Check if provided is `MediaDeviceInfo` |
+| [isMediaDeviceInfoArray](functions/isMediaDeviceInfoArray.mdx) | - |
+| [isInputConstraintSet](functions/isInputConstraintSet.mdx) | - |
+| [isMediaStreamTrack](functions/isMediaStreamTrack.mdx) | Check if provided is `MediaStreamTrack` |
+| [isFacingMode](functions/isFacingMode.mdx) | - |
+| [isIndexedDevices](functions/isIndexedDevices.mdx) | - |
+| [isDeviceGranted](functions/isDeviceGranted.mdx) | Check if provided device is a permission-granted device by inspecting the device label |
+| [getDeviceId](functions/getDeviceId.mdx) | Create a device ID from provided `device`. The device ID here is in the format of `deviceId:kind`, be default. |
+| [reverseDeviceId](functions/reverseDeviceId.mdx) | Reverse the device ID to its original form i.e. `MediaDeviceInfo` The device ID here is in the format of `groupId:deviceId:kind`, be default. |
+| [createIndexedDevices](functions/createIndexedDevices.mdx) | Create an `IndexedDevices` construct from provided `devices` which index the device by device ID or kind. |
+| [compareDevices](functions/compareDevices.mdx) | Compare 2 devices to see if they are the same by `deviceId` or `label` as a fallback |
+| [findDevice](functions/findDevice.mdx) | Lookup the `device` from `devices` list |

package/api-docs/enumerations/MediaDeviceFailure.mdx

@@ -0,0 +1,23 @@
+**`Beta`**
+
+An enum of failure events for media device
+
+## Enumeration Members
+
+| Enumeration Member | Value | Description |
+| ------ | ------ | ------ |
+| <a id="aborterror"></a> `AbortError` | `"AbortError"` | **`Beta`** some problem (not user or permissions) occurred which prevented the device from being used. |
+| <a id="audioandvideodevicenotfounderror"></a> `AudioAndVideoDeviceNotFoundError` | `"AudioAndVideoDeviceNotFoundError"` | **`Beta`** Custom error for when selected audio and video device is not found |
+| <a id="audioinputdevicenotfounderror"></a> `AudioInputDeviceNotFoundError` | `"AudioInputDeviceNotFoundError"` | **`Beta`** Custom error for selected audio device not found |
+| <a id="missingconstraintserror"></a> `MissingConstraintsError` | `"MissingConstraintsError"` | **`Beta`** Custom missing constraints error |
+| <a id="notallowederror"></a> `NotAllowedError` | `"NotAllowedError"` | **`Beta`** user has blocked access |
+| <a id="notfounderror"></a> `NotFoundError` | `"NotFoundError"` | **`Beta`** the media tracks doesn't match the constraints |
+| <a id="notreadableerror"></a> `NotReadableError` | `"NotReadableError"` | **`Beta`** hardware failure after user granted access |
+| <a id="overconstrainederror"></a> `OverconstrainedError` | `"OverconstrainedError"` | **`Beta`** no devices met the criteria for the constraints |
+| <a id="permissiondeniederror"></a> `PermissionDeniedError` | `"PermissionDeniedError"` | **`Beta`** user has blocked access old chrome |
+| <a id="securityerror"></a> `SecurityError` | `"SecurityError"` | **`Beta`** User media support disabled by agent |
+| <a id="trackstarterror"></a> `TrackStartError` | `"TrackStartError"` | **`Beta`** when hardware in use old chrome win os |
+| <a id="typeerror"></a> `TypeError` | `"TypeError"` | **`Beta`** GetUserMedia invalid constraints error |
+| <a id="videoinputdevicenotfounderror"></a> `VideoInputDeviceNotFoundError` | `"VideoInputDeviceNotFoundError"` | **`Beta`** Custom error for selected video device not found |
+| <a id="notsupportederror"></a> `NotSupportedError` | `"NotSupportedError"` | **`Beta`** action or function is not supported by the current platform |
+| <a id="streamtracknotfound"></a> `StreamTrackNotFound` | `"StreamTrackNotFound"` | **`Beta`** Canvas capture is not supported |

package/api-docs/enumerations/MediaDeviceKinds.mdx

@@ -0,0 +1,11 @@
+**`Beta`**
+
+an enum of MediaDeviceKind which can be reused
+
+## Enumeration Members
+
+| Enumeration Member | Value | Description |
+| ------ | ------ | ------ |
+| <a id="audioinput"></a> `AUDIOINPUT` | `"audioinput"` | **`Beta`** audio input |
+| <a id="audiooutput"></a> `AUDIOOUTPUT` | `"audiooutput"` | **`Beta`** audio output |
+| <a id="videoinput"></a> `VIDEOINPUT` | `"videoinput"` | **`Beta`** video input |

package/api-docs/enumerations/MediaEventType.mdx

@@ -0,0 +1,22 @@
+**`Beta`**
+
+MediaStreamTrack Events
+
+## Remarks
+
+See MDN [Events](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack#Events)
+
+## Enumeration Members
+
+| Enumeration Member | Value | Description |
+| ------ | ------ | ------ |
+| <a id="mute"></a> `Mute` | `"mute"` | **`Beta`** Sent to the MediaStreamTrack when the value of the muted property is changed to true, indicating that the track is unable to provide data temporarily (such as when the network is experiencing a service malfunction). |
+| <a id="unmute"></a> `Unmute` | `"unmute"` | **`Beta`** Sent to the track when data becomes available again, ending the muted state. |
+| <a id="ended"></a> `Ended` | `"ended"` | **`Beta`** Sent when playback of the track ends (when the value readyState changes to ended). |
+| <a id="deviceschanged"></a> `DevicesChanged` | `"devices:changed"` | **`Beta`** Fired when a media input or output device is attached to or removed from the user's computer. **Remarks** See MDN [Events](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices#Events) |
+| <a id="devicesfound"></a> `DevicesFound` | `"devices:found"` | **`Beta`** Found new devices from authorized device list |
+| <a id="deviceslost"></a> `DevicesLost` | `"devices:lost"` | **`Beta`** Lost devices from authorized device list |
+| <a id="devicelost"></a> `DeviceLost` | `"device:lost"` | **`Beta`** Lost device from authorized device list |
+| <a id="noinputdevices"></a> `NoInputDevices` | `"devices:noinput"` | **`Beta`** No Input Devices, and no further device events will be emitted |
+| <a id="error"></a> `Error` | `"error"` | **`Beta`** Other errors |
+| <a id="stream"></a> `Stream` | `"stream"` | **`Beta`** When stream |

package/api-docs/functions/applyConstraints.mdx

@@ -0,0 +1,16 @@
+```ts
+function applyConstraints(tracks, constraints): Promise<void>;
+```
+
+Call applyConstraints foreach track accordingly
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tracks` | `MediaStreamTrack`[] \| `undefined` | Tracks to be applied |
+| `constraints` | [`MediaDeviceRequest`](../interfaces/MediaDeviceRequest.mdx) | constraints to be applied |
+
+## Returns
+
+`Promise`\<`void`\>

package/api-docs/functions/areMultipleFacingModeSupported.mdx

@@ -0,0 +1,21 @@
+```ts
+function areMultipleFacingModeSupported(currentDevices, getSupportedConstraints): boolean;
+```
+
+An utility function to check if facing mode is supported by interpreting the
+device label and the API `getSupportedConstraints`
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `currentDevices` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] | Current list of devices available |
+| `getSupportedConstraints` | () => `MediaTrackSupportedConstraints` | A function to get supported constraints, i.e. `navigator.mediaDevices.getSupportedConstraints()` |
+
+## Returns
+
+`boolean`
+
+## Remarks
+
+Only support snooping the label for English

package/api-docs/functions/areTracksEnabled.mdx

@@ -0,0 +1,16 @@
+```ts
+function areTracksEnabled(stream, type): boolean;
+```
+
+**`Beta`**
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `stream` | `MediaStream` \| `undefined` |
+| `type` | `"audio"` \| `"video"` |
+
+## Returns
+
+`boolean`

package/api-docs/functions/compareDevices.mdx

@@ -0,0 +1,28 @@
+```ts
+function compareDevices(deviceInfo, key): (anotherDeviceInfo) => boolean;
+```
+
+**`Beta`**
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `deviceInfo` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) | `undefined` |
+| `key` | `"toJSON"` \| `"deviceId"` \| `"groupId"` \| `"label"` | `'deviceId'` |
+
+## Returns
+
+```ts
+(anotherDeviceInfo): boolean;
+```
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `anotherDeviceInfo` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) |
+
+### Returns
+
+`boolean`

package/api-docs/functions/createIndexedDevices.mdx

@@ -0,0 +1,16 @@
+```ts
+function createIndexedDevices(devices): IndexedDevices;
+```
+
+Create an `IndexedDevices` construct from provided `devices` which index the
+device by device ID or kind.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `devices` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] |
+
+## Returns
+
+[`IndexedDevices`](../interfaces/IndexedDevices.mdx)

package/api-docs/functions/createStreamTrackEventSubscriptions.mdx

@@ -0,0 +1,20 @@
+```ts
+function createStreamTrackEventSubscriptions(track, handlers): Unsubscribe;
+```
+
+Create a MediaStreamTrack's native events subscription
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `track` | `MediaStreamTrack` | The track used for the subscription |
+| `handlers` | [`StreamTrackEventHandlers`](../interfaces/StreamTrackEventHandlers.mdx) | An object contains the event handlers |
+
+## Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+## See
+
+https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack#events

package/api-docs/functions/createTrackDevicesChanges.mdx

@@ -0,0 +1,31 @@
+```ts
+function createTrackDevicesChanges(prevDevices): (devices) => object;
+```
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `prevDevices` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] | `[]` |
+
+## Returns
+
+```ts
+(devices): object;
+```
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `devices` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] |
+
+### Returns
+
+`object`
+
+| Name | Type |
+| ------ | ------ |
+| `found` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] |
+| `lost` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] |
+| `devices` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[] |

package/api-docs/functions/deviceChanged.mdx

@@ -0,0 +1,21 @@
+```ts
+function deviceChanged(fn): () => void;
+```
+
+**`Beta`**
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `fn` | (`event`) => `void` |
+
+## Returns
+
+```ts
+(): void;
+```
+
+### Returns
+
+`void`

package/api-docs/functions/extractConstrainDevice.mdx

@@ -0,0 +1,14 @@
+```ts
+function extractConstrainDevice(constraints, initialParam): ConstrainNoneTuple | ConstrainDeviceTuple;
+```
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `constraints` | \| [`InputDeviceConstraint`](../type-aliases/InputDeviceConstraint.mdx) \| `undefined` | `undefined` |
+| `initialParam` | `"exact"` \| `"ideal"` | `'ideal'` |
+
+## Returns
+
+`ConstrainNoneTuple` \| `ConstrainDeviceTuple`