Einstieg

Installieren

bun add @capgo/capacitor-brightness
bunx cap sync

Importieren

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

API Übersicht

getBrightness

Holen Sie sich den aktuellen Helligkeitswert der Hauptbildschirm-Helligkeit des Geräts.

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

await CapgoBrightness.getBrightness();

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({} as SetBrightnessOptions);

getSystemBrightness

Erhalten Sie die Bildschirmhelligkeit auf der gesamten Systemebene.

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

await CapgoBrightness.getSystemBrightness();

setSystemBrightness

Setzen Sie die Bildschirmhelligkeit auf der gesamten Systemebene. Bereitstellung der Berechtigung WRITE_SETTINGS auf Android erforderlich. Dies ändert auch den Helligkeitsmodus auf HANDSCHUH.

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

await CapgoBrightness.setSystemBrightness({} as SetBrightnessOptions);

getSystemBrightnessMode

Erhalten Sie den aktuellen Helligkeitsmodus des Systems (automatisch oder manuell). Bereitstellung der Berechtigung WRITE_SETTINGS auf Android erforderlich.

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

Setzen Sie den Helligkeitsmodus des Systems (automatisch oder manuell). Bereitstellung der Berechtigung WRITE_SETTINGS auf Android erforderlich.

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

await CapgoBrightness.setSystemBrightnessMode({} as SetBrightnessModeOptions);

isUsingSystemBrightness

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

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

await CapgoBrightness.isUsingSystemBrightness();

restoreSystemBrightness

Setzen Sie die Helligkeits-Einstellung der aktuellen Aktivität zurück, um den systemweiten Wert zu verwenden.

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

await CapgoBrightness.restoreSystemBrightness();

isAvailable

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

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

await CapgoBrightness.isAvailable();

checkPermissions

Überprüfen Sie die Berechtigungen des Benutzers für die 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

Ergbnis von getSystemBrightnessMode.

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

SetBrightnessModeOptions

Optionen für die Einstellung der Systemhelligkeit.

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

IsUsingSystemBrightnessResult

Ergbnis der Überprüfung der Systemhelligkeit.

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

IsAvailableResult

Ergbnis der Verfügbarkeit.

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

PermissionStatus

Ergbnis des Berechtigungsstatus.

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

GetPluginVersionResult

Ergebnis von 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 wurde aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Weitergehen von Getting Started

Wenn Sie " Getting Started um das Dashboard und API-Betrieb zu planen, verbinden Sie es mit Mit @capgo/capacitor-Helligkeit für die native Fähigkeit in Mit @capgo/capacitor-Helligkeit, 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äten.