Aller au contenu

Prise en main

GitHub

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

Fenêtre de terminal
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

Fenêtre de terminal
bun add @capgo/capacitor-brightness
npx cap sync
import { CapgoBrightness } from '@capgo/capacitor-brightness';
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();
console.log(result);
import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });
import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();
console.log(result);
  • Autorisations: appelez checkPermissions() puis requestPermissions() si nécessaire.
  • Sync native : exécuter npx cap sync après les mises à jour du plugin.
  • Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Récupérez le niveau de luminosité actuel de l'écran principal de l'appareil.

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getBrightness();
console.log(result);

Réglez le niveau de luminosité de l'écran principal de l'appareil.

Sur iOS, la luminosité persiste jusqu'au verrouillage de l'appareil. Sur Android, la luminosité ne s'applique qu'à l'activité en cours.

import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setBrightness({ brightness: 0.5 });

Récupérer la luminosité système de l'écran.

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightness();
console.log(result);

Définir la luminosité système de l'écran. Nécessite la permission WRITE_SETTINGS sur Android. Cela passe également le mode de luminosité à MANUAL.

import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });

Récupérer le mode de luminosité système actuel (automatique ou manuel). Nécessite la permission WRITE_SETTINGS sur Android.

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.getSystemBrightnessMode();
console.log(result);

Configurez le mode de luminosité du système (automatique ou manuel). Nécessite la permission WRITE_SETTINGS sur Android.

import { CapgoBrightness, BrightnessMode } from '@capgo/capacitor-brightness';
await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });

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

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isUsingSystemBrightness();
console.log(result);

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

import { CapgoBrightness } from '@capgo/capacitor-brightness';
await CapgoBrightness.restoreSystemBrightness();

Vérifiez si Brightness API est disponible sur l'appareil actuel.

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.isAvailable();
console.log(result);

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

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.checkPermissions();
console.log(result);

Demandez les autorisations d’accès à la luminosité du système. Sur Android, cela ouvre les paramètres système pour accorder l’autorisation WRITE_SETTINGS.

import { CapgoBrightness } from '@capgo/capacitor-brightness';
const result = await CapgoBrightness.requestPermissions();
console.log(result);

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;
}

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;
}

Résultat de getSystemBrightnessMode.

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

Options pour setSystemBrightnessMode.

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

Résultat de isUsingSystemBrightness.

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

Résultat de isAvailable.

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

Résultat du statut de la permission.

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

Résultat de getPluginVersion.

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

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,
}

État de la permission.

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

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-brightness pour la capacité native dans « Utiliser @capgo/capacitor-brightness », Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.