SDK 集成指引

最近更新时间:2025-09-03 14:10:22

我的收藏
此 SDK 提供在 Web 端快速接入云手机 Paas 平台的能力,可以通过 SDK 操作云手机实例。

运行环境

iOS 11.0 及以上系统版本。
Android 浏览器:需要支持 WebRTC 的浏览器内核。
PC Web 浏览器:内核为 Chrome 90+ 的浏览器,以及 Safari 11 及以上版本。

快速接入

获取 SDK

SDK
下载地址
SDK 说明文档
版本发布日志
JavaScript SDK

引入 SDK

说明:
TCGSDK export UMD module 已默认将 TCGSDK 挂载到 Window 下,可直接使用 TCGSDK 对象,也可以自行初始化实例。SDK 说明可参考 SDK 声明文件
方法一:script 标签引入。
<script src="path/to/sdk" charset="utf-8"></script>
方法二:模块形式引入,默认 export module 为 UMD。
import TCGSDK, {CloudGamingWebSDK} from 'path-to-TCGSDK';

// 直接使用 TCGSDK 或 new CloudGamingWebSDK()

启动 SDK

// 以下均为伪代码

// 调用 云API 创建安卓实例访问Token
// https://cloud.tencent.com/document/api/1162/119708

// 参考 https://github.com/tencentyun/cloudgame-js-sdk/blob/master/samples/android_instance/src/android_instance/network.ts
const {AccessInfo, Token} = await CreateAndroidInstancesAccessToken({AndroidInstanceIds});

TCGSDK.init({
appid: 1234567,
mount: 'mount-point', // 填入需要挂载入云渲染视图的节点
accessToken: {
accessInfo: AccessInfo,
token: Token
},
debugSetting: {
showLog: true,
},
// 连接成功回调
onConnectSuccess: (res) => {
console.log('onConnectSuccess', res);
},
// 网络中断/被踢触发此回调
onDisconnect: (res) => {
console.log('onDisconnect', res);
},
// 初始化成功回调
onInitSuccess: async (res) => {
console.log('%c onInitSuccess', 'color: red', res);
// 开始渲染
TCGSDK.access({
instanceId: AndroidInstanceIds[0]
});
}
});

完整 Demo

完整代码可参考 Android Instance React Demo