抖音开放平台Logo
开发者文档
小游戏
控制台
  • API 概览
  • 开放能力
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker

    • API 概览

    收藏
    我的收藏
    ​开放能力​
    ​登录​
    tt.login​
    ​
    tt.checkSession​
    ​
    社交转发裂变​
    分享介绍总览​
    ​
    用户信息及授权​
    用户信息​
    tt.getUserInfo​
    ​
    ​
    authenticateRealName​
    ​
    ​
    实名认证完成​
    ​
    ​
    敏感数据处理​
    ​
    设置​
    tt.getSetting​
    ​
    ​
    tt.openSetting​
    ​
    ​
    AuthSetting​
    ​
    授权​
    用户授权​
    ​
    ​
    tt.authorize​
    ​
    ​
    tt.showDouyinOpenAuth​
    小游戏收藏​
    收藏​
    tt.showFavoriteGuide​
    ​
    ​
    tt.onFavoriteStateChange​
    群聊​
    游戏群聊能力接入介绍​
    ​
    ​
    tt.joinGroup​
    ​
    ​
    tt.checkGroupInfo​
    ​
    关注​
    游戏内关注抖音号​
    关注抖音号能力介绍​
    ​
    ​
    tt.checkFollowAwemeState​
    ​
    ​
    tt.openAwemeUserProfile​
    ​
    关注头条号​
    tt.createFollowButton​
    ​
    FollowButton​
    FollowButton​
    ​
    ​
    FollowButton.onTap​
    ​
    ​
    FollowButton.offTap​
    ​
    ​
    FollowButton.destroy​
    ​
    ​
    FollowButton.show​
    ​
    ​
    FollowButton.hide​
    ​
    ​
    tt.checkFollowState​
    游戏互推组件​
    游戏推荐组件能力介绍​
    ​
    ​
    tt.createGridGamePanel​
    ​
    ​
    GridGamePanel​
    GridGamePanel​
    ​
    ​
    GridGamePanel.show​
    ​
    ​
    GridGamePanel.hide​
    ​
    ​
    GridGamePanel.onStateChange​
    ​
    ​
    GridGamePanel.offStateChange​
    ​
    ​
    GridGamePanel.destroy​
    添加到桌面​
    tt.addShortcut​
    ​
    ​
    tt.checkShortcut​
    ​
    游戏排行榜​
    游戏排行榜功能介绍​
    ​
    ​
    tt.setImRankData​
    ​
    ​
    tt.getImRankList​
    ​
    ​
    tt.getImRankData​
    ​
    ​
    tt.setImRankDataInOpenContext​
    ​
    数据分析​
    tt.reportAnalytics​
    ​
    视频拍摄器​
    调起方法​
    ​
    订阅消息​
    订阅消息能力介绍​
    ​
    ​
    tt.requestSubscribeMessage​
    ​
    关系链​
    开放数据域基础能力​
    ​
    ​
    开放数据域​
    tt.getOpenDataContext​
    ​
    ​
    tt.onMessage​
    ​
    开放数据​
    tt.getCloudStorageByRelation​
    ​
    ​
    tt.setUserCloudStorage​
    ​
    ​
    tt.getUserCloudStorage​
    ​
    ​
    tt.removeUserCloudStorage​
    ​
    ​
    tt.getSharedCanvas​
    ​
    ​
    KVData​
    ​
    开放数据分组​
    数据分组实现游戏排行​
    ​
    ​
    tt.setUserGroup​
    客服能力​
    tt.openCustomerServiceConversation​
    ​
    ​
    tt.createContactButton​
    ​
    ​
    ContactButton​
    ​
    推荐流直出游戏能力​
    tt.requestFeedSubscribe​
    ​
    ​
    tt.checkFeedSubscribeStatus​
    ​
    ​基础​
    tt.canIUse​
    ​
    ​
    ​
    ​更新​
    tt.getUpdateManager​
    ​
    ​
    ​
    UpdateManager​
    UpdateManager​
    ​
    ​
    UpdateManager.onCheckForUpdate​
    ​
    ​
    UpdateManager.onUpdateReady​
    ​
    ​
    UpdateManager.onUpdateFailed​
    ​
    ​
    UpdateManager.applyUpdate​
    ​
    ​分包加载​
    tt.loadSubpackage​
    ​
    ​
    ​
    LoadSubpackageTask​
    ​
    ​
    性能​
    tt.getPerformance​
    ​
    ​
    ​
    tt.onMemoryWarning​
    ​
    ​
    ​
    tt.triggerGC​
    ​
    渲染​
    字体​
    ​tt.loadFont​
    ​
    ​
    帧率​
    ​tt.setPreferredFramesPerSecond​
    ​
    ​
    ​
    ​requestAnimationFrame​
    ​
    ​
    ​
    ​cancelAnimationFrame​
    ​
    ​
    图片​
    tt.createCanvas​
    ​
    ​
    ​
    Canvas.getContext​
    ​
    ​
    ​
    Canvas.toTempFilePath​
    ​
    ​
    资源压缩​
    tt.createBuffer​
    ​
    ​
    ​
    tt.inflate​
    ​
    设备​
    加速度计​
    ​tt.startAccelerometer​
    ​
    ​
    ​
    tt.stopAccelerometer​
    ​
    ​
    ​
    tt.onAccelerometerChange​
    ​
    ​
    ​
    tt.offAccelerometerChange​
    ​
    ​
    剪贴板​
    tt.getClipboardData​
    ​
    ​
    ​
    tt.setClipboardData​
    ​
    ​
    罗盘​
    tt.startCompass​
    ​
    ​
    ​
    tt.stopCompass​
    ​
    ​
    ​
    tt.onCompassChange​
    ​
    ​
    ​
    tt.offCompassChange​
    ​
    ​
    网络​
    tt.getNetworkType​
    ​
    ​
    ​
    tt.onNetworkStatusChange​
    ​
    ​
    ​
    tt.offNetworkStatusChange​
    ​
    ​
    屏幕亮度​
    tt.setKeepScreenOn​
    ​
    ​
    ​
    tt.getScreenBrightness​
    ​
    ​
    ​
    tt.setScreenBrightness​
    ​
    ​
    振动​
    tt.vibrateLong​
    ​
    ​
    ​
    tt.vibrateShort​
    ​
    ​
    扫码​
    tt.scanCode​
    ​
    ​
    陀螺仪​
    tt.startGyroscope​
    ​
    ​
    ​
    tt.stopGyroscope​
    ​
    ​
    ​
    tt.onGyroscopeChange​
    ​
    ​
    ​
    tt.offGyroscopeChange​
    ​
    ​
    日历​
    tt.addPhoneCalendar​
    ​
    文件​
    tt.getFileSystemManager​
    ​
    ​
    ​
    FileSystemManager​
    FileSystemManager​
    ​
    ​
    ​
    FileSystemManager.access​
    ​
    ​
    ​
    FileSystemManager.accessSync​
    ​
    ​
    ​
    FileSystemManager.saveFile​
    ​
    ​
    ​
    FileSystemManager.saveFileSync​
    ​
    ​
    ​
    FileSystemManager.getSavedFileList​
    ​
    ​
    ​
    FileSystemManager.removeSavedFile​
    ​
    ​
    ​
    FileSystemManager.copyFile​
    ​
    ​
    ​
    FileSystemManager.copyFileSync​
    ​
    ​
    ​
    FileSystemManager.getFileInfo​
    ​
    ​
    ​
    FileSystemManager.mkdir​
    ​
    ​
    ​
    FileSystemManager.mkdirSync​
    ​
    ​
    ​
    FileSystemManager.readdir​
    ​
    ​
    ​
    FileSystemManager.readdirSync​
    ​
    ​
    ​
    FileSystemManager.readFile​
    ​
    ​
    ​
    FileSystemManager.readFileSync​
    ​
    ​
    ​
    FileSystemManager.rename​
    ​
    ​
    ​
    FileSystemManager.renameSync​
    ​
    ​
    ​
    FileSystemManager.rmdir​
    ​
    ​
    ​
    FileSystemManager.rmdirSync​
    ​
    ​
    ​
    FileSystemManager.stat​
    ​
    ​
    ​
    FileSystemManager.statSync​
    ​
    ​
    ​
    FileSystemManager.unlink​
    ​
    ​
    ​
    FileSystemManager.unlinkSync​
    ​
    ​
    ​
    FileSystemManager.readZipEntry​
    ​
    ​
    ​
    FileSystemManager.unzip​
    ​
    ​
    ​
    FileSystemManager.writeFile​
    ​
    ​
    ​
    FileSystemManager.writeFileSync​
    ​
    ​
    Stats​
    Stats​
    ​
    ​
    ​
    Stats.isDirectory​
    ​
    ​
    ​
    Stats.isFile​
    ​
    位置​
    tt.getLocation​
    ​
    ​
    媒体​
    音频​
    tt.addAudioTrack​
    ​
    ​
    ​
    tt.createInnerAudioContext​
    ​
    ​
    ​
    tt.getAudioContext​
    ​
    ​
    InnerAudioContext​
    InnerAudioContext​
    ​
    ​
    ​
    InnerAudioContext.play​
    ​
    ​
    ​
    InnerAudioContext.seek​
    ​
    ​
    ​
    InnerAudioContext.pause​
    ​
    ​
    ​
    InnerAudioContext.stop​
    ​
    ​
    ​
    InnerAudioContext.destroy​
    ​
    ​
    ​
    InnerAudioContext.onCanplay​
    ​
    ​
    ​
    InnerAudioContext.onPlay​
    ​
    ​
    ​
    InnerAudioContext.onSeeking​
    ​
    ​
    ​
    InnerAudioContext.onSeeked​
    ​
    ​
    ​
    InnerAudioContext.onPause​
    ​
    ​
    ​
    InnerAudioContext.onStop​
    ​
    ​
    ​
    InnerAudioContext.onEnded​
    ​
    ​
    ​
    InnerAudioContext.onError​
    ​
    ​
    ​
    InnerAudioContext.onWaiting​
    ​
    ​
    ​
    InnerAudioContext.onTimeUpdate​
    ​
    ​
    ​
    InnerAudioContext.offCanplay​
    ​
    ​
    ​
    InnerAudioContext.offPlay​
    ​
    ​
    ​
    InnerAudioContext.offSeeking​
    ​
    ​
    ​
    InnerAudioContext.offSeeked​
    ​
    ​
    ​
    InnerAudioContext.offPause​
    ​
    ​
    ​
    InnerAudioContext.offStop​
    ​
    ​
    ​
    InnerAudioContext.offEnded​
    ​
    ​
    ​
    InnerAudioContext.offError​
    ​
    ​
    ​
    InnerAudioContext.offWaiting​
    ​
    ​
    ​
    InnerAudioContext.offTimeUpdate​
    ​
    ​
    AudioContext​
    AudioContext​
    ​
    ​
    ​
    AudioContext.createAudio​
    ​
    ​
    ​
    AudioContext.createBuffer​
    ​
    ​
    ​
    AudioContext.createBufferSource​
    ​
    ​
    ​
    AudioContext.createMediaElementSource​
    ​
    ​
    ​
    AudioContext.createMediaStreamSource​
    ​
    ​
    ​
    AudioContext.createAnalyser​
    ​
    ​
    ​
    AudioContext.createGain​
    ​
    ​
    ​
    AudioContext.createReverb​
    ​
    ​
    ​
    AudioContext.createEqualizer​
    ​
    ​
    ​
    AudioContext.createDelay​
    ​
    ​
    ​
    AudioContext.createF0Detection​
    ​
    ​
    ​
    AudioContext.createVolumeDetection​
    ​
    ​
    ​
    AudioContext.createOscillator​
    ​
    ​
    ​
    AudioContext.createFading​
    ​
    ​
    ​
    AudioContext.createStreamFileWriter​
    ​
    ​
    ​
    AudioContext.createFastForward​
    ​
    ​
    ​
    AudioContext.decodeAudioData​
    ​
    ​
    ​
    Audio​
    ​
    ​
    ​
    AudioNode​
    ​
    ​
    ​
    AudioBuffer​
    ​
    ​
    ​
    AudioBufferSourceNode​
    ​
    ​
    ​
    AudioParam​
    ​
    ​
    ​
    MediaElementAudioSourceNode​
    ​
    ​
    ​
    MediaStreamAudioSourceNode​
    ​
    ​
    ​
    AnalyserNode​
    ​
    ​
    ​
    GainNode​
    ​
    ​
    ​
    ReverbNode​
    ​
    ​
    ​
    EqualizerNode​
    ​
    ​
    ​
    DelayNode​
    ​
    ​
    ​
    F0DetectionNode​
    ​
    ​
    ​
    VolumeDetectionNode​
    ​
    ​
    ​
    OscillatorNode​
    ​
    ​
    ​
    FadingNode​
    ​
    ​
    ​
    StreamFileWriterNode​
    ​
    ​
    ​
    FastForwardNode​
    ​
    ​
    图片​
    ImageFile​
    ​
    ​
    ​
    tt.chooseImage​
    ​
    ​
    ​
    tt.previewImage​
    ​
    ​
    ​
    tt.saveImageToPhotosAlbum​
    ​
    ​
    ​
    tt.getImageInfo​
    ​
    ​
    麦克风​
    tt.requestMicrophone​
    ​
    ​
    ​
    tt.pauseMicrophone​
    ​
    ​
    ​
    tt.resumeMicrophone​
    ​
    ​
    录屏​
    tt.getGameRecorderManager​
    ​
    ​
    GameRecorderManager​
    GameRecorderManager​
    ​
    ​
    ​
    GameRecorderManager.start​
    ​
    ​
    ​
    GameRecorderManager.onStart​
    ​
    ​
    ​
    GameRecorderManager.recordClip​
    ​
    ​
    ​
    GameRecorderManager.clipVideo​
    ​
    ​
    ​
    GameRecorderManager.pause​
    ​
    ​
    ​
    GameRecorderManager.onPause​
    ​
    ​
    ​
    GameRecorderManager.resume​
    ​
    ​
    ​
    GameRecorderManager.onResume​
    ​
    ​
    ​
    GameRecorderManager.stop​
    ​
    ​
    ​
    GameRecorderManager.onStop​
    ​
    ​
    ​
    GameRecorderManager.onError​
    ​
    ​
    ​
    GameRecorderManager.onInterruptionBegin​
    ​
    ​
    ​
    GameRecorderManager.onInterruptionEnd​
    ​
    ​
    ​
    getMark​
    ​
    ​
    相机​
    tt.createCamera​
    ​
    ​
    ​
    Camera​
    ​
    ​
    ​
    Camera.start​
    ​
    ​
    ​
    Camera.pause​
    ​
    ​
    ​
    Camera.resume​
    ​
    ​
    ​
    Camera.setBeautifyParam​
    ​
    ​
    ​
    Camera.destroy​
    ​
    ​
    录音​
    RecorderManager​
    RecorderManager​
    ​
    ​
    ​
    RecorderManager.start​
    ​
    ​
    ​
    RecorderManager.pause​
    ​
    ​
    ​
    RecorderManager.resume​
    ​
    ​
    ​
    RecorderManager.stop​
    ​
    ​
    ​
    RecorderManager.onStart​
    ​
    ​
    ​
    RecorderManager.onPause​
    ​
    ​
    ​
    RecorderManager.onResume​
    ​
    ​
    ​
    RecorderManager.onStop​
    ​
    ​
    ​
    RecorderManager.onError​
    ​
    ​
    ​
    RecorderManager.onFrameRecorded​
    ​
    ​
    tt.getRecorderManager​
    ​
    ​
    视频​
    tt.chooseVideo​
    ​
    ​
    ​
    tt.createVideo​
    ​
    ​
    ​
    tt.createOffscreenVideo​
    ​
    ​
    ​
    tt.saveVideoToPhotosAlbum​
    ​
    ​
    ​
    tt.mergeVideo​
    ​
    ​
    ​
    Video​
    ​
    ​
    人脸检测​
    tt.createFaceDetector​
    ​
    ​
    ​
    Detector​
    ​
    ​
    ​
    DetectData​
    ​
    ​
    手势识别​
    tt.createHandDetector​
    ​
    ​
    ​
    Detector​
    ​
    ​
    ​
    HandInfo​
    ​
    ​
    ​
    手势说明​
    ​
    网络​
    下载​
    DownloadTask​
    ​
    ​
    ​
    tt.downloadFile​
    ​
    ​
    发起请求​
    RequestTask.abort​
    ​
    ​
    ​
    RequestTask​
    ​
    ​
    ​
    tt.request​
    ​
    ​
    上传​
    tt.uploadFile​
    ​
    ​
    ​
    UploadTask​
    ​
    ​
    Websocket​
    SoketTask​
    SocketTask​
    ​
    ​
    ​
    SocketTask.send​
    ​
    ​
    ​
    SocketTask.close​
    ​
    ​
    ​
    SocketTask.onOpen​
    ​
    ​
    ​
    SocketTask.onClose​
    ​
    ​
    ​
    SocketTask.onError​
    ​
    ​
    ​
    SocketTask.onMessage​
    ​
    ​
    tt.connectSocket​
    ​
    游戏转发分享​
    分享逻辑​
    ​
    ​
    ​
    ShareParam​
    ​
    ​
    ​
    tt.shareAppMessage​
    ​
    ​
    ​
    tt.showShareMenu​
    ​
    ​
    ​
    视频拍摄器​
    ​
    ​
    ​
    剪映模版​
    ​
    ​
    ​
    tt.hideShareMenu​
    ​
    ​
    ​
    tt.onShareAppMessage​
    ​
    ​
    ​
    tt.offShareAppMessage​
    ​
    ​
    ​
    tt.navigateToVideoView​
    ​
    ​
    实时语音​
    RTC实时语音文档介绍​
    ​
    ​
    数据缓存​
    本地数据缓存​
    ​
    ​
    ​
    tt.clearStorage​
    ​
    ​
    ​
    tt.clearStorageSync​
    ​
    ​
    ​
    tt.getStorage​
    ​
    ​
    ​
    tt.getStorageSync​
    ​
    ​
    ​
    tt.getStorageInfo​
    ​
    ​
    ​
    tt.getStorageInfoSync​
    ​
    ​
    ​
    tt.removeStorage​
    ​
    ​
    ​
    tt.removeStorageSync​
    ​
    ​
    ​
    tt.setStorage​
    ​
    ​
    ​
    tt.setStorageSync​
    ​
    ​
    系统​
    生命周期​
    tt.restartMiniProgramSync​
    ​
    ​
    ​
    tt.exitMiniProgram​
    ​
    ​
    ​
    tt.getLaunchOptionsSync​
    ​
    ​
    ​
    tt.onShow​
    ​
    ​
    ​
    tt.onHide​
    ​
    ​
    ​
    tt.offShow​
    ​
    ​
    ​
    tt.offHide​
    ​
    ​
    系统信息​
    tt.getSystemInfoSync​
    ​
    ​
    ​
    tt.getEnvInfoSync​
    ​
    ​
    ​
    tt.getSystemInfo​
    ​
    ​
    触摸事件​
    Touch​
    ​
    ​
    ​
    tt.onTouchStart​
    ​
    ​
    ​
    tt.onTouchMove​
    ​
    ​
    ​
    tt.onTouchEnd​
    ​
    ​
    ​
    tt.onTouchCancel​
    ​
    ​
    ​
    tt.offTouchStart​
    ​
    ​
    ​
    tt.offTouchMove​
    ​
    ​
    ​
    tt.offTouchEnd​
    ​
    ​
    ​
    tt.offTouchCancel​
    ​
    ​
    应用级事件​
    tt.onError​
    ​
    ​
    ​
    tt.offError​
    ​
    ​
    clearTimeout​
    ​
    ​
    ​
    clearInterval​
    ​
    ​
    广告​
    商业化激励再得能力介绍​
    ​
    ​
    ​
    tt.createBannerAd​
    ​
    ​
    ​
    tt.createRewardedVideoAd​
    ​
    ​
    ​
    tt.createInterstitialAd​
    ​
    ​
    ​
    BannerAd​
    BannerAd​
    ​
    ​
    ​
    BannerAd.hide​
    ​
    ​
    ​
    BannerAd.show​
    ​
    ​
    ​
    BannerAd.onLoad​
    ​
    ​
    ​
    BannerAd.offLoad​
    ​
    ​
    ​
    BannerAd.onError​
    ​
    ​
    ​
    BannerAd.offError​
    ​
    ​
    ​
    BannerAd.onResize​
    ​
    ​
    ​
    BannerAd.offResize​
    ​
    ​
    ​
    BannerAd.destroy​
    ​
    ​
    RewardedVideoAd​
    RewardedVideoAd​
    ​
    ​
    ​
    RewardedVideoAd.show​
    ​
    ​
    ​
    RewardedVideoAd.onLoad​
    ​
    ​
    ​
    RewardedVideoAd.offLoad​
    ​
    ​
    ​
    RewardedVideoAd.load​
    ​
    ​
    ​
    RewardedVideoAd.onError​
    ​
    ​
    ​
    RewardedVideoAd.offError​
    ​
    ​
    ​
    RewardedVideoAd.onClose​
    ​
    ​
    ​
    RewardedVideoAd.offClose​
    ​
    ​
    ​
    RewardedVideoAd.destroy​
    ​
    ​
    ​
    激励视频广告注意​
    ​
    ​
    InterstitialAd​
    InterstitialAd​
    ​
    ​
    ​
    InterstitialAd.show​
    ​
    ​
    ​
    InterstitialAd.load​
    ​
    ​
    ​
    InterstitialAd.destroy​
    ​
    ​
    ​
    InterstitialAd.onLoad​
    ​
    ​
    ​
    InterstitialAd.offLoad​
    ​
    ​
    ​
    InterstitialAd.onError​
    ​
    ​
    ​
    InterstitialAd.offError​
    ​
    ​
    ​
    InterstitialAd.onClose​
    ​
    ​
    ​
    InterstitialAd.offClose​
    ​
    ​
    ​
    插屏广告注意事项​
    ​
    界面​
    交互​
    按钮​
    tt.createInteractiveButton​
    ​
    ​
    ​
    InteractiveButton​
    ​
    ​
    ​
    InteractiveButton.show​
    ​
    ​
    ​
    InteractiveButton.hide​
    ​
    ​
    ​
    InteractiveButton.destroy​
    ​
    ​
    ​
    InteractiveButton.onTap​
    ​
    ​
    ​
    InteractiveButton.offTap​
    ​
    ​
    ​
    tt.showModal​
    ​
    ​
    ​
    tt.showLoading​
    ​
    ​
    ​
    tt.showActionSheet​
    ​
    ​
    ​
    tt.hideLoading​
    ​
    ​
    ​
    tt.showToast​
    ​
    ​
    ​
    tt.hideToast​
    ​
    键盘​
    tt.showKeyboard​
    ​
    ​
    ​
    tt.updateKeyboard​
    ​
    ​
    ​
    tt.hideKeyboard​
    ​
    ​
    ​
    tt.onKeyboardComplete​
    ​
    ​
    ​
    tt.onKeyboardConfirm​
    ​
    ​
    ​
    tt.onKeyboardInput​
    ​
    ​
    ​
    tt.offKeyboardComplete​
    ​
    ​
    ​
    tt.offKeyboardConfirm​
    ​
    ​
    ​
    tt.offKeyboardInput​
    ​
    ​
    菜单​
    tt.getMenuButtonLayout​
    ​
    支付​
    小游戏支付简介​
    ​
    ​
    ​
    接入流程​
    ​
    ​
    ​
    tt.requestGamePayment​
    ​
    ​
    ​
    获取游戏币余额​
    ​
    ​
    ​
    游戏币扣除接口​
    ​
    ​
    ​
    游戏币赠送接口​
    ​
    ​
    ​
    支付签名生成算法​
    ​
    ​
    ​
    服务端回调接口​
    ​
    ​
    Worker​
    tt.createWorker​
    ​
    ​
    ​
    Worker​
    ​
    ​
    ​
    Worker.onMessage​
    ​
    ​
    ​
    Worker.postMessage​
    ​
    ​
    ​
    Worker.terminate​
    ​
    ​
    ​

    ​ ​

    ​