Skip to main content

powerSaveBlocker

Block the system from entering low-power (sleep) mode.阻止系统进入低功耗（睡眠）模式。

Process:进程：Main

For example:例如：

const { powerSaveBlocker } = require('electron')

const id = powerSaveBlocker.start('prevent-display-sleep')
console.log(powerSaveBlocker.isStarted(id))

powerSaveBlocker.stop(id)

Methods方法​

The powerSaveBlocker module has the following methods:powerSaveBlocker模块具有以下方法：

powerSaveBlocker.start(type)​

  • type string - Power save blocker type.省电阻断器类型。
    • prevent-app-suspension - Prevent the application from being suspended. 防止应用程序被挂起。Keeps system active but allows screen to be turned off. 保持系统处于活动状态，但允许关闭屏幕。Example use cases: downloading a file or playing audio.示例用例：下载文件或播放音频。
    • prevent-display-sleep - Prevent the display from going to sleep. 防止显示器进入睡眠状态。Keeps system and screen active. 保持系统和屏幕处于活动状态。Example use case: playing video.示例用例：播放视频。

Returns返回Integer - The blocker ID that is assigned to this power blocker.分配给此电源阻止程序的阻止程序ID。

Starts preventing the system from entering lower-power mode. 开始阻止系统进入低功率模式。Returns an integer identifying the power save blocker.返回一个标识节能阻止程序的整数。

Note: prevent-display-sleep has higher precedence over prevent-app-suspension. 具有比prevent-app-suspension更高的优先级。Only the highest precedence type takes effect. 只有优先级最高的类型才会生效。In other words, prevent-display-sleep always takes precedence over prevent-app-suspension.换句话说，prevent-display-sleep总是优先于prevent-app-suspension。

For example, an API calling A requests for prevent-app-suspension, and another calling B requests for prevent-display-sleep. 例如，一个调用A的API请求用于prevent-app-suspension，另一个调用B的API请求用于prevent-display-sleep。prevent-display-sleep will be used until B stops its request. 将被使用，直到B停止其请求。After that, prevent-app-suspension is used.之后，将使用prevent-app-suspension。

powerSaveBlocker.stop(id)​

  • id Integer - The power save blocker id returned by powerSaveBlocker.start.powerSaveBlocker.start返回的节能阻止程序id。

Stops the specified power save blocker.停止指定的节能阻止程序。

powerSaveBlocker.isStarted(id)​

  • id Integer - The power save blocker id returned by powerSaveBlocker.start.powerSaveBlocker.start返回的节能阻止程序id。

Returns返回boolean - Whether the corresponding powerSaveBlocker has started.是否已启动相应的powerSaveBlocker。