开始

安装

您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-light-sensor` plugin in my project.

如果您更喜欢手动设置，请按照以下命令安装插件并遵循以下平台特定的说明:

bun add @capgo/capacitor-light-sensor
bunx cap sync

导入

import { LightSensor } from '@capgo/capacitor-light-sensor';

API概述

isAvailable

检测当前设备上的光感器是否可用。 在使用感器之前，应始终检查其可用性。

import { LightSensor } from '@capgo/capacitor-light-sensor';

const { available } = await LightSensor.isAvailable();

start

开始监听光感器更新。 此操作将在指定间隔开始感测。 使用 addListener 接收感测数据。

import { LightSensor } from '@capgo/capacitor-light-sensor';

await LightSensor.start({ updateInterval: 500 });

stop

停止监听光感器更新。 此操作将停止感测并节省电池。

import { LightSensor } from '@capgo/capacitor-light-sensor';

await LightSensor.stop();

checkPermissions

检查高采样率感器的当前权限状态。 在 Android 12+ 上，高采样率感器更新需要 HIGH_SAMPLING_RATE_SENSORS 权限 才能实现 200ms 以下的感测更新间隔。

import { LightSensor } from '@capgo/capacitor-light-sensor';

const status = await LightSensor.checkPermissions();

requestPermissions

高采样率传感器的请求权限。 在 Android 12+ 中，这个请求 HIGH_SAMPLING_RATE_SENSORS 权限。

import { LightSensor } from '@capgo/capacitor-light-sensor';

const status = await LightSensor.requestPermissions();

类型参考

IsAvailableResult

传感器是否可用结果。

export interface IsAvailableResult {
  /**
   * Whether the light sensor is available on this device.
   * Always false on iOS as the light sensor API is not available.
   *
   * @since 0.0.1
   */
  available: boolean;
}

StartOptions

启动光线传感器监听器的选项。

export interface StartOptions {
  /**
   * The desired interval between sensor updates in milliseconds.
   * On Android 12+, there's a minimum interval of 200ms unless the app
   * has the HIGH_SAMPLING_RATE_SENSORS permission.
   *
   * @default 200
   * @since 0.0.1
   */
  updateInterval?: number;
}

LightSensorCallback

Callback function for light sensor updates.

export type LightSensorCallback = (measurement: LightSensorMeasurement) => void;

PermissionStatus

权限请求或检查的结果。

export interface PermissionStatus {
  /**
   * Whether the high sampling rate sensor permission is granted.
   * On Android 12+, this permission is required for update intervals below 200ms.
   *
   * @since 0.0.1
   */
  highSamplingRate: 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';
}

VersionResult

Capacitor插件版本信息。

export interface VersionResult {
  /**
   * The current version of the plugin.
   *
   * @since 0.0.1
   */
  version: string;
}

LightSensorMeasurement

单个光线传感器测量值。

export interface LightSensorMeasurement {
  /**
   * Ambient light level in lux (lx).
   *
   * @since 0.0.1
   */
  illuminance: number;

  /**
   * Timestamp of the measurement in seconds since epoch.
   *
   * @since 0.0.1
   */
  timestamp: number;
}

真实数据源

该页面由插件生成 src/definitions.ts当公共API上游更改时，请重新运行同步

继续从开始

如果您正在使用 开始 规划仪表板和API操作 Using @capgo/capacitor-light-sensor 使用@capgo/capacitor-light-sensor 使用@API/__CAPGO_KEEP_1__-light-sensor API概述 简介 为简介中的实现细节 API 键 为API 键中的实现细节,以及 设备 为设备中的实现细节。