@pexip/media-control 20.3.4 → 20.3.5

package/api-docs/functions/isStreamingRequestedDevices.mdx

@@ -0,0 +1,28 @@
+```ts
+function isStreamingRequestedDevices(
+   request, 
+   stream, 
+   devices): object;
+```
+
+Check if provided request has already been fulfilled
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `request` | [`MediaDeviceRequest`](../interfaces/MediaDeviceRequest.mdx) | A media request constraints |
+| `stream` | `MediaStream` \| `undefined` | Current media stream |
+| `devices` | [`IndexedDevices`](../interfaces/IndexedDevices.mdx) | - |
+
+## Returns
+
+`object`
+
+audio - The stream is using the same device as requested if `true`
+video - The stream is using the same device as requested if `true`
+
+| Name | Type |
+| ------ | ------ |
+| `audio` | `boolean` |
+| `video` | `boolean` |

package/api-docs/functions/isStreamingRequestedDevicesBase.mdx

@@ -0,0 +1,25 @@
+```ts
+function isStreamingRequestedDevicesBase(
+   request, 
+   tracksOrDevices, 
+   devices): object;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `request` | [`MediaDeviceRequest`](../interfaces/MediaDeviceRequest.mdx) |
+| `tracksOrDevices` | \{ `audio?`: \| [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) \| `MediaStreamTrack`[]; `video?`: \| [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) \| `MediaStreamTrack`[]; \} |
+| `tracksOrDevices.audio?` | \| [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) \| `MediaStreamTrack`[] |
+| `tracksOrDevices.video?` | \| [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) \| `MediaStreamTrack`[] |
+| `devices` | [`IndexedDevices`](../interfaces/IndexedDevices.mdx) |
+
+## Returns
+
+`object`
+
+| Name | Type |
+| ------ | ------ |
+| `audio` | `boolean` |
+| `video` | `boolean` |

package/api-docs/functions/isStreamingRequestingDevice.mdx

@@ -0,0 +1,18 @@
+```ts
+function isStreamingRequestingDevice(
+   request, 
+   trackOrDevice, 
+   devices): boolean;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `request` | \| [`InputDeviceConstraint`](../type-aliases/InputDeviceConstraint.mdx) \| `undefined` |
+| `trackOrDevice` | \| [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) \| `MediaStreamTrack`[] \| `undefined` |
+| `devices` | [`IndexedDevices`](../interfaces/IndexedDevices.mdx) |
+
+## Returns
+
+`boolean`

package/api-docs/functions/isTrackMutedOrEnded.mdx

@@ -0,0 +1,15 @@
+```ts
+function isTrackMutedOrEnded(track): boolean;
+```
+
+Check if the track is muted or 'ended'
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `track` | `MediaStreamTrack` | The media stream tracks |
+
+## Returns
+
+`boolean`

package/api-docs/functions/limitSharingMonitorInterface.mdx

@@ -0,0 +1,18 @@
+```ts
+function limitSharingMonitorInterface(constraints, stream): MediaStream;
+```
+
+A fallback implementation of `monitorTypeSurfaces` limitation when it is not
+supported by the current browser and the source of the `displaySurface` is
+available.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `constraints` | [`DisplayMediaOptions`](../interfaces/DisplayMediaOptions.mdx) | The constraints used to request display media. |
+| `stream` | `MediaStream` | The MediaStream returned from the requesting display media. |
+
+## Returns
+
+`MediaStream`

package/api-docs/functions/mergeConstraints.mdx

@@ -0,0 +1,35 @@
+```ts
+function mergeConstraints(baseConstraints): (constraints) => 
+  | boolean
+  | InputConstraintSet
+  | undefined;
+```
+
+Merge base constraints with provided base constraints and another constraints
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `baseConstraints` | \| `boolean` \| [`InputConstraintSet`](../interfaces/InputConstraintSet.mdx) \| `undefined` |
+
+## Returns
+
+```ts
+(constraints): 
+  | boolean
+  | InputConstraintSet
+  | undefined;
+```
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `constraints` | \| [`InputDeviceConstraint`](../type-aliases/InputDeviceConstraint.mdx) \| `undefined` |
+
+### Returns
+
+  \| `boolean`
+  \| [`InputConstraintSet`](../interfaces/InputConstraintSet.mdx)
+  \| `undefined`

package/api-docs/functions/muteStreamTrack.mdx

