Skip to content

Main Navigation 介绍接入指南客户端 API 服务端 API SaaS API 迁移

Sidebar Navigation

Android API Reference

SUDOP

initSDK

uninitSDK

createRuntime

auth

registerWrappedClient

getGameSignature

preDownloadGame

preDownloadGameBySignature

preDownloadGameByUrl

preLoadGame

preLoadGameBySignature

preLoadGameByPkgPath

preLoadGameByDirectoryPath

preLoadGameByUrl

preStartGame

preStartGameBySignature

preStartGameByPkgPath

preStartGameByDirectoryPath

preStartGameByUrl

startGame

startGameBySignature

startGameByPkgPath

startGameByDirectoryPath

startGameByUrl

SUDOPWrappedClient

onGetLegacyUserIdentity

onGetUserInfo

onGetUserProfile

SUDOPGameTask

destroy

SUDRT

cancelCleanUp

cleanUpExpiredTemporaryFiles

createGameHandle

getManager

loadCore

loadPackage

getRuntimeVersion

getRuntimeDescription

SUDRTGameCoreHandle

getCoreRootPath

getCoreAssetsPath

getCoreVersion

getCoreDesc

getCoreFeatures

SUDRTGameHanlde

setGameStartOptions

getGameAudioSession

getGameState

setGameDrawFrameListener

setGameLoadSubpackageListener

setGameScreenStateChangeListener

setGameStateListener

setGameFatalErrorListener

setGameQueryExitListener

setGameQueryPermissionListener

setGameQuerySystemPermissionListener

setGameQueryClipboardListener

create

start

play

pause

stop

destroy

getGameView

getMediaPlayerHandle

setMediaPlayerCreatedListener

registerExtendedClient

SUDRTGameAudioSession

isMute

getVolumeFactor

mute

setGameQueryAudioOptionsListener

setVolumeFactor

setAudioInterruption

getAudioInterruption

setAudioSessionStartOptions

iOS API Refrence

SUDOP

initializeWithConfiguration:completion:

uninitialize

createRuntime:completion:

authWithUserSignature:completion:

registerWrappedClientWithGameHandle:clientDelegate

getGameSignatureWithGameID:completion:

preDownloadGameWithSignature:completion:

preLoadGameWithSignature:completion:

preStartGameWithSignature:completion:

preStartGameWithURLOptions:completion:

startGameWithSignature:didGameHandleCreated:completion:

preDownloadGame:completion:

preDownloadGameWithURL:options:completion:

preLoadGame:completion:

preLoadGameWithDirectoryPath:options:completion:

preLoadGameWithPkgPath:options:completion:

preLoadGameWithURL:options:completion:

preStartGame:completion:

preStartGameWithDerectoryPath:options:completion:

preStartGameWithPkgPath:options:completion:

startGame:didGameHandleCreated:completion:

startGameWithDerectoryPath:options:onCreated:completion:

startGameWithFilePath:options:didGameHandleCreated:completion:

startGameWithURL:options:didGameHandleCreated:completion:

SUDOPWrappedClientDelegate

onGetLegacyUserIdentity:dataJson

onGetUserInfo:dataJson

onGetUserProfile:dataJson

SUDOPGameTask

destroy

SUDRT

getRuntimeFeatures

getRuntimeVersion

cancelCleanUp

cleanUpExpiredTemporaryFiles:start:progress:completion:

createGameHandleWithOptions:completion:

getManagerWithName:options:

loadPackage:progress:completion:

getRuntimeDescription

SUDRTGameHandle

create

destroy

getGameAudioSession

getGameState

getGameView

getMediaPlayerHandle

pause

play

registerExtendedClient:client:

setGameDrawFrameListener

setGameFatalErrorListener

setGameLoadSubpackageListener

setGameQueryClipboardListener

setGameQueryExitListener

setGameQueryPermissionListener

setGameQuerySystemPermissionListener

setGameScreenStateChangeListener

setGameStartOptions:options:

setGameStateListener

setMediaPlayerListener

start

stop

SUDRTGameAudioSession

getVolumeFactor

isMute

mute

setGameQueryAudioOptionsListener

setVolumeFactor

JS API Refrence

模块加载

基础

系统

sud.getSystemInfo

sud.env

sud.getSystemInfoSync

生命周期

sud.exitApplication

sud.getLaunchOptionsSync

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.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

XMLHttpRequest

XMLHttpRequest.open

数据存储

localStorage

数据缓存

localStorage.currentSize

localStorage.limitSize

媒体

视频

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.mkdir

FileSystemManager.mkdirSync

FileSystemManager.readdir

FileSystemManager.readdirSync

FileSystemManager.readFile

FileSystemManager.readFileSync

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.getNetworkType

sud.offNetworkStatusChange

sud.onNetworkStatusChange

振动

sud.vibrateLong

sud.vibrateShort

转屏

sud.offDeviceOrientationChange

sud.onDeviceOrientationChange

Worker

sud.createWorker

Worker.onMessage

Worker.postMessage

Worker.terminate

WebAssembly APIs

WebAssembly APIs

其他

功能状态

sud.getFeature

sud.setFeature

On this page

sud.env

JS

    sud.env

运行环境常量对象

env 的属性说明

属性	键值类型	说明
USER_DATA_PATH	string	用户数据根目录别名
TEMP_DATA_PATH	string	临时数据根目录别名