Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo Fähigkeiten Ihrem AI-Tool mit der folgenden Befehl hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Verwenden Sie dann die folgende Anfrage:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-brightness` plugin in my project.

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die Plattform-spezifischen Anweisungen unten befolgen:

bun add @capgo/capacitor-brightness
bunx cap sync

Importieren

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

API Übersicht

getBrightness

Rufen Sie den aktuellen Helligkeitswert der Hauptbildschirm-Helligkeit des Geräts ab.

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

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

setBrightness

Setzen Sie den Helligkeitswert der Hauptbildschirm-Helligkeit des Geräts.

Bei iOS bleibt die Helligkeit bestehen, bis das Gerät gesperrt wird. Bei Android gilt die Helligkeit nur für die aktuelle Aktivität.

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

await CapgoBrightness.setBrightness({ brightness: 0.5 });

getSystemBrightness

Die aktuelle Bildschirmhelligkeit des Systems abrufen.

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

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

setSystemBrightness

Die Bildschirmhelligkeit des Systems festlegen. Für Android ist die Berechtigung WRITE_SETTINGS erforderlich. Dies ändert auch den Helligkeitsmodus auf HANDSCHUH.

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

await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });

getSystemBrightnessMode

Den aktuellen Helligkeitsmodus des Systems (automatisch oder manuell) abrufen. Für Android ist die Berechtigung WRITE_SETTINGS erforderlich.

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

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

setSystemBrightnessMode

Den Helligkeitsmodus des Systems (automatisch oder manuell) festlegen. Für Android ist die Berechtigung WRITE_SETTINGS erforderlich.

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

await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });

isUsingSystemBrightness

Überprüfen, ob die aktuelle Aktivität den systemweiten Helligkeitswert verwendet.

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

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

restoreSystemBrightness

Richten Sie die Helligkeits-Einstellung der aktuellen Aktivität so ein, dass sie den systemweiten Wert verwendet.

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

await CapgoBrightness.restoreSystemBrightness();

isAvailable

Überprüfen Sie, ob die Helligkeits-Funktion API auf dem aktuellen Gerät verfügbar ist.

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

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

checkPermissions

Überprüfe die Berechtigungen des Benutzers für den Zugriff auf die Systemhelligkeit.

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

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

requestPermissions

Berechtigungen für den Zugriff auf die Systemhelligkeit anfordern. Bei Android öffnet dies die Systemeinstellungen, um die Berechtigung WRITE_SETTINGS zu erteilen.

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

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

Typenreferenz

GetBrightnessResult

Ergebnis von getBrightness oder 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

Optionen für setBrightness oder 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

Ergibtum von getSystemBrightnessMode.

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

SetBrightnessModeOptions

Optionen für setSystemBrightnessMode.

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

IsUsingSystemBrightnessResult

Ergibtum von isUsingSystemBrightness.

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

IsAvailableResult

Ergibtum von isAvailable.

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

PermissionStatus

Zustand der Berechtigung.

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

GetPluginVersionResult

Ergbnis der getPluginVersion.

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

BrightnessMode

Der Helligkeitsmodus.

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

Zustand der Berechtigung.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Fortsetzung von Getting Started

Wenn Sie das Plugin verwenden Getting Started um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-brightness Für die native Fähigkeit in Mit @capgo/capacitor-brightness, API-Übersicht zur Implementierungsdetail in API Übersicht Einleitung zur Implementierungsdetail in Einleitung API Schlüssel zur Implementierungsdetail in API Schlüssel und Geräte für die Implementierungsdetails in Geräten.