@pexip/media 20.3.4 → 21.0.0

package/api-docs/functions/createMediaSignal.mdx

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

package/api-docs/functions/createMediaSignals.mdx

@@ -0,0 +1,33 @@
+```ts
+function createMediaSignals<K>(more, scope): Pick<Required<MediaSignals>, SignalKeys>;
+```
+
+Create and return all required and optional (if specified with `more`),
+signals for media to work
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `K` *extends* \| `"onAddTrack"` \| `"onDevicesChanged"` \| `"onMediaTrackMuted"` \| `"onMediaTrackResumed"` \| `"onMediaTrackStopped"` \| `"onMediaTrackSuspended"` \| `"onRemoveTrack"` \| `"onStatusChanged"` \| `"onUpdatingAudio"` \| `"onUpdatingVideo"` |
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `more` | `K`[] | `undefined` | Keys from `MediaSignalsOptional`, |
+| `scope` | `string` | `''` | any scope prefix for the generated signal name, |
+
+## Returns
+
+`Pick`\<`Required`\<[`MediaSignals`](../type-aliases/MediaSignals.mdx)\>, `SignalKeys`\>
+
+## See
+
+ - MediaSignalsOptional
+ - Signal
+
+The following signals created by default
+- 'onMediaChanged',
+- 'onVAD',
+ - REQUIRED_SIGNAL_KEYS

package/api-docs/functions/createPreviewStreamController.mdx

@@ -0,0 +1,13 @@
+```ts
+function createPreviewStreamController(__namedParameters): PreviewStreamController;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | [`PreviewStreamParams`](../interfaces/PreviewStreamParams.mdx) |
+
+## Returns
+
+[`PreviewStreamController`](../interfaces/PreviewStreamController.mdx)

package/api-docs/functions/createVideoStreamProcess.mdx

@@ -0,0 +1,13 @@
+```ts
+function createVideoStreamProcess(__namedParameters): TrackProcessor;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | `VideoStreamProcessOptions` |
+
+## Returns
+
+[`TrackProcessor`](../type-aliases/TrackProcessor.mdx)

package/api-docs/functions/deriveInitialPermissionStatus.mdx

@@ -0,0 +1,14 @@
+```ts
+function deriveInitialPermissionStatus(prevStatus, getPermissionState): Promise<UserMediaStatus>;
+```
+
+## Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `prevStatus` | [`UserMediaStatus`](../enumerations/UserMediaStatus.mdx) | `undefined` |
+| `getPermissionState` | (`anyActiveAudioTrack?`, `anyActiveVideoTrack?`, `getDevices?`) => `Promise`\<`InputDevicePermission`\> | `getInputDevicePermissionState` |
+
+## Returns
+
+`Promise`\<[`UserMediaStatus`](../enumerations/UserMediaStatus.mdx)\>

package/api-docs/functions/getBlurKernelSize.mdx

@@ -0,0 +1,25 @@
+```ts
+function getBlurKernelSize(
+   norm, 
+   heightRef, 
+   height, 
+   max): number;
+```
+
+A function to get the blur kernel size of image height based on
+Kawase blur algorithm
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `norm` | `number` | [0-100] The normalized blur amount |
+| `heightRef` | `number` | The reference image height |
+| `height` | `number` | The current image height |
+| `max` | `number` | The upper bound |
+
+## Returns
+
+`number`
+
+blur kernel size

package/api-docs/functions/getPermissionStatus.mdx

