Getting Started

Installieren

Sie können unsere KI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem KI-Tool hinzu, indem Sie den folgenden Befehl ausführen:

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

Verwenden Sie dann den folgenden Prompt:

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 folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

bun add @capgo/capacitor-brightness
bunx cap sync

Importieren

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

API Übersicht

getBrightness

Ermitteln Sie derzeitigen Helligkeitslevel der Hauptbildschirm des Geräts.

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

await CapgoBrightness.getBrightness();

setBrightness

Setzen Sie den Helligkeitslevel des Hauptbildschirms 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({} as SetBrightnessOptions);

getSystemBrightness

Die Helligkeit des Bildschirms abrufen.

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

await CapgoBrightness.getSystemBrightness();

setSystemBrightness

Die Helligkeit des Bildschirms festlegen. Bereitstellung der WRITE_SETTINGS-Berechtigung auf Android erforderlich. Dies ändert auch den Helligkeitsmodus auf HANDSCHUH.

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

await CapgoBrightness.setSystemBrightness({} as SetBrightnessOptions);

getSystemBrightnessMode

Den aktuellen Helligkeitsmodus (automatisch oder manuell) abrufen. Bereitstellung der WRITE_SETTINGS-Berechtigung auf Android erforderlich.

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

Den Helligkeitsmodus (automatisch oder manuell) festlegen. Bereitstellung der WRITE_SETTINGS-Berechtigung auf Android erforderlich.

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

await CapgoBrightness.setSystemBrightnessMode({} as SetBrightnessModeOptions);

isUsingSystemBrightness

Überprüfen, ob die aktuelle Aktivität die Systemhelligkeit verwendet.

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

await CapgoBrightness.isUsingSystemBrightness();

restoreSystemBrightness

Die Helligkeits-Einstellung der aktuellen Aktivität auf die Systemhelligkeit zurücksetzen.

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

await CapgoBrightness.restoreSystemBrightness();

isAvailable

Überprüfen, ob die Helligkeit API auf dem aktuellen Gerät verfügbar ist.

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

await CapgoBrightness.isAvailable();

checkPermissions

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

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

await CapgoBrightness.checkPermissions();

requestPermissions

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

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

await CapgoBrightness.requestPermissions();

Typenreferenz

GetBrightnessResult

Ergbnis 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

Ergebnis von getSystemBrightnessMode.

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

SetBrightnessModeOptions

Einstellungen für setSystemBrightnessMode.

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

IsUsingSystemBrightnessResult

Ergebnis von isUsingSystemBrightness.

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

IsAvailableResult

Ergebnis von isAvailable.

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

PermissionStatus

Erlaubnisstatus-Ergebnis.

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

GetPluginVersionResult

Ergbnis von getPluginVersion.

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

BrightnessMode

Die 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

Erlaubniszustand.

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.

Weiter von Anleitung zum Einstieg

Wenn Sie "Anleitung zum Einstieg" verwenden, um das Dashboard und die __CAPGO_KEEP_0__-Operationen zu planen, verbinden Sie es mit Anleitung zum Einstieg Verwenden Sie @API/__CAPGO_KEEP_1__-Helligkeit Verwenden Sie @capgo/capacitor-Helligkeit für die native Fähigkeit in Verwenden Sie @capgo/capacitor-Helligkeit, for the native capability in Using @capgo/capacitor-brightness, API-Übersicht für die Implementierungsdetails in API Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.