Getting Started

インストール

AI-Assisted セットアップを使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

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-brightness` plugin in my project.

Manual Setupを使用する場合は、プラットフォーム固有の指示に従うために、以下のコマンドを実行してプラグインをインストールしてください。

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

__CAPGO_KEEP_0__を取得します (自動または手動)。 Android上でWRITE_SETTINGS許可権が必要です。

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

__CAPGO_KEEP_0__を設定します (自動または手動)。 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

システムの明るさにアクセスするために許可を求めます。 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がアップストリームで変更された場合に再度同期してください。

Getting Startedから続けて

Capacitorを使用している場合 Getting Started ダッシュボードとAPIの運用計画を立てるには、 Using @capgo/capacitor-brightness Using @capgo/capacitor-brightness APIの概要 APIの実装詳細 導入 __CAPGO_KEEP_0__のキー APIの実装詳細 for the implementation detail in API Keys, and __CAPGO_KEEP_0__の実装詳細 ページを編集