WakeLock

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

WakeLock は画面起動ロック API のインターフェイスで、アプリケーションが動作し続ける必要があるときに、端末の画面が暗くなったりロックされたりすることを防ぐためのものです。

システムの起動ロックはグローバルの Navigator.wakeLock プロパティで公開されています。

メソッド

request

WakeLockSentinel オブジェクトを要求し、 WakeLockSentinel オブジェクトで解決する Promise を返します。

例

以下の非同期関数は、 WakeLockSentinel オブジェクトを要求します。WakeLock.request メソッドはブラウザーが何らかの理由でリクエストを拒否した場合を想定して、 try...catch 文で囲まれています。

js
try {
  const wakeLock = await navigator.wakeLock.request("screen");
} catch (err) {
  // 起動ロックの要求に失敗 - 通常は、バッテリー低下などシステムに起因する。
  console.log(`${err.name}, ${err.message}`);
}

仕様書

Specification
Screen Wake Lock API
# the-wakelock-interface

ブラウザーの互換性

BCD tables only load in the browser