- JS API 列表
- 基础
- 网络
- 媒体
- 地图
- 文件
- 开放接口
- 数据缓存
- 地理位置
- 设备
- 画布
- 界面
- 页面导航
- 侧边栏能力
- 行业开放
- AI/AR能力
- 第三方平台
- TTML
- 转发和挂载
- 其它
- 直播能力
JS API 列表收藏我的收藏
收藏
我的收藏基础
API | 描述 |
判断小程序的 API、回调、参数、组件等是否在当前版本可用。 | |
生命周期
API | 描述 |
获取本次小程序启动时的参数。 | |
获取小程序冷启动时的参数,其值与 App.onLaunch 方法传入的参数一致,并且不会随着小程序使用而发生变化。 | |
退出当前小程序到后台。 |
版本更新
API | 描述 |
当向字节小程序后台请求完新版本信息,此函数被调用。 | |
当新版本下载完成,会进行回调。 | |
小程序冷启动后,如果有更新版本,客户端会触发新版本下载,当新版本下载失败(比如网络错误),会进行回调。 | |
当小程序新版本下载完成(即收到 onUpdateReady 回调)时,调用该方法会强制应用新版本并重启。 |
定时器
API | 描述 |
设置一个定时器,在一定延时后触发回调函数。 | |
清除一个定时器。 | |
设定一个定时器。按照指定的周期(以毫秒计)来执行注册的回调函数。 | |
清除一个定时器。 |
应用级事件
API | 描述 |
取消监听小程序进前台事件。 | |
取消监听小程序切后台事件。 | |
取 消监听未处理的 Promise 拒绝事件。 | |
取消监听小程序错误事件。 | |
监听小程序异步组件加载失败事件。 | |
移除小程序异步组件加载失败事件的监听函数。 | |
环境变量
API | 描述 |
获取小程序环境信息。 |
性能
API | 描述 |
创建全局性能事件监听器。 | |
设置当前缓冲区中可缓存的页面的性能数据的页面数,默认缓存 10 个页面的数据。 | |
该方法返回当前缓冲区中的所有性能数据。 | |
获取当前缓冲区中所有名称为 [name] 且类型为 [entryType] 的性能数据。 | |
获取当前缓冲区中所有类型为 [entryType] 的性能数据。 | |
获取当前缓冲区中当前页面的性能数据。 | |
获取当前缓冲区中页面路径为 [pagePath] 的性能数据。 | |
在性能缓冲区中使用给定名称添加一个 name 为 [name] 的性能数据。 | |
清空性能缓冲区中 name 为 [name] 的自定义性能数据。 | |
性能数据的实例。 |
线程
API | 描述 |
监听接收主线程/ Worker 线程向当前线程发送的消息,支持在主线程/Worker 线程内调用 | |
向主线程/ Worker 线程发送消息,支持在主线程/Worker 线程内调用。 | |
结束当前 Worker 线程,仅限在主线程 Worker 对象上调用。 |
窗口尺寸变化
API | 描述 |
监听窗口尺寸变化事件,仅 Andriod 支持。 | |
取消监听窗口尺寸变化事件,仅 Android 支持。 |
网络
API | 描述 |
中断请求任务。其中 RequestTask 是通过 tt.request() 返回的对象。 | |
下载文件资源到本地。 | |
中断上传任务。其中 UploadTask 是通过 tt.uploadFile() 返回的对象。 | |
监听上传进度变化事件,其中 UploadTask 是 tt.uploadFile() 返回的对象。 | |
取消监听上传进度变化事件,其中 UploadTask 是通过 tt.uploadFile() 返回的对象。 | |
中断下载任务。其中 DownloadTask 是通过 tt.downloadFile() 返回的对象。 | |
监听下载进度变化事件,其中 DownloadTask 是 tt.downloadFile() 返回的对象。 | |
取消监听下载进度变化事件,其中 DownloadTask 是通过 tt.downloadFile() 返回的对象。 | |
WebSocket 发送给服务端数据的方法。 | |
关闭 WebSocket 连接的方法。 | |
监听 WebSocket 连接服务器成功的事件。表示 WebSocket 的状态变成 open,可以发送数据给服务器。 | |
监听 WebSocket 与服务器连接断开的事件。 | |
监听 WebSocket 接收到服务器发送信息的事件。 | |
监听 WebSocket 发生错误的事件。 |
媒体
图片
API | 描述 |
保存图片到系统相册。 | |
预览一组图片。 | |
获取图片信息。 | |
压缩图片接口,可选压缩质量,并可以产出压缩后的图片到本地临时文件。仅对 jpg 格式图片有效。 |
录音
API | 描述 |
获取全局唯一的 recorderManager 。通过 recorderManager 进行录音操作和管理。该 api 多次调用时返回的是同一个实例,在多页面使用时,会操作到同一个上下文对象。 | |
暂停录音。 | |
继续录音。在调用暂停录音之后,可以调用 resume 继续录音,继续录音的内容会拼接到上一次暂停录音之后。 | |
停止录音。 | |
监听录音暂停事件。 | |
监听录音结束事件,成功时回调录音文件临时路径。 | |
监听录音开始事件。 | |
监听录音错误事件,录音出错时回调错误信息。 | |
监听录音继续事件。 | |
监听已录制完指定帧大小的文件事件。如果设置了 frameSize,则会回调此事件,不设置则没有此回调。 |
音频
| |
播放。 | |
暂停播放。 | |
停止播放。 | |
当前音频跳转到指定位置,并开始播放。 | |
监听音频进入可以播放状态,此时文件资源的元信息解析完成,但不保证后面可以流畅播放,具体可播放时机取决于播放器的实现。 | |
监听背景音频播放事件。 | |
监听音频暂停事件。 | |
监听音频停止事件。 | |
监听音频进度更新事件,回调执行时机为音频开始播放时,状态更新间隔约为 250ms,暂停或停止播放时音频进度也停止更新。 | |
监听音频播放错误事件。包括设置的属性类型不合法,API 调用过程中错误等。 | |
监听加载中事件,当音频因为数据不足,需要停下来加载时会触发,音频开始播放后需要停下来加载资源时也会触发,此时首先会暂停播放,待资源加载完成后继续播放。 | |
监听背景音频完成跳转操作事件。仅 Android 支持。 | |
监听用户在系统音乐播放面板点击下一曲事件(暂仅支持 iOS)。 | |
监听背景音频开始跳转操作事件。若存在多次添加监听,只触发最后一个监听事件的回调。仅 Android 支持。 | |
监听用户在系统音乐播放面板点击上一曲事件(暂仅支持 iOS)。 | |
取消监听 timeUpdate 事件。 | |
播放音频。 | |
暂停播放。暂停后再次播放时基于此状态继续播放。 | |
停止播放。停止后再次播放时从头开始播放。 | |
跳转到指定位置播放。 | |
销毁当前实例。销毁后该实例将不存在,如需播放需要再次创建。 | |
监听音频进入可以播放状态,但不保证后面可以流畅播放。 | |
监听音频播放事件。 | |
监听音频暂停事件。 | |
监听音频自然播放结束事件。 | |
监听音频进度更新事件。 | |
监听音频播放错误事件。 | |
监听音频加载中事件,当音频因为数据不足,需要停下来加载时会触发。 | |
监听音频停止播放事件。 |
视频
API | 描述 |
从系统相册中选择视频,或使用相机拍摄视频,返回视频的临时文件路径。 | |
保存视频到系统相册。 | |
创建视频预加载任务。预加载成功后的视频资源生效区间为整个小程序。 | |
中断视频预加载任务。预加载成功后执行该操作不生效。 | |
调用该 API 拍摄或从手机相册中选择图片或视频。 | |
播放视频。 | |
暂停视频。 | |
停止视频播放。 | |
进入全屏。 | |
视频点播。 | |
退出全屏。 | |
设置普通水印,目前仅抖音支持,展示的水印内容为抖音 id,水印会铺满整个视频容器。 | |
获取音量。 | |
设置音量。 | |
设置倍速播放。 |
相机
API | 描述 |
创建并返回 camera 上下文 CameraContext 对象。 | |
设置 Camera 缩放级别。 | |
拍摄照片。 | |
开始录像。 | |
结束录像。 | |
停止监听帧数据。 |
特效相机
API | 描述 |
设置数据源(相机)参数,并请求相机资源,用户授权后将占用相机资源。 | |
开启相机。 | |
监听相机开启事件成功事件,资源请求成功后触发。 | |
暂停相机的使用并停止更新数据,调用后若有其他数据流处理事件,则继续执行该处理逻辑到 stop 前的最后一帧(没有销毁底层相机图像缓冲区,只是不再更新数据)。 | |
取消监听相机暂停事件。 | |
关闭相机并释放相机资源。 | |
EffectCameraVideo 为特效相机返回数据类型。 |
Canvas 录制
API | 描述 |
开始录制。 | |
监听录制开始事件。 | |
监听录制结束事件。 | |
结束录制。真正结束录制写入文件完成后会触发注册的 MediaRecorder.onstop 回调。stop 后无法重新调用start 。 | |
暂停录制。 | |
恢复录制。 | |
监听 Canvas 录制器的错误事件。 | |
手动模式中主动录制当前 Canvas 上的当前画面到视频帧中,仅在手动模式中生效。 | |
销毁 Canvas 录制器并释放资源,建议在不使用录制器后及时调用本函数释放资源。 |
地图
API | 描述 |
获取地图视野范围。 | |
获取地图缩放值。 | |
将地图中心移动到定位点。地图能力基于 gcj02 坐标系,请注意入参的经纬度信息转换。 | |
获取地图的旋转角。 | |
缩放视野展示所有经纬度。 | |
获取当前地图的倾斜角。 | |
平移 marker,带动画。 | |
沿指定路径移动 marker,用于轨迹回放等场景。动画完成时触发回调事件,若动画进行中,对同一 marker 再次调用 moveAlong 方法,前一次的动画将被打断。 | |
用于将地图经纬度坐标系转换成屏幕坐标系。 | |
用于将屏幕坐标系转换成地图经纬度坐标系。 | |
设置定位点图标,支持网络路径、本地路径、代码包路径。 | |
拉起地图 APP 选择导航。 | |
创建自定义图片图层,图片会随着地图缩放而缩放。 | |
设置地图中心点偏移,未设置时默认偏移为 [0.5, 0.5]。 | |
更新自定义图片图层。 | |
移除自定义图片图层。 |
文件
API | 描述 |
保存临时文件到用户目录, 用户目录以 ttfile://user 开头。 | |
获取文件信息。 | |
获取该小程序下用户目录文件列表, 用户目录以 ttfile://user 开头。 | |
新开页面打开文档,支持格式:doc,docx,xls,xlsx,ppt,pptx,pdf。 | |
删除该小程序下用户目录内的文件, 用户目录以 ttfile://user 开头。 | |
获取全局唯一的文件管理器。 | |
判断文件/目录是否存在。 | |
判断文件/目录是否存在。 | |
在文件结尾追加内容,只有用户目录( ttfile://user )下的文件可以追加,文件不存在时会新建。 | |
在文件结尾追加内容,只有用户目录( ttfile://user )下的文件可以追加,文件不存在时会新建。 | |
同步复制文件。 | |
复制文件。 | |
获取临时目录(ttfile://temp) 或用户目录( ttfile://user )下的文件信息。 | |
获取该小程序下用户目录文件列表, 用户目录以 ttfile://user 开头。 | |
在用户目录下创建目录。 | |
在用户目录下创建目录。 | |
读取本地文件内容。 | |
读取本地文件内容。 | |
读取目录内文件列表。 | |
读取目录内文件列表。 | |
删除该小程序下用户目录内的文件, 用户目录以 ttfile://user 开头。 | |
重命名文件,可以把文件从 oldPath 移动到 newPath。 | |
重命名文件,可以把文件从 oldPath 移动到 newPath。 | |
删除目录, 开发者只能删除 用户目录( ttfile://user )下的目录。 | |
删除目录, 只能是 ttfile://user 下的目录。 | |
保存临时文件到用户目录, 用户目录以 ttfile://user 开头。 | |
保存临时文件到用户目录, 用户目录以 ttfile://user 开头。 | |
获取文件 Stat 对象。 | |
获取文件 Stat 对象。 | |
对文件内容进行截断操作,只有用户目录( ttfile://user )下的文件可以截断。 | |
对文件内容进行截断操作,只有用户目录( ttfile://user )下的文件可以截断。 | |
删除文件,只能删除 用户目录( ttfile://user )下的文件。 | |
删除文件,只能在 ttfile://user 开头的用户目录下操作。 | |
解压文件。 | |
写文件。 | |
写文件,只能写入用户目录( ttfile://user )。 | |
Stat | 描述文件状态的对象。 |
判断当前文件是否一个目录。 | |
判断当前文件是否一个普通文件。 |
开放接口
环境信息
API | 描述 |
获取小程序环境信息。 |
登录
API | 描述 |
调用该 API 可以获取用户临时的登录凭证。 | |
用户的登录态具有时效性,随着用户未使用小程序的时间增加,用户的登录态越容易失效;反之,则用户登录态可持续保持有效。使用该 API 可检查用户当前的 session 状态是否有效,登录态过期后开发者可以再调用 tt.login 获取新的用户登录态。 |
用户信息
API | 描述 |
获取用户的基本信息,只可在 tap 事件回调中调用,每次调用都会弹出授权提示窗,若用户同意,则会返回用户的真实数据。 |
广告
API | 描述 |