• JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 行业开放
  • 第三方平台
  • 其它
  • JS API 列表
    收藏
    我的收藏

    基础

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

    生命周期

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

    版本更新

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

    定时器

    API
    描述
    设置一个定时器,在一定延时后触发回调函数。
    清除一个定时器。
    设定一个定时器。按照指定的周期(以毫秒计)来执行注册的回调函数。
    清除一个定时器。

    应用级事件

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

    环境变量

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

    性能

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

    线程

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

    窗口尺寸变化

    API
    描述
    监听窗口尺寸变化事件,仅 Andriod 支持。
    取消监听窗口尺寸变化事件,仅 Android 支持。

    网络

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

    媒体

    图片

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

    录音

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

    音频

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

    视频

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

    相机

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

    特效相机

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

    Canvas 录制

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

    地图

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