MediaTrackSettings.cursor
The MediaTrackSettings dictionary's cursor property indicates whether or not the cursor should be captured as part of the video track included in the MediaStream returned by getDisplayMedia().
Syntax
cursorSetting = mediaTrackSettings.cursor;
Value
The value of cursor comes from the CursorCaptureConstraint enumerated string type, and may have one of the following values:
always-
The mouse should always be visible in the video content of the
MediaStream, unless the mouse has moved outside the area of the content. motion-
The mouse cursor should always be included in the video if it's moving, and for a short time after it stops moving.
never-
The mouse cursor is never included in the shared video.
Specifications
| Specification |
|---|
| Screen Capture # dom-mediatracksettings-cursor |
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
cursor |
71 |
≤79 |
No |
No |
Yes |
No |
71 |
71 |
No |
? |
No |
10.0 |
See also
- Screen Capture API
- Using the screen capture API
- Capabilities, constraints, and settings
MediaDevices.getDisplayMedia()MediaStreamTrack.getConstraints()MediaStreamTrack.applyConstraints()MediaStreamTrack.getSettings()
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSettings/cursor