Skip to content

Define the windowAudio option #283

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

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Define the windowAudio option #283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
67 changes: 67 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,16 @@ <h2><dfn>MediaDevices</dfn> Additions</h2>
</li>


<li>
<p>If <var>options</var>.{{DisplayMediaStreamOptions/windowAudio}}
is set to {{WindowAudioPreferenceEnum/"exclude"}}, and
<var>options</var>.{{DisplayMediaStreamOptions/systemAudio}}
is either unset or set to {{SystemAudioPreferenceEnum/"include"}},
return a promise [=reject|rejected=] with a newly [=exception/created=]
{{TypeError}}.</p>
</li>


<li>
<p>For each [= map/exist | existing =] member in
<var>constraints</var> whose value, <var>CS</var>, is a
Expand Down Expand Up @@ -1399,6 +1409,53 @@ <h2><dfn>SelfCapturePreferenceEnum</dfn>
</section>


<section>
<h2><dfn>WindowAudioPreferenceEnum</dfn>
</h2>


<p>Describes whether an application invoking
{{MediaDevices/getDisplayMedia()}} would like the user agent to include
window audio among the audio sources offered to the user.</p>

<pre class="idl">
enum WindowAudioPreferenceEnum {
"include",
"exclude"
};
</pre>

<table data-dfn-for="WindowAudioPreferenceEnum" class="simple">
<tbody>
<tr>
<th colspan="2">Enumeration description</th>
</tr>


<tr>
<td><dfn id=
"idl-def-WindowAudioPreferenceEnum.include">include</dfn>
</td>

<td>The application prefers that options to share window audio be
offered to the user for [=display surface/monitor=] [=display
surfaces=].</td>
</tr>


<tr>
<td><dfn id=
"idl-def-WindowAudioPreferenceEnum.exclude">exclude</dfn>
</td>

<td>The application prefers that options to share window audio
not be offered to the user.</td>
</tr>
</tbody>
</table>
</section>


<section>
<h2><dfn>SystemAudioPreferenceEnum</dfn>
</h2>
Expand Down Expand Up @@ -1560,6 +1617,7 @@ <h2>DisplayMediaStreamOptions</h2>
(boolean or MediaTrackConstraints) audio = false;
CaptureController controller;
SelfCapturePreferenceEnum selfBrowserSurface;
WindowAudioPreferenceEnum windowAudio;
SystemAudioPreferenceEnum systemAudio;
SurfaceSwitchingPreferenceEnum surfaceSwitching;
MonitorTypeSurfacesEnum monitorTypeSurfaces;
Expand Down Expand Up @@ -1630,6 +1688,15 @@ <h2>Dictionary <a class="idlType">DisplayMediaStreamOptions</a>
ignore this hint.</dd>


<dt><dfn><code>windowAudio</code></dfn> of type
{{WindowAudioPreferenceEnum}}</dt>


<dd>If present, signals whether the application would like window
audio to be included among the possible audio sources offered to
the user.</dd>


<dt><dfn><code>systemAudio</code></dfn> of type
{{SystemAudioPreferenceEnum}}</dt>

Expand Down