PreviewStreamController

Properties

Property	Type
audioInput	PreviewInput
audioInputChanged	boolean
cleanup	() => Promise<void>
inputChanged	boolean
media	undefined | Media
updatingMain	boolean
updatingPreviewAudio	boolean
updatingPreviewVideo	boolean
videoInput	PreviewInput
videoInputChanged	boolean

Methods

applyChanges()

applyChanges(force?): Promise<void>;

Parameters

Parameter	Type
force?	boolean

Returns

Promise<void>

---

onApplyChangesError()

onApplyChangesError(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventErrorCallback

Returns

Unsubscribe

---

onAudioInputChanged()

onAudioInputChanged(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<PreviewInput>

Returns

Unsubscribe

---

onAudioInputError()

onAudioInputError(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventErrorCallback

Returns

Unsubscribe

---

onAudioMuted()

onAudioMuted(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<undefined | boolean>

Returns

Unsubscribe

---

onAudioSuspended()

onAudioSuspended(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<undefined | boolean>

Returns

Unsubscribe

---

onMediaChanged()

onMediaChanged(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<Media>

Returns

Unsubscribe

---

onRevertChangesError()

onRevertChangesError(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventErrorCallback

Returns

Unsubscribe

---

onUpdatingMain()

onUpdatingMain(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<boolean>

Returns

Unsubscribe

---

onUpdatingPreviewAudio()

onUpdatingPreviewAudio(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<boolean>

Returns

Unsubscribe

---

onUpdatingPreviewVideo()

onUpdatingPreviewVideo(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<boolean>

Returns

Unsubscribe

---

onVideoInputChanged()

onVideoInputChanged(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<PreviewInput>

Returns

Unsubscribe

---

onVideoInputError()

onVideoInputError(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventErrorCallback

Returns

Unsubscribe

---

onVideoMuted()

onVideoMuted(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<undefined | boolean>

Returns

Unsubscribe

---

onVideoSuspended()

onVideoSuspended(callback): Unsubscribe;

Parameters

Parameter	Type
callback	EventCallback<undefined | boolean>

Returns

Unsubscribe

---

revertChanges()

revertChanges(): Promise<void>;

Returns

Promise<void>

---

updateAudioInput()

updateAudioInput(id): void;

Parameters

Parameter	Type
id	string

Returns

void

---

updatePreviewInput()

updatePreviewInput(input): void;

Parameters

Parameter	Type
input	PreviewInput

Returns

void

---

updateVideoInput()

updateVideoInput(id): void;

Parameters

Parameter	Type
id	string

Returns

void