@@ -0,0 +1,34 @@
+```ts
+function getPermissionStatus(__namedParameters): 
+  | Initial
+  | InitialPermissionsGranted
+  | InitialPermissionsNotGranted
+  | InitialPermissionsVideoInputDenied
+  | InitialPermissionsAudioInputDenied
+  | InitialPermissionsVideoInputGranted
+  | InitialPermissionsAudioInputGranted
+  | InitialPermissionsGrantedVideoInputDenied
+  | InitialPermissionsGrantedAudioInputDenied
+  | PermissionsRejected;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | \{ `audio`: `PermissionState`; `video`: `PermissionState`; \} |
+| `__namedParameters.audio` | `PermissionState` |
+| `__namedParameters.video` | `PermissionState` |
+
+## Returns
+
+  \| [`Initial`](../enumerations/UserMediaStatus.mdx#initial)
+  \| [`InitialPermissionsGranted`](../enumerations/UserMediaStatus.mdx#initialpermissionsgranted)
+  \| [`InitialPermissionsNotGranted`](../enumerations/UserMediaStatus.mdx#initialpermissionsnotgranted)
+  \| [`InitialPermissionsVideoInputDenied`](../enumerations/UserMediaStatus.mdx#initialpermissionsvideoinputdenied)
+  \| [`InitialPermissionsAudioInputDenied`](../enumerations/UserMediaStatus.mdx#initialpermissionsaudioinputdenied)
+  \| [`InitialPermissionsVideoInputGranted`](../enumerations/UserMediaStatus.mdx#initialpermissionsvideoinputgranted)
+  \| [`InitialPermissionsAudioInputGranted`](../enumerations/UserMediaStatus.mdx#initialpermissionsaudioinputgranted)
+  \| [`InitialPermissionsGrantedVideoInputDenied`](../enumerations/UserMediaStatus.mdx#initialpermissionsgrantedvideoinputdenied)
+  \| [`InitialPermissionsGrantedAudioInputDenied`](../enumerations/UserMediaStatus.mdx#initialpermissionsgrantedaudioinputdenied)
+  \| [`PermissionsRejected`](../enumerations/UserMediaStatus.mdx#permissionsrejected)

package/api-docs/functions/getTentBlurSize.mdx

@@ -0,0 +1,24 @@
+```ts
+function getTentBlurSize(
+   norm, 
+   heightRef, 
+   height, 
+   max): number;
+```
+
+A function to get the Tent blur size of image height
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `norm` | `number` | `undefined` | [0-100] The normalized blur amount |
+| `heightRef` | `number` | `undefined` | The reference image height |
+| `height` | `number` | `undefined` | The current image height |
+| `max` | `number` | `MAX_TENT_BLUR_SIZE` | The upper bound |
+
+## Returns
+
+`number`
+
+tent blur size

package/api-docs/functions/isAnalyzerNodeInitProp.mdx

@@ -0,0 +1,13 @@
+```ts
+function isAnalyzerNodeInitProp(value): value is AnalyzerNodeInit | undefined;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
+
+## Returns
+
+value is AnalyzerNodeInit \| undefined

package/api-docs/functions/isAudioContentHint.mdx

@@ -0,0 +1,13 @@
+```ts
+function isAudioContentHint(value): value is AudioContentHint;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
+
+## Returns
+
+`value is AudioContentHint`

package/api-docs/functions/isMedia.mdx

@@ -0,0 +1,13 @@
+```ts
+function isMedia(value): value is Media;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
+
+## Returns
+
+`value is Media`

package/api-docs/functions/isNonNullObject.mdx

@@ -0,0 +1,13 @@
+```ts
+function isNonNullObject(value): value is Record<string, unknown>;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
+
+## Returns
+
+`value is Record<string, unknown>`

package/api-docs/functions/isUserMediaStatus.mdx

@@ -0,0 +1,13 @@
+```ts
+function isUserMediaStatus(value): value is UserMediaStatus;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
+
+## Returns
+
+`value is UserMediaStatus`

package/api-docs/functions/isVideoContentHint.mdx

@@ -0,0 +1,13 @@
+```ts
+function isVideoContentHint(value): value is VideoContentHint;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
+
+## Returns
+
+`value is VideoContentHint`

package/api-docs/functions/isVideoStreamTrackProcessorAPIs.mdx

@@ -0,0 +1,13 @@
+```ts
+function isVideoStreamTrackProcessorAPIs(value): value is VideoStreamTrackProcessorAPIs;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
+
+## Returns
+
+`value is VideoStreamTrackProcessorAPIs`

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/toDeniedDevices.mdx

