Skip to main content

InputConstraintSet

Extends

  • MediaTrackConstraints

Properties

PropertyTypeDescriptionInherited from
device?DeviceConstraint | ConstraintDeviceParametersSame purpose as deviceId but it gives more information about the device so that we can have extra tolerance on device selection-
videoSegmentation?ConstrainDOMStringWhether or not using video segmentation, e.g. background blur/replacement, to specify the effects, intended to be applied to the segment. Available effects are none, blur, overlay or remove-
videoSegmentationModel?ConstrainDOMStringSegmentation model to be used for video segmentation, currently only supports mediapipeSelfie and personify-
denoise?ConstrainBooleanWhether or not using our own noise suppression-
vad?ConstrainBooleanVoice Activity Detection-
asd?ConstrainBooleanAudio Signal Detection for the purpose of checking if the audio input is hardware muted or unusable-
mixWithAdditionalMedia?ConstrainBooleanAudio Signal Detection for the purpose of checking if the audio input is hardware muted or unusable-
backgroundBlurAmount?ConstrainULongBlur size/level parameter when using video segmentation with blur effects-
edgeBlurAmount?ConstrainULongBlur amount applied to the segmented person's edge-
foregroundThreshold?ConstrainDoubleErode level for edge smoothing when using video segmentation-
backgroundImageUrl?ConstrainDOMStringImage Url that is being used for video overlay effects-
maskCombineRatio?ConstrainDoubleThe ratio to be used for smoothing segmentation mask. How much uncertainty enables temporal blend, [0,1]. Higher = more frame-to-frame blending, more stability but more trailing ghosts. Typical: 0.6–0.85.-
backgroundThreshold?ConstrainDouble[0,1] Lower mask confidence: all mask pixels <= this are considered definite background. Adjust to make mask edges tighter or more permissive for background inclusion. Example: 0.3 ("mask < 0.3 = sure background").-
sigmaSpace?ConstrainDoubleBilateral filter: sigma in pixel space for mask edge snapping. Controls the neighborhood/pixel distance—higher is larger window (5–10 typical).-
sigmaRangeLo?ConstrainDoubleBilateral filter: minimum sigma in color/luma (for mask interiors), [0,1]. Controls how little color difference is needed to cross-mask regions away from edge. Lower = sharper edge preservation in mask interiors. Example: 0.2-
sigmaRangeHi?ConstrainDoubleBilateral filter: maximum sigma in color/luma (for mask uncertain zones), [0,1]. Controls how much color similarity is required at uncertain/edge mask locations. Higher = more mask smoothing at edges. Example: 0.8-
excludeBystanders?ConstrainBooleanWhether to exclude bystanders/connected people from the output mask. The main person instance (closest to personCenter OR largest blob) is kept in the output mask. All other bystanders/connected people are suppressed (bystander removal).-
personCenterX?ConstrainDoublePerson center: normalized in [0,1] image coordinates for main subject selection. Used by the CCL/bias filter to select the main person blob.-
personCenterY?ConstrainDoublePerson center: normalized in [0,1] image coordinates for main subject selection. Used by the CCL/bias filter to select the main person blob.-
morphErodeRadiusPx?ConstrainULongMorphological erosion: radius in pixels [1,12]. Sets kernel size for bridge-breaking. Larger values break thicker bridges but may erode fine details.-
morphPass?ConstrainULongMorphological pass: number of separable passes [1,10]. More passes increase the effective span.-
morphDilateRadiusPx?ConstrainULongGeodesic dilation: radius in pixels [1,12]. Must match erosion for good reconstruction.-
lightWrapIntensity?ConstrainDouble[0,1] Light wrap amount (halo intensity) at mask edge. Wraps blurred background color just outside the subject edge onto the subject boundary for realism.-
lightWrapTightness?ConstrainDouble[0.5,4.0] Controls power/tightness of the wrap band falloff. Higher = tighter/narrower wrap.-
lightWrapEdgeBand?ConstrainDoubleWidth of the wrap band (feather size, in normalized mask units) between the backgroundThreshold and foregroundThreshold in [0.0, (foregroundThreshold - backgroundThreshold) / 2] Higher = wider soft halo.-
lightWrapBlurAmount?ConstrainULongBlur amount used for background color in the wrap band (units=blur passes).-
downSampleFactor?ConstrainULongDownsampling factor for mask/blurring, must be [2,4]. 2 = half resolution, 4 = quarter resolution for faster filtering. Use for performance tuning vs. quality.-
resizeMode?ConstrainDOMStringImage Url that is being used for video overlay effects-
pan?booleanCurrent pan, tilt and zoom level for a PTZ controllable camera on web-
tilt?boolean--
zoom?boolean--
contentHint?ConstrainDOMStringContent Hint for the track to apply-
volume?ConstrainNumber-MediaTrackConstraints.volume
latency?ConstrainNumber-MediaTrackConstraints.latency
aspectRatio?ConstrainDouble-MediaTrackConstraints.aspectRatio
autoGainControl?ConstrainBoolean-MediaTrackConstraints.autoGainControl
backgroundBlur?ConstrainBoolean-MediaTrackConstraints.backgroundBlur
channelCount?ConstrainULong-MediaTrackConstraints.channelCount
deviceId?ConstrainDOMString-MediaTrackConstraints.deviceId
displaySurface?ConstrainDOMString-MediaTrackConstraints.displaySurface
echoCancellation?ConstrainBoolean-MediaTrackConstraints.echoCancellation
facingMode?ConstrainDOMString-MediaTrackConstraints.facingMode
frameRate?ConstrainDouble-MediaTrackConstraints.frameRate
groupId?ConstrainDOMString-MediaTrackConstraints.groupId
height?ConstrainULong-MediaTrackConstraints.height
noiseSuppression?ConstrainBoolean-MediaTrackConstraints.noiseSuppression
sampleRate?ConstrainULong-MediaTrackConstraints.sampleRate
sampleSize?ConstrainULong-MediaTrackConstraints.sampleSize
width?ConstrainULong-MediaTrackConstraints.width
advanced?MediaTrackConstraintSet[]-MediaTrackConstraints.advanced