MediaTrackConstraints: restrictOwnAudio property
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The MediaTrackConstraints dictionary's restrictOwnAudio property is a ConstrainBoolean that specifies the requested or mandatory constraints placed on the value of the restrictOwnAudio constrainable property.
This property controls whether system audio originating from the capturing tab is filtered out of screen capture, allowing for cleaner screen recordings in some cases. For example, if the capturing web page itself is playing embedded audio or video, that audio would be included in the capture. Since this could lead to an undesirable echo or interfere with the intended audio sources from other tabs or applications, removing it from the capture is desirable.
If needed, you can determine whether or not this constraint is supported by checking
the value of MediaTrackSupportedConstraints.restrictOwnAudio, as returned
by MediaDevices.getSupportedConstraints(). However,
this is rarely necessary since browsers typically ignore any constraints they don't recognize.
Value
A ConstrainBoolean value.
If the value is true, the user agent will attempt to remove any audio originating from the tab that called MediaDevices.getDisplayMedia() to initiate screen capture. If removal of audio via processing fails, the user agent may exclude all audio originating from the capturing tab.
Note: If the captured display surface doesn't include system audio, this setting will have no effect.
If the value is given as exact, that field's boolean value indicates an exact requirement for the restrictOwnAudio feature; if the user agent can't meet this requirement, the request will result in an error.
If the value is false, the user agent will not attempt to restrict any system audio originating from the capturing tab.
Examples
let isCapturingTabSystemAudioRestricted = displayStream
.getAudioTracks()[0]
.getSettings().restrictOwnAudio;
The Constraint exerciser example shows how to use media track constraints.
Specifications
| Specification |
|---|
| Screen Capture # dom-mediatrackconstraintset-restrictownaudio |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
restrictOwnAudio constraint
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.