Web/API/MediaTrackSupportedConstraints/cursor

The MediaTrackSupportedConstraints dictionary's cursor property indicates whether or not the cursor constraint is supported by the user agent and the device on which the content is being used.

The supported constraints list is obtained by calling navigator.mediaDevices.getSupportedConstraints().

Syntax

isCursorSupported = supportedConstraints.cursor;

Value

A Boolean value which is true if the cursor constraint is supported by the device and user agent.

Example

This method sets up the constraints object specifying the options for the call to getDisplayMedia(). It adds the cursor constraint only if it is known to be supported by the browser. Capturing is then started by calling getDisplayMedia() and attaching the returned stream to the video element referenced by the variable videoElem.

async function captureWithCursor() {
  let supportedConstraints = navigator.mediaDevices.getSupportedConstraints();
  let displayMediaOptions = {
    video: {
      displaySurface: "browser"
    },
    audio: false;
  };

  if (supportedConstraints.cursor) {
    displayMediaOptions.video.cursor = "always";
  }

  try {
    videoElem.srcObject = await navigator.mediaDevices.getDisplayMedia(displayMediaOptions);
  } catch(err) {
    /* handle the error */
  }
}

Specifications

Specification	Status	Comment
Screen CaptureThe definition of 'MediaTrackSupportedConstraints.cursor' in that specification.	Unknown	Initial definition

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`cursor`	Chrome No support No	Edge No support No	Firefox No support No	IE No support No	Opera Full support Yes	Safari ?	WebView Android No support No	Chrome Android No support No	Firefox Android No support No	Opera Android ?	Safari iOS ?	Samsung Internet Android No support No

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown