KEMBAR78
Define DisplayMediaStreamConstraints.selfBrowserSurface by eladalon1983 · Pull Request #216 · w3c/mediacapture-screen-share · GitHub
Skip to content
Merged
Changes from all commits
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
52 changes: 52 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -721,6 +721,47 @@ <h2>
</p>
</div>
</section>
<section>
<h2><dfn>SelfCapturePreferenceEnum</dfn></h2>
<p>
Describes the different hints an application can provide about whether the
[=display surface=] the application is in, should be among the choices
offered to the user.
</p>
<pre class="idl">
enum SelfCapturePreferenceEnum {
"include",
"exclude"
};
</pre>
<table data-dfn-for="SelfCapturePreferenceEnum" class="simple">
<tbody>
<tr>
<th colspan="2">
Enumeration description
</th>
</tr>
<tr>
<td>
<dfn id="idl-def-SelfCapturePreferenceEnum.include">include</dfn>
</td>
<td>
The application prefers the surface be included
among the choices offered.
</td>
</tr>
<tr>
<td>
<dfn id="idl-def-SelfCapturePreferenceEnum.exclude">exclude</dfn>
</td>
<td>
The application prefers the surface be excluded
from the choices offered.
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h2>DisplayMediaStreamConstraints</h2>
<p>The <dfn>DisplayMediaStreamConstraints</dfn> dictionary is used to
Expand All @@ -732,6 +773,7 @@ <h2>DisplayMediaStreamConstraints</h2>
dictionary DisplayMediaStreamConstraints {
(boolean or MediaTrackConstraints) video = true;
(boolean or MediaTrackConstraints) audio = false;
SelfCapturePreferenceEnum selfBrowserSurface;
};</pre>
<section>
<h2>Dictionary <a class="idlType">DisplayMediaStreamConstraints</a>
Expand Down Expand Up @@ -761,6 +803,16 @@ <h2>Dictionary <a class="idlType">DisplayMediaStreamConstraints</a>
the audio track. If <code>false</code>, the {{MediaStream}}
will not contain an audio track.</p>
</dd>
<dt>
<dfn><code>selfBrowserSurface</code></dfn> of type {{SelfCapturePreferenceEnum}}
</dt>
<dd>
If present, signals application preference for whether the
[=browser=] [=display surface=] which is associated with
[=this=]'s [=relevant global object=]'s [=associated Document=]'s
[=top-level browsing context=], should be among the choices
offered to the user. The user agent MAY ignore this hint.
</dd>
</dl>
</section>
</div>
Expand Down