Démarrage

Installer

bun add @capgo/capacitor-brightness
bunx cap sync

Importer

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

API Vue d'ensemble

getBrightness

Obtenir le niveau de luminosité actuel de l'écran principal du dispositif.

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

await CapgoBrightness.getBrightness();

setBrightness

Définir le niveau de luminosité de l'écran principal du dispositif.

Sur iOS, la luminosité sera conservée jusqu'à ce que le dispositif soit verrouillé. Sur Android, la luminosité ne s'applique qu'à la session actuelle.

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

await CapgoBrightness.setBrightness({} as SetBrightnessOptions);

getSystemBrightness

Obtenez la luminosité de l'écran système.

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

await CapgoBrightness.getSystemBrightness();

setSystemBrightness

Définissez la luminosité de l'écran système. Exige la permission WRITE_SETTINGS sur Android. Cela change également le mode de luminosité en MANUEL.

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

await CapgoBrightness.setSystemBrightness({} as SetBrightnessOptions);

getSystemBrightnessMode

Obtenez le mode de luminosité système actuel (automatique ou manuel). Exige la permission WRITE_SETTINGS sur Android.

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

Définissez le mode de luminosité système (automatique ou manuel). Exige la permission WRITE_SETTINGS sur Android.

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

await CapgoBrightness.setSystemBrightnessMode({} as SetBrightnessModeOptions);

isUsingSystemBrightness

Vérifiez si l'activité actuelle utilise la valeur de luminosité système.

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

await CapgoBrightness.isUsingSystemBrightness();

restoreSystemBrightness

Réinitialisez la valeur de luminosité de l'activité actuelle pour utiliser la valeur système.

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

await CapgoBrightness.restoreSystemBrightness();

isAvailable

Vérifiez si la luminosité API est disponible sur le dispositif actuel.

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

await CapgoBrightness.isAvailable();

checkPermissions

Vérifiez les permissions de l'utilisateur pour accéder à la luminosité système.

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

await CapgoBrightness.checkPermissions();

requestPermissions

Demandez les autorisations pour accéder à la luminosité du système.

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

await CapgoBrightness.requestPermissions();

Copier dans le presse-papier

GetBrightnessResult

Section intitulée “GetBrightnessResult”

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

Section intitulée “SetBrightnessOptions”

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

Section intitulée “GetBrightnessModeResult”

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

SetBrightnessModeOptions

Options pour setSystemBrightnessMode.

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

IsUsingSystemBrightnessResult

Résultat de isUsingSystemBrightness.

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

IsAvailableResult

Résultat de isAvailable.

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

PermissionStatus

Statut de résultat de permission.

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

GetPluginVersionResult

Résultat de la version du plugin.

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

BrightnessMode

Le mode de luminosité.

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

État de la permission.

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

Source de vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run la synchronisation lorsque la public API change en amont.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier le tableau de bord et les API opérations, connectez-le avec Utilisation de @capgo/capacitor-brightness pour la capacité native dans Utilisation de @capgo/capacitor-brightness, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.