AmbientLightSensor: AmbientLightSensor() constructor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

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

The AmbientLightSensor() constructor creates a new AmbientLightSensor object, which returns the current light level or illuminance of the ambient light around the hosting device.

Syntax

js
new AmbientLightSensor()
new AmbientLightSensor(options)

Parameters

options Optional

Currently only one option is supported:

frequency Optional

The desired number of times per second a sample should be taken, meaning the number of times per second that reading event will be called. A whole number or decimal may be used, the latter for frequencies less than a second. The actual reading frequency depends on the device hardware and consequently may be less than requested.

Exceptions

SecurityError DOMException

Use of this feature was blocked by a Permissions Policy.

Specifications

Specification
Ambient Light Sensor
# dom-ambientlightsensor-ambientlightsensor

Browser compatibility

See also