Firefox Tomorrow

web api instance method

MediaSession: setCameraActive() method

View on MDN ↗

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

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().

let cameraActive = false;

navigator.mediaSession.setCameraActive(cameraActive);

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

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.