tt.setKeepScreenOn
收藏我的收藏
收藏基础库 1.0.0 开始支持本方法，这是一个异步方法。
设置是否保持屏幕常亮状态。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 仅在当前小游戏生效，离开小游戏后设置失效。 |
| 注意事项 | 无 |
| 相关教程 | 无 |
语法
tt.setKeepScreenOn(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| keepScreenOn | boolean | 是 | 是否保持屏幕常亮 | 1.0.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "setKeepScreenOn:ok" | 1.0.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "setKeepScreenOn:fail" + 错误信息 | 1.0.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 20001 | invalid param | 参数错误 | 1.0.0 |
| 20000 | internal error | 小游戏框架内部错误，有需要请创建工单咨询 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.setKeepScreenOn({ keepScreenOn: false, success(res) { console.log(`屏幕常亮已关闭，省电中`); }, fail(res) { console.log(`setKeepScreenOn调用失败`); }, });
