@pexip/media 20.3.4 → 20.3.5

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/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/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` |

package/api-docs/interfaces/Media.mdx

@@ -0,0 +1,316 @@
+## Extends
+
+- [`MediaAttributes`](MediaAttributes.mdx)
+
+## Properties
+
+| Property | Modifier | Type | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="active"></a> `active` | `readonly` | `boolean` | Indicating whether the media is active A stream is considered active if at least one of its MediaStreamTracks does not have its property MediaStreamTrack.readyState set to ended. Once every track has ended, the stream's active property becomes false. | [`MediaAttributes`](MediaAttributes.mdx).[`active`](MediaAttributes.mdx#active) |
+| <a id="id"></a> `id` | `readonly` | `string` | A string containing a 36-character universally unique identifier (UUID) for the object. | [`MediaAttributes`](MediaAttributes.mdx).[`id`](MediaAttributes.mdx#id) |
+| <a id="devices"></a> `devices` | `public` | `IndexedDevices` | The devices used for the media | [`MediaAttributes`](MediaAttributes.mdx).[`devices`](MediaAttributes.mdx#devices) |
+| <a id="stream"></a> `stream` | `public` | `MediaStream` | Media stream for the media | [`MediaAttributes`](MediaAttributes.mdx).[`stream`](MediaAttributes.mdx#stream) |
+| <a id="expectedaudioinput"></a> `expectedAudioInput?` | `public` | `MediaDeviceInfoLike` | The audio input device which is expected to be used for the current stream based on the provided constraints | [`MediaAttributes`](MediaAttributes.mdx).[`expectedAudioInput`](MediaAttributes.mdx#expectedaudioinput) |
+| <a id="expectedvideoinput"></a> `expectedVideoInput?` | `public` | `MediaDeviceInfoLike` | The video input device which is expected to be used for the current stream based on the provided constraints | [`MediaAttributes`](MediaAttributes.mdx).[`expectedVideoInput`](MediaAttributes.mdx#expectedvideoinput) |
+| <a id="status"></a> `status` | `public` | [`UserMediaStatus`](../enumerations/UserMediaStatus.mdx) | The status of the media | [`MediaAttributes`](MediaAttributes.mdx).[`status`](MediaAttributes.mdx#status) |
+| <a id="audiomuted"></a> `audioMuted` | `public` | `boolean` \| `undefined` | Current mute state of audio track `undefined` means there is no such track from the stream | [`MediaAttributes`](MediaAttributes.mdx).[`audioMuted`](MediaAttributes.mdx#audiomuted) |
+| <a id="videomuted"></a> `videoMuted` | `public` | `boolean` \| `undefined` | Current mute state of video track `undefined` means there is no such track from the stream | [`MediaAttributes`](MediaAttributes.mdx).[`videoMuted`](MediaAttributes.mdx#videomuted) |
+| <a id="audioinput"></a> `audioInput?` | `public` | `MediaDeviceInfoLike` | Audio input device is used for the audio track from the current stream | [`MediaAttributes`](MediaAttributes.mdx).[`audioInput`](MediaAttributes.mdx#audioinput) |
+| <a id="videoinput"></a> `videoInput?` | `public` | `MediaDeviceInfoLike` | Video input device is used for the video track from the current stream | [`MediaAttributes`](MediaAttributes.mdx).[`videoInput`](MediaAttributes.mdx#videoinput) |
+
+## Methods
+
+### muteAudio()
+
+```ts
+muteAudio(mute): void;
+```
+
+mute/unmute the audio track
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `mute` | `boolean` |
+
+#### Returns
+
+`void`
+
+***
+
+### muteVideo()
+
+```ts
+muteVideo(mute): void;
+```
+
+mute/unmute the video track
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `mute` | `boolean` |
+
+#### Returns
+
+`void`
+
+***
+
+### applyConstraints()
+
+```ts
+applyConstraints(constraints): Promise<void>;
+```
+
+Apply the constraints to the current media
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `constraints` | `MediaDeviceRequest` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### release()
+
+```ts
+release(): Promise<void>;
+```
+
+Release the media resources, e.g. camera/microphone
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### getConstraints()
+
+```ts
+getConstraints(): MediaDeviceRequest;
+```
+
+#### Returns
+
+`MediaDeviceRequest`
+
+***
+
+### setOriginalConstraints()
+
+```ts
+setOriginalConstraints(constraints): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `constraints` | `MediaDeviceRequest` |
+
+#### Returns
+
+`void`
+
+***
+
+### getOriginalConstraints()
+
+```ts
+getOriginalConstraints(): MediaDeviceRequest;
+```
+
+#### Returns
+
+`MediaDeviceRequest`
+
+***
+
+### isAudioInputUnavailable()
+
+```ts
+isAudioInputUnavailable(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+***
+
+### isVideoInputUnavailable()
+
+```ts
+isVideoInputUnavailable(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+***
+
+### requestedAudio()
+
+```ts
+requestedAudio(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+***
+
+### requestedVideo()
+
+```ts
+requestedVideo(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+***
+
+### getSettings()
+
+```ts
+getSettings(): MediaSettings;
+```
+
+#### Returns
+
+[`MediaSettings`](MediaSettings.mdx)
+
+***
+
+### toJSON()
+
+```ts
+toJSON(): unknown;
+```
+
+#### Returns
+
+`unknown`
+
+***
+
+### getTracks()
+
+```ts
+getTracks(): MediaTrack[];
+```
+
+#### Returns
+
+[`MediaTrack`](MediaTrack.mdx)[]
+
+***
+
+### getAudioTracks()
+
+```ts
+getAudioTracks(): MediaTrack[];
+```
+
+#### Returns
+
+[`MediaTrack`](MediaTrack.mdx)[]
+
+***
+
+### getVideoTracks()
+
+```ts
+getVideoTracks(): MediaTrack[];
+```
+
+#### Returns
+
+[`MediaTrack`](MediaTrack.mdx)[]
+
+***
+
+### addTrack()
+
+```ts
+addTrack(track): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `track` | [`MediaTrack`](MediaTrack.mdx) |
+
+#### Returns
+
+`void`
+
+***
+
+### isCurrentTrack()
+
+```ts
+isCurrentTrack(track): boolean;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `track` | [`MediaTrack`](MediaTrack.mdx) |
+
+#### Returns
+
+`boolean`
+
+***
+
+### removeTrack()
+
+```ts
+removeTrack(track): void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `track` | [`MediaTrack`](MediaTrack.mdx) |
+
+#### Returns
+
+`void`
+
+***
+
+### clone()
+
+```ts
+clone(signals?, label?): Media;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `signals?` | [`MediaSignals`](../type-aliases/MediaSignals.mdx) |
+| `label?` | `string` |
+
+#### Returns
+
+`Media`

package/api-docs/interfaces/MediaAttributes.mdx

@@ -0,0 +1,19 @@
+## Extended by
+
+- [`Media`](Media.mdx)
+
+## Properties
+
+| Property | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="active"></a> `active` | `readonly` | `boolean` | Indicating whether the media is active A stream is considered active if at least one of its MediaStreamTracks does not have its property MediaStreamTrack.readyState set to ended. Once every track has ended, the stream's active property becomes false. |
+| <a id="id"></a> `id` | `readonly` | `string` | A string containing a 36-character universally unique identifier (UUID) for the object. |
+| <a id="devices"></a> `devices` | `public` | `IndexedDevices` | The devices used for the media |
+| <a id="stream"></a> `stream` | `public` | `MediaStream` | Media stream for the media |
+| <a id="expectedaudioinput"></a> `expectedAudioInput?` | `public` | `MediaDeviceInfoLike` | The audio input device which is expected to be used for the current stream based on the provided constraints |
+| <a id="expectedvideoinput"></a> `expectedVideoInput?` | `public` | `MediaDeviceInfoLike` | The video input device which is expected to be used for the current stream based on the provided constraints |
+| <a id="status"></a> `status` | `public` | [`UserMediaStatus`](../enumerations/UserMediaStatus.mdx) | The status of the media |
+| <a id="audiomuted"></a> `audioMuted` | `public` | `boolean` \| `undefined` | Current mute state of audio track `undefined` means there is no such track from the stream |
+| <a id="videomuted"></a> `videoMuted` | `public` | `boolean` \| `undefined` | Current mute state of video track `undefined` means there is no such track from the stream |
+| <a id="audioinput"></a> `audioInput?` | `public` | `MediaDeviceInfoLike` | Audio input device is used for the audio track from the current stream |
+| <a id="videoinput"></a> `videoInput?` | `public` | `MediaDeviceInfoLike` | Video input device is used for the video track from the current stream |

package/api-docs/interfaces/MediaChangesSignals.mdx

@@ -0,0 +1,15 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="onaddtrack"></a> `onAddTrack` | `Signal`\<`MediaStreamTrack`\> |
+| <a id="ondeviceschanged"></a> `onDevicesChanged` | `Signal`\<`IndexedDevices`\> |
+| <a id="onmediachanged"></a> `onMediaChanged` | `Signal`\<[`Media`](Media.mdx) \| `undefined`\> |
+| <a id="onmediatrackmuted"></a> `onMediaTrackMuted` | `Signal`\<[`MediaTrack`](MediaTrack.mdx)\> |
+| <a id="onmediatrackresumed"></a> `onMediaTrackResumed` | `Signal`\<[`MediaTrack`](MediaTrack.mdx)\> |
+| <a id="onmediatrackstopped"></a> `onMediaTrackStopped` | `Signal`\<[`MediaTrack`](MediaTrack.mdx)\> |
+| <a id="onmediatracksuspended"></a> `onMediaTrackSuspended` | `Signal`\<[`MediaTrack`](MediaTrack.mdx)\> |
+| <a id="onremovetrack"></a> `onRemoveTrack` | `Signal`\<`MediaStreamTrack`\> |
+| <a id="onstatuschanged"></a> `onStatusChanged` | `Signal`\<[`UserMediaStatus`](../enumerations/UserMediaStatus.mdx)\> |
+| <a id="onupdatingaudio"></a> `onUpdatingAudio` | `Signal`\<`boolean`\> |
+| <a id="onupdatingvideo"></a> `onUpdatingVideo` | `Signal`\<`boolean`\> |

package/api-docs/interfaces/MediaController.mdx

@@ -0,0 +1,11 @@
+## Properties
+
+| Property | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="updatingaudio"></a> `updatingAudio` | `readonly` | `boolean` | - |
+| <a id="updatingvideo"></a> `updatingVideo` | `readonly` | `boolean` | - |
+| <a id="media"></a> `media?` | `readonly` | [`Media`](Media.mdx) | Current Media |
+| <a id="devices"></a> `devices` | `readonly` | `IndexedDevices` | Current device list |
+| <a id="getusermedia"></a> `getUserMedia` | `public` | (`constraints`) => `void` | Execute the media pipeline immediately with provided constraints **See** MediaDeviceRequest |
+| <a id="getusermediaasync"></a> `getUserMediaAsync` | `public` | (`constraints`) => `Promise`\<`void`\> | Execute the media pipeline immediately with provided constraints. An explicit version of `getUserMedia` to make it possible to chain other async actions **See** MediaDeviceRequest |
+| <a id="tryandgetusermedia"></a> `tryAndGetUserMedia` | `public` | (`constraints`) => `void` | Cross-check PermissionState and available devices before requesting user media, the request will be skipped if there is no granted device. |