跳转至正文

保持唤醒 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 App,然后扫描二维码 code。

Keep Awake 插件预览二维码 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 插件常见问题

如何在 Capacitor 应用中安装 Keep Awake 插件?

运行 "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 包,因此任何运行在 Capacitor 里的 Web 框架都能用,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-keep-awake 支持哪个 Capacitor 版本?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-keep-awake 是免费开源的吗?

是的。code 的源码已在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-keep-awake/,包可在 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我能不经过 App Store 审核,直接更新使用了 Keep Awake 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App 审核,即可发布 Keep Awake 更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo