抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 基础
  • 渲染
  • 媒体
  • 数据缓存
  • TTML
  • 数据分析
  • 页面导航
  • 设备
  • 系统信息
  • tt.getSystemInfo
  • tt.getDeviceInfoSync
  • tt.getSystemInfoSync
  • 加密
  • 性能
  • 剪切板
  • 画布
  • 界面
  • 直播开放能力
  • tt.getSystemInfo
    收藏
    我的收藏

    基础库 3.41.0 开始支持本方法,这是一个异步方法。
    获取系统信息。如果在页面渲染时,需要通过调用 API 获取到的信息来设置节点宽高,建议在 Page.onReady 或者更后的时机调用,调用过早可能出现获取的宽高信息不准确。

    语法

    tt.getSystemInfo(options)

    参数说明

    options 为 object 类型,属性如下:
    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    useCache
    boolean
    false
    否
    是否使用缓存中的系统信息(默认不使用)
    3.41.0
    success
    function
    ​
    否
    接口调用成功后的回调函数
    3.41.0
    fail
    function
    ​
    否
    接口调用失败后的回调函数
    3.41.0
    complete
    function
    ​
    否
    接口调用结束后的回调函数(调用成功、失败都会执行)
    3.41.0

    回调成功

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    system
    string
    操作系统版本
    3.41.0
    platform
    string
    操作系统类型,详情见 操作系统说明
    3.41.0
    brand
    string
    手机品牌
    3.41.0
    model
    string
    手机型号
    3.41.0
    version
    string
    宿主 App 版本号(宿主指今日头条、抖音等)
    3.41.0
    appName
    string
    宿主 APP 名称,详情见 appName 说明
    3.41.0
    SDKVersion
    string
    客户端基础库版本
    3.41.0
    screenWidth
    number
    屏幕宽度
    3.41.0
    screenHeight
    number
    屏幕高度
    3.41.0
    windowWidth
    number
    可使用窗口宽度
    3.41.0
    windowHeight
    number
    可使用窗口高度
    3.41.0
    pixelRatio
    number
    设备像素比
    3.41.0
    statusBarHeight
    number
    状态栏的高度,单位 px
    3.41.0
    safeArea
    SafeArea
    在竖屏正方向下的安全区域,详情见 SafeArea 类型说明
    3.41.0
    battery
    number
    电池电量
    3.41.0
    fontSizeSetting
    string
    字体大小
    3.41.0
    language
    string
    系统语言
    3.41.0
    screenRatio
    number
    分屏参数,即 X 分屏状态下,分屏占全屏幕的比例
    3.41.0
    errMsg
    string
    "getSystemInfo:ok"
    3.41.0
    useCache 为 true 时,以下字段可能不准确需要特别注意:
    属性名
    类型
    说明
    原因
    最低支持版本
    windowWidth
    string
    可使用窗口宽度
    在 X 分屏场景下可使用窗口宽度可能为正常高度
    3.41.0
    windowHeight
    string
    可使用窗口高度
    在 X 分屏场景下可使用窗口高度可能为正常高度
    3.41.0
    battery
    number
    电池电量
    电池电量实时变化使用缓存值电池电量可能会不准确
    3.41.0
    screenRatio
    number
    分屏参数
    分屏状态下,分屏比例会随拖动改变,使用缓存值分屏参数会不准确。
    3.41.0

    SafeArea 类型说明

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    left
    number
    安全区域左上角横坐标
    3.41.0
    right
    number
    安全区域右下角横坐标
    3.41.0
    top
    number
    安全区域左上角纵坐标
    3.41.0
    bottom
    number
    安全区域右下角纵坐标
    3.41.0
    width
    number
    安全区域的宽度,单位逻辑像素
    3.41.0
    height
    number
    安全区域的高度,单位逻辑像素
    3.41.0

    appName 类型说明

    返回值
    类型
    说明
    最低支持版本
    Toutiao
    string
    今日头条
    3.41.0
    Douyin
    string
    抖音(国内版)
    3.41.0
    news_article_lite
    string
    今日头条(极速版)
    3.41.0
    douyin_lite
    string
    抖音(极速版)
    3.41.0
    aweme_hotsoon
    string
    抖音火山版
    3.41.0
    XiGua
    string
    西瓜
    3.41.0
    PPX
    string
    皮皮虾
    3.41.0

    回调失败

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    errMsg
    string
    "getSystemInfo:fail" + 详细错误信息
    3.41.0

    操作系统说明

    返回值如下:
    返回值
    说明
    ios
    iOS系统
    Android
    Android系统
    devtools
    开发者工具

    扫码体验

    代码示例

    Bug & Tip

      •Tip:暂不支持获取deviceId(设备唯一标识);
      •Tip:建议未使用到 windowWidth、windowHeight、battery、screenRatio 参数时,传入 useCache 参数为 true,可提升该 API 的响应速度;
      •Tip:建议在使用 windowWidth、windowHeight、battery、screenRatio 参数时,调用同步 API tt.getSystemInfoSync,异步 API tt.getSystemInfo 的返回值可能因时序原因造成值不准确。