抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 基础
  • 渲染
  • 设备
  • 加速度计
  • 剪贴板
  • 罗盘
  • 网络
  • 屏幕亮度
  • tt.setKeepScreenOn
  • tt.getScreenBrightness
  • tt.setScreenBrightness
  • 振动
  • 扫码
  • 陀螺仪
  • 设备方向
  • 日历
  • 滚轮
  • 键盘
  • 鼠标
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • tt.getScreenBrightness

    收藏
    我的收藏

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

    获取屏幕亮度。

    前提条件
    业务背景
    使用限制
    注意事项
    在没有设置小游戏屏幕亮度的情况下,默认获取系统屏幕亮度
    相关教程

    语法

    tt.getScreenBrightness(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    successfunction
    接口调用成功的回调函数
    1.79.0
    failfunction
    接口调用失败的回调函数
    1.79.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    1.79.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    valuenumber
    屏幕亮度值,范围 0 ~ 1。(0 最暗,1 最亮)
    1.79.0
    errMsgstring
    "getScreenBrightness:ok"
    1.79.0

    回调失败

    object 类型,属性如下:

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

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    999991Failed to get screen brightness.F
    小游戏框架内部错误,有需要请创建工单咨询
    1.79.0
    999993internal errorF
    小游戏框架内部错误,有需要请创建工单咨询
    1.79.0

    代码示例

    tt.getScreenBrightness({ success: (res) => { console.log("getScreenBrightness success", res); }, fail: (res) => { console.log("getScreenBrightness fail", res); }, });