Skip to content

小游戏开发者文档

Main Navigation

简体中文

English

简体中文

English

Sidebar Navigation

MINIGAME 文档目录

开始使用

首页

小游戏文档指引

常见问题

接入指南

新手教程

入驻与发布

发布流程

小游戏接入指南

IAP 游戏指引

IAA 游戏发布指引

账号与主体

小游戏账号注册

企业认证

功能权限管理能力介绍

游戏资料

名称、简称 & 图标设置

类目设置

小游戏适龄提示设置指引

审核规范

版本审核

资质与备案

资质审核(IAA)

资质审核(IAP)

小游戏接入中宣部实名认证系统流程指引

小游戏备案

隐私合规

小游戏隐私合规开发指南

开发接入

工具

开发工具概述

PinK

HelloPinK

运行时

小游戏的运行环境

JavaScript支持情况

小游戏运行机制

小游戏更新机制

Adapter

游戏引擎

引擎适配概述

Cocos/Laya/Egret引擎适配

Unity/团结引擎

Unity/团结引擎适配

性能优化总览

多平台适配

鸿蒙OS适配指南

基础能力

网络

存储

渲染

权限

模块加载

视频

音频

多线程Worker

设备信息

WebAssembly

硬件连接

蓝牙

介绍

蓝牙低功耗 (BLE)

蓝牙低功耗网状网络 (BLE Mesh)

蓝牙信标 (Beacon)

安全指南

平台开放能力

用户信息

登录态管理

UnionID 机制说明

用户信息获取

用户敏感数据获取

手机号验证组件

开放数据校验与解密

虚拟支付

虚拟支付简介

虚拟支付开通

虚拟支付配置 - 道具直购

支付密钥

支付签名规范

获取小游戏链接

获取 URL Link

添加到桌面

广告接入

激励广告服务端验证接入指引

API 接口

API

模块加载

基础

系统

sud.getSystemInfoSync

sud.env

sud.getSystemInfo

sud.getAppAuthorizeSetting

sud.getAppBaseInfo

sud.getDeviceInfo

sud.getSystemSetting

sud.getWindowInfo

sud.getZoneId

生命周期

sud.exitMiniProgram

sud.offHide

sud.offShow

sud.onHide

sud.onShow

应用级事件

sud.offAudioInterruptionBegin

sud.offAudioInterruptionEnd

sud.offError

sud.onAudioInterruptionBegin

sud.onAudioInterruptionEnd

sud.onError

触摸事件

sud.offTouchCancel

sud.offTouchEnd

sud.offTouchMove

sud.offTouchStart

sud.onTouchCancel

sud.onTouchEnd

sud.onTouchMove

sud.onTouchStart

Touch

性能

getPerformance

Performance

Performance.now

sud.triggerGC

分包加载

LoadSubpackageTask

LoadSubpackageTask.onProgressUpdate

sud.loadSubpackage

调试

console

console.debug

console.error

console.info

console.log

console.warn

sud.setEnableDebug

定时器

clearInterval

clearTimeout

setInterval

setTimeout

render

画布

Canvas.getContext

Canvas.toDataURL

Canvas.toTempFilePath

Canvas.toTempFilePathSync

RenderingContext

sud.createCanvas

图片

sud.createImage

帧率

cancelAnimationFrame

requestAnimationFrame

sud.setPreferredFramesPerSecond

字体

sud.getTextLineHeight

sud.loadFont

界面

交互

sud.showLoading

sud.hideLoading

sud.showToast

sud.hideToast

sud.showActionSheet

sud.showModal

菜单

sud.getMenuButtonBoundingClientRect

窗口

sud.offWindowResize

sud.onWindowResize

键盘

sud.hideKeyboard

sud.offKeyboardComplete

sud.offKeyboardConfirm

sud.offKeyboardInput

sud.onKeyboardComplete

sud.onKeyboardConfirm

sud.onKeyboardInput

sud.showKeyboard

sud.updateKeyboard

网络

上传

sud.uploadFile

UploadTask.abort

UploadTask.offHeadersReceived

UploadTask.offProgressUpdate

UploadTask.onHeadersReceived

UploadTask.onProgressUpdate

下载

DownloadTask.abort

