Skip to main content

PreviewStreamController

Properties

PropertyType
audioInputPreviewInput
audioInputChangedboolean
cleanup() => Promise<void>
inputChangedboolean
mediaundefined | Media
updatingMainboolean
updatingPreviewAudioboolean
updatingPreviewVideoboolean
videoInputPreviewInput
videoInputChangedboolean

Methods

applyChanges()

applyChanges(force?): Promise<void>;

Parameters

ParameterType
force?boolean

Returns

Promise<void>


onApplyChangesError()

onApplyChangesError(callback): Unsubscribe;

Parameters

ParameterType
callbackEventErrorCallback

Returns

Unsubscribe


onAudioInputChanged()

onAudioInputChanged(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<PreviewInput>

Returns

Unsubscribe


onAudioInputError()

onAudioInputError(callback): Unsubscribe;

Parameters

ParameterType
callbackEventErrorCallback

Returns

Unsubscribe


onAudioMuted()

onAudioMuted(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<undefined | boolean>

Returns

Unsubscribe


onAudioSuspended()

onAudioSuspended(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<undefined | boolean>

Returns

Unsubscribe


onMediaChanged()

onMediaChanged(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<Media>

Returns

Unsubscribe


onRevertChangesError()

onRevertChangesError(callback): Unsubscribe;

Parameters

ParameterType
callbackEventErrorCallback

Returns

Unsubscribe


onUpdatingMain()

onUpdatingMain(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<boolean>

Returns

Unsubscribe


onUpdatingPreviewAudio()

onUpdatingPreviewAudio(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<boolean>

Returns

Unsubscribe


onUpdatingPreviewVideo()

onUpdatingPreviewVideo(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<boolean>

Returns

Unsubscribe


onVideoInputChanged()

onVideoInputChanged(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<PreviewInput>

Returns

Unsubscribe


onVideoInputError()

onVideoInputError(callback): Unsubscribe;

Parameters

ParameterType
callbackEventErrorCallback

Returns

Unsubscribe


onVideoMuted()

onVideoMuted(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<undefined | boolean>

Returns

Unsubscribe


onVideoSuspended()

onVideoSuspended(callback): Unsubscribe;

Parameters

ParameterType
callbackEventCallback<undefined | boolean>

Returns

Unsubscribe


revertChanges()

revertChanges(): Promise<void>;

Returns

Promise<void>


updateAudioInput()

updateAudioInput(id): void;

Parameters

ParameterType
idstring

Returns

void


updatePreviewInput()

updatePreviewInput(input): void;

Parameters

ParameterType
inputPreviewInput

Returns

void


updateVideoInput()

updateVideoInput(id): void;

Parameters

ParameterType
idstring

Returns

void