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

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

    监听键盘按键按下事件,仅适用于 PC 平台

    前提条件
    业务背景
    使用限制

    只支持 PC 端使用该能力

    注意事项
    相关教程

    语法

    tt.onKeyDown(handler)

    参数说明

    handler

    类型默认值必填说明最低支持版本
    function

    传入的事件回调函数

    3.54.0

    handler 是一个回调函数,接收 object 类型的参数,属性如下:

    属性名类型说明最低支持版本
    keystring

    点击键盘的按钮 key 值,参考 Web 规范 KeyEvent key 属性

    3.54.0
    codestring

    点击键盘的按钮 code 值,参考 Web 规范 KeyEvent code 属性

    3.54.0
    timeStampnumber

    事件触发的高精度时间戳

    3.54.0

    返回值

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    999999invalid paramD

    参数错误

    3.54.0
    999988The feature is not available in current operating systemD

    不支持该系统,只支持在 PC 端调用

    3.54.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    tt.onKeyDown((e) => { tt.showToast({ title: `KeyDown key: ${e.key}`, }); })