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.

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

Clarify that frameRate as a setting is the configured value, not a measurement. #908

Merged
merged 2 commits into from
Oct 13, 2022
Merged
Changes from 1 commit
Commits
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
11 changes: 9 additions & 2 deletions getusermedia.html
Original file line number Diff line number Diff line change
Expand Up @@ -1774,7 +1774,7 @@ <h2>Constrainable Properties</h2>
<tr id="def-constraint-frameRate">
<td><dfn>frameRate</dfn></td>
<td>{{ConstrainDouble}}</td>
<td>The exact frame rate (frames per second) or frame rate range.
<td><p>The exact frame rate (frames per second) or frame rate range.
henbos marked this conversation as resolved.
Show resolved Hide resolved
If video source's pre-set can determine frame rate values, the range, as a capacity,
should span the video source's pre-set frame rate values with
min being equal to 0 and max being the largest frame rate.
Expand All @@ -1783,7 +1783,14 @@ <h2>Constrainable Properties</h2>
If this frame rate cannot be determined (e.g. the source does not
natively provide a frame rate, or the frame rate cannot be
determined from the source stream), then this value MUST refer to
the [=User Agent=]'s vsync display rate.</td>
the [=User Agent=]'s vsync display rate.</p>
<p>As a setting, this value represents the configured frame rate.
If decimation is used, this is that value rather than the native
frame rate. For example, if the setting is 25 frames per second
via decimation, the native frame rate of the camera is 30 frames
per second but due to lighting conditions only 20 frames per
second is achieved, {{frameRate}} reports the setting: 25 frames
per second.</p></td>
henbos marked this conversation as resolved.
Show resolved Hide resolved
</tr>
<tr id="def-constraint-aspect">
<td><dfn>aspectRatio</dfn></td>
Expand Down