ContextQMD
Back to Content

MediaSession: setCameraActive() method

files/en-us/web/api/mediasession/setcameraactive/index.md

latest1.2 KB
Original Source

{{APIRef("Media Session API")}}

The setCameraActive() method of the {{domxref("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 {{domxref("navigator.mediaSession", "mediaSession")}} object.

Note that the status of the camera is not tracked in the {{domxref("MediaSession")}} itself, but must be tracked separately.

Syntax

js-nolint
setCameraActive(active)

Parameters

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

Return value

None ({{jsxref("undefined")}}).

Examples

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

js
let cameraActive = false;

navigator.mediaSession.setCameraActive(cameraActive);

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}