Passer à la navigation principale
@capgo/capacitor-éclairage APIs de dispositif Source ouvert

L'éclairement plugin Capacitor

Control device screen brightness programmatically with support for app-specific and system-wide control

Installer

bun add @capgo/capacitor-brightness bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-brightness
  • pnpm add @capgo/capacitor-brightness
  • yarn add @capgo/capacitor-brightness

Guide

Comment utiliser la luminosité dans Capacitor

Tester sur appareil

Téléchargez l'application Capgo, puis scannez le QR code.

Prévisualisation du plugin de luminosité QR code

Utiliser @capgo/capacitor-luminosité

Contrôler la luminosité de l'écran sur iOS et Android.

Installer

bun add @capgo/capacitor-brightness
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à jour du plugin.

Importer

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

API en un coup d'œil

Méthode Description
getBrightness Obtenez le niveau de luminosité actuel de l'écran principal du dispositif.
setBrightness Fixez le niveau de luminosité de l'écran principal du dispositif.
getSystemBrightness Obtenez la luminosité d'écran système.
setSystemBrightness Fixer l'éclairement de l'écran système. Exige la permission WRITE_SETTINGS sur Android. Cela change également le mode d'éclairement en MANUEL.
getSystemBrightnessMode Obtenez la configuration actuelle de la luminosité du système (automatique ou manuelle). Exige la permission WRITE_SETTINGS sur Android.
setSystemBrightnessMode Réglage de la mode de luminosité du système (automatique ou manuel). Exige la permission WRITE_SETTINGS sur Android.
isUsingSystemBrightness Vérifiez si l'activité actuelle utilise la valeur de luminosité système.
restoreSystemBrightness Réinitialisez la valeur de la luminosité de l'activité actuelle pour utiliser la valeur système.
isAvailable Vérifiez si la luminosité API est disponible sur le dispositif actuel.
checkPermissions Vérifiez les permissions de l'utilisateur pour accéder à la luminosité du système.
requestPermissions Demandez les permissions pour accéder à la luminosité système. Sur Android, cela ouvre les paramètres système pour accorder la permission WRITE_SETTINGS.

Exemples

getBrightness()

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

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

const result = await CapgoBrightness.getBrightness();
console.log(result);

setBrightness()

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

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

await CapgoBrightness.setBrightness({ brightness: 0.5 });

getSystemBrightness()

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

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

const result = await CapgoBrightness.getSystemBrightness();
console.log(result);

setSystemBrightness()

Fixer l'éclairement de l'écran système. Exige la permission WRITE_SETTINGS sur Android. Cela change également le mode d'éclairement en MANUEL.

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

await CapgoBrightness.setSystemBrightness({ brightness: 0.5 });

getSystemBrightnessMode()

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

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

const result = await CapgoBrightness.getSystemBrightnessMode();
console.log(result);

setSystemBrightnessMode()

Fixez le mode de luminosité système (automatique ou manuel). Exigez la permission WRITE_SETTINGS sur Android.

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

await CapgoBrightness.setSystemBrightnessMode({ mode: BrightnessMode.AUTOMATIC });

La table ci-dessus liste les 11 méthodes de base. Les aides pour les listeners et les versions, ainsi que le contrat complet de chaque méthode, sont documentés dans répertoire GitHub.

Référence complète

Continuez à partir de l'utilisation de @capgo/capacitor-brightness

Si vous utilisez L'utilisation de @capgo/capacitor-brightness pour planifier le comportement des médias et de l'interface native, connectez-l’avec @capgo/capacitor-éclairage pour les détails d'implémentation dans @capgo/capacitor-brightness Prise en main pour le détail d'implémentation dans Getting Started, Utilisation de @capgo/capacitor-activités-en-vive pour la capacité native dans Utilisation de @capgo/capacitor-activités-en-vive, @capgo/capacitor-activités-en-vive pour le détail d'implémentation dans @capgo/capacitor-activités-en-vive, et Utilisation de @capgo/capacitor-joueur-de-videos pour la capacité native dans Utilisation de @capgo/capacitor-joueur-de-videos.

FAQ

FAQ du plugin de luminosité

Comment installer le plugin de luminosité dans une application Capacitor?

Exécutez « bun add @capgo/capacitor-brightness » (ou « npm install @capgo/capacitor-brightness »), puis exécutez « bunx cap sync » afin que les projets iOS et Android prennent en charge les code natifs. Importez-l’à partir de « @capgo/capacitor-brightness » dans votre application code.

Le plugin @capgo/capacitor-brightness fonctionne-t-il avec React, Vue et Angular?

Oui. Brightness est un paquet Capacitor, il fonctionne donc avec tout framework web qui s'exécute à l'intérieur de Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript simple.

Quelle version de Capacitor est prise en charge par @capgo/capacitor-brightness?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à votre version majeure de Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le README du GitHub liste les versions maintenues.

Est-ce que @capgo/capacitor-brightness est gratuit et open source ?

Oui. Le code source code est public sur GitHub à https://github.com/Cap-go/capacitor-brightness/ et le package est gratuit à installer depuis npm. Les rapports de bugs et les demandes de mise à jour sont les bienvenus.

Peut-on mettre à jour code qui utilise Brightness sans passer par une revue de l'App Store ?

L'installation ou la mise à niveau du plugin modifie le code natif code, il faut donc une nouvelle version de l'application. Une fois cela fait, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être envoyées instantanément avec les mises à jour Capgo.

Envoyez les modifications de luminosité sans attendre la revue de l'application

Une fois le plugin est dans votre magasin de build, les mises à jour en direct Capgo poussent vos modifications de JavaScript, HTML et CSS vers les utilisateurs en quelques minutes.

Démarrer avec Capgo