@pexip/media 20.3.3 → 20.3.5

package/api-docs/interfaces/MediaInit.mdx

@@ -0,0 +1,14 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="constraints"></a> `constraints` | `MediaDeviceRequest` |
+| <a id="permission"></a> `permission` | `object` |
+| `permission.audio` | `PermissionState` |
+| `permission.video` | `PermissionState` |
+| <a id="originalconstraints"></a> `originalConstraints?` | `MediaDeviceRequest` |
+| <a id="tracks"></a> `tracks` | [`MediaTrack`](MediaTrack.mdx)[] |
+| <a id="devices"></a> `devices` | `IndexedDevices` |
+| <a id="status"></a> `status` | [`UserMediaStatus`](../enumerations/UserMediaStatus.mdx) |
+| <a id="stream"></a> `stream` | `MediaStream` \| `undefined` |
+| <a id="signals"></a> `signals?` | [`MediaSignals`](../type-aliases/MediaSignals.mdx) |

package/api-docs/interfaces/MediaOptions.mdx

@@ -0,0 +1,10 @@
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="signals"></a> `signals` | [`MediaSignals`](../type-aliases/MediaSignals.mdx) | Media signals to be used for the module **See** MediaSignals |
+| <a id="audioprocessors"></a> `audioProcessors` | [`TrackProcessor`](../type-aliases/TrackProcessor.mdx)[] | Media Processors |
+| <a id="videoprocessors"></a> `videoProcessors` | [`TrackProcessor`](../type-aliases/TrackProcessor.mdx)[] | - |
+| <a id="stopvideotrackasmute"></a> `stopVideoTrackAsMute?` | () => `boolean` | - |
+| <a id="getmutestate"></a> `getMuteState` | () => `DeviceMuteState` | A function to get the devices' mute state |
+| <a id="getdefaultconstraints"></a> `getDefaultConstraints?` | () => `object` | Pass default constraints to use with get media wrappers |

package/api-docs/interfaces/MediaProps.mdx

@@ -0,0 +1,9 @@
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="media"></a> `media?` | [`Media`](Media.mdx) | Current media |
+| <a id="devices"></a> `devices` | `IndexedDevices` | Current device |
+| <a id="discardmedia"></a> `discardMedia` | `boolean` | When should we discard the requested MediaStream |
+| <a id="updatingaudio"></a> `updatingAudio` | `boolean` | - |
+| <a id="updatingvideo"></a> `updatingVideo` | `boolean` | - |

package/api-docs/interfaces/MediaSettings.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="audio"></a> `audio?` | [`ExtendedMediaTrackSettings`](ExtendedMediaTrackSettings.mdx) |
+| <a id="video"></a> `video?` | [`ExtendedMediaTrackSettings`](ExtendedMediaTrackSettings.mdx) |

package/api-docs/interfaces/MediaTrack.mdx

