ガイド
Capacitor で Brightness を使用する方法
@capgo/capacitor-brightness の使い方
iOSとAndroidで画面の明るさを制御します。
インストール
bun add @capgo/capacitor-brightness
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { CapgoBrightness } from '@capgo/capacitor-brightness';
API の概要
| メソッド | 説明 |
|---|---|
getBrightness |
デバイスのメイン画面の現在の輝度を取得します。 |
setBrightness |
デバイスのメイン画面の輝度を設定します。 |
getSystemBrightness |
システム全体の画面の明るさを取得します。 |
setSystemBrightness |
システム全体の画面の明るさを設定します。AndroidではWRITE_SETTINGS権限が必要です。また、明るさモードがMANUALに変更されます。 |
getSystemBrightnessMode |
現在のシステムの明るさモード（自動または手動）を取得します。AndroidではWRITE_SETTINGS権限が必要です。 |
setSystemBrightnessMode |
システムの明るさモード（自動または手動）を設定します。AndroidではWRITE_SETTINGS権限が必要です。 |
isUsingSystemBrightness |
現在のActivityがシステム全体の明るさの値を使用しているか確認します。 |
restoreSystemBrightness |
現在のActivityの明るさ設定をリセットし、システム全体の値を適用します。 |
isAvailable |
現在のデバイスで Brightness API が利用可能か確認します。 |
checkPermissions |
システム輝度へのアクセス権限を確認します。 |
requestPermissions |
システム輝度へのアクセス権限をリクエストします。Androidの場合、WRITE_SETTINGS権限を付与するためにシステム設定が開きます。 |
例
getBrightness()
デバイスのメイン画面の現在の輝度を取得します。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();
console.log(result);
setBrightness()
デバイスのメイン画面の輝度を設定します。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });
getSystemBrightness()
システム全体の画面の明るさを取得します。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();
console.log(result);
setSystemBrightness()
システム全体の画面の明るさを設定します。AndroidではWRITE_SETTINGS権限が必要です。また、明るさモードがMANUALに変更されます。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });
getSystemBrightnessMode()
現在のシステムの明るさモード（自動または手動）を取得します。AndroidではWRITE_SETTINGS権限が必要です。
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightnessMode();
console.log(result);
setSystemBrightnessMode()
システムの明るさモード（自動または手動）を設定します。AndroidではWRITE_SETTINGS権限が必要です。
import { CapgoBrightness, BrightnessMode } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });
上記の表には11個のコアメソッドが記載されています。リスナー、バージョンヘルパー、および各メソッドの完全な仕様については、以下に記載されています。 GitHub リポジトリ.
完全なリファレンス
「@capgo/capacitor-brightness の使い方」から続ける
使用している場合 @capgo/capacitor-brightness の使い方 ネイティブメディアとインターフェースの挙動を計画するには、次と連携させてください @capgo/capacitor-brightness @capgo/capacitor-brightness の実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 @capgo/capacitor-live-activities の使用 @capgo/capacitor-live-activities の使用におけるネイティブ機能については、 @capgo/capacitor-live-activities @capgo/capacitor-live-activities の実装の詳細については、 @capgo/capacitor-video-playerの使用方法 「@capgo/capacitor-video-player. の使い方」のネイティブ機能については