The MediaTrackSettings
dictionary's displaySurface
property indicates the type of display surface being captured.
Syntax
displaySurface = mediaTrackSettings.displaySurface;
Value
The value of displaySurface
is a string that comes from the DisplayCaptureSurfaceType
enumerated type, and is one of the following:
application
- The stream's video track contains all of the windows belonging to the application chosen by the user. The windows are aggragated into a single video track, with any empty space filled with a backdrop; that backdrop is selected by the user agent.
browser
- The stream's video track presents the entire contents of a single browser tab which the user selected during the
getDisplayMedia()
call. monitor
- The video track in the stream presents the complete contents of one or more of the user's screens. Any empty space (if the displays are of different dimensions) is filled with a backdrop chosen by the user agent.
window
- The stream's video track presents the contents of a single window selected by the user. The window may be from any application, not necessarily just from within the user agent.
Not all user agents support all of these surface types.
Specifications
Specification | Status | Comment |
Screen CaptureThe definition of 'MediaTrackSettings.displaySurface' in that specification. | Working Draft | Initial definition |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
displaySurface
|
Chrome
Full support 71 |
Edge
Full support ≤79 |
Firefox
No support No |
IE
No support No |
Opera
Full support Yes |
Safari
? |
WebView Android
Full support 71 |
Chrome Android
Full support 71 |
Firefox Android
No support No |
Opera Android
? |
Safari iOS
? |
Samsung Internet Android
Full support 10.0 |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
See also
- Screen Capture API
- Using the screen capture API
- Capabilities, constraints, and settings
MediaDevices.getDisplayMedia()
MediaStreamTrack.getConstraints()
MediaStreamTrack.applyConstraints()
MediaStreamTrack.getSettings()
MediaTrackSettings.displaySurface by Mozilla Contributors is licensed under CC-BY-SA 2.5.