メインコンテンツへスキップ
@capgo/capacitor-keep-awake デバイス API オープンソース

スリープ防止 Capacitor プラグイン

動画再生、ナビゲーション、プレゼンテーション中にデバイスの画面が暗くなったりスリープしたりするのを防ぎます

インストール

bun add @capgo/capacitor-keep-awake bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-keep-awake
  • pnpm add @capgo/capacitor-keep-awake
  • yarn add @capgo/capacitor-keep-awake

ガイド

Capacitor で Keep Awake を使う方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

Keep Awake プラグインのプレビューQR code

@capgo/capacitor-keep-awake の使用方法

デバイスの画面消灯やスリープを防ぐ Capacitor Keep Awake プラグイン。

インストール

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

bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

インポート

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

API の概要

メソッド 説明
keepAwake デバイスの画面が暗くなるのを防ぎます。
allowSleep デバイスの画面減光を許可する(keep awakeを無効化)。
isSupported 現在のプラットフォームでkeep awake機能がサポートされているか確認します。
isKeptAwake デバイスが現在keep awake状態か確認します。

例

keepAwake()

デバイスの画面が暗くなるのを防ぎます。

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

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

allowSleep()

デバイスの画面減光を許可する(keep awakeを無効化)。

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

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

isSupported()

現在のプラットフォームでkeep awake機能がサポートされているか確認します。

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

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

isKeptAwake()

デバイスが現在keep awake状態か確認します。

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

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

完全なリファレンス

@capgo/capacitor-keep-awake の使い方から続ける

使用している場合 @capgo/capacitor-keep-awake の使用方法 ネイティブメディアとインターフェースの挙動を計画するには、次と連携させてください @capgo/capacitor-keep-awake @capgo/capacitor-keep-awake の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 @capgo/capacitor-live-activities の使用 @capgo/capacitor-live-activities の使用におけるネイティブ機能については、 @capgo/capacitor-live-activities @capgo/capacitor-live-activities の実装の詳細については、 @capgo/capacitor-video-playerの使用方法 「@capgo/capacitor-video-player. の使い方」のネイティブ機能については

よくある質問

Keep Awake プラグイン FAQ

Capacitor アプリに Keep Awake plugin をインストールするにはどうすればよいですか?

"bun add @capgo/capacitor-keep-awake"(または "npm install @capgo/capacitor-keep-awake")を実行した後、"bunx cap sync" を実行して、iOS および Android プロジェクトにネイティブの code を反映させてください。その後、アプリの code で "@capgo/capacitor-keep-awake" からインポートします。

@capgo/capacitor-keep-awake は React、Vue、Angular で動作しますか?

はい。Keep Awake は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、およびプレーンな JavaScript を含む、Capacitor 内で動作するあらゆる Web フレームワークで使用できます。

@capgo/capacitor-keep-awake はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-keep-awake は無料のオープンソースですか?

はい。code のソースコードは GitHub の https://github.com/Cap-go/capacitor-keep-awake/ で公開されており、パッケージは npm から無料でインストールできます。バグ報告やプルリクエストもお待ちしています。

App Store の審査なしで、Keep Awake を使用している code をアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに Keep Awake の変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める