@@ -0,0 +1,121 @@
+## Properties
+
+| Property | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `readonly` | `string` | A unique identifier for the track same as `MediaStreamTrack.id` if `track` is available otherwise it uses the `id` from the construction or the `kind`. **See** MediaTrackInit |
+| <a id="stopped"></a> `stopped?` | `readonly` | `boolean` | It maps to MediaStreamTrack['readyState'] When `true` the track's `readyState` is `ended`, `false` means `live` otherwise the track is not available |
+| <a id="suspended"></a> `suspended?` | `readonly` | `boolean` | Indicate that the media has been suspended by the User Agent, and it could happen at any time. `undefined` means the track is not available |
+| <a id="kind"></a> `kind` | `readonly` | `"audioinput"` \| `"videoinput"` | - |
+| <a id="label"></a> `label?` | `readonly` | `string` | - |
+| <a id="previousmediatrack"></a> `previousMediaTrack?` | `readonly` | `MediaTrack` | - |
+| <a id="track"></a> `track?` | `readonly` | `MediaStreamTrack` | The MediaStreamTrack object representing the track **See** https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack |
+| <a id="input"></a> `input?` | `readonly` | `MediaDeviceInfoLike` | The `MediaDeviceInfo` object representing the device that the track is connected to. **See** https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo |
+| <a id="expectedinput"></a> `expectedInput?` | `readonly` | `MediaDeviceInfoLike` | The `MediaDeviceInfo` object representing the device that the track is expected to be connected to. **See** https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo |
+| <a id="muted"></a> `muted?` | `public` | `boolean` | The current mute state of the track. `undefined` means the track is not available |
+| <a id="source"></a> `source` | `readonly` | `MediaTrack` | The source track that it is originated from |
+
+## Methods
+
+### mute()
+
+```ts
+mute(toMute, soft?): void;
+```
+
+Mute the track
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `toMute` | `boolean` | `true` to mute the track, `false` to unmute |
+| `soft?` | `boolean` | `true` to indicate a soft mute i.e. setting the track to NOT `enabled` `false` or `undefined` for default mute |
+
+#### Returns
+
+`void`
+
+***
+
+### getSettings()
+
+```ts
+getSettings(): ExtendedMediaTrackSettings;
+```
+
+#### Returns
+
+[`ExtendedMediaTrackSettings`](ExtendedMediaTrackSettings.mdx)
+
+***
+
+### getConstraints()
+
+```ts
+getConstraints(): InputDeviceConstraint;
+```
+
+#### Returns
+
+`InputDeviceConstraint`
+
+***
+
+### applyConstraints()
+
+```ts
+applyConstraints(constraints): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `constraints` | `InputDeviceConstraint` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### release()
+
+```ts
+release(): Promise<void>;
+```
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### clone()
+
+```ts
+clone(signals?, label?): MediaTrack;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `signals?` | [`MediaSignals`](../type-aliases/MediaSignals.mdx) |
+| `label?` | `string` |
+
+#### Returns
+
+`MediaTrack`
+
+***
+
+### toJSON()
+
+```ts
+toJSON(): unknown;
+```
+
+#### Returns
+
+`unknown`

package/api-docs/interfaces/MediaTrackInit.mdx

