Merge pull request #274 from eladalon1983/monitors

Define monitorTypeSurfaces
w3c · Aug 31, 2023 · 881fd35 · 881fd35
2 parents afeaf03 + 525c995
commit 881fd35
Showing 1 changed file with 58 additions and 0 deletions.
diff --git a/index.html b/index.html
@@ -1190,6 +1190,46 @@ <h2><dfn>SurfaceSwitchingPreferenceEnum</dfn></h2>
             </tbody>
           </table>
         </section>
+        <section>
+          <h2><dfn>MonitorTypeSurfacesEnum</dfn></h2>
+          <p>
+            Describes whether the application would like the user agent to offer the user
+            the option to choose [=display surfaces=] whose type is [=display surface/monitor=].
+          </p>
+          <pre class="idl">
+            enum MonitorTypeSurfacesEnum {
+              "include",
+              "exclude"
+            };
+          </pre>
+          <table  data-dfn-for="MonitorTypeSurfacesEnum" class="simple">
+            <tbody>
+              <tr>
+                <th colspan="2">
+                  Enumeration description
+                </th>
+              </tr>
+              <tr>
+                <td>
+                  <dfn id="idl-def-MonitorTypeSurfacesEnum.include">include</dfn>
+                </td>
+                <td>
+                  The application prefers that the [=display surfaces=] presented
+                  to the user include those of type [=display surface/monitor=].
+                </td>
+              </tr>
+              <tr>
+                <td>
+                  <dfn id="idl-def-MonitorTypeSurfacesEnum.exclude">exclude</dfn>
+                </td>
+                <td>
+                  The application prefers that the [=display surfaces=] presented
+                  to the user exclude those of type [=display surface/monitor=].
+                </td>
+              </tr>
+            </tbody>
+          </table>
+        </section>
         <section>
           <h2>DisplayMediaStreamOptions</h2>
           <p>The <dfn>DisplayMediaStreamOptions</dfn> dictionary is used to
@@ -1205,6 +1245,7 @@ <h2>DisplayMediaStreamOptions</h2>
   SelfCapturePreferenceEnum selfBrowserSurface;
   SystemAudioPreferenceEnum systemAudio;
   SurfaceSwitchingPreferenceEnum surfaceSwitching;
+  MonitorTypeSurfacesEnum monitorTypeSurfaces;
 };</pre>
             <section>
               <h2>Dictionary <a class="idlType">DisplayMediaStreamOptions</a>
@@ -1269,6 +1310,23 @@ <h2>Dictionary <a class="idlType">DisplayMediaStreamOptions</a>
                   user agent to offer the user an option to dynamically switch
                   the captured [=display surface=].
                 </dd>
+                <dt>
+                  <dfn><code>monitorTypeSurfaces</code></dfn> of type {{MonitorTypeSurfacesEnum}}
+                </dt>
+                <dd>
+                  <p>
+                    If present, signals whether the application would like the user agent
+                    to include [=display surfaces=] whose type is [=display surface/monitor=]
+                    among the choices offered to the user. The user agent MAY ignore this hint.
+                  </p>
+                  <div class="note">
+                    <p>
+                      The user agent may still offer to the user the option to capture [=display surfaces=] 
+                      of type [=display surface/monitor=]. Applications are therefore encouraged to still
+                      check the {{MediaTrackSettings/displaySurface}} setting of the tracks they receive.
+                    </p>
+                  </div>        
+                </dd>
               </dl>
             </section>
           </div>