Skip to main content

PreviewStreamController

Properties​

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

Methods​

updatePreviewInput()​

updatePreviewInput(input): void;

Parameters​

ParameterType
inputPreviewInput

Returns​

void


updateAudioInput()​

updateAudioInput(id): void;

Parameters​

ParameterType
idstring

Returns​

void


updateVideoInput()​

updateVideoInput(id): void;

Parameters​

ParameterType
idstring

Returns​

void


applyChanges()​

applyChanges(force?): Promise<void>;

Parameters​

ParameterType
force?boolean

Returns​

Promise<void>


revertChanges()​

revertChanges(): Promise<void>;

Returns​

Promise<void>


onMediaChanged()​

onMediaChanged(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<Media>

Returns​

Unsubscribe


onAudioInputChanged()​

onAudioInputChanged(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<PreviewInput>

Returns​

Unsubscribe


onVideoInputChanged()​

onVideoInputChanged(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<PreviewInput>

Returns​

Unsubscribe


onUpdatingPreviewAudio()​

onUpdatingPreviewAudio(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<boolean>

Returns​

Unsubscribe


onUpdatingPreviewVideo()​

onUpdatingPreviewVideo(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<boolean>

Returns​

Unsubscribe


onUpdatingMain()​

onUpdatingMain(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<boolean>

Returns​

Unsubscribe


onAudioInputError()​

onAudioInputError(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventErrorCallback

Returns​

Unsubscribe


onVideoInputError()​

onVideoInputError(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventErrorCallback

Returns​

Unsubscribe


onApplyChangesError()​

onApplyChangesError(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventErrorCallback

Returns​

Unsubscribe


onRevertChangesError()​

onRevertChangesError(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventErrorCallback

Returns​

Unsubscribe


onAudioMuted()​

onAudioMuted(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<boolean | undefined>

Returns​

Unsubscribe


onAudioSuspended()​

onAudioSuspended(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<boolean | undefined>

Returns​

Unsubscribe


onVideoMuted()​

onVideoMuted(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<boolean | undefined>

Returns​

Unsubscribe


onVideoSuspended()​

onVideoSuspended(callback): Unsubscribe;

Parameters​

ParameterType
callbackEventCallback<boolean | undefined>

Returns​

Unsubscribe