Skip to content

Minigame docs

Main Navigation

English

简体中文

English

简体中文

Sidebar Navigation

MINIGAME Contents

Getting started

Home

Minigame Documentation Guide

FAQ

Integration Guide

Getting Started

Registration & publishing

Publishing workflow

Minigame Integration Guide

IAP Game Guide

IAA Game Release Guide

Account & organization

Minigame Account Registration

Enterprise Verification

Feature Permission Management Introduction

Game information

Name, Abbreviation & Icon Setup

Category Setup

Minigame Age-Rating Notice Setup Guide

Version Review

Qualifications & filing

Qualification Review (IAA)

Qualification Review (IAP)

Guide to Integrating the Minigame with the Publicity Department Real-name Verification System

Minigame Filing

Privacy compliance

Minigame Privacy Compliance Development Guide

User Privacy Protection Guide

Development integration

Tools

Development Tools Overview

PinK

HelloPinK

Runtime

Minigame Runtime Environment

JavaScript Support

Minigame Runtime Mechanism

Minigame Update Mechanism

Adapter

Game Engine

Engine Adaptation Overview

Cocos/Laya/Egret Engine Adaptation

Unity/Tuanjie Engine

Unity/Tuanjie Engine Adaptation

Performance Optimization Overview

Cross-Platform Adaptation

HarmonyOS Adaptation Guide

Basic Abilities

Network

Storage

Rendering

Permissions

Module Loading

Video

Audio

Multithreaded Worker

Device Info

WebAssembly

Hardware Connection

Bluetooth

Bluetooth Beacon (Beacon)

Bluetooth Low Energy (BLE)

Bluetooth Low Energy Mesh Network (BLE Mesh)

Introduction

Safety Guide

Platform capabilities

User Info

Session Management

UnionID Mechanism Overview

Getting User Info

Phone Number Verification Component

Virtual Payment

Introduction to Virtual Payment

Virtual Payment Onboarding

Virtual Payment Configuration - Direct IAP

Payment Key

Get minigame links

Add to Home Screen

Get URL Link

Ad integration

Rewarded Ad Server-Side Verification Integration Guide

API reference

API

Module Loading

Basis

System

sud.getSystemInfoSync

sud.env

sud.getSystemInfo

sud.getAppAuthorizeSetting

sud.getAppBaseInfo

sud.getDeviceInfo

sud.getSystemSetting

sud.getWindowInfo

sud.getZoneId

Lifecycle

sud.exitMiniProgram

sud.offHide

sud.offShow

sud.onHide

sud.onShow

Application-Level Events

sud.offAudioInterruptionBegin

sud.offAudioInterruptionEnd

sud.offError

sud.onAudioInterruptionBegin

sud.onAudioInterruptionEnd

sud.onError

Touch Events

sud.offTouchCancel

sud.offTouchEnd

sud.offTouchMove

sud.offTouchStart

sud.onTouchCancel

sud.onTouchEnd

sud.onTouchMove

sud.onTouchStart

Touch

Performance

getPerformance

Performance

Performance.now

sud.triggerGC

Subpackage Loading

LoadSubpackageTask

LoadSubpackageTask.onProgressUpdate

sud.loadSubpackage

Debugging

console

console.debug

console.error

console.info

console.log

console.warn

sud.setEnableDebug

Timer

clearInterval

clearTimeout

setInterval

setTimeout

render

Canvas

Canvas.getContext

Canvas.toDataURL

Canvas.toTempFilePath

Canvas.toTempFilePathSync

RenderingContext

sud.createCanvas

Font

sud.getTextLineHeight

sud.loadFont

Frame Rate

cancelAnimationFrame

requestAnimationFrame

sud.setPreferredFramesPerSecond

Image

sud.createImage

Interface

Interaction

sud.showLoading

sud.hideLoading

sud.showToast

sud.hideToast

sud.showActionSheet

sud.showModal

Window

sud.offWindowResize

sud.onWindowResize

Keyboard

sud.hideKeyboard

sud.offKeyboardComplete

sud.offKeyboardConfirm

sud.offKeyboardInput

sud.onKeyboardComplete

sud.onKeyboardConfirm

sud.onKeyboardInput

sud.showKeyboard

sud.updateKeyboard

Network

Download

DownloadTask.abort

DownloadTask.offHeadersReceived

DownloadTask.offProgressUpdate

DownloadTask.onHeadersReceived

DownloadTask.onProgressUpdate

sud.downloadFile

UDP Communication

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

Upload

sud.uploadFile

UploadTask.abort

UploadTask.offHeadersReceived

UploadTask.offProgressUpdate

UploadTask.onHeadersReceived

UploadTask.onProgressUpdate

WebSocket

XMLHttpRequest

XMLHttpRequest.open