DownloadTask.offHeadersReceived

DownloadTask.offProgressUpdate

DownloadTask.onHeadersReceived

DownloadTask.onProgressUpdate

sud.downloadFile

UDP 通信

sud.createUDPSocket

UDPSocket

UDPSocket.bind

UDPSocket.close

UDPSocket.connect

UDPSocket.offClose

UDPSocket.offError

UDPSocket.offListening

UDPSocket.offMessage

UDPSocket.onClose

UDPSocket.onError

UDPSocket.onListening

UDPSocket.onMessage

UDPSocket.send

UDPSocket.setTTL

UDPSocket.write

WebSocket

XMLHttpRequest

XMLHttpRequest.open

开放接口

用户信息

sud.getUserInfo

sud.getUserProfile

数据存储

localStorage

数据缓存

localStorage.currentSize

localStorage.limitSize

媒体

图片

sud.chooseImage

sud.previewImage

sud.saveImageToPhotosAlbum

图片解码器

sud.createImageDecoder

SUDImageDecoder

SUDImageDecoder.decode

SUDImageDecoder.reset

SUDImageDecoder.close

SUDImageDecoder.isTypeSupported

ImageTrackList

ImageTrack

VideoFrame

VideoFrame.close

VideoFrame.clone

VideoFrame.copyTo

VideoFrame.allocationSize

VideoFrame.metadata

录音

RecorderManager.offError

RecorderManager.offFrameRecorded

RecorderManager.offInterruptionBegin

RecorderManager.offInterruptionEnd

RecorderManager.offPause

RecorderManager.offResume

RecorderManager.offStart

RecorderManager.offStop

RecorderManager.onError

RecorderManager.onFrameRecorded

RecorderManager.onInterruptionBegin

RecorderManager.onInterruptionEnd

RecorderManager.onPause

RecorderManager.onResume

RecorderManager.onStart

RecorderManager.onStop

RecorderManager.pause

RecorderManager.resume

RecorderManager.start

RecorderManager.stop

sud.getRecorderManager

视频

sud.createVideo

TimeRanges

TimeRanges.end

TimeRanges.start

Video

Video.destroy

Video.offAbort

Video.offCanplay

Video.offDuratioffChange

Video.offEnded

Video.offError

Video.offLoadedData

Video.offLoadedMetadata

Video.offLoadStart

Video.offPause

Video.offPlay

Video.offPlaying

Video.offProgress

Video.offRateChange

Video.offResize

Video.offSeeked

Video.offSeeking

Video.offTimeUpdate

Video.offVolumeChange

Video.offWaiting

Video.onAbort

Video.onCanplay

Video.onDurationChange

Video.onEnded

Video.onError

Video.onLoadedData

Video.onLoadedMetadata

Video.onLoadStart

Video.onPause

Video.onPlay

Video.onPlaying

Video.onProgress

Video.onRateChange

Video.onResize

Video.onSeeked

Video.onSeeking

Video.onTimeUpdate

Video.onVolumeChange

Video.onWaiting

Video.pause

Video.play

Video.stop

音频

InnerAudioContext.destroy

InnerAudioContext.offCanplay

InnerAudioContext.offEnded

InnerAudioContext.offError

InnerAudioContext.offPause

InnerAudioContext.offPlay

InnerAudioContext.offSeeked

InnerAudioContext.offSeeking

InnerAudioContext.offStop

InnerAudioContext.offTimeUpdate

InnerAudioContext.offWaiting

InnerAudioContext.onCanplay

InnerAudioContext.onEnded

InnerAudioContext.onError

InnerAudioContext.onPause

InnerAudioContext.onPlay

InnerAudioContext.onSeeked

InnerAudioContext.onSeeking

InnerAudioContext.onStop

InnerAudioContext.onTimeUpdate

InnerAudioContext.onWaiting

InnerAudioContext.pause

InnerAudioContext.play

InnerAudioContext.seek

InnerAudioContext.stop

sud.createInnerAudioContext

sud.setInnerAudioOption

位置

sud.getLocation

文件

FileSystemManager.access

FileSystemManager.accessSync

FileSystemManager.appendFile

FileSystemManager.appendFileSync

