@pexip/media 20.3.4 → 21.0.0

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;
+```

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

@@ -0,0 +1,19 @@
+```ts
+type Process<T> = (a) => Promise<MediaTrack>;
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `a` | `T` |
+
+## Returns
+
+`Promise`\<[`MediaTrack`](../interfaces/MediaTrack.mdx)\>

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

@@ -0,0 +1,3 @@
+```ts
+type Segmenters = { [Property in SegmentationModel]: Segmenter };
+```

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

@@ -0,0 +1,3 @@
+```ts
+type TrackProcessor = Process<MediaTrack>;
+```

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

@@ -0,0 +1,7 @@
+```ts
+type Unsubscribe = () => void;
+```
+
+## Returns
+
+`void`

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

@@ -0,0 +1,13 @@
+```ts
+type UserMediaValidator = (status) => boolean;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `status` | [`UserMediaStatus`](../enumerations/UserMediaStatus.mdx) |
+
+## Returns
+
+`boolean`

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

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

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

@@ -0,0 +1,17 @@
+```ts
+type VideoRenderParams = Omit<RendererOptions, "effects" | "personCenter"> & object;
+```
+
+## Type Declaration
+
+| Name | Type | Description |
+| ------ | ------ | ------ |
+| `frameRate` | `number` | Target frame rate for the video segmentation |
+| `width` | `number` | Render Effects |
+| `height` | `number` | - |
+| `videoSegmentation` | `RenderEffects` | - |
+| `pan?` | `boolean` | - |
+| `tilt?` | `boolean` | - |
+| `zoom?` | `boolean` | - |
+| `personCenterX?` | `number` | - |
+| `personCenterY?` | `number` | - |

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

@@ -0,0 +1,7 @@
+```ts
+type VideoStreamTrackProcessorAPIs = "stream" | "canvas";
+```
+
+Use which processor API to process the stream track
+`stream` - Use `MediaStreamTrackProcessor`, when available
+`canvas` - Use Canvas

package/api-docs/variables/AUDIO_CONTENT_HINTS.mdx

@@ -0,0 +1,17 @@
+```ts
+const AUDIO_CONTENT_HINTS: object;
+```
+
+Audio content hints are only applicable when the MediaStreamTrack contains an
+audio track
+
+[https://www.w3.org/TR/mst-content-hint/#audio-content-hints](https://www.w3.org/TR/mst-content-hint/#audio-content-hints)
+
+## Type Declaration
+
+| Name | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="nohint"></a> `NoHint` | `""` | `''` | No hint has been provided, the implementation should make its best-informed guess on how to handle contained audio data. This may be inferred from how the track was opened or by doing content analysis |
+| <a id="speech"></a> `Speech` | `"speech"` | `'speech'` | The track should be treated as if it contains speech data. Consuming this signal it may be appropriate to apply noise suppression or boost intelligibility of the incoming signal. |
+| <a id="speechrecognition"></a> `SpeechRecognition` | `"speech-recognition"` | `'speech-recognition'` | The track should be treated as if it contains data for the purpose of speech recognition by a machine. Consuming this signal it may be appropriate to boost intelligibility of the incoming signal for transcription and turn off audio-processing components that are used for human consumption. |
+| <a id="music"></a> `Music` | `"music"` | `'music'` | The track should be treated as if it contains music data. Generally this might imply tuning or turning off audio-processing components that are used to process speech data to prevent the audio from being distorted. |

package/api-docs/variables/REQUIRED_SIGNAL_KEYS.mdx

@@ -0,0 +1,3 @@
+```ts
+const REQUIRED_SIGNAL_KEYS: readonly ["onMediaChanged", "onVAD", "onSilentDetected"];
+```

package/api-docs/variables/VIDEO_CONTENT_HINTS.mdx

@@ -0,0 +1,17 @@
+```ts
+const VIDEO_CONTENT_HINTS: object;
+```
+
+Video content hints are only applicable when the MediaStreamTrack contains a
+video track.
+
+[https://www.w3.org/TR/mst-content-hint/#video-content-hints](https://www.w3.org/TR/mst-content-hint/#video-content-hints)
+
+## Type Declaration
+
+| Name | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="nohint"></a> `NoHint` | `""` | `''` | No hint has been provided, the implementation should make its best-informed guess on how contained video content should be treated. This can for example be inferred from how the track was opened or by doing content analysis. |
+| <a id="motion"></a> `Motion` | `"motion"` | `'motion'` | The track should be treated as if it contains video where motion is important. This is normally webcam video, movies or video games. Quantization artefacts and downscaling are acceptable in order to preserve motion as well as possible while still retaining target bitrates. During low bitrates when compromises have to be made, more effort is spent on preserving frame rate than edge quality and details. |
+| <a id="detail"></a> `Detail` | `"detail"` | `'detail'` | The track should be treated as if video details are extra important. This is generally applicable to presentations or web pages with text content, painting or line art. This setting would normally optimize for detail in the resulting individual frames rather than smooth playback. Artefacts from quantization or downscaling that make small text or line art unintelligible should be avoided. |
+| <a id="text"></a> `Text` | `"text"` | `'text'` | The track should be treated as if video details are extra important, and that significant sharp edges and areas of consistent color can occur frequently. This is generally applicable to presentations or web pages with text content. This setting would normally optimize for detail in the resulting individual frames rather than smooth playback, and may take advantage of encoder tools that optimize for text rendering. Artefacts from quantization or downscaling that make small text or line art unintelligible should be avoided. |

package/api-docs/variables/areBothGranted.mdx

@@ -0,0 +1,3 @@
+```ts
+const areBothGranted: UserMediaValidator;
+```

package/api-docs/variables/hasNoAudioDevices.mdx

@@ -0,0 +1,3 @@
+```ts
+const hasNoAudioDevices: UserMediaValidator;
+```

package/api-docs/variables/hasNoDevice.mdx

@@ -0,0 +1,3 @@
+```ts
+const hasNoDevice: UserMediaValidator;
+```

package/api-docs/variables/hasNoVideoDevices.mdx

@@ -0,0 +1,3 @@
+```ts
+const hasNoVideoDevices: UserMediaValidator;
+```

package/api-docs/variables/internalSignals.mdx

@@ -0,0 +1,13 @@
+```ts
+const internalSignals: object;
+```
+
+**`Internal`**
+
+Internal signals
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| <a id="ondeviceschanged"></a> `onDevicesChanged` | `Signal`\<`IndexedDevices`, `IndexedDevices`\> |

package/api-docs/variables/isAudioDeviceInUse.mdx

@@ -0,0 +1,3 @@
+```ts
+const isAudioDeviceInUse: UserMediaValidator;
+```

package/api-docs/variables/isDeviceInUse.mdx

@@ -0,0 +1,3 @@
+```ts
+const isDeviceInUse: UserMediaValidator;
+```

package/api-docs/variables/isDevicesInUse.mdx

@@ -0,0 +1,3 @@
+```ts
+const isDevicesInUse: UserMediaValidator;
+```

package/api-docs/variables/isFallback.mdx

@@ -0,0 +1,3 @@
+```ts
+const isFallback: UserMediaValidator;
+```

package/api-docs/variables/isFallbackAudio.mdx

@@ -0,0 +1,3 @@
+```ts
+const isFallbackAudio: UserMediaValidator;
+```

package/api-docs/variables/isFallbackVideo.mdx

@@ -0,0 +1,3 @@
+```ts
+const isFallbackVideo: UserMediaValidator;
+```

package/api-docs/variables/isGranted.mdx

@@ -0,0 +1,3 @@
+```ts
+const isGranted: UserMediaValidator;
+```

package/api-docs/variables/isGrantedAudio.mdx

@@ -0,0 +1,3 @@
+```ts
+const isGrantedAudio: UserMediaValidator;
+```

package/api-docs/variables/isGrantedOnlyAudio.mdx

@@ -0,0 +1,3 @@
+```ts
+const isGrantedOnlyAudio: UserMediaValidator;
+```

package/api-docs/variables/isGrantedOnlyAudioNoVideoDevices.mdx

@@ -0,0 +1,3 @@
+```ts
+const isGrantedOnlyAudioNoVideoDevices: UserMediaValidator;
+```

package/api-docs/variables/isGrantedOnlyVideo.mdx

@@ -0,0 +1,3 @@
+```ts
+const isGrantedOnlyVideo: UserMediaValidator;
+```

package/api-docs/variables/isGrantedOnlyVideoNoAudioDevices.mdx

@@ -0,0 +1,3 @@
+```ts
+const isGrantedOnlyVideoNoAudioDevices: UserMediaValidator;
+```

package/api-docs/variables/isGrantedVideo.mdx

@@ -0,0 +1,3 @@
+```ts
+const isGrantedVideo: UserMediaValidator;
+```