updateInputSettings(inputSettings)
Updates settings applied to local media inputs during a call. Returns a Promise that resolves once settings are applied and triggers an input-settings-updated event when settings change.
Only the keys you provide are updated — omitting audio leaves audio settings unchanged, and vice versa. However, within settings or processor, you must specify all values you want applied; they are not merged with existing values.
Parameters
Settings for the local microphone.
Settings for the local camera.
Return value
ReturnsPromise<{ inputSettings: DailyInputSettings }> that resolves once settings are applied.
Providing custom constraints
settings accepts a MediaTrackConstraints object. Specify all constraints you want applied — they replace existing constraints entirely and are not merged.
To change just the
deviceId without affecting other constraints, use setInputDevicesAsync() — it merges the new deviceId with existing constraints.Providing a custom track
Pass{ customTrack: track } as settings to use a MediaStreamTrack you manage directly. When a custom track is provided, any existing constraints are cleared.
Video processor
background-blur — obscures the participant’s background. Optionally accepts config.strength (float 0–1, default 1).
background-image — replaces the background with an image. Accepts an HTTP URL or ArrayBuffer as config.source. Supported formats: .jpg, .jpeg, .png.
face-detection — detects the number of faces visible and triggers face-counts-updated events. Does not alter the video.
Audio processor
noise-cancellation — reduces background noise on the microphone input.
Error handling
Invalid fields or wrong types throw immediately. Errors during application emit anonfatal-error event of type input-settings-error. In addition:
-
Settings errors — If the constraints provided result in a
getUserMedia()error, acamera-errorwill also be emitted and the input will likely be muted (There are scenarios where if the device was already on and only a minor constraint was being applied, the device can remain on). When a constraints error occurs, the settings are reset to defaults so that they do not repeatedly cause issues. Note: If the device is off or has not been initialized at the time of the update, the issue will not be detected until the device is turned on and only thecamera-errorevent will be emitted. The settings will still be cleared and aninput-settings-updatedevent will be emitted with the cleared settings. -
Processor errors — If an error occurs after the settings have been applied and the processor has started, a nonfatal-error of type
video-processor-errororaudio-processor-errorwill be emitted. The processor will be turned off and the processor settings will be cleared. Aninput-settings-updatedevent will also be emitted with the cleared settings. For video processor failures, the video will be turned off to ensure the user is not broadcasting unintended content.