@pexip/media 20.3.4 → 21.0.0

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. |

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) |