Rester activé avec l'API Screen Wake Lock

L'API Screen Wake Lock permet d'empêcher les appareils de réduire la luminosité ou de verrouiller l'écran lorsqu'une application doit continuer à fonctionner.

Pete LePage
Thomas Steiner

Qu'est-ce que l'API Screen Wake Lock ?

Pour éviter de décharger la batterie, la plupart des appareils passent rapidement en veille lorsqu'ils sont inactifs. Bien que cela ne pose pas de problème la plupart du temps, certaines applications doivent maintenir l'écran activé pour effectuer leur travail. Par exemple, les applications de cuisine qui montrent les étapes d'une recette ou un jeu comme Ball Puzzle, qui utilise les API de mouvement de l'appareil pour la saisie.

L'API Screen Wake Lock permet d'empêcher l'appareil de réduire la luminosité et de verrouiller l'écran. Cette fonctionnalité permet de proposer de nouvelles expériences qui, jusqu'à présent, nécessitaient une application spécifique à la plate-forme.

L'API Screen Wake Lock réduit le besoin de solutions de contournement peu fiables et potentiellement gourmandes en énergie. Elle corrige les lacunes d'une ancienne API qui se limitait simplement à maintenir l'écran allumé et qui présentait un certain nombre de problèmes de sécurité et de confidentialité.

Cas d'utilisation suggérés pour l'API Screen Wake Lock

RioRun, une application Web développée par The Guardian, était un cas d'utilisation parfait (mais elle n'est plus disponible). L'application vous emmène dans une visite audio virtuelle de Rio, en suivant le parcours du marathon olympique de 2016. Sans verrouillage de réveil, les écrans des utilisateurs s'éteignent fréquemment pendant la visite, ce qui la rend difficile à utiliser.

Bien sûr, il existe de nombreux autres cas d'utilisation:

  • Une application de recettes qui maintient l'écran allumé pendant que vous préparez un gâteau ou un dîner
  • Une application de carte d'embarquement ou de billet qui maintient l'écran allumé jusqu'à ce que le code-barres ait été scanné
  • Une application de type kiosque qui maintient l'écran allumé en permanence
  • Une application de présentation Web qui maintient l'écran allumé pendant une présentation

État actuel

Étape État
1. Créer un message d'explication N/A
2. Créer une première ébauche de la spécification Fin
3. Recueillir des commentaires et itérer la conception Fin
4. Phase d'évaluation Terminé
5. Lancement Fin

Utiliser l'API Screen Wake Lock

Types de wakelocks

L'API Screen Wake Lock ne propose actuellement qu'un seul type de verrouillage de réveil: screen.

Wakelock screen

Un verrouillage de réveil screen empêche l'écran de l'appareil de s'éteindre afin que l'utilisateur puisse voir les informations affichées à l'écran.

Obtenir le wakelock en cas d'activation de l'écran

Pour demander un wakelock d'écran, vous devez appeler la méthode navigator.wakeLock.request() qui renvoie un objet WakeLockSentinel. Vous transmettez à cette méthode le type de wakelock souhaité en tant que paramètre, qui est actuellement limité à 'screen' et qui est donc facultatif. Le navigateur peut refuser la requête pour diverses raisons (par exemple, parce que le niveau de charge de la batterie est trop faible). Il est donc recommandé d'encapsuler l'appel dans une instruction try…catch. En cas d'échec, le message de l'exception contient plus de détails.

Libérer un wakelock d'écran

Vous devez également disposer d'un moyen de libérer le verrouillage de l'écran, ce qui se fait en appelant la méthode release() de l'objet WakeLockSentinel. Si vous ne stockez pas de référence à WakeLockSentinel, il n'est pas possible de relâcher le verrouillage manuellement, mais il sera relâché une fois que l'onglet actuel sera invisible.

Si vous souhaitez libérer automatiquement le verrouillage de l'écran après un certain temps, vous pouvez utiliser window.setTimeout() pour appeler release(), comme illustré dans l'exemple ci-dessous.

// The wake lock sentinel.
let wakeLock = null;

