From ea67069b19936f3f90173354527b21dc01883875 Mon Sep 17 00:00:00 2001
From: Elad Alon <eladalon@google.com>
Date: Wed, 9 Oct 2024 13:46:36 +0200
Subject: [PATCH] Introduce ViewportMediaStreamOptions

Fixes #21.
---
 index.html | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 62 insertions(+), 1 deletion(-)

diff --git a/index.html b/index.html
index 1dc5b1c..76f7343 100644
--- a/index.html
+++ b/index.html
@@ -87,7 +87,7 @@ <h2><dfn>MediaDevices</dfn> Additions</h2>
         <pre class="idl">
 partial interface MediaDevices {
   Promise&lt;MediaStream&gt; getViewportMedia(
-      optional DisplayMediaStreamOptions options = {});
+      optional ViewportMediaStreamOptions options = {});
 };</pre
         >
         <dl data-link-for="MediaDevices" data-dfn-for="MediaDevices" class="methods">
@@ -316,6 +316,67 @@ <h2><dfn>MediaDevices</dfn> Additions</h2>
           </dd>
         </dl>
       </section>
+      <section>
+        <h2>ViewportMediaStreamOptions</h2>
+        <p>
+          The <dfn>ViewportMediaStreamOptions</dfn> dictionary is used to instruct the user agent what sort of
+          {{MediaStreamTrack}}s may be included in the {{MediaStream}} returned by {{MediaDevices/getViewportMedia}}.
+        </p>
+        <div>
+          <pre class="idl">
+            dictionary ViewportMediaStreamOptions {
+            (boolean or MediaTrackConstraints) video = true;
+            (boolean or MediaTrackConstraints) audio = false;
+            CaptureController controller;
+            };
+          </pre>
+          <section>
+            <h2>Dictionary <a class="idlType">ViewportMediaStreamOptions</a> Members</h2>
+            <dl
+              data-link-for="ViewportMediaStreamOptions"
+              data-dfn-for="ViewportMediaStreamOptions"
+              class="dictionary-members"
+            >
+              <dt>
+                <dfn><code>video</code></dfn> of type <code>(boolean or {{MediaTrackConstraints}})</code>, defaulting to
+                <code>true</code>
+              </dt>
+              <dd>
+                <p>
+                  If <code>true</code>, it requests that the returned {{MediaStream}} contain a video track. If a
+                  <code>Constraints</code> structure is provided, it further specifies desired processing options to be
+                  applied to the video track rendition of the display surface chosen by the user. If <code>false</code>,
+                  the request will be [=rejected=] with a {{TypeError}}, as per the getViewportMedia algorithm.
+                </p>
+              </dd>
+              <dt>
+                <dfn><code>audio</code></dfn> of type <code>(boolean or {{MediaTrackConstraints}})</code>, defaulting to
+                <code>false</code>
+              </dt>
+              <dd>
+                <p>
+                  If <code>true</code>, it signals an interest that the returned {{MediaStream}} contain an audio track,
+                  if supported and audio is available for display surface chosen by the user. If a
+                  <code>Constraints</code> structure is provided, it further specifies desired processing options to be
+                  applied to the audio track. If <code>false</code>, the {{MediaStream}} will not contain an audio
+                  track.
+                </p>
+              </dd>
+              <dt>
+                <dfn><code>controller</code></dfn> of type <code>{{CaptureController}}</code>
+              </dt>
+              <dd>
+                <p>
+                  If present, this {{CaptureController}} object will be associated with the
+                  <a data-cite="SCREEN-CAPTURE#dfn-capture-session">capture-session</a>. Through the methods exposed on
+                  this object, the <a data-cite="SCREEN-CAPTURE#dfn-capture-session">capture-session</a> can be
+                  manipulated.
+                </p>
+              </dd>
+            </dl>
+          </section>
+        </div>
+      </section>
       <section>
         <h2 id="constrainable-properties">Constrainable Properties for Captured Viewport Surfaces</h2>
         <p>