JS API 列表

基础

TTML

网络

媒体

地图

文件

数据缓存

地理位置

设备

画布

界面

页面导航

开放接口

行业开放

第三方平台

其它

JS API 列表
收藏
我的收藏

基础

API	描述
tt.canIUse	判断小程序的 API、回调、参数、组件等是否在当前版本可用。
tt.base64ToArrayBuffer	将 base64 字符串转成 arraybuffer 对象。
tt.arrayBufferToBase64	将 arraybuffer 对象转成 base64 字符串。
tt.canIPutStuffOverComponent	小程序中的一些组件是由客户端实现的，如 video、ad 等。如果开发者希望通过 css 等途径往这些组件的上方放置一些其他组件，是需要小程序所在 App 具备一定能力才可以实现的。

生命周期


tt.getEnterOptionsSync	获取本次小程序启动时的参数。
tt.getLaunchOptionsSync	获取小程序冷启动时的参数，其值与 `App.onLaunch` 方法传入的参数一致，并且不会随着小程序使用而发生变化。
tt.exitMiniProgram	退出当前小程序到后台。

版本更新

API	描述
tt.getUpdateManager	获取全局唯一的版本更新管理器 updateManager 实例，用于管理小程序更新。关于小程序更新的原理，可以查看小程序运行机制。
UpdateManager	通过 tt.getUpdateManager 获取的小程序版本更新管理器对象。
UpdateManager.onCheckForUpdate	当向抖音小程序后台请求完新版本信息，此函数被调用。
UpdateManager.onUpdateReady	当新版本下载完成，会进行回调。
UpdateManager.onUpdateFailed	小程序冷启动后，如果有更新版本，客户端会触发新版本下载，当新版本下载失败（比如网络错误），会进行回调。
UpdateManager.applyUpdate	当小程序新版本下载完成（即收到 onUpdateReady 回调）时，调用该方法会强制应用新版本并重启。

定时器

API	描述
setTimeout	设置一个定时器，在一定延时后触发回调函数。
clearTimeout	清除一个定时器。
setInterval	设定一个定时器。按照指定的周期（以毫秒计）来执行注册的回调函数。
clearInterval	清除一个定时器。

应用级事件

API	描述
tt.onAppShow	监听小程序切前台事件，该事件回调参数与 App.onShow 一致。
tt.offAppShow	取消监听小程序进前台事件。
tt.onAppHide	监听小程序切后台事件，该事件回调参数与 App.onHide 一致。
tt.offAppHide	取消监听小程序切后台事件。
tt.offUnhandledRejection	取消监听未处理的 Promise 拒绝事件。
tt.onError	监听小程序错误事件，如脚本错误或 API 调用报错等。该事件与 App.onError 获取的小程序版本更新管理器对象。
tt.offError	取消监听小程序错误事件。
tt.onUnhandledRejection	监听未处理的 Promise 拒绝事件。该事件与 App.onUnhandledRejection 的回调时机与参数一致。
tt.onLazyLoadError	监听小程序异步组件加载失败事件。
tt.offLazyLoadError	移除小程序异步组件加载失败事件的监听函数。
tt.onAppLaunch	监听小程序启动事件。该事件与 App.onLaunch 的回调时机与参数一致。
tt.offAppLaunch	取消监听小程序启动事件。

环境变量

API	描述
tt.getEnvInfoSync	同步获取小程序环境信息。

性能

API	描述
tt.performance.createObserver	创建全局性能事件监听器。
tt.performance.setBufferSize	设置当前缓冲区中可缓存的页面的性能数据的页面数，默认缓存 10 个页面的数据。
tt.performance.getEntries	该方法返回当前缓冲区中的所有性能数据。
tt.performance.getEntriesByName	获取当前缓冲区中所有名称为 [name] 且类型为 [entryType] 的性能数据。
tt.performance.getEntriesByType	获取当前缓冲区中所有类型为 [entryType] 的性能数据。
tt.performance.getCurrentPageEntries	获取当前缓冲区中当前页面的性能数据。
tt.performance.getEntriesByPage	获取当前缓冲区中页面路径为 [pagePath] 的性能数据。
tt.performance.mark	在性能缓冲区中使用给定名称添加一个 name 为 [name] 的性能数据。
tt.performance.clearMarks	清空性能缓冲区中 name 为 [name] 的自定义性能数据。
PerformanceEntry	性能数据的实例。

线程

API	描述
tt.createWorker	创建一个 `Worker` 线程，目前限制最多只能创建一个 `Worker`，创建下一个 `Worker` 前请调用 Worker.terminate() 销毁当前 `Worker` 实例
Worker	通过在主线程调用 tt.createWorker 创建/`Worker` 线程内置的实例，可以实现主线程和 `Worker` 线程之间的通信。
Worker.onMessage	监听接收主线程/`Worker` 线程向当前线程发送的消息，支持在主线程/`Worker` 线程内调用
Worker.postMessage	向主线程/`Worker` 线程发送消息，支持在主线程/`Worker` 线程内调用。
Worker.terminate	结束当前 `Worker` 线程，仅限在主线程 `Worker` 对象上调用。

窗口尺寸变化

API	描述
tt.onWindowResize	监听窗口尺寸变化事件，仅 Andriod 支持。
tt.offWindowResize	取消监听窗口尺寸变化事件，仅 Android 支持。

网络

API	描述
RequestTask	通过 tt.request 获取的实例，能够控制网络请求任务。
RequestTask.abort	中断请求任务。其中 `RequestTask` 是通过 `tt.request()` 返回的对象。
tt.downloadFile	下载文件资源到本地。
tt.request	发起 HTTPS 网络请求。网络相关的 API 在使用前需要配置域名白名单。请参考网络请求。
UploadTask	通过 tt.uploadFile 获取的实例，能够控制网络上传任务。
UploadTask.abort	中断上传任务。其中 `UploadTask` 是通过 `tt.uploadFile()` 返回的对象。
UploadTask.onProgressUpdate	监听上传进度变化事件，其中 `UploadTask` 是 `tt.uploadFile()` 返回的对象。
UploadTask.offProgressUpdate	取消监听上传进度变化事件，其中 `UploadTask` 是通过 `tt.uploadFile()` 返回的对象。
DownloadTask	通过 tt.downloadFile 获取的实例，能够控制网络下载任务。
DownloadTask.abort	中断下载任务。其中 `DownloadTask` 是通过 `tt.downloadFile()` 返回的对象。
DownloadTask.onProgressUpdate	监听下载进度变化事件，其中 `DownloadTask` 是 `tt.downloadFile()` 返回的对象。
DownloadTask.offProgressUpdate	取消监听下载进度变化事件，其中 `DownloadTask` 是通过 `tt.downloadFile()` 返回的对象。
tt.uploadFile	将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求，其中 `content-type` 为 `multipart/form-data`。网络相关的 API 在使用前需要配置域名白名单。请参考网络请求。
tt.connectSocket	创建一个 WebSocket 连接实例，并通过返回的 socketTask 操作该连接。网络相关的 API 在使用前需要配置域名白名单。请参考网络请求。
SocketTask	通过 tt.connectSocket 获取的 WebSocket 任务实例。
SocketTask.send	WebSocket 发送给服务端数据的方法。
SocketTask.close	关闭 WebSocket 连接的方法。
SocketTask.onOpen	监听 WebSocket 连接服务器成功的事件。表示 WebSocket 的状态变成 open，可以发送数据给服务器。
SocketTask.onClose	监听 WebSocket 与服务器连接断开的事件。
SocketTask.onMessage	监听 WebSocket 接收到服务器发送信息的事件。
SocketTask.onError	监听 WebSocket 发生错误的事件。

媒体

图片

API	描述
tt.chooseImage	从系统相册中选择图片，或使用相机拍摄图片，选取成功后将存入本地临时文件，并在 success 回调中返回相应路径列表。该 API 需要用户授权方可调用，详细信息可参考用户授权。
tt.saveImageToPhotosAlbum	保存图片到系统相册。
tt.previewImage	预览一组图片。
tt.getImageInfo	获取图片信息。
tt.compressImage	压缩图片接口，可选压缩质量，并可以产出压缩后的图片到本地临时文件。仅对 jpg 格式图片有效。

录音

