はじめから始める

インストール

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

__CAPGO_KEEP_0__をシステム全体の画面明るさを取得します。

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

Check if the Brightness API is available on the current device.

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

__CAPGO_KEEP_2__

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

IsUsingSystemBrightnessResult

__CAPGO_KEEP_2__

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

IsAvailableResult

__CAPGO_KEEP_2__

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

PermissionStatus

__CAPGO_KEEP_2__

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. upstreamのpublic APIが変更された場合に再度syncを実行してください。

Getting Startedから続けてください。

Capacitorを使用している場合 Getting Started ダッシュボードとAPIの作業を計画するために、CapacitorをAPIに接続してください。 Capacitorを使用して@capgo/capacitor-brightnessを実装する場合 Capacitorを使用して@capgo/capacitor-brightnessを実装する場合 APIの概要 APIの実装詳細 導入 for the implementation detail in Introduction、 API キー for the implementation detail in API キー、そして デバイス for the implementation detail in デバイス。