@@ -0,0 +1,13 @@
+```ts
+function toDeniedDevices(status?): DeniedDevices | undefined;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `status?` | [`UserMediaStatus`](../enumerations/UserMediaStatus.mdx) |
+
+## Returns
+
+[`DeniedDevices`](../enumerations/DeniedDevices.mdx) \| `undefined`

package/api-docs/interfaces/AudioDetectionSignals.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="onvad"></a> `onVAD` | `Signal`\<`undefined`\> |
+| <a id="onsilentdetected"></a> `onSilentDetected` | `Signal`\<`boolean`\> |

package/api-docs/interfaces/AudioSignalDetectionOptions.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="audiosignaldetectionduration"></a> `audioSignalDetectionDuration?` | `number` | Audio Signal Detection Duration in second |
+| <a id="shoulddetectaudio"></a> `shouldDetectAudio` | () => `boolean` | Whether or not to detect audio signal for malfunctioning device |

package/api-docs/interfaces/DenoiseParams.mdx

@@ -0,0 +1,9 @@
+URL links needed for creating a denoise node for audio processing
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="wasmurl"></a> `wasmURL` | `string` | wasm URL to get the denoise wasm |
+| <a id="workletmodule"></a> `workletModule` | `string` | AudioWorklet module URL to get the worklet, **See** AudioContext['audioWorklet']['addModule'] |
+| <a id="workletoptions"></a> `workletOptions?` | `WorkletOptions` | AudioWorklet options to pass **See** AudioContext['audioWorklet']['addModule'] |

package/api-docs/interfaces/ExtendedMediaTrackSettings.mdx

@@ -0,0 +1,38 @@
+## Extends
+
+- `MediaTrackSettings`
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="mixwithadditionalmedia"></a> `mixWithAdditionalMedia?` | `boolean` | - | - |
+| <a id="channelcount"></a> `channelCount?` | `number` | `MediaTrackSettings.channelCount` | - |
+| <a id="denoise"></a> `denoise?` | `boolean` | - | - |
+| <a id="vad"></a> `vad?` | `boolean` | - | - |
+| <a id="asd"></a> `asd?` | `boolean` | - | - |
+| <a id="backgroundbluramount"></a> `backgroundBlurAmount?` | `number` | - | - |
+| <a id="backgroundimageurl"></a> `backgroundImageUrl?` | `string` | - | - |
+| <a id="edgebluramount"></a> `edgeBlurAmount?` | `number` | - | - |
+| <a id="maskcombineratio"></a> `maskCombineRatio?` | `number` | - | - |
+| <a id="foregroundthreshold"></a> `foregroundThreshold?` | `number` | - | - |
+| <a id="videosegmentation"></a> `videoSegmentation?` | `"none"` \| `"blur"` \| `"overlay"` | - | - |
+| <a id="videosegmentationmodel"></a> `videoSegmentationModel?` | `SegmentationModel` | - | - |
+| <a id="pan"></a> `pan?` | `boolean` | - | - |
+| <a id="tilt"></a> `tilt?` | `boolean` | - | - |
+| <a id="zoom"></a> `zoom?` | `boolean` | - | - |
+| <a id="contenthint"></a> `contentHint?` | \| `""` \| `"speech"` \| `"speech-recognition"` \| `"music"` \| `"motion"` \| `"detail"` \| `"text"` | - | - |
+| <a id="aspectratio"></a> `aspectRatio?` | `number` | - | `MediaTrackSettings.aspectRatio` |
+| <a id="autogaincontrol"></a> `autoGainControl?` | `boolean` | - | `MediaTrackSettings.autoGainControl` |
+| <a id="backgroundblur"></a> `backgroundBlur?` | `boolean` | - | `MediaTrackSettings.backgroundBlur` |
+| <a id="deviceid"></a> `deviceId?` | `string` | - | `MediaTrackSettings.deviceId` |
+| <a id="displaysurface"></a> `displaySurface?` | `string` | - | `MediaTrackSettings.displaySurface` |
+| <a id="echocancellation"></a> `echoCancellation?` | `boolean` | - | `MediaTrackSettings.echoCancellation` |
+| <a id="facingmode"></a> `facingMode?` | `string` | - | `MediaTrackSettings.facingMode` |
+| <a id="framerate"></a> `frameRate?` | `number` | - | `MediaTrackSettings.frameRate` |
+| <a id="groupid"></a> `groupId?` | `string` | - | `MediaTrackSettings.groupId` |
+| <a id="height"></a> `height?` | `number` | - | `MediaTrackSettings.height` |
+| <a id="noisesuppression"></a> `noiseSuppression?` | `boolean` | - | `MediaTrackSettings.noiseSuppression` |
+| <a id="samplerate"></a> `sampleRate?` | `number` | - | `MediaTrackSettings.sampleRate` |
+| <a id="samplesize"></a> `sampleSize?` | `number` | - | `MediaTrackSettings.sampleSize` |
+| <a id="width"></a> `width?` | `number` | - | `MediaTrackSettings.width` |