@@ -0,0 +1,28 @@
+```ts
+function muteStreamTrack(stream?): (mute, mediaType) => void;
+```
+
+**`Beta`**
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `stream?` | `MediaStream` |
+
+## Returns
+
+```ts
+(mute, mediaType): void;
+```
+
+### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `mute` | `boolean` | `undefined` |
+| `mediaType` | `"audio"` \| `"video"` \| `"all"` | `'all'` |
+
+### Returns
+
+`void`

package/api-docs/functions/relaxInputConstraint.mdx

@@ -0,0 +1,26 @@
+```ts
+function relaxInputConstraint(
+   kind, 
+   input, 
+   devices): 
+  | InputDeviceConstraint
+  | undefined;
+```
+
+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`.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `kind` | `"audioinput"` \| `"videoinput"` | - |
+| `input` | \| [`InputDeviceConstraint`](../type-aliases/InputDeviceConstraint.mdx) \| `undefined` | The input constraints to be relaxed |
+| `devices` | [`IndexedDevices`](../interfaces/IndexedDevices.mdx) | The current device list |
+
+## Returns
+
+  \| [`InputDeviceConstraint`](../type-aliases/InputDeviceConstraint.mdx)
+  \| `undefined`

package/api-docs/functions/resolveMediaDeviceConstraints.mdx

@@ -0,0 +1,19 @@
+```ts
+function resolveMediaDeviceConstraints(constraints?, base?): boolean | MediaTrackConstraints | undefined;
+```
+
+**`Internal`**
+
+Resolve *constraints* and mediaTrackConstraints by checking the type and
+try to return the best possible from mediaTrackConstraints.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `constraints?` | [`InputDeviceConstraint`](../type-aliases/InputDeviceConstraint.mdx) |
+| `base?` | `boolean` \| `MediaTrackConstraints` |
+
+## Returns
+
+`boolean` \| `MediaTrackConstraints` \| `undefined`

package/api-docs/functions/reverseDeviceId.mdx

@@ -0,0 +1,22 @@
+```ts
+function reverseDeviceId(id, separator): object;
+```
+
+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.
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `id` | `string` | `undefined` | The device ID to reverse |
+| `separator` | `string` | `DEVICE_ID_SEPARATOR` | The separator used to split the device ID |
+
+## Returns
+
+`object`
+
+| Name | Type |
+| ------ | ------ |
+| `deviceId` | `string` |
+| `kind` | `MediaDeviceKind` |

package/api-docs/functions/setLogger.mdx

@@ -0,0 +1,13 @@
+```ts
+function setLogger(newLogger): void;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `newLogger` | `Logger` |
+
+## Returns
+
+`void`

package/api-docs/functions/shouldRequestDevice.mdx

@@ -0,0 +1,21 @@
+```ts
+function shouldRequestDevice(deviceRequestParams): boolean;
+```
+
+Decide if we should send a new gUM request
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `deviceRequestParams` | `DeviceRequestParams` |  |
+
+## Returns
+
+`boolean`
+
+`true` means the request should be conducted, otherwise `false`.
+
+## See
+
+DeviceRequestParams

package/api-docs/functions/stopMediaStream.mdx

@@ -0,0 +1,20 @@
+```ts
+function stopMediaStream(stream, onStopped?): void;
+```
+
+Stops all tracks in the given stream
+
+Immediately after calling stop(), the readyState property is set to `ended`.
+Note that the `ended` event will not be fired in this situation
+https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/stop#description
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `stream` | `MediaStream` \| `undefined` | `MediaStream` which we mutate |
+| `onStopped?` | (`track`) => `void` | callback to be called when the track is stopped |
+
+## Returns
+
+`void`

package/api-docs/functions/toKey.mdx

@@ -0,0 +1,15 @@
+```ts
+function toKey(__namedParameters): string;
+```
+
+**`Beta`**
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | `ToKeyOptions` |
+
+## Returns
+
+`string`

package/api-docs/functions/toMediaDeviceInfo.mdx

@@ -0,0 +1,20 @@
+```ts
+function toMediaDeviceInfo(info): object;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `info` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) |
+
+## Returns
+
+`object`
+
+| Name | Type | Default value |
+| ------ | ------ | ------ |
+| `deviceId` | `string` | `info.deviceId` |
+| `groupId` | `string` | `info.groupId` |
+| `kind` | `MediaDeviceKind` | `info.kind` |
+| `label` | `string` | `info.label` |

package/api-docs/functions/toMediaDeviceInfoLike.mdx

@@ -0,0 +1,18 @@
+```ts
+function toMediaDeviceInfoLike(track): 
+  | MediaDeviceInfoLike
+  | undefined;
+```
+
+**`Beta`**
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `track` | `MediaStreamTrack` |
+
+## Returns
+
+  \| [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)
+  \| `undefined`

package/api-docs/functions/toMediaDeviceInputKind.mdx

@@ -0,0 +1,13 @@
+```ts
+function toMediaDeviceInputKind(track): "audioinput" | "videoinput";
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `track` | `Pick`\<`MediaStreamTrack`, `"kind"`\> |
+
+## Returns
+
+`"audioinput"` \| `"videoinput"`

