Capture HandleLimited availability
The capture handle API allows you to share a custom handle (a string) from a web application being captured by getDisplayMedia() to the capturing web application.
Not yet supported in all major browsers — check the table and provide a fallback.
Browser support
DesktopChrome
1–101Not supported
102+Supportedsince May 24, 2022
Current: 155Edge
12–101Not supported
102+Supportedsince May 31, 2022
Current: 154Firefox
✕Not supportedup to 157
Current: 157Safari
✕Not supportedup to 27
Current: 27MobileChrome Android
✕Not supportedup to 155
Current: 155Firefox Android
✕Not supportedup to 157
Current: 157Safari iOS
✕Not supportedup to 27
Current: 27How to use
Not supported in Firefox, Safari, Chrome Android, Firefox Android, Safari iOS. Use feature detection below and provide a fallback (or a polyfill) for those browsers.
Example
Full syntax and examples are on MDN — see the links below.
Feature detection
JS · check before using
if ("MediaDevices" in globalThis && "setCaptureHandleConfig" in MediaDevices.prototype) {
// MediaDevices.setCaptureHandleConfig is available
}Specification
Sub-features
Support for each part of the feature (3). The overall table above shows when the whole feature works.
| Sub-feature | Chrome | Edge | Firefox | Safari | Chrome Android | Firefox Android | Safari iOS |
|---|---|---|---|---|---|---|---|
| MediaDevices.setCaptureHandleConfig | 102 | 102 | ✕ | ✕ | ✕ | ✕ | ✕ |
| MediaStreamTrack.capturehandlechange_event | 102 | 102 | ✕ | ✕ | ✕ | ✕ | ✕ |
| MediaStreamTrack.getCaptureHandle | 102 | 102 | ✕ | ✕ | ✕ | ✕ | ✕ |