抖音开放平台Logo
控制台

tt.setKeepScreenOn
收藏
我的收藏

基础库 1.0.0 开始支持本方法，这是一个异步方法。

设置是否保持屏幕常亮状态。

前提条件无
业务背景无
使用限制无
注意事项
仅在当前小程序生效，离开小程序后设置失效。
支持沙盒
否
相关教程无

语法

tt.setKeepScreenOn(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
keepScreenOnboolean否
是否保持屏幕常亮
1.0.0
successfunction否
接口调用成功的回调函数
1.0.0
failfunction否
接口调用失败的回调函数
1.0.0
completefunction否
接口调用结束的回调函数（调用成功、失败都会执行）
1.0.0

回调成功

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring
"setKeepScreenOn:ok"
1.0.0

回调失败

object 类型，属性如下：

属性名类型说明最低支持版本
errMsgstring
"setKeepScreenOn:fail" + 详细错误信息
1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.setKeepScreenOn({
  keepScreenOn: false,
  success(res) {
    console.log(`屏幕常亮已关闭，省电中`);
  },
  fail(res) {
    console.log(`setKeepScreenOn调用失败`);
  },
});