@anuradev/capacitor-background-mode

中文文档
8.1.0发布于 2026/08/16MITTypeScriptESM + CJS零依赖近 30 天下载 8372

启用背景模式的电容插件

中文使用文档
文档目录26 节
  1. 安装
  2. 背景麦克风访问
  3. API 密码
  4. 启用(...)
  5. 禁用( c)
  6. 更新通知(...)
  7. 检查通知
  8. 批准()
  9. 麦克风
  10. 麦克风
  11. 检查 Battery Optimizations ()
  12. 不可拆卸电池 Optimizations ()
  13. 启用WebViewoptimizations ()
  14. 禁用WebView optimization ()
  15. 移动背景 ()
  16. 移动到前景 ()
  17. isScreenOff () (中文(简体) )
  18. 已启用
  19. 正态( A)
  20. 唤醒( )
  21. 解锁( )
  22. 添加倾听器( “ 应用背景” ,...)
  23. 添加倾听器( “ 应用前景 ” ,...)
  24. 删除所有收听器( )
  25. 接口
  26. 类型异名

@anuradev/电容-背景-模式

启用背景模式的电容插件

此插件替换为 电容器-插件-背景-模式

安装

npm install @anuradev/capacitor-background-mode
npx cap sync

背景麦克风访问

背景麦克风访问默认被禁用 。 为了启用它,宣布 消费申请中要求的许可 AndroidManifest.xml数字 :

<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />

请求麦克风许可并启用前台服务:

await BackgroundMode.requestMicrophonePermission();
await BackgroundMode.enable({ allowMicrophoneInBackground: true });

API 密码

启用(...)

enable(settings: Partial<ISettings>) => Promise<void>
参数类型
settingsPartial<ISettings>

禁用( c)

disable() => Promise<void>

更新通知(...)

updateNotification(settings: Partial<ISettings>) => Promise<void>
参数类型
settingsPartial<ISettings>

检查通知

checkNotificationsPermission() => Promise<NotificationPermissionStatus>

回返情况: Promise<NotificationPermissionStatus>


批准()

requestNotificationsPermission() => Promise<NotificationPermissionStatus>

回返情况: Promise<NotificationPermissionStatus>


麦克风

checkMicrophonePermission() => Promise<MicrophonePermissionStatus>

回返情况: Promise<MicrophonePermissionStatus>


麦克风

requestMicrophonePermission() => Promise<MicrophonePermissionStatus>

回返情况: Promise<MicrophonePermissionStatus>


检查 Battery Optimizations ()

checkBatteryOptimizations() => Promise<{ enabled: boolean; }>

回返情况: Promise<{ enabled: boolean; }>


不可拆卸电池 Optimizations ()

requestDisableBatteryOptimizations() => Promise<{ enabled: boolean; }>

回返情况: Promise<{ enabled: boolean; }>


启用WebViewoptimizations ()

enableWebViewOptimizations() => Promise<void>

禁用WebView optimization ()

disableWebViewOptimizations() => Promise<void>

移动背景 ()

moveToBackground() => Promise<void>

移动到前景 ()

moveToForeground() => Promise<void>

isScreenOff () (中文(简体) )

isScreenOff() => Promise<{ isScreenOff: boolean; }>

回返情况: Promise<{ isScreenOff: boolean; }>


已启用

isEnabled() => Promise<{ enabled: boolean; }>

回返情况: Promise<{ enabled: boolean; }>


正态( A)

isActive() => Promise<{ activated: boolean; }>

回返情况: Promise<{ activated: boolean; }>


唤醒( )

wakeUp() => Promise<void>

解锁( )

unlock() => Promise<void>

添加倾听器( “ 应用背景” ,...)

addListener(eventName: 'appInBackground', listenerFunc: () => void) => Promise<PluginListenerHandle>
参数类型
eventName'appInBackground'
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


添加倾听器( “ 应用前景 ” ,...)

addListener(eventName: 'appInForeground', listenerFunc: () => void) => Promise<PluginListenerHandle>
参数类型
eventName'appInForeground'
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


删除所有收听器( )

removeAllListeners() => Promise<void>

接口

定居

Prop类型说明默认
titlestring
textstring
subTextstring
bigTextboolean
resumeboolean
silentboolean
hiddenboolean
colorstring
iconstring
channelNamestring
channelDescriptionstring
allowCloseboolean
closeIconstring
closeTitlestring
showWhenboolean
disableWebViewOptimizationboolean
allowMicrophoneInBackgroundboolean允许前台服务在应用程序处于后台时使用麦克风.false
visibility'public' | 'private' | 'secret'

通知状态

Prop类型
notificationsPermissionState

微型电话

Prop类型
microphonePermissionState

插件听筒

Prop类型
remove() => Promise<void>

类型异名

部分

让 T 中的所有属性可选

{ [P in keyof T]?: T[P]; }

权限状态

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

版本与发布记录

@anuradev/capacitor-background-mode 共发布 40 个版本,首次发布于 2023/05/02;过去 12 个月发布了 6 个版本。

版本发布日期距今
8.1.0latest2026/08/162 个月前
8.0.42026/08/162 个月前
8.0.32026/08/132 个月前
8.0.22026/08/132 个月前
8.0.12026/08/122 个月前
8.0.02026/07/233 个月前

关于 @anuradev/capacitor-background-mode 的常见问题

@anuradev/capacitor-background-mode 是什么?

启用背景模式的电容插件

如何安装 @anuradev/capacitor-background-mode?

在项目目录运行 npm install @anuradev/capacitor-background-mode,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@capacitor/core(>=8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@anuradev/capacitor-background-mode 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@anuradev/capacitor-background-mode 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@anuradev/capacitor-background-mode 可以商用吗?

@anuradev/capacitor-background-mode 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@anuradev/capacitor-background-mode 的下载量有多少?

根据 npm 官方下载统计,@anuradev/capacitor-background-mode 在 2026/10/06 – 2026/11/04 这 30 天内被下载 8,372 次,日均约 279 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@anuradev/capacitor-background-mode 还在维护吗?

最新版本 8.1.0 发布于 2026/08/16(2 个月前);至今共发布 40 个版本,其中过去 12 个月发布了 6 个;首次发布于 2023/05/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。