FileSystemManager.copyFile

FileSystemManager.copyFileSync

FileSystemManager.getFileInfo

FileSystemManager.getSavedFileList

FileSystemManager.mkdir

FileSystemManager.mkdirSync

FileSystemManager.readCompressedFile

FileSystemManager.readCompressedFileSync

FileSystemManager.readdir

FileSystemManager.readdirSync

FileSystemManager.readFile

FileSystemManager.readFileSync

FileSystemManager.readZipEntry

FileSystemManager.removeSavedFile

FileSystemManager.rename

FileSystemManager.renameSync

FileSystemManager.rmdir

FileSystemManager.rmdirSync

FileSystemManager.saveFile

FileSystemManager.saveFileSync

FileSystemManager.stat

FileSystemManager.statSync

FileSystemManager.unlink

FileSystemManager.unlinkSync

FileSystemManager.unzip

FileSystemManager.writeFile

FileSystemManager.writeFileSync

Stats.isDirectory

Stats.isFile

sud.getFileSystemManager

权限

sud.authorize

设备

电量

sud.getBatteryInfo

sud.getBatteryInfoSync

加速计

sud.offAccelerometerChange

sud.onAccelerometerChange

sud.startAccelerometer

sud.stopAccelerometer

剪贴板

sud.getClipboardData

sud.setClipboardData

罗盘

sud.offCompassChange

sud.onCompassChange

sud.startCompass

sud.stopCompass

屏幕

sud.getScreenBrightness

sud.onUserCaptureScreen

sud.setKeepScreenOn

sud.setScreenBrightness

设备方向

sud.offDeviceMotionChange

sud.onDeviceMotionChange

sud.startDeviceMotionListening

sud.stopDeviceMotionListening

陀螺仪

sud.offGyroscopeChange

sud.onGyroscopeChange

sud.startGyroscope

sud.stopGyroscope

网络

sud.getNetworkType

sud.offNetworkStatusChange

sud.onNetworkStatusChange

振动

sud.vibrateLong

sud.vibrateShort

转屏

sud.offDeviceOrientationChange

sud.onDeviceOrientationChange

Worker

sud.createWorker

Worker.onMessage

Worker.postMessage

Worker.terminate

WebAssembly APIs

服务端 API

服务区域与接口地址

开放接口

鉴权

登录凭证校验

获取接口调用凭证

支付

支付-查询订单

回调接口

支付

支付回调

登录与用户信息 API

sud.login

sud.getUserInfo

sud.getUserProfile

登录与用户信息获取流程

虚拟支付 API

sud.requestVirtualPayment

sud.getBalance

支付流程

API 安全

服务端 API 签名加密

示例代码

Golang示例代码

Java示例代码

Nodejs示例代码

PHP示例代码

Python示例代码

客户端错误码

Errno错误码

调试与优化

调试

vConsole

Source Map

使用 Hello PinK 调试

实时日志

OpenPaaS日志分析指南

性能优化

优化启动性能

资源纹理压缩

WebAssembly

WebGPU

垃圾回收

运行模式与渲染加速

高性能模式

高性能+模式

EmscriptenGLX

Worker异步计算

启动性能

提升游戏启动速度

资源按需加载

使用 AssetBundle 进行资源按需加载

运行性能

优化渲染性能

优化内存

iOS 高性能与高性能+模式

WebGL2.0渲染支持

优化运行性能

当前文档目录

菜单

API	说明
sud.getMenuButtonBoundingClientRect	获取菜单按钮位置和尺寸

Pager

上一篇sud.showModal

下一篇sud.getMenuButtonBoundingClientRect

系统

生命周期

应用级事件

触摸事件

性能

分包加载

调试

定时器

画布

图片

帧率

字体

界面

交互

菜单

窗口

键盘

上传

下载

UDP 通信

WebSocket

XMLHttpRequest

开放接口

登录

用户信息

数据缓存

媒体

图片

图片解码器

录音

视频

音频

电量

加速计

剪贴板

罗盘

屏幕

设备方向

陀螺仪

网络

振动

转屏

鉴权

支付

回调接口

支付

广告

Banner 广告

激励视频广告

插屏广告

示例代码

菜单 ​

菜单