スタートガイド

インストール

AIアシストセットアップを使用してプラグインをインストールできます。次のコマンドを使用して、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.

手動でのセットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、各プラットフォームごとの手順に従ってください：

bun add @capgo/capacitor-brightness
npx cap sync

インポート

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

クイックスタート

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);

よくある落とし穴

• 権限：call checkPermissions() その後 requestPermissions() 必要に応じて。
• Native sync: 実行 npx cap sync プラグインのアップグレード後。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

API の概要

getBrightness

デバイスのメイン画面の現在の輝度を取得します。

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

const result = await CapgoBrightness.getBrightness();
console.log(result);

setBrightness

デバイスのメイン画面の輝度を設定します。

iOSでは、デバイスがロックされるまで明るさが維持されます。 Androidでは、明るさは現在のActivityにのみ適用されます。

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

現在のシステム明るさモード（automaticまたはmanual）を取得します。 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 });

isUsingSystemBrightness

現在のActivityがシステム全体の明るさ設定を使用しているか確認します。

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

const result = await CapgoBrightness.isUsingSystemBrightness();
console.log(result);

restoreSystemBrightness

現在のActivityの明るさ設定をリセットし、システム全体の値を適用します。

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

await CapgoBrightness.restoreSystemBrightness();

isAvailable

現在のデバイスで Brightness API が利用可能か確認します。

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

const result = await CapgoBrightness.isAvailable();
console.log(result);

checkPermissions

システムの明るさにアクセスするためのユーザー権限を確認します。

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

const result = await CapgoBrightness.checkPermissions();
console.log(result);

requestPermissions

システムの明るさにアクセスするための権限をリクエストします。 Androidの場合、WRITE_SETTINGS権限を付与するためにシステム設定が開きます。

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

const result = await CapgoBrightness.requestPermissions();
console.log(result);

型リファレンス

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

getPluginVersion の結果。

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 の次のステップ

使用している場合 スタートガイド ダッシュボードや API の運用を計画し、これと連携させるには、 @capgo/capacitor-brightness を使用する 「@capgo/capacitor-brightness を使用する」におけるネイティブ機能について、 API の概要 API Overview の実装詳細については、 はじめに Introduction の実装詳細については、 API キー API Keys の実装詳細については、 デバイス 実装の詳細については Devices を参照してください。