partial interface MediaDevices {
Promise<MediaStream> getViewportMedia(
- optional DisplayMediaStreamOptions options = {});
+ optional ViewportMediaStreamOptions options = {});
};
+ The ViewportMediaStreamOptions dictionary is used to instruct the user agent what sort of + {{MediaStreamTrack}}s may be included in the {{MediaStream}} returned by {{MediaDevices/getViewportMedia}}. +
+
+ dictionary ViewportMediaStreamOptions {
+ (boolean or MediaTrackConstraints) video = true;
+ (boolean or MediaTrackConstraints) audio = false;
+ CaptureController controller;
+ };
+
+ video of type (boolean or {{MediaTrackConstraints}}), defaulting to
+ true
+
+ If true, it requests that the returned {{MediaStream}} contain a video track. If a
+ Constraints 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 false,
+ the request will be [=rejected=] with a {{TypeError}}, as per the getViewportMedia algorithm.
+
audio of type (boolean or {{MediaTrackConstraints}}), defaulting to
+ false
+
+ If true, 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
+ Constraints structure is provided, it further specifies desired processing options to be
+ applied to the audio track. If false, the {{MediaStream}} will not contain an audio
+ track.
+
controller of type {{CaptureController}}
+ + If present, this {{CaptureController}} object will be associated with the + capture-session. Through the methods exposed on + this object, the capture-session can be + manipulated. +
+