メインコンテンツにジャンプ
Back to plugins
@capgo/capacitor-keep-awake
チュートリアル
@capgo/capacitor-keep-awake

Sleep から目を離さない

ビデオプレーヤー、ナビゲーション、プレゼンテーションなどで、端末のディスプレイが暗くなるか寝るのを防ぐ

ガイド

Keep Awakeのチュートリアル

デバイスでテスト

Download the Capgo app, then scan the QR code.

QRコードのプレビュー code

@capgo/capacitor-keep-awakeを使用します

Capacitor スクリーンを暗くしない/寝ないようにするためのキープアウェイク プラグインです。

インストール

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

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

  • keepAwake - スクリーンを暗くしないようにする。
  • allowSleep - スクリーンを暗くする (キープアウェイクを無効化)。
  • isSupported - キープアウェイク機能が現在のプラットフォームでサポートされているかどうかを確認します。
  • isKeptAwake - デバイスが現在キープアウェイクされているかどうかを確認します。

使用例

keepAwake

スクリーンを暗くしないようにする。

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

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

allowSleep

画面を暗くすることを許可する (常時起動を無効にする)。

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

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

isSupported

__CAPGO_KEEP_0__が現在のプラットフォームで常時起動機能をサポートしているかどうかを確認する。

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);

フルリファレンス

常時起動から@capgo/capacitor-常時起動を継続する

__CAPGO_KEEP_0__を使用している場合 @capgo/capacitor-常時起動を使用して __CAPGO_KEEP_0__と接続して @capgo/capacitor-常時起動 実装詳細については @capgo/capacitor-keep-awake に Getting Started 実装詳細については Getting Started に 使用する @capgo/capacitor-live-activities 使用する @capgo/capacitor-live-activities のネイティブ機能について @capgo/capacitor-live-activities 実装詳細については @capgo/capacitor-live-activities に 使用する @capgo/capacitor-video-player 使用する @capgo/capacitor-video-player のネイティブ機能について