メインコンテンツにジャンプ
プラグインに戻る
@capgo/capacitor-keep-awake
チュートリアル
github.com/Cap-go による

Keep Awake

動画プレーヤー、ナビゲーション、プレゼンテーションなどで、デバイスのディスプレイを暗くするか寝るのを防ぐ

ガイド

Keep Awakeのチュートリアル

Using @capgo/capacitor-keep-awake

Capacitor Keep Awake プラグイン (画面の暗転/睡眠を防ぐ)

インストール

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

このプラグインが公開するもの

  • keepAwake - スクリーンを暗転させないようにする
  • allowSleep - スクリーンを暗転させる (Keep Awakeを無効にする)
  • isSupported - Keep Awakeの機能が現在のプラットフォームでサポートされているかどうかを確認する
  • isKeptAwake - __CAPGO_KEEP_0__が現在起動中であるかどうかを確認します。

使用例

keepAwake

画面を暗くすることを__CAPGO_KEEP_0__から防止します。

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

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

allowSleep

__CAPGO_KEEP_0__が画面を暗くすることを許可します (起動中の防止を無効にします)。

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

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

isSupported

現在のプラットフォームで起動中の防止機能がサポートされているかどうかを確認します。

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

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

isKeptAwake

__CAPGO_KEEP_0__が現在起動中であるかどうかを確認します。

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

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

フルリファレンス