// Function that attempts to request a screen wake lock.
const requestWakeLock = async () => {
  try {
    wakeLock = await navigator.wakeLock.request();
    wakeLock.addEventListener('release', () => {
      console.log('Screen Wake Lock released:', wakeLock.released);
    });
    console.log('Screen Wake Lock released:', wakeLock.released);
  } catch (err) {
    console.error(`${err.name}, ${err.message}`);
  }
};

// Request a screen wake lock…
await requestWakeLock();
// …and release it again after 5s.
window.setTimeout(() => {
  wakeLock.release();
  wakeLock = null;
}, 5000);

L'objet WakeLockSentinel possède une propriété appelée released qui indique si une sentinelle a déjà été libérée. Sa valeur est initialement false, puis elle passe à true une fois qu'un événement "release" est envoyé. Cette propriété permet aux développeurs Web de savoir quand un verrou a été libéré, afin qu'ils n'aient pas besoin d'en effectuer le suivi manuellement. Elle est disponible à partir de Chrome 87.

Cycle de vie du wakelock de l'écran

Lorsque vous jouez avec la démonstration du verrouillage de l'écran, vous remarquerez que les verrouillages de l'écran sont sensibles à la visibilité de la page. Cela signifie que le wakelock de l'écran sera automatiquement libéré lorsque vous réduirez un onglet ou une fenêtre, ou que vous quittez un onglet ou une fenêtre pour lesquels un wakelock de l'écran est actif.

Pour récupérer le wakelock de l'écran, écoutez l'événement visibilitychange et demandez un nouveau wakelock d'écran lorsqu'ils se produisent:

const handleVisibilityChange = async () => {
  if (wakeLock !== null && document.visibilityState === 'visible') {
    await requestWakeLock();
  }
};

document.addEventListener('visibilitychange', handleVisibilityChange);

Réduire l'impact sur les ressources système

Faut-il utiliser un écran de verrouillage dans votre application ? L'approche que vous adoptez dépend des besoins de votre application. Quoi qu'il en soit, vous devez utiliser l'approche la plus légère possible pour votre application afin de minimiser son impact sur les ressources système.

Avant d'ajouter un verrouillage de l'écran à votre application, demandez-vous si vos cas d'utilisation peuvent être résolus avec l'une des solutions alternatives suivantes:

Démo

Consultez la démo de Screen Wake Lock et la source de la démo. Notez que le verrouillage de l'écran est automatiquement libéré lorsque vous passez d'un onglet ou d'une application à une autre.

Wakelocks forçant l'activation de l'écran dans le gestionnaire de tâches de l'OS

Vous pouvez utiliser le gestionnaire de tâches de votre système d'exploitation pour savoir si une application empêche votre ordinateur de passer en mode veille. La vidéo ci-dessous montre le moniteur d'activité macOS indiquant que Chrome dispose d'un verrouillage d'écran actif qui maintient le système actif.

Commentaires

Le WiCG (Web Platform Incubator Community Group) et l'équipe Chrome souhaitent en savoir plus sur vos réflexions et vos expériences concernant l'API Screen Wake Lock.

Parlez-nous de la conception de l'API

Y a-t-il un aspect de l'API qui ne fonctionne pas comme prévu ? Ou manque-t-il des méthodes ou des propriétés dont vous avez besoin pour mettre en œuvre votre idée ?

Signaler un problème d'implémentation

Avez-vous trouvé un bug dans l'implémentation de Chrome ? Ou l'implémentation est-elle différente de la spécification ?

  • Signalez un bug sur https://new.crbug.com. Veillez à inclure autant de détails que possible, à fournir des instructions simples pour reproduire le bug et à définir Components sur Blink>WakeLock. Glitch est idéal pour partager des répétitions rapidement et facilement.

Afficher la compatibilité avec l'API

Comptez-vous utiliser l'API Screen Wake Lock ? Votre assistance publique aide l'équipe Chrome à hiérarchiser les fonctionnalités et montre aux autres fournisseurs de navigateurs à quel point il est essentiel de les prendre en charge.

Liens utiles

Remerciements

Image principale de Kate Stone Matheson sur Unsplash. Vidéo sur le gestionnaire de tâches, avec l'aimable autorisation de Henry Lim.