Anfangen

Installieren

bun add @capgo/capacitor-brightness
bunx cap sync

Importieren

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

API Übersicht

getBrightness

Ermitteln Sie derzeitige Helligkeitsstufe der Hauptbildschirm des Geräts.

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

await CapgoBrightness.getBrightness();

setBrightness

Setze die Helligkeitsstufe der Geräte-Hauptanzeige.

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

Ermittle die Gerätebreite Helligkeit der Bildschirm.

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

await CapgoBrightness.getSystemBrightness();

setSystemBrightness

Setze die Gerätebreite Helligkeit des Bildschirms. Bei Android ist die Berechtigung WRITE_SETTINGS erforderlich. Dies ändert auch die Helligkeitsmodus auf HANDSCHUH.

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

await CapgoBrightness.setSystemBrightness({} as SetBrightnessOptions);

getSystemBrightnessMode

Ermittle den aktuellen Helligkeitsmodus des Systems (automatisch oder manuell). Bei Android ist die Berechtigung WRITE_SETTINGS erforderlich.

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

Setze die Systemhelligkeitsmodus (automatisch oder manuell). Berechtigung WRITE_SETTINGS erforderlich auf Android.

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

await CapgoBrightness.setSystemBrightnessMode({} as SetBrightnessModeOptions);

isUsingSystemBrightness

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

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

await CapgoBrightness.isUsingSystemBrightness();

restoreSystemBrightness

Setze 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üfe, ob die Helligkeitsfunktion API auf dem aktuellen Gerät verfügbar ist.

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

await CapgoBrightness.isAvailable();

checkPermissions

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

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

await CapgoBrightness.checkPermissions();

requestPermissions

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

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

await CapgoBrightness.requestPermissions();

Typenverweis

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

Ergbnis 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

Ergbnis von isUsingSystemBrightness.

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

IsAvailableResult

Ergibt sich aus ist verfügbar.

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

PermissionStatus

Ergibt sich aus der Berechtigungsstatus.

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

GetPluginVersionResult

Ergibt sich aus 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

Zustimmungsstatus.

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

Quellwahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run the sync when the public API changes upstream.