ガイド
Capacitor で Light Sensor を使う方法
@capgo/capacitor-light-sensor の使用方法
デバイスの環境光センサーにアクセスするための Capacitor プラグイン。
インストール
bun add @capgo/capacitor-light-sensor
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { LightSensor } from '@capgo/capacitor-light-sensor';
API の概要
| メソッド | 説明 |
|---|---|
isAvailable |
現在のデバイスでライトセンサーが利用可能か確認します。センサーを使用する前には、必ず利用可能性を確認してください。 |
start |
ライトセンサーの更新のリスニングを開始します。指定した間隔でセンサーの計測が始まります。使用するには addListener を使用します。 |
stop |
ライトセンサーの更新のリスニングを停止します。これによりセンサーが停止し、バッテリー消費を抑えられます。 |
checkPermissions |
高サンプリングレートセンサーの現在の権限ステータスを確認します。Android 12以降では、200ms未満の更新間隔を使用する場合、HIGH_SAMPLING_RATE_SENSORS 権限が必要です。 |
requestPermissions |
高サンプリングレートセンサーの権限をリクエストします。Android 12以降では、HIGH_SAMPLING_RATE_SENSORS 権限をリクエストします。 |
例
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以降では、200ms未満のセンサー更新間隔を使用する場合、HIGH_SAMPLING_RATE_SENSORS権限が必要です。
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();
イベントをリッスンする
addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() 画面がアンマウントされるとき、または LightSensor.removeAllListeners() すべてのリスナーを解除します。
完全なリファレンス
@capgo/capacitor-light-sensor の使用方法から続ける
使用している場合 @capgo/capacitor-light-sensor の使用方法 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-light-sensor @capgo/capacitor-light-sensor の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 API の概要 「API の概要」の実装の詳細については、 はじめに はじめに の実装詳細、および API キー API Keys の実装詳細については、