AmbientLightSensor

{{securecontext_header}}{{APIRef("Sensor API")}}{{SeeCompatTable}}

The AmbientLightSensor interface of the Sensor APIs returns the current light level or illuminance of the ambient light around the hosting device.

To use this sensor, the user must grant permission to the 'ambient-light-sensor' device sensor through the Permissions API.

This feature may be blocked by a Permissions Policy set on your server.

{{InheritanceDiagram}}

Constructor

• {{domxref("AmbientLightSensor.AmbientLightSensor()", "AmbientLightSensor()")}} {{Experimental_Inline}}
  • : Creates a new AmbientLightSensor object.

Instance properties

• {{domxref('AmbientLightSensor.illuminance')}} {{ReadOnlyInline}} {{Experimental_Inline}}
  • : Returns the current light level in lux of the ambient light level around the hosting device.

Instance methods

AmbientLightSensor doesn't have own methods. However, it inherits methods from its parent interfaces, {{domxref("Sensor")}} and {{domxref("EventTarget")}}.

Events

AmbientLightSensor doesn't have own events. However, it inherits events from its parent interface, {{domxref('Sensor')}}.

Example

if ("AmbientLightSensor" in window) {
  const sensor = new AmbientLightSensor();
  sensor.addEventListener("reading", (event) => {
    console.log("Current light level:", sensor.illuminance);
  });
  sensor.addEventListener("error", (event) => {
    console.log(event.error.name, event.error.message);
  });
  sensor.start();
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}