Class IRSensor

The IRSensor class is a Sensor subclass. When the sensor is activated, the controller's IR (infrared) camera is enabled, allowing the application to get the image data for each frame of the camera.

Example

const ctx = screen.getContext('2d');

const sensor = new Switch.IRSensor();
sensor.addEventListener('reading', () => {
    ctx.drawImage(sensor.image, 0, 0);
});
sensor.start();

Hierarchy

Accessors

activated hasReading image timestamp

Methods

addEventListener dispatchEvent removeEventListener start stop

Accessors

activated

hasReading

image

  • get image(): ImageBitmap

  • The underlying ImageBitmap instance containing the contents of the IR sensor. Can be used with ctx.drawImage() or any other functions that work with ImageBitmap instances.

    Returns ImageBitmap

timestamp

  • get timestamp(): null | number

  • A read-only number representing the timestamp of the latest sensor reading. Value is null if there has not yet been a reading of the sensor.

    Returns null | number

    See

    https://developer.mozilla.org/docs/Web/API/Sensor/timestamp

Methods

addEventListener

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Parameters

    • type: "error" | "activate" | "reading"
    • listener: ((ev) => any)
        • (ev): any

        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

    See

    https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

dispatchEvent

removeEventListener

start

stop

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc