MediaSession: setCameraActive() method

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The setCameraActive() method of the MediaSession interface is used to indicate to the user agent whether the user's camera is considered to be active.

Call this method on the navigator object's mediaSession object.

Note that the status of the camera is not tracked in the MediaSession itself, but must be tracked separately.

Syntax

js
setCameraActive(active)

Parameters

active

A boolean indicating whether the camera is considered active or not.

Return value

None (undefined).

Examples

Below is an example of updating the camera active state of the current MediaSession, as well as listening to requests to change the camera status with setActionHandler().

js
let cameraActive = false;

navigator.mediaSession.setCameraActive(cameraActive);

navigator.mediaSession.setActionHandler("togglecamera", () => {
  cameraActive = !cameraActive;
  navigator.mediaSession.setCameraActive(cameraActive);
});

Specifications

Specification
Media Session
# dom-mediasession-setcameraactive

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
setCameraActive()
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.