package/api-docs/interfaces/DisplayMediaOptions.mdx

@@ -0,0 +1,22 @@
+The `DisplayMediaStreamOptions` dictionary is used to instruct the user agent
+what sort of `MediaStreamTracks` may be included in the `MediaStream`
+returned by `getDisplayMedia`.
+
+## See
+
+[https://w3c.github.io/mediacapture-screen-share/#displaymediastreamoptions](https://w3c.github.io/mediacapture-screen-share/#displaymediastreamoptions)
+
+## Extends
+
+- `DisplayMediaStreamOptions`
+
+## Properties
+
+| Property | Type | Overrides |
+| ------ | ------ | ------ |
+| <a id="audio"></a> `audio?` | `boolean` \| `DisplayAudioTrackConstraints` | `DisplayMediaStreamOptions.audio` |
+| <a id="video"></a> `video?` | `boolean` \| `DisplayVideoTrackConstraints` | `DisplayMediaStreamOptions.video` |
+| <a id="selfbrowsersurface"></a> `selfBrowserSurface?` | `ConstrainDOMString` | - |
+| <a id="systemaudio"></a> `systemAudio?` | `ConstrainDOMString` | - |
+| <a id="surfaceswitching"></a> `surfaceSwitching?` | `ConstrainDOMString` | - |
+| <a id="monitortypesurfaces"></a> `monitorTypeSurfaces?` | `ConstrainDOMString` | - |

package/api-docs/interfaces/IndexedDevices.mdx

@@ -0,0 +1,102 @@
+## Methods
+
+### get()
+
+```ts
+get(device?): MediaDeviceInfoLike[];
+```
+
+Get devices by kind and device id or label
+When both `deviceId` and `label` are provided, it will use `deviceId` to
+find the device, and when it's not found, it will use `label` to find
+
+When device is not provided, it returns all devices.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `device?` | `Pick`\<`Partial`\<[`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)\>, `"deviceId"` \| `"groupId"` \| `"kind"` \| `"label"`\> | the device to find |
+
+#### Returns
+
+[`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[]
+
+found devices otherwise empty array
+
+***
+
+### size()
+
+```ts
+size(kind?): number;
+```
+
+Size of particular kind of devices. When kind is not specified, it
+returns the total size.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `kind?` | `MediaDeviceKind` |
+
+#### Returns
+
+`number`
+
+***
+
+### first()
+
+```ts
+first(kind): 
+  | MediaDeviceInfoLike
+  | undefined;
+```
+
+First device of the kind
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `kind` | `MediaDeviceKind` |
+
+#### Returns
+
+  \| [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)
+  \| `undefined`
+
+***
+
+### toJSON()
+
+```ts
+toJSON(): Record<MediaDeviceKind, MediaDeviceInfoLike[]>;
+```
+
+#### Returns
+
+`Record`\<`MediaDeviceKind`, [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx)[]\>
+
+***
+
+### anyAuthorizedDevice()
+
+```ts
+anyAuthorizedDevice(kind?): boolean;
+```
+
+`true` when there is any authorized device of the kind. When kind is not
+provided, it checks for any audio or video input device.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `kind?` | `MediaDeviceKind` |
+
+#### Returns
+
+`boolean`

package/api-docs/interfaces/InputConstraintSet.mdx

@@ -0,0 +1,43 @@
+## Extends
+
+- `MediaTrackConstraints`
+
+## Properties
+
+| Property | Type | Description | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="device"></a> `device?` | `DeviceConstraint` \| `ConstraintDeviceParameters` | Same purpose as `deviceId` but it gives more information about the device so that we can have extra tolerance on device selection | - |
+| <a id="videosegmentation"></a> `videoSegmentation?` | `ConstrainDOMString` | 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` | - |
+| <a id="videosegmentationmodel"></a> `videoSegmentationModel?` | `ConstrainDOMString` | Segmentation model to be used for video segmentation, currently only supports `mediapipeSelfie` and `personify` | - |
+| <a id="denoise"></a> `denoise?` | `ConstrainBoolean` | Whether or not using our own noise suppression | - |
+| <a id="vad"></a> `vad?` | `ConstrainBoolean` | Voice Activity Detection | - |
+| <a id="asd"></a> `asd?` | `ConstrainBoolean` | Audio Signal Detection for the purpose of checking if the audio input is hardware muted or unusable | - |
+| <a id="mixwithadditionalmedia"></a> `mixWithAdditionalMedia?` | `ConstrainBoolean` | Audio Signal Detection for the purpose of checking if the audio input is hardware muted or unusable | - |
+| <a id="backgroundbluramount"></a> `backgroundBlurAmount?` | `ConstrainULong` | Blur size/level parameter when using video segmentation with `blur` effects | - |
+| <a id="edgebluramount"></a> `edgeBlurAmount?` | `ConstrainULong` | Blur amount applied to the segmented person's edge | - |
+| <a id="foregroundthreshold"></a> `foregroundThreshold?` | `ConstrainDouble` | Erode level for edge smoothing when using video segmentation | - |
+| <a id="backgroundimageurl"></a> `backgroundImageUrl?` | `ConstrainDOMString` | Image Url that is being used for video overlay effects | - |
+| <a id="maskcombineratio"></a> `maskCombineRatio?` | `ConstrainDouble` | The ratio to be used for smoothing segmentation mask | - |
+| <a id="resizemode"></a> `resizeMode?` | `ConstrainDOMString` | Image Url that is being used for video overlay effects | - |
+| <a id="pan"></a> `pan?` | `boolean` | Current pan, tilt and zoom level for a PTZ controllable camera on web | - |
+| <a id="tilt"></a> `tilt?` | `boolean` | - | - |
+| <a id="zoom"></a> `zoom?` | `boolean` | - | - |
+| <a id="contenthint"></a> `contentHint?` | `ConstrainDOMString` | Content Hint for the track to apply | - |
+| <a id="volume"></a> `volume?` | `ConstrainNumber` | - | `MediaTrackConstraints.volume` |
+| <a id="latency"></a> `latency?` | `ConstrainNumber` | - | `MediaTrackConstraints.latency` |
+| <a id="aspectratio"></a> `aspectRatio?` | `ConstrainDouble` | - | `MediaTrackConstraints.aspectRatio` |
+| <a id="autogaincontrol"></a> `autoGainControl?` | `ConstrainBoolean` | - | `MediaTrackConstraints.autoGainControl` |
+| <a id="backgroundblur"></a> `backgroundBlur?` | `ConstrainBoolean` | - | `MediaTrackConstraints.backgroundBlur` |
+| <a id="channelcount"></a> `channelCount?` | `ConstrainULong` | - | `MediaTrackConstraints.channelCount` |
+| <a id="deviceid"></a> `deviceId?` | `ConstrainDOMString` | - | `MediaTrackConstraints.deviceId` |
+| <a id="displaysurface"></a> `displaySurface?` | `ConstrainDOMString` | - | `MediaTrackConstraints.displaySurface` |
+| <a id="echocancellation"></a> `echoCancellation?` | `ConstrainBoolean` | - | `MediaTrackConstraints.echoCancellation` |
+| <a id="facingmode"></a> `facingMode?` | `ConstrainDOMString` | - | `MediaTrackConstraints.facingMode` |
+| <a id="framerate"></a> `frameRate?` | `ConstrainDouble` | - | `MediaTrackConstraints.frameRate` |
+| <a id="groupid"></a> `groupId?` | `ConstrainDOMString` | - | `MediaTrackConstraints.groupId` |
+| <a id="height"></a> `height?` | `ConstrainULong` | - | `MediaTrackConstraints.height` |
+| <a id="noisesuppression"></a> `noiseSuppression?` | `ConstrainBoolean` | - | `MediaTrackConstraints.noiseSuppression` |
+| <a id="samplerate"></a> `sampleRate?` | `ConstrainULong` | - | `MediaTrackConstraints.sampleRate` |
+| <a id="samplesize"></a> `sampleSize?` | `ConstrainULong` | - | `MediaTrackConstraints.sampleSize` |
+| <a id="width"></a> `width?` | `ConstrainULong` | - | `MediaTrackConstraints.width` |
+| <a id="advanced"></a> `advanced?` | `MediaTrackConstraintSet`[] | - | `MediaTrackConstraints.advanced` |

package/api-docs/interfaces/InputDevicePermission.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="audio"></a> `audio` | `PermissionState` |
+| <a id="video"></a> `video` | `PermissionState` |

package/api-docs/interfaces/MediaControl.mdx

@@ -0,0 +1,14 @@
+**`Beta`**
+
+MediaControl Interface
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="devicechanged"></a> `deviceChanged` | (`fn`) => () => `void` | **`Beta`** Unified interface for subscribing [DeviceChangedChanges](../type-aliases/DeviceChangedChanges.mdx) Event |
+| <a id="getdevices"></a> `getDevices` | () => `Promise`\<`MediaDeviceInfo`[]\> | **`Beta`** 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) |
+| <a id="mediaeventtype"></a> `MediaEventType` | *typeof* [`MediaEventType`](../enumerations/MediaEventType.mdx) | **`Beta`** MediaStreamTrack Events **Remarks** See MDN [Events](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack#Events) |
+| <a id="getusermedia"></a> `getUserMedia` | (`__namedParameters`) => `Promise`\<`MediaStream`\> | **`Beta`** Get MediaStream with provided [input constraints](MediaDeviceRequest.mdx) |
+| <a id="setdefaultconstraints"></a> `setDefaultConstraints` | (`newConstraints`) => `void` | **`Beta`** Set default media stream constraints A [MediaStreamConstraints](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints) object specifying the types of media to request, along with any requirements for each type. |
+| <a id="subscribe"></a> `subscribe` | (`listener`) => () => `void` | **`Beta`** Subscribe media events |

package/api-docs/interfaces/MediaDeviceRequest.mdx

@@ -0,0 +1,10 @@
+**`Beta`**
+
+The request constraints that applies to `getMediaStream`
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="audio"></a> `audio?` | [`InputDeviceConstraint`](../type-aliases/InputDeviceConstraint.mdx) | **`Beta`** Either a Boolean (which indicates whether or not an audio track is requested) or a [MediaDeviceInfoLike](../type-aliases/MediaDeviceInfoLike.mdx) object providing a hint for the audio track included in the returned MediaStream |
+| <a id="video"></a> `video?` | [`InputDeviceConstraint`](../type-aliases/InputDeviceConstraint.mdx) | **`Beta`** Either a Boolean (which indicates whether or not an video track is requested) or a [MediaDeviceInfoLike](../type-aliases/MediaDeviceInfoLike.mdx) object providing a hint for the video track included in the returned MediaStream |

package/api-docs/interfaces/MediaInput.mdx

@@ -0,0 +1,10 @@
+**`Beta`**
+
+Holds user media input devices
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="audioinput"></a> `audioInput?` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) | **`Beta`** |
+| <a id="videoinput"></a> `videoInput?` | [`MediaDeviceInfoLike`](../type-aliases/MediaDeviceInfoLike.mdx) | **`Beta`** |

package/api-docs/interfaces/StreamTrackEventHandlers.mdx

@@ -0,0 +1,9 @@
+An object contains the event handlers
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="ended"></a> `ended?` | `TrackEventCallback` |
+| <a id="mute"></a> `mute?` | `TrackEventCallback` |
+| <a id="unmute"></a> `unmute?` | `TrackEventCallback` |

package/api-docs/type-aliases/CursorCaptureConstraint.mdx

@@ -0,0 +1,10 @@
+```ts
+type CursorCaptureConstraint = ExtractObjectValueTypes<typeof CURSOR_CAPTURE_CONSTRAINT>;
+```
+
+The `CursorCaptureConstraint` enumerates the conditions under which the
+cursor is captured.
+
+## See
+
+[https://w3c.github.io/mediacapture-screen-share/#cursorcaptureconstraint](https://w3c.github.io/mediacapture-screen-share/#cursorcaptureconstraint)

package/api-docs/type-aliases/DeviceChangedChanges.mdx

@@ -0,0 +1,19 @@
+```ts
+type DeviceChangedChanges = object;
+```
+
+**`Beta`**
+
+DeviceChange Event
+
+```
+devices (raw)
+```
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="found"></a> `found` | [`MediaDeviceInfoLike`](MediaDeviceInfoLike.mdx)[] |
+| <a id="lost"></a> `lost` | [`MediaDeviceInfoLike`](MediaDeviceInfoLike.mdx)[] |
+| <a id="devices"></a> `devices` | [`MediaDeviceInfoLike`](MediaDeviceInfoLike.mdx)[] |

package/api-docs/type-aliases/DisplayCaptureSurfaceType.mdx

@@ -0,0 +1,10 @@
+```ts
+type DisplayCaptureSurfaceType = ExtractObjectValueTypes<typeof DISPLAY_CAPTURE_SURFACE_TYPE>;
+```
+
+The `DisplayCaptureSurfaceType` enumeration describes the different types of
+display surface
+
+## See
+
+[https://w3c.github.io/mediacapture-screen-share/#displaycapturesurfacetype](https://w3c.github.io/mediacapture-screen-share/#displaycapturesurfacetype)