はじめに

インストール

bun add @capgo/capacitor-brightness
bunx cap sync

インポート

import { CapgoBrightness } from '@capgo/capacitor-brightness';

API オーバービュー

getBrightness

デバイスの主ディスプレイの現在の明るさを取得します。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.getBrightness();

setBrightness

デバイスの主ディスプレイの明るさを設定します。

iOSでは、画面の明るさは端末がロックされるまで続きます。 Androidでは、画面の明るさは現在のアクティビティにのみ適用されます。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.setBrightness({} as SetBrightnessOptions);

getSystemBrightness

画面全体の明るさを取得します。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.getSystemBrightness();

setSystemBrightness

画面全体の明るさを設定します。 AndroidではWRITE_SETTINGS権限が必要です。 また、明るさモードもMANUALに変更されます。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.setSystemBrightness({} as SetBrightnessOptions);

getSystemBrightnessMode

画面の明るさモード（自動または手動）を取得します。 AndroidではWRITE_SETTINGS権限が必要です。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

システム明るさモードを設定 (自動または手動)。 Android で WRITE_SETTINGS 権限が必要です。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.setSystemBrightnessMode({} as SetBrightnessModeOptions);

isUsingSystemBrightness

現在のアクティビティがシステム全体の明るさ値を使用しているかどうかを確認します。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.isUsingSystemBrightness();

restoreSystemBrightness

現在のアクティビティの明るさ設定をシステム全体の値にリセットします。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.restoreSystemBrightness();

isAvailable

現在のデバイスで明るさ API が利用可能かどうかを確認します。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.isAvailable();

checkPermissions

システム明るさへのアクセスをチェックするユーザーの権限を確認します。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.checkPermissions();

requestPermissions

システム明るさへのアクセスを許可するためにWRITE_SETTINGSパーミッションを取得します。 Androidでは、システム設定を開いてWRITE_SETTINGSパーミッションを付与します。

import { CapgoBrightness } from '@capgo/capacitor-brightness';

await CapgoBrightness.requestPermissions();

タイプ リファレンス

GetBrightnessResult

getBrightnessまたはgetSystemBrightnessの結果です。

export interface GetBrightnessResult {
  /**
   * The brightness value from 0 to 1.
   * 0 is the minimum brightness, 1 is the maximum brightness.
   *
   * @since 8.0.0
   */
  brightness: number;
}

SetBrightnessOptions

setBrightnessまたはsetSystemBrightnessのオプションです。

export interface SetBrightnessOptions {
  /**
   * The brightness value from 0 to 1.
   * 0 is the minimum brightness, 1 is the maximum brightness.
   *
   * @since 8.0.0
   */
  brightness: number;
}

GetBrightnessModeResult

getSystemBrightnessModeの結果

export interface GetBrightnessModeResult {
  /**
   * The current brightness mode.
   *
   * @since 8.0.0
   */
  mode: BrightnessMode;
}

SetBrightnessModeOptions

setSystemBrightnessModeのオプション

export interface SetBrightnessModeOptions {
  /**
   * The brightness mode to set.
   * Cannot be set to UNKNOWN.
   *
   * @since 8.0.0
   */
  mode: BrightnessMode;
}

IsUsingSystemBrightnessResult

isUsingSystemBrightnessの結果

export interface IsUsingSystemBrightnessResult {
  /**
   * Whether the current activity is using the system-wide brightness value.
   *
   * @since 8.0.0
   */
  isUsing: boolean;
}

IsAvailableResult

isAvailableの結果

export interface IsAvailableResult {
  /**
   * Whether the Brightness API is available on the current device.
   *
   * @since 8.0.0
   */
  available: boolean;
}

PermissionStatus

許可状態の結果。

export interface PermissionStatus {
  /**
   * Whether the permission to modify system brightness is granted.
   *
   * @since 8.0.0
   */
  brightness: PermissionState;
}

GetPluginVersionResult

プラグインバージョンの結果。

export interface GetPluginVersionResult {
  /**
   * The native plugin version.
   *
   * @since 8.0.0
   */
  version: string;
}

BrightnessMode

明るさモード。

export enum BrightnessMode {
  /**
   * The brightness mode is unknown.
   *
   * @since 8.0.0
   */
  UNKNOWN = 0,
  /**
   * The brightness is automatically adjusted by the system.
   *
   * @since 8.0.0
   */
  AUTOMATIC = 1,
  /**
   * The brightness is manually set by the user.
   *
   * @since 8.0.0
   */
  MANUAL = 2,
}

PermissionState

許可状態。

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

真実の源

このページはプラグインから生成されています。 src/definitions.tsパブリック API がアップストリームで変更された場合に、再度同期を実行してください。