API	描述
tt.getRecorderManager	获取全局唯一的 `recorderManager`。通过 `recorderManager` 进行录音操作和管理。该 api 多次调用时返回的是同一个实例，在多页面使用时，会操作到同一个上下文对象。
RecorderManager	通过 tt.getRecorderManager 获取的全局唯一的录音管理器。
RecorderManager.pause	暂停录音。
RecorderManager.start	开始录音。该方法需要用户授权方可调用，详细信息可参考用户授权。
RecorderManager.resume	继续录音。在调用暂停录音之后，可以调用 resume 继续录音，继续录音的内容会拼接到上一次暂停录音之后。
RecorderManager.stop	停止录音。
RecorderManager.onPause	监听录音暂停事件。
RecorderManager.onStop	监听录音结束事件，成功时回调录音文件临时路径。
RecorderManager.onStart	监听录音开始事件。
RecorderManager.onError	监听录音错误事件，录音出错时回调错误信息。
RecorderManager.onResume	监听录音继续事件。
RecorderManager.onFrameRecorded	监听已录制完指定帧大小的文件事件。如果设置了 frameSize，则会回调此事件，不设置则没有此回调。

音频

API	描述
tt.getBackgroundAudioManager	获取全局唯一的背景音频管理器 BackgroundAudioManager。
BackgroundAudioManager	BackgroundAudioManager 实例。可通过 tt.getBackgroundAudioManager 接口获取，通过它能够操作背景音频播放。
BackgroundAudioManager.play	播放。
BackgroundAudioManager.pause	暂停播放。
BackgroundAudioManager.stop	停止播放。
BackgroundAudioManager.seek	当前音频跳转到指定位置，并开始播放。
BackgroundAudioManager.onCanplay	监听音频进入可以播放状态，此时文件资源的元信息解析完成，但不保证后面可以流畅播放，具体可播放时机取决于播放器的实现。
BackgroundAudioManager.onPlay	监听背景音频播放事件。
BackgroundAudioManager.onPause	监听音频暂停事件。
BackgroundAudioManager.onStop	监听音频停止事件。
BackgroundAudioManager.onEnded	监听音频停止事件。触发时机：调用 seek 跳转到音频结尾，或自动播放结束。
BackgroundAudioManager.onTimeUpdate	监听音频进度更新事件，回调执行时机为音频开始播放时，状态更新间隔约为 250ms，暂停或停止播放时音频进度也停止更新。
BackgroundAudioManager.onError	监听音频播放错误事件。包括设置的属性类型不合法，API 调用过程中错误等。
BackgroundAudioManager.onWaiting	监听加载中事件，当音频因为数据不足，需要停下来加载时会触发，音频开始播放后需要停下来加载资源时也会触发，此时首先会暂停播放，待资源加载完成后继续播放。
BackgroundAudioManager.onSeeked	监听背景音频完成跳转操作事件。仅 Android 支持。
BackgroundAudioManager.onNext	监听用户在系统音乐播放面板点击下一曲事件（暂仅支持 iOS）。
BackgroundAudioManager.onSeeking	监听背景音频开始跳转操作事件。若存在多次添加监听，只触发最后一个监听事件的回调。仅 Android 支持。
BackgroundAudioManager.onPrev	监听用户在系统音乐播放面板点击上一曲事件（暂仅支持 iOS）。
BackgroundAudioManager.offTimeUpdate	取消监听 `timeUpdate` 事件。
tt.createInnerAudioContext	创建并返回内部 audio 上下文 innerAudioContext 实例，通过它能够操作音频播放。
InnerAudioContext	通过 tt.createInnerAudioContext 获取的实例，通过它能够操作音频播放。
InnerAudioContext.play	播放音频。
InnerAudioContext.pause	暂停播放。暂停后再次播放时基于此状态继续播放。
InnerAudioContext.stop	停止播放。停止后再次播放时从头开始播放。
InnerAudioContext.seek	跳转到指定位置播放。
InnerAudioContext.destroy	销毁当前实例。销毁后该实例将不存在，如需播放需要再次创建。
InnerAudioContext.onCanplay	监听音频进入可以播放状态，但不保证后面可以流畅播放。
InnerAudioContext.offCanplay	取消 InnerAudioContext.onCanplay 监听的事件。
InnerAudioContext.onPlay	监听音频播放事件。
InnerAudioContext.onPause	监听音频暂停事件。
InnerAudioContext.onEnded	监听音频自然播放结束事件。
InnerAudioContext.onTimeUpdate	监听音频进度更新事件。
InnerAudioContext.onError	监听音频播放错误事件。
InnerAudioContext.onWaiting	监听音频加载中事件，当音频因为数据不足，需要停下来加载时会触发。
InnerAudioContext.onSeeking	监听音频开始进行 seek 操作的事件。
InnerAudioContext.onSeeked	监听音频完成 seek 操作的事件。
InnerAudioContext.offPlay	取消 InnerAudioContext.onPlay 监听的事件。
InnerAudioContext.offPause	取消 InnerAudioContext.onPause 监听的事件。
InnerAudioContext.offStop	取消 InnerAudioContext.onStop 监听的事件。
InnerAudioContext.offEnded	取消 InnerAudioContext.onEnded 监听的事件。
InnerAudioContext.offTimeUpdate	取消 InnerAudioContext.onTimeUpdate 监听的事件。
InnerAudioContext.offError	取消 InnerAudioContext.onError 监听的事件。
InnerAudioContext.offWaiting	取消 InnerAudioContext.onWaiting 监听的事件。
InnerAudioContext. offSeeking	取消 InnerAudioContext.onSeeking 监听的事件。
InnerAudioContext.offSeeked	取消 InnerAudioContext.onSeeked 监听的事件。
InnerAudioContext.onStop	监听音频停止播放事件。

