跳过主要内容

保持唤醒 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中使用保持唤醒

在设备上测试

下载 Capgo 应用,扫描二维码 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 允许设备降低屏幕亮度(禁用保持唤醒)。
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()

检查当前平台是否支持保持唤醒功能。

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

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

isKeptAwake()

检查设备是否正在保持唤醒。

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 中实现详细信息 开始使用 为 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 中的原生能力

常见问题

Keep Awake插件FAQ

如何在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。

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

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 请求。

code 使用 Keep Awake 时是否可以在 App Store 评论中更新?

安装或升级插件会更改本机 code,因此需要新建商店。之后,JavaScript、HTML 和 CSS 调用插件的更改可以立即通过 Capgo 实时更新。

不必等待应用程序审查就可以将保持唤醒功能的更改推送到商店

一旦插件在您的商店构建中,Capgo实时更新将推送您的JavaScript、HTML和CSS更改到用户中几分钟内。

开始使用Capgo