Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Identify the list of allowed required constraints for getUserMedia #707

Merged
merged 4 commits into from
Sep 29, 2020
Merged

Identify the list of allowed required constraints for getUserMedia #707

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d1eaff4
Identify the list of allowed required constraints for getUserMedia
youennf Jul 23, 2020
a084f38
Address review comments
youennf Sep 24, 2020
f58e76a
Update getusermedia.html
jan-ivar Sep 24, 2020
3330f7a
Update getusermedia.html
youennf Sep 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 33 additions & 7 deletions getusermedia.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1802,19 +1802,19 @@ <h2>Constrainable Properties</h2>
</thead>
<tbody>
<tr id="def-constraint-sampleRate">
<td>sampleRate</td>
<td><dfn>sampleRate</dfn></td>
<td>{{ConstrainULong}}</td>
<td>The sample rate in samples per second for the audio
data.</td>
</tr>
<tr id="def-constraint-sampleSize">
<td>sampleSize</td>
<td><dfn>sampleSize</dfn></td>
<td>{{ConstrainULong}}</td>
<td>The linear sample size in bits. This constraint can only be
satisfied for audio devices that produce linear samples.</td>
</tr>
<tr id="def-constraint-echoCancellation">
<td>echoCancellation</td>
<td><dfn>echoCancellation</dfn></td>
<td>{{ConstrainBoolean}}</td>
<td>When one or more audio streams is being played in the
processes of various microphones, it is often desirable to
Expand All @@ -1826,7 +1826,7 @@ <h2>Constrainable Properties</h2>
behavior.</td>
</tr>
<tr id="def-constraint-autoGainControl">
<td>autoGainControl</td>
<td><dfn>autoGainControl</dfn></td>
<td>{{ConstrainBoolean}}</td>
<td>Automatic gain control is often desirable on the input signal
recorded by the microphone. There are cases where it is not
Expand All @@ -1835,7 +1835,7 @@ <h2>Constrainable Properties</h2>
behavior.</td>
</tr>
<tr id="def-constraint-noiseSuppression">
<td>noiseSuppression</td>
<td><dfn>noiseSuppression</dfn></td>
<td>{{ConstrainBoolean}}</td>
<td>Noise suppression is often desirable on the input signal
recorded by the microphone. There are cases where it is not
Expand All @@ -1844,7 +1844,7 @@ <h2>Constrainable Properties</h2>
behavior.</td>
</tr>
<tr id="def-constraint-latency">
<td>latency</td>
<td><dfn>latency</dfn></td>
<td>{{ConstrainDouble}}</td>
<td>The latency or latency range, in seconds. The latency is the
time between start of processing (for instance, when sound occurs
Expand All @@ -1856,7 +1856,7 @@ <h2>Constrainable Properties</h2>
some variation from that.</td>
</tr>
<tr id="def-constraint-channelCount">
<td>channelCount</td>
<td><dfn>channelCount</dfn></td>
<td>{{ConstrainULong}}</td>
<td>The number of independent channels of sound that the audio
data contains, i.e. the number of audio samples per sample
Expand Down Expand Up @@ -3479,6 +3479,11 @@ <h2>Methods</h2>
inside of <a>"video"</a> and video-only constraints inside of
<a>"audio"</a> are simply ignored rather than causing
<code>OverconstrainedError</code>.</li>
<li><p>If <var>CS</var> contains a member that is a
<a>required constraint</a> and whose name is not in the
list of <a>allowed required constraints for device selection</a>,
then <a>reject</a> <var>p</var> with a {{TypeError}}, and abort
these steps.</p></li>
<li>
<p>Run the <a>SelectSettings</a> algorithm on each
track in <var>candidateSet</var> with <var>CS</var>
Expand Down Expand Up @@ -3664,6 +3669,27 @@ <h2>Methods</h2>
between those checks, so it is conceivable that the selected device is
no longer suitable. In this case, a NotReadableError will result.</p>
</div>
<div>
<p>The <dfn>allowed required constraints for device selection</dfn>
contains the following constraint names:
<a>width</a>,
<a>height</a>,
<a>aspectRatio</a>,
<a>frameRate</a>,
<a>facingMode</a>,
<a>resizeMode</a>,
<a>sampleRate</a>,
<a>sampleSize</a>,
<a>echoCancellation</a>,
<a>autoGainControl</a>,
<a>noiseSuppression</a>,
<a>latency</a>,
<a>channelCount</a>,
<a>deviceId</a>,
<a>groupId</a>.
</p>
youennf marked this conversation as resolved.
Show resolved Hide resolved
</div>

</section>
<section>
<h2>{{MediaStreamConstraints}}</h2>
Expand Down