视频

API	描述
tt.chooseVideo	从系统相册中选择视频，或使用相机拍摄视频，返回视频的临时文件路径。
tt.saveVideoToPhotosAlbum	保存视频到系统相册。
tt.preloadVideo	创建视频预加载任务。预加载成功后的视频资源生效区间为整个小程序。
PreloadVideoTask	通过 tt.preloadVideo 实例，通过它能够操作音频播放。
PreloadVideoTask.abort	中断视频预加载任务。预加载成功后执行该操作不生效。
tt.chooseMedia	调用该 API 拍摄或从手机相册中选择图片或视频。
tt.createVideoContext	根据组件 ID 创建可以控制组件的上下文 VideoContext 对象。
VideoContext.play	播放视频。
VideoContext.pause	暂停视频。
VideoContext.stop	停止视频播放。
VideoContext.requestFullScreen	进入全屏。
VideoContext.seek	视频点播。
VideoContext.exitFullScreen	退出全屏。
VideoContext.setWaterMark	设置普通水印，目前仅抖音支持，展示的水印内容为抖音 id，水印会铺满整个视频容器。
VideoContext.getMediaVolume	获取音量。
VideoContext.setMediaVolume	设置音量。
VideoContext.playbackRate	设置倍速播放。

相机

API	描述
tt.createCameraContext	创建并返回 camera 上下文 CameraContext 对象。
CameraContext.onCameraFrame	获取 Camera 实时帧数据，返回监听器 CameraFrameListener。
CameraContext.setZoom	设置 Camera 缩放级别。
CameraContext.takePhoto	拍摄照片。
CameraContext.startRecord	开始录像。
CameraContext.stopRecord	结束录像。
CameraFrameListener	CameraContext.onCameraFrame() 返回的监听器。
CameraFrameListener.start	开始监听帧数据。开始监听后，CameraContext.onCameraFrame 回调中开始接收帧数据。
CameraFrameListener.stop	停止监听帧数据。

特效相机