@@ -0,0 +1,29 @@
+## Extends
+
+- `Partial`\<`Omit`\<[`MediaTrack`](MediaTrack.mdx), `"mute"`\>\>
+
+## Properties
+
+| Property | Modifier | Type | Description | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id?` | `readonly` | `string` | A unique identifier for the track same as `MediaStreamTrack.id` if `track` is available otherwise it uses the `id` from the construction or the `kind`. **See** MediaTrackInit | - | [`MediaTrack`](MediaTrack.mdx).[`id`](MediaTrack.mdx#id) |
+| <a id="stopped"></a> `stopped?` | `readonly` | `boolean` | It maps to MediaStreamTrack['readyState'] When `true` the track's `readyState` is `ended`, `false` means `live` otherwise the track is not available | - | [`MediaTrack`](MediaTrack.mdx).[`stopped`](MediaTrack.mdx#stopped) |
+| <a id="suspended"></a> `suspended?` | `readonly` | `boolean` | Indicate that the media has been suspended by the User Agent, and it could happen at any time. `undefined` means the track is not available | - | [`MediaTrack`](MediaTrack.mdx).[`suspended`](MediaTrack.mdx#suspended) |
+| <a id="label"></a> `label?` | `readonly` | `string` | - | - | [`MediaTrack`](MediaTrack.mdx).[`label`](MediaTrack.mdx#label) |
+| <a id="previousmediatrack"></a> `previousMediaTrack?` | `readonly` | [`MediaTrack`](MediaTrack.mdx) | - | - | [`MediaTrack`](MediaTrack.mdx).[`previousMediaTrack`](MediaTrack.mdx#previousmediatrack) |
+| <a id="track"></a> `track?` | `readonly` | `MediaStreamTrack` | The MediaStreamTrack object representing the track **See** https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack | - | [`MediaTrack`](MediaTrack.mdx).[`track`](MediaTrack.mdx#track) |
+| <a id="muted"></a> `muted?` | `public` | `boolean` | The current mute state of the track. `undefined` means the track is not available | - | [`MediaTrack`](MediaTrack.mdx).[`muted`](MediaTrack.mdx#muted) |
+| <a id="source"></a> `source?` | `readonly` | [`MediaTrack`](MediaTrack.mdx) | The source track that it is originated from | - | [`MediaTrack`](MediaTrack.mdx).[`source`](MediaTrack.mdx#source) |
+| <a id="getsettings"></a> `getSettings?` | `public` | () => [`ExtendedMediaTrackSettings`](ExtendedMediaTrackSettings.mdx) | - | - | [`MediaTrack`](MediaTrack.mdx).[`getSettings`](MediaTrack.mdx#getsettings) |
+| <a id="getconstraints"></a> `getConstraints?` | `public` | () => `InputDeviceConstraint` | - | - | [`MediaTrack`](MediaTrack.mdx).[`getConstraints`](MediaTrack.mdx#getconstraints) |
+| <a id="applyconstraints"></a> `applyConstraints?` | `public` | (`constraints`) => `Promise`\<`void`\> | - | - | [`MediaTrack`](MediaTrack.mdx).[`applyConstraints`](MediaTrack.mdx#applyconstraints) |
+| <a id="release"></a> `release?` | `public` | () => `Promise`\<`void`\> | - | - | [`MediaTrack`](MediaTrack.mdx).[`release`](MediaTrack.mdx#release) |
+| <a id="clone"></a> `clone?` | `public` | (`signals?`, `label?`) => [`MediaTrack`](MediaTrack.mdx) | - | - | [`MediaTrack`](MediaTrack.mdx).[`clone`](MediaTrack.mdx#clone) |
+| <a id="tojson"></a> `toJSON?` | `public` | () => `unknown` | - | - | [`MediaTrack`](MediaTrack.mdx).[`toJSON`](MediaTrack.mdx#tojson) |
+| <a id="kind"></a> `kind` | `public` | `"audioinput"` \| `"videoinput"` | - | [`MediaTrack`](MediaTrack.mdx).[`kind`](MediaTrack.mdx#kind) | - |
+| <a id="input"></a> `input` | `public` | `MediaDeviceInfoLike` \| `undefined` | The `MediaDeviceInfo` object representing the device that the track is connected to. **See** https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo | [`MediaTrack`](MediaTrack.mdx).[`input`](MediaTrack.mdx#input) | - |
+| <a id="expectedinput"></a> `expectedInput?` | `public` | `MediaDeviceInfoLike` | The `MediaDeviceInfo` object representing the device that the track is expected to be connected to. **See** https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo | [`MediaTrack`](MediaTrack.mdx).[`expectedInput`](MediaTrack.mdx#expectedinput) | - |
+| <a id="constraints"></a> `constraints` | `public` | `InputDeviceConstraint` | - | - | - |
+| <a id="overridemute"></a> `overrideMute?` | `public` | `boolean` | - | - | - |
+| <a id="signals"></a> `signals?` | `public` | [`MediaSignals`](../type-aliases/MediaSignals.mdx) | - | - | - |
+| <a id="mute"></a> `mute?` | `public` | (`toMute`, `self`, `soft?`) => `void` | Overriding Mute the track | - | - |

package/api-docs/interfaces/PreviewControllerProps.mdx

@@ -0,0 +1,14 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="media"></a> `media` | [`Media`](Media.mdx) \| `undefined` |
+| <a id="audioinput"></a> `audioInput?` | `MediaDeviceInfoLike` |
+| <a id="videoinput"></a> `videoInput?` | `MediaDeviceInfoLike` |
+| <a id="updatingpreviewaudio"></a> `updatingPreviewAudio` | `boolean` |
+| <a id="updatingpreviewvideo"></a> `updatingPreviewVideo` | `boolean` |
+| <a id="updatingmain"></a> `updatingMain` | `boolean` |
+| <a id="originalmainaudioinput"></a> `originalMainAudioInput?` | `MediaDeviceInfoLike` |
+| <a id="discardmedia"></a> `discardMedia` | `boolean` |
+| <a id="initialized"></a> `initialized` | `boolean` |
+| <a id="signals"></a> `signals` | [`MediaSignals`](../type-aliases/MediaSignals.mdx) |

package/api-docs/interfaces/PreviewEventHandler.mdx

@@ -0,0 +1,19 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="audioinput"></a> `audioInput?` | `EventCallback`\<[`PreviewInput`](../type-aliases/PreviewInput.mdx)\> |
+| <a id="videoinput"></a> `videoInput?` | `EventCallback`\<[`PreviewInput`](../type-aliases/PreviewInput.mdx)\> |
+| <a id="media"></a> `media?` | `EventCallback`\<[`Media`](Media.mdx)\> |
+| <a id="videoinputerror"></a> `videoInputError?` | `EventErrorCallback` |
+| <a id="audioinputerror"></a> `audioInputError?` | `EventErrorCallback` |
+| <a id="applychangeserror"></a> `applyChangesError?` | `EventErrorCallback` |
+| <a id="revertchangeserror"></a> `revertChangesError?` | `EventErrorCallback` |
+| <a id="audiomuted"></a> `audioMuted?` | `EventCallback`\<`boolean` \| `undefined`\> |
+| <a id="audiosuspended"></a> `audioSuspended?` | `EventCallback`\<`boolean` \| `undefined`\> |
+| <a id="updatingmain"></a> `updatingMain?` | `EventCallback`\<`boolean`\> |
+| <a id="updatingpreviewaudio"></a> `updatingPreviewAudio?` | `EventCallback`\<`boolean`\> |
+| <a id="updatingpreviewvideo"></a> `updatingPreviewVideo?` | `EventCallback`\<`boolean`\> |
+| <a id="videomuted"></a> `videoMuted?` | `EventCallback`\<`boolean` \| `undefined`\> |
+| <a id="videosuspended"></a> `videoSuspended?` | `EventCallback`\<`boolean` \| `undefined`\> |
+| <a id="unsubscribemain"></a> `unsubscribeMain?` | [`Unsubscribe`](../type-aliases/Unsubscribe.mdx) |

package/api-docs/interfaces/PreviewStreamController.mdx

@@ -0,0 +1,350 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="media"></a> `media` | [`Media`](Media.mdx) \| `undefined` |
+| <a id="audioinputchanged"></a> `audioInputChanged` | `boolean` |
+| <a id="videoinputchanged"></a> `videoInputChanged` | `boolean` |
+| <a id="inputchanged"></a> `inputChanged` | `boolean` |
+| <a id="audioinput"></a> `audioInput` | [`PreviewInput`](../type-aliases/PreviewInput.mdx) |
+| <a id="videoinput"></a> `videoInput` | [`PreviewInput`](../type-aliases/PreviewInput.mdx) |
+| <a id="updatingmain"></a> `updatingMain` | `boolean` |
+| <a id="updatingpreviewaudio"></a> `updatingPreviewAudio` | `boolean` |
+| <a id="updatingpreviewvideo"></a> `updatingPreviewVideo` | `boolean` |
+| <a id="cleanup"></a> `cleanup` | () => `Promise`\<`void`\> |
+
+## Methods
+
+### updatePreviewInput()
+
+```ts
+updatePreviewInput(input): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `input` | [`PreviewInput`](../type-aliases/PreviewInput.mdx) |
+
+#### Returns
+
+`void`
+
+***
+
+### updateAudioInput()
+
+```ts
+updateAudioInput(id): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `id` | `string` |
+
+#### Returns
+
+`void`
+
+***
+
+### updateVideoInput()
+
+```ts
+updateVideoInput(id): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `id` | `string` |
+
+#### Returns
+
+`void`
+
+***
+
+### applyChanges()
+
+```ts
+applyChanges(force?): Promise<void>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `force?` | `boolean` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### revertChanges()
+
+```ts
+revertChanges(): Promise<void>;
+```
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### onMediaChanged()
+
+```ts
+onMediaChanged(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<[`Media`](Media.mdx)\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onAudioInputChanged()
+
+```ts
+onAudioInputChanged(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<[`PreviewInput`](../type-aliases/PreviewInput.mdx)\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onVideoInputChanged()
+
+```ts
+onVideoInputChanged(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<[`PreviewInput`](../type-aliases/PreviewInput.mdx)\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onUpdatingPreviewAudio()
+
+```ts
+onUpdatingPreviewAudio(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<`boolean`\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onUpdatingPreviewVideo()
+
+```ts
+onUpdatingPreviewVideo(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<`boolean`\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onUpdatingMain()
+
+```ts
+onUpdatingMain(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<`boolean`\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onAudioInputError()
+
+```ts
+onAudioInputError(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventErrorCallback` |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onVideoInputError()
+
+```ts
+onVideoInputError(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventErrorCallback` |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onApplyChangesError()
+
+```ts
+onApplyChangesError(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventErrorCallback` |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onRevertChangesError()
+
+```ts
+onRevertChangesError(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventErrorCallback` |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onAudioMuted()
+
+```ts
+onAudioMuted(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<`boolean` \| `undefined`\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onAudioSuspended()
+
+```ts
+onAudioSuspended(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<`boolean` \| `undefined`\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onVideoMuted()
+
+```ts
+onVideoMuted(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<`boolean` \| `undefined`\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)
+
+***
+
+### onVideoSuspended()
+
+```ts
+onVideoSuspended(callback): Unsubscribe;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `callback` | `EventCallback`\<`boolean` \| `undefined`\> |
+
+#### Returns
+
+[`Unsubscribe`](../type-aliases/Unsubscribe.mdx)

package/api-docs/interfaces/PreviewStreamParams.mdx

@@ -0,0 +1,15 @@
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="getcurrentdevices"></a> `getCurrentDevices` | () => `IndexedDevices` | - |
+| <a id="getcurrentmedia"></a> `getCurrentMedia` | () => [`Media`](Media.mdx) \| `undefined` | - |
+| <a id="updatemainstream"></a> `updateMainStream` | (`request`) => `Promise`\<`void`\> | - |
+| <a id="mainmediasignal"></a> `mainMediaSignal` | `Signal`\<[`Media`](Media.mdx) \| `undefined`, [`Media`](Media.mdx) \| `undefined`\> | - |
+| <a id="signals"></a> `signals` | [`MediaSignals`](../type-aliases/MediaSignals.mdx) | - |
+| <a id="onended"></a> `onEnded?` | () => `void` | - |
+| <a id="fftsize"></a> `fftSize?` | `number` | - |
+| <a id="queueoptions"></a> `queueOptions?` | `Partial`\<`AsyncQueueOptions`\> | - |
+| <a id="audioprocessors"></a> `audioProcessors` | [`TrackProcessor`](../type-aliases/TrackProcessor.mdx)[] | - |
+| <a id="videoprocessors"></a> `videoProcessors` | [`TrackProcessor`](../type-aliases/TrackProcessor.mdx)[] | - |
+| <a id="getdefaultconstraints"></a> `getDefaultConstraints?` | () => `object` | Pass default constraints to use with get media wrappers |

package/api-docs/interfaces/VoiceActivityDetectionOptions.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="vadthrottlems"></a> `vadThrottleMS?` | `number` | Voice Activity Detection in millisecond |
+| <a id="shoulddetectvoiceactivity"></a> `shouldDetectVoiceActivity` | () => `boolean` | Whether or not to detect voice activity |

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

@@ -0,0 +1,3 @@
+```ts
+type AudioContentHint = typeof AUDIO_CONTENT_HINTS[keyof typeof AUDIO_CONTENT_HINTS];
+```

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

@@ -0,0 +1,3 @@
+```ts
+type CreatePreviewStreamController = typeof createPreviewStreamController;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type ExtendedMediaTrackSettingsKey = keyof ExtendedMediaTrackSettings;
+```

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

@@ -0,0 +1,9 @@
+```ts
+type GeneratedMediaSignals<K> = Pick<Required<MediaSignals>, K>;
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `K` *extends* keyof [`MediaSignals`](MediaSignals.mdx) |

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

@@ -0,0 +1,3 @@
+```ts
+type GetDisplayMedia = ReturnType<typeof createGetDisplayMedia>;
+```

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

@@ -0,0 +1,19 @@
+```ts
+type GetUserMediaProcess = (request) => Promise<Media>;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `request` | \{ `constraints`: `MediaDeviceRequest`; `originalConstraints`: `MediaDeviceRequest`; `permission`: \{ `audio`: `PermissionState`; `video`: `PermissionState`; \}; `currentMedia`: [`Media`](../interfaces/Media.mdx) \| `undefined`; \} |
+| `request.constraints` | `MediaDeviceRequest` |
+| `request.originalConstraints` | `MediaDeviceRequest` |
+| `request.permission` | \{ `audio`: `PermissionState`; `video`: `PermissionState`; \} |
+| `request.permission.audio` | `PermissionState` |
+| `request.permission.video` | `PermissionState` |
+| `request.currentMedia` | [`Media`](../interfaces/Media.mdx) \| `undefined` |
+
+## Returns
+
+`Promise`\<[`Media`](../interfaces/Media.mdx)\>

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

@@ -0,0 +1,3 @@
+```ts
+type MediaSignals = MediaSignalsRequired & MediaSignalsOptional;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type MediaSignalsOptional = Omit<Partial<MediaChangesSignals>, "onMediaChanged">;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type MediaSignalsRequired = Pick<MediaChangesSignals, "onMediaChanged"> & AudioDetectionSignals;
+```

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

@@ -0,0 +1,3 @@
+```ts
+type PreviewInput = MediaDeviceInfoLike | undefined;
+```