Open APIs

Login

sud.login

User Information

sud.getUserInfo

sud.getUserProfile

Storage

localStorage

Cache

localStorage.currentSize

localStorage.limitSize

Media

Image

sud.chooseImage

sud.previewImage

sud.saveImageToPhotosAlbum

Audio

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

Recorder

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

Video

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

Location

sud.getLocation

File

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

Permission

sud.authorize

Device

Accelerometer

sud.offAccelerometerChange

sud.onAccelerometerChange

sud.startAccelerometer

sud.stopAccelerometer

Battery

sud.getBatteryInfo

sud.getBatteryInfoSync

Clipboard

sud.getClipboardData

sud.setClipboardData

Compass

sud.offCompassChange

sud.onCompassChange

sud.startCompass

sud.stopCompass

Device Motion

sud.offDeviceMotionChange

sud.onDeviceMotionChange

sud.startDeviceMotionListening

sud.stopDeviceMotionListening

Gyroscope

sud.offGyroscopeChange

sud.onGyroscopeChange

sud.startGyroscope

sud.stopGyroscope

Network

sud.getNetworkType

sud.offNetworkStatusChange

sud.onNetworkStatusChange

Rotation

sud.offDeviceOrientationChange

sud.onDeviceOrientationChange

Screen

sud.getScreenBrightness

sud.onUserCaptureScreen

sud.setKeepScreenOn

sud.setScreenBrightness

Vibration

sud.vibrateLong

sud.vibrateShort

Worker

sud.createWorker

Worker.onMessage

Worker.postMessage

Worker.terminate

WebAssembly APIs

Server API

Service Regions and API Addresses

Open API

Authentication

Login Credential Verification

Obtain API Call Credential

Payment

Payment - Order Query

Webhook

Payment

Payment Webhook

Ad

Rewarded Video Completion Webhook

Ads

Ad creation APIs

sud.createBannerAd

sud.createRewardedVideoAd

sud.createInterstitialAd

sud.getContainerInfo

Banner Ad

BannerAd.show

BannerAd.hide

BannerAd.destroy

BannerAd.onResize

BannerAd.offResize

BannerAd.onLoad

BannerAd.offLoad

BannerAd.onError

BannerAd.offError

Rewarded Video Ad

RewardedVideoAd.load

RewardedVideoAd.show

RewardedVideoAd.destroy

RewardedVideoAd.onLoad

RewardedVideoAd.offLoad

RewardedVideoAd.onError

RewardedVideoAd.offError

RewardedVideoAd.onClose

RewardedVideoAd.offClose

RewardedVideoAd.setServerSideVerificationData

Interstitial Ad

InterstitialAd.load

InterstitialAd.show

InterstitialAd.destroy

InterstitialAd.onLoad

InterstitialAd.offLoad

InterstitialAd.onError

InterstitialAd.offError

InterstitialAd.onClose

InterstitialAd.offClose

Login & user information APIs

sud.login

sud.getUserInfo

sud.getUserProfile

Login and User Info Retrieval Flow

Virtual payment APIs

sud.requestVirtualPayment

sud.getBalance

Payment Flow

Client error codes

Errno Error Codes

Debugging & optimization

Debugging

vConsole

Source Map

HelloPinK Debugging

Real-time Logs

OpenPaaS Log Analysis Guide

Performance Optimization

Optimizing Startup Performance

Resource Texture Compression

WebAssembly

WebGPU

Garbage Collection

Runtime modes & rendering acceleration

High-Performance Mode

High-Performance+ Mode

EmscriptenGLX

Worker Asynchronous Computation

Startup Performance

Improve Game Startup Speed

On-Demand Resource Loading

Use AssetBundle for On-Demand Resource Loading

Runtime Performance

Optimize Rendering Performance

Optimize Memory

iOS High Performance and High Performance+ Modes

WebGL2.0 Rendering Support

Optimize Runtime Performance

On this page

UDPSocket

A UDP Socket instance, using the IPv4 protocol by default.

Pager

Previous pagesud.createUDPSocket

Next pageUDPSocket.bind

System

Lifecycle

Application-Level Events

Touch Events

Performance

Subpackage Loading

Debugging

Timer

Canvas

Font

Frame Rate

Image

Interface

Interaction

Menu

Window

Keyboard

Download

UDP Communication

Upload

WebSocket

XMLHttpRequest

Open APIs

Login

User Information

Cache

Media

Image

Audio

Recorder

Video

Accelerometer

Battery

Clipboard

Compass

Device Motion

Gyroscope

Network

Rotation

Screen

Vibration

Authentication

Payment

Webhook

Payment

Ad

Banner Ad

Rewarded Video Ad

Interstitial Ad

UDPSocket ​

UDPSocket