API	描述
tt.createEffectCameraStream	创建并返回特效相机数据流实例 EffectCameraStream，通过该对象的 API 可操作相机数据的开始、暂停、绘制等能力。同步 API。
EffectCameraStream	`EffectCameraStream` 实例。可通过 tt.createEffectCameraStream 接口获取，后续可通过它调用特效相机相关能力，当前仅提供相机基本能力。
EffectCameraStream.request	设置数据源（相机）参数，并请求相机资源，用户授权后将占用相机资源。
EffectCameraStream.onRequest	监听相机资源请求成功事件，资源请求成功后触发，可通过 EffectCameraStream.offRequest 取消监听。
EffectCameraStream.offRequest	取消监听相机资源请求事件，取消后 EffectCameraStream.onRequest 的回调参数将不被触发。
EffectCameraStream.play	开启相机。
EffectCameraStream.onPlay	监听相机开启事件成功事件，资源请求成功后触发。
EffectCameraStream.offPlay	取消监听相机开启事件，取消后 EffectCameraStream.onPlay 中的回调参数将不被触发。
EffectCameraStream.stop	暂停相机的使用并停止更新数据，调用后若有其他数据流处理事件，则继续执行该处理逻辑到 stop 前的最后一帧（没有销毁底层相机图像缓冲区，只是不再更新数据）。
EffectCameraStream.onStop	监听相机暂停事件 EffectCameraStream.stop 成功事件。
EffectCameraStream.offStop	取消监听相机暂停事件。
EffectCameraStream.paintTo	将相机数据绘制到指定的 canvas 画布区域（仅适用于 canvas V2）。
EffectCameraStream.onError	监听 EffectCameraStream 生命周期中的业务错误，包括 request、 play、stop。
EffectCameraStream.offError	取消对 EffectCameraStream 生命周期错误事件的监听，包括 request、 play、stop。
EffectCameraStream.dispose	关闭相机并释放相机资源。
EffectCameraVideo	EffectCameraVideo 为特效相机返回数据类型。

Canvas 录制

API	描述
tt.createMediaRecorder	小程序中的 Canvas 录制器 MediaRecorder 可以录制 Canvas（v2）上绘制的所有画面，可以精确的控制录制的开始暂停，并且在录制结束时会自动导出 mp4 视频文件。
MediaRecorder	通过 tt.createMediaRecorder 获取的实例。
MediaRecorder.start	开始录制。
MediaRecorder.onStart	监听录制开始事件。
MediaRecorder.onStop	监听录制结束事件。
MediaRecorder.stop	结束录制。真正结束录制写入文件完成后会触发注册的`MediaRecorder.onstop`回调。`stop`后无法重新调用`start`。
MediaRecorder.pause	暂停录制。
MediaRecorder.resume	恢复录制。
MediaRecorder.onError	监听 Canvas 录制器的错误事件。
MediaRecorder.requestFrame	手动模式中主动录制当前 Canvas 上的当前画面到视频帧中，仅在手动模式中生效。
MediaRecorder.destroy	销毁 Canvas 录制器并释放资源，建议在不使用录制器后及时调用本函数释放资源。

地图

API	描述
tt.createMapContext	创建组件上下文 MapContext 对象。
MapContext	通过 tt.createMapContext 获取的实例，通过它能够操作地图。
MapContext.getCenterLocation	获取当前地图中心的经纬度，返回的是 `gcj02` 坐标系，可以用于 tt.openLocation()。
MapContext.getRegion	获取地图视野范围。
MapContext.getScale	获取地图缩放值。
MapContext.moveToLocation	将地图中心移动到定位点。地图能力基于 `gcj02` 坐标系，请注意入参的经纬度信息转换。
MapContext.getRotate	获取地图的旋转角。
MapContext.includePoints	缩放视野展示所有经纬度。
MapContext.getSkew	获取当前地图的倾斜角。
MapContext.translateMarker	平移 marker，带动画。
MapContext.moveAlong	沿指定路径移动 marker，用于轨迹回放等场景。动画完成时触发回调事件，若动画进行中，对同一 marker 再次调用 moveAlong 方法，前一次的动画将被打断。
MapContext.mapToScreen	用于将地图经纬度坐标系转换成屏幕坐标系。
MapContext.screenToMap	用于将屏幕坐标系转换成地图经纬度坐标系。
MapContext.setLocMarkerIcon	设置定位点图标，支持网络路径、本地路径、代码包路径。
MapContext.openMapApp

JS API 列表收藏我的收藏

基础

生命周期

版本更新

定时器

应用级事件

环境变量

性能

线程

窗口尺寸变化

网络

媒体

图片

录音

音频

视频

相机

特效相机

Canvas 录制

地图

JS API 列表
收藏
我的收藏