Démarrage

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

bun add @capgo/capacitor-brightness
bunx cap sync

Importer

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

API Vue d'ensemble

getBrightness

Obtenez le niveau de luminosité actuel de l’écran principal du dispositif.

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

await CapgoBrightness.getBrightness();

setBrightness

Définissez le niveau de luminosité de l’écran principal du dispositif.

Sur iOS, la luminosité persiste 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 du système.

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

await CapgoBrightness.getSystemBrightness();

setSystemBrightness

Définir la luminosité de l'écran système.

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

await CapgoBrightness.setSystemBrightness({} as SetBrightnessOptions);

getSystemBrightnessMode

Copier dans le presse-papier

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

await CapgoBrightness.getSystemBrightnessMode();

setSystemBrightnessMode

Exige la permission WRITE_SETTINGS sur Android.

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

await CapgoBrightness.setSystemBrightnessMode({} as SetBrightnessModeOptions);

isUsingSystemBrightness

Définir le mode de luminosité système (automatique ou manuel).

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

await CapgoBrightness.isUsingSystemBrightness();

restoreSystemBrightness

Réinitialiser 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érifier si la luminosité API est disponible sur le dispositif actuel.

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

await CapgoBrightness.isAvailable();

checkPermissions

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

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

await CapgoBrightness.checkPermissions();

requestPermissions

Demander les permissions pour accéder à la luminosité système. Sur Android, cela ouvre les paramètres système pour accorder la permission WRITE_SETTINGS.

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

await CapgoBrightness.requestPermissions();

Référence de type

GetBrightnessResult

Résultat de getBrightness ou 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

Options pour setBrightness ou 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

Résultat de getSystemBrightnessMode.

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

Résultat du statut de permission.

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

GetPluginVersionResult

Résultat de getPluginVersion.

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 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 the sync when the public API changes upstream.

Continuez de l'étape de démarrage

Si vous utilisez Accueil pour planifier l’affichage de tableau et les opérations API, connectez-le avec Utilisez @capgo/capacitor-éclairage pour la capacité native dans Utilisez @capgo/capacitor-éclairage, API Vue d’ensemble pour le détail d’implémentation dans API Vue d’ensemble, Introduction pour le détail d’implémentation dans Introduction, API Clés pour le détail d’implémentation dans API Clés, et Appareils pour le détail d'implémentation dans Appareils.