Aller au contenu principal
@capgo/capacitor-keep-awake API de l'appareil Open source

Rester en veille Plugin Capacitor

Empêcher l'écran de l'appareil de s'assombrir ou de se mettre en veille pour les lecteurs vidéo, la navigation et les présentations

Installer

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

Guide

Comment utiliser Keep Awake dans Capacitor

Tester sur l'appareil

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

QR code de l'aperçu du plugin Keep Awake code

Utiliser @capgo/capacitor-keep-awake

Plugin Capacitor Keep Awake pour empêcher l'écran de l'appareil de s'éteindre ou de se mettre en veille.

Installer

bun add @capgo/capacitor-keep-awake
bunx cap sync

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

Importer

import { KeepAwake } from '@capgo/capacitor-keep-awake';

Aperçu de API

Méthode Description
keepAwake Empêche l'appareil d'assombrir l'écran.
allowSleep Autorise l'appareil à assombrir l'écran (désactive keep awake).
isSupported Vérifie si la fonctionnalité keep awake est prise en charge sur la plateforme actuelle.
isKeptAwake Vérifie si l'appareil est actuellement maintenu en éveil.

Exemples

keepAwake()

Empêche l'appareil d'assombrir l'écran.

import { KeepAwake } from '@capgo/capacitor-keep-awake';

await KeepAwake.keepAwake();
console.log('Screen will stay awake');

allowSleep()

Autorise l'appareil à assombrir l'écran (désactive keep awake).

import { KeepAwake } from '@capgo/capacitor-keep-awake';

await KeepAwake.allowSleep();
console.log('Screen can now dim');

isSupported()

Vérifie si la fonctionnalité keep awake est prise en charge sur la plateforme actuelle.

import { KeepAwake } from '@capgo/capacitor-keep-awake';

const { isSupported } = await KeepAwake.isSupported();
if (isSupported) {
  console.log('Keep awake is supported');
}

isKeptAwake()

Vérifie si l'appareil est actuellement maintenu en éveil.

import { KeepAwake } from '@capgo/capacitor-keep-awake';

const { isKeptAwake } = await KeepAwake.isKeptAwake();
console.log('Is kept awake:', isKeptAwake);

Référence complète

Continuer après l'utilisation de @capgo/capacitor-keep-awake

Si vous utilisez Utiliser @capgo/capacitor-keep-awake pour planifier le comportement des médias et de l'interface natifs, connectez-l’à @capgo/capacitor-keep-awake pour les détails d'implémentation de @capgo/capacitor-keep-awake, Prise en main pour les détails d'implémentation dans Getting Started Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour les détails d'implémentation dans @capgo/capacitor-live-activities, et Utiliser @capgo/capacitor-video-player pour la fonctionnalité native dans Utilisation de @capgo/capacitor-video-player.

FAQ

FAQ du plugin Keep Awake

Comment installer le plugin Keep Awake dans une application Capacitor ?

Exécutez "bun add @capgo/capacitor-keep-awake" (ou "npm install @capgo/capacitor-keep-awake"), puis lancez "bunx cap sync" pour que les projets iOS et Android prennent en compte le code natif. Importez-le depuis "@capgo/capacitor-keep-awake" dans votre code.

Est-ce que @capgo/capacitor-keep-awake fonctionne avec React, Vue et Angular ?

Oui. Keep Awake est un package Capacitor, il fonctionne donc avec n'importe quel framework web qui tourne dans Capacitor, y compris Ionic, React, Vue, Angular, Svelte et le JavaScript pur.

Quelle version de Capacitor est supportée par @capgo/capacitor-keep-awake ?

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

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

Oui. Le code source est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-keep-awake/ et le package s'installe gratuitement depuis npm. Les rapports de bugs et les pull requests sont les bienvenus.

Puis-je mettre à jour code utilisant Keep Awake sans passer par une revue de l'App Store ?

L'installation ou la mise à jour du plugin modifie le code natif, ce qui impose un nouveau build pour les stores. Ensuite, les changements JavaScript, HTML et CSS qui appellent le plugin peuvent être livrés instantanément via les live updates de Capgo.

Déployez les changements de Keep Awake sans attendre la validation de l'app

Une fois le plugin intégré à votre build de store, Capgo live updates déploie vos changements JavaScript, HTML et CSS aux utilisateurs en quelques minutes.

Commencez avec Capgo