You need to enable JavaScript to run this app.
导航
云游戏
  • 文档首页
    • /
  • 云游戏

客户端 SDK

最近更新时间：2024.01.15 20:41:03

首次发布时间：2023.01.04 19:24:52

我的收藏

本文记录火山引擎云游戏客户端 SDK 接口功能和相关文档的动态。

2024年1月

云游戏客户端 SDK V1.32.x 的发布说明如下：

Android

Android 端 SDK V1.32.3 包含以下新增功能和变更：

  • 对 SDK 进行一些内部功能优化。

2023年12月

云游戏客户端 SDK V1.31.0 的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 新增 “收发二进制消息”（sendBinaryMessage）相关接口和回调，支持与云端游戏之间收发二进制数据。详细信息，参考 收发二进制数据。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 新增 “收发二进制消息”（sendBinaryMessage）相关接口和回调，支持与云端游戏之间收发二进制数据。详细信息，参考 发送二进制消息。

  • 更新了 “收发文本消息”（sendMessage）相关接口，“发送的消息内容” 参数名称由 paylaod 修改为 text。详细信息，参考 发送消息。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • “发送自定义消息” 接口和回调扩展为支持与云端游戏之间收发二进制消息。详细信息，参考 发送自定义消息。

2023年11月

云游戏客户端 SDK V1.29.x 和 V1.30.0 的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 申请云游戏服务时，新增通过 streamType 参数指定拉取音视频流类型，支持启动游戏时默认静音的场景。详细信息，参考 开始播放。
  • 申请游戏服务时，新增通过 debugConfig 可选参数传入 JSON 字符串，用于配置 SDK 的属性（例如：海外域名配置）。详细信息，参考 开始播放。
  • 云游戏端游支持游戏排队功能。详细信息，参考 开始播放。
  • 删除 “设置 Logger”（setLogger）接口。可使用“设置 Debug 模式”（setDebug）接口替代，打印日志信息。详细信息，参考 设置 Debug 模式。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 在调用 startWithConfig: 启动游戏之前，新增通过 streamType 参数指定拉取音视频流的类型，支持启动游戏时默认静音的场景。详细信息，参考 订阅音视频流。
  • 云游戏端游支持游戏排队功能。详细信息，参考 创建 VeGameManager 实例。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 云游戏端游支持游戏排队功能。详细信息，参考 启动 start 。

2023年10月

云游戏客户端 SDK V1.29.0 和 V1.28.x 的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

注意

重要变更

  • 增加了 prepare 函数，用于设置 SDK 的 Android Application 全局上下文对象 ，并开始下载对应的插件。需要在调用 start 接口之前调用。需要特别注意，调用 veGameEngine prepare 函数就是正式开始使用 SDK 了。因为 SDK 在运行过程中需要采集必要的用户信息，所以在调用 veGameEngine 的 prepare 函数前，必须提示并获得用户授权。详细信息，参考 SDK prepare 函数。

  • 删除 “设置 Logger”（setLogger）接口。可使用“设置 Debug 模式”（setDebug）接口替代，打印日志信息。详细信息，参考 设置 Debug 模式。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 新增 “开启调试日志”（setDebugInfoEnable）接口。详细信息，参考 开启调试日志。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 修复了部分已知问题。

2023年8月

云游戏客户端 SDK V1.27.0 的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

注意

重要变更

  • 升级日志管理系统，支持日志动态开启、日志回捞、加密存储功能。删除 “设置是否生成本地日志文件”（setCreateLocalLog）接口。如需保存日志到本地文件，可以通过 “设置 Logger”（setLogger(AcLog.ILogger logger)）接口接收日志后自行实现。

注：“设置 Logger”接口已于 V1.29.0 下线，可使用 设置 Debug 模式 接口替代，打印日志信息。建议按业务需要尽快升级 SDK 版本。

  • 申请游戏服务时，新增在 extra 参数列表中通过设置 enable_archive_upload 参数，设置是否在游戏结束后上传用户存档。详细信息，参考 自定义扩展参数说明。

  • 修复了云游戏旋转逻辑在特殊机型上显示不全的已知问题。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 申请游戏服务时，新增在 extra 参数列表中通过设置 enable_archive_upload 参数，设置是否在游戏结束后上传用户存档。详细信息，参考 自定义扩展参数说明。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 申请游戏服务时，新增在 extra 参数列表中通过设置 enable_archive_upload 参数，设置是否在游戏结束后上传用户存档。详细信息，参考 自定义扩展参数说明。

2023年7月

云游戏客户端 SDK V1.25.1 和 V1.26.0 的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 申请游戏服务时，新增通过 queuePriority 参数设置游戏玩家排队功能以及队列优先级。详细信息，参考 开始播放。
  • 在 “拉流播放状态回调” 监听（IGamePlayerListener）中新增 “排队信息更新回调”（onQueueUpdate）和 “排队完成后申请服务回调”（onQueueSuccessAndStart）。详细信息，参考 IGamePlayerListener。
  • 新增错误码 10029 和 警告码 10030。详细信息，参考 错误码 和 警告码。
  • 删除申请游戏服务时可指定的可选参数 enableFileChannel（开启文件传输通道）和 “收发数据” 相关接口及回调。可使用 “文件传输” 接口实现云游戏客户端 SDK 与云端游戏之间传输文件。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 申请游戏服务时，新增通过 queuePriority 参数设置游戏玩家排队功能以及队列优先级。详细信息，参考 配置参数。
  • 在回调接口中新增 “启动游戏排队回调”（onQueueUpdate）和 “启动游戏排队完成回调”（onQueueSuccessAndStart）。详细信息，参考 回调接口。
  • 新增错误码 10029 和 警告码 10030。详细信息，参考 错误码 和 警告码。
  • 删除 “消息传输”（sendData）接口及相关回调。可使用 “文件传输” 接口实现云游戏客户端 SDK 与云端游戏之间传输文件。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 在申请游戏服务时，新增通过 queuePriority 参数设置游戏玩家排队功能以及队列优先级。详细信息，参考 启动 Start。
  • 新增 “排队状态更新”（queue-update）和 “排队完成”（queue-success）回调。详细信息，参考 游戏玩家排队相关事件。
  • 新增错误码 10029 和 警告码 10030。详细信息，参考 错误码 和 警告码。
  • 删除实例化 veGameSDK 时可指定的可选参数 needConnectFileChannel（开启文件传输通道）和 “文件传输” 相关接口及回调。可使用 “文件传输” 接口实现云游戏客户端 SDK 与云端游戏之间传输文件和数据。
  • 支持通过 npm 加载 SDK。详细信息，参考 快速接入。

2023年6月

云游戏客户端 SDK V1.25.0 的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 申请游戏服务时，如果启动游戏使用的资源套餐为 “基础型”，视频流清晰度档位将被默认设置为 “1”（720P，4000kbps，30FPS）。
  • 更新 “清晰度切换” 接口（switchVideoStreamProfile）说明（如果游戏使用的资源套餐为 “基础型”，切换清晰度档位时，只能切换清晰度档位对应的码率，视频流清晰度和帧率仍保持为 720P 和 30FPS）。详细信息，参考 清晰度切换。
  • 新增警告码 30011 和 40052。详细信息，参考 警告码。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 申请游戏服务时，如果启动游戏使用的资源套餐为 “基础型”，视频流清晰度档位将被默认设置为 “1”（720P，4000kbps，30FPS）。
  • 更新 “清晰度切换” 接口（switchVideoStreamProfile）说明（如果游戏使用的资源套餐为 “基础型”，切换清晰度档位时，只能切换清晰度档位对应的码率，视频流清晰度和帧率仍保持为 720P 和 30FPS）。详细信息，参考 清晰度切换。
  • 新增警告码 30011、40052 和错误码 40009。详细信息，参考 警告码 和 错误码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 申请游戏服务时，如果启动游戏使用的资源套餐为 “基础型”，视频流清晰度档位将被默认设置为 “1”（720P，4000kbps，30FPS）。
  • 更新 “清晰度切换” 接口（switchVideoStreamProfile）说明（如果游戏使用的资源套餐为 “基础型”，切换清晰度档位时，只能切换清晰度档位对应的码率，视频流清晰度和帧率仍保持为 720P 和 30FPS）。详细信息，参考 清晰度切换。
  • 新增警告码 30011 和 40052。详细信息，参考 警告码。
  • 修复了部分已知问题。

2023年5月

云游戏客户端 SDK V1.24.0 的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • （云游戏端游）新增 “发送游戏手柄事件”、“发送鼠标事件” 和 “发送键盘事件” 相关接口。开发者可通过调用接口并自绘制虚拟键位，优化在移动端操控 PC 游戏的体验。详细信息，参考 发送游戏手柄事件、发送鼠标事件 和 发送键盘事件。
  • 新增 “拦截 touch 事件”（setInterceptTouchSend）和 “监听 touch 事件”（setTouchListener）等接口，将触控事件转换为鼠标事件，支持在移动端操控 PC 游戏。详细信息，参考 发送鼠标事件。
  • 新增错误码 40051。详细信息，参考 onPodExit 相关信息。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • （云游戏端游）新增 “发送游戏手柄事件”、“发送鼠标事件” 和 “发送键盘事件” 相关接口。开发者可通过调用接口并自绘制虚拟键位，优化在移动端操控 PC 游戏的体验。详细信息，参考 发送游戏手柄事件、发送鼠标事件 和 发送键盘事件。
  • （云游戏端游）在申请游戏服务时，新增通过 disableTouchEvent 配置参数指定是否禁止 SDK 将触控事件发送到云端游戏（支持将触控事件转换为鼠标事件）。详细信息，参考 配置参数。
  • 新增 “媒体设备状态” 和 “媒体设备错误” 相关枚举项和说明，替换已有 “本地/远端音视频流状态及错误码” 相关枚举项和说明。详细信息，参考 媒体设备状态 和 媒体设备错误 枚举说明。
  • 新增错误码 40051。详细信息，参考 错误码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • （云游戏端游）新增 “发送鼠标、键盘、游戏手柄消息” 相关封装接口。开发者可通过调用接口并自绘制虚拟键位，优化在移动端操控 PC 游戏的体验。详细信息，参考 发送鼠标、键盘、手柄消息。
  • （云游戏端游）支持将触控操作转换为鼠标操作，新增以下相关参数和接口：
  • 在实例化 SDK 时，支持通过 disableDefaultTouchEvent 参数指定是否禁止 SDK 将触控事件发送到云端游戏（支持将触控事件转换为鼠标事件）。详细信息，参考 实例化 veGameSDK。
  • 更新发送鼠标事件接口（sendMouseMessage）的参数说明。详细信息，参考 发送鼠标事件。
  • 新增触控事件回调（on-touch-event）。详细信息，参考 on-touch-event 事件。
  • 新增错误码 40051。详细信息，参考 错误码。

2023年4月

云游戏客户端 SDK V1.23.0 的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 在申请游戏服务时，新增通过 “启动游戏模式”（sessionMode）参数以挂机模式启动游戏。详细信息，参考 开始播放。
  • 新增 “设置挂机模式” 接口（setSessionMode），支持在游戏过程中切换游戏为普通模式或者挂机模式。详细信息，参考 设置挂机模式。
  • 新增 “游戏挂机模式” 相关错误码 10028。详细信息，参考 错误码。
  • 更新实时音视频服务并修复了部分已知问题。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 申请游戏服务时，新增通过 “启动游戏模式”（sessionMode）参数以挂机模式启动游戏。详细信息，参考 配置参数。
  • 新增 “设置挂机模式” 接口（setSessionMode），支持在游戏过程中切换游戏为普通模式或者挂机模式。详细信息，参考 设置挂机模式。
  • 新增 “游戏挂机模式” 相关错误码 10028。详细信息，参考 错误码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 在申请云游戏服务时，支持通过 videoRenderMode 参数传入 VIDEO_RENDER_MODE.FILL，指定视频流渲染模式，实现非等比拉伸视频画面并充满整个容器。详细信息，参考 启动 Start。
  • 新增 “更新画面渲染模式” 接口（updateVideoRenderMode），支持在运行过程中设置视频流画面渲染模式。详细信息，参考 更新画面渲染模式。
  • 在申请游戏服务时，新增通过 “启动游戏模式”（sessionMode）参数以挂机模式启动游戏。详细信息，参考 启动 Start。
  • 新增 “设置挂机模式” 接口（setSessionMode），支持在游戏过程中切换游戏为普通模式或者挂机模式。详细信息，参考 设置挂机模式。
  • 新增 “游戏挂机模式” 相关错误码 10028。详细信息，参考 错误码。

2023年3月

云游戏客户端 SDK V1.21.0 和 V1.22.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 新增插件包依赖。在开发项目中引入 veGameSDK 时，可同时添加插件包的依赖，代替在 SDK 初始化的时候下载插件。详细信息，参考 快速接入。
  • 收发文件接口中新增 options 参数，支持客户端与云端游戏之间收发文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 收发文件。
  • 游戏控制权转移功能增加对云游戏手游的支持。在申请游戏服务时，可以通过 roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 游戏控制权转移。
  • 新增 “创建 Engine 失败” 相关错误 30010。详细信息，参考 错误码。

iOS

iOS 端 SDK 包含以下新增功能和变更：

注意

重要变更：
“设置音频播放设备” 接口的名称，由 setAudioRoute 变更为 setAudioPlaybackDevice。详细信息，参考 设置音频播放设备。

  • 在申请游戏服务时，新增通过 control 可选参数设置 “启用游戏控制权转移” 相关参数，然后通过 VeGameControlObject 配置参数指定用户进入游戏的默认角色和游戏房间类型。详细信息，参考 配置参数。
  • 新增获取本地音频采集音频接口（getLocalAudioCaptureVolume）和 获取音频播放设备接口（getAudioPlaybackDevice）。详细信息，参考 获取音频采集音量 和 获取音频播放设备。
  • 文件传输接口中新增 options 参数，支持客户端向云端游戏发送大文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 文件传输。
  • 游戏控制权转移功能增加对云游戏手游的支持。在申请游戏服务时，可以通过 roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 新增实体游戏手柄连接事件回调（gamepad-connected 和 gamepad-disconnected）。详细信息，参考 实体游戏手柄连接事件。
  • 大文件传输接口中新增 options 参数，支持客户端向云端游戏发送大文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 大文件传输。
  • （云游戏端游）在申请云游戏服务时，支持通过 videoRenderMode 参数指定视频流渲染模式，可传入 VIDEO_RENDER_MODE.COVER，实现视频流根据视频画面分辨率长边做裁剪。详细信息，参考 启动 Start。
  • 游戏控制权转移功能增加对云游戏手游的支持。在申请游戏服务时，可以通过 podSettings 参数指定启动游戏的场景、是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。

2023年2月

云游戏客户端 SDK V1.20.1 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 收发文件接口中新增 options 参数，支持客户端与云端游戏之间收发文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 收发文件。
  • 游戏控制权转移功能增加对云游戏手游的支持。在申请游戏服务时，可以通过 roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 游戏控制权转移。
  • 更新、优化了音视频流传输协议。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 获取服务端设备接口名称由 getServiceDeviceId 改为 serviceDeviceId。
  • 文件传输接口中新增 options 参数，支持客户端向云端游戏发送大文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 文件传输。
  • 游戏控制权转移功能增加对云游戏手游的支持。在申请游戏服务时，可以通过 roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。
  • 更新、优化了音视频流传输协议。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 大文件传输接口中新增 options 参数，支持客户端向云端游戏发送大文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 大文件传输。
  • （云游戏端游）在申请云游戏服务时，支持通过 videoRenderMode 参数指定视频流渲染模式，可传入 VIDEO_RENDER_MODE.COVER，实现视频流根据视频画面分辨率长边做裁剪。详细信息，参考 启动 Start。
  • 游戏控制权转移功能增加对云游戏手游的支持。在申请游戏服务时，可以通过 podSettings 参数指定启动游戏的场景、是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。
  • 更新、优化了音视频流传输协议。

2023年1月

云游戏客户端 SDK V1.19.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 新增支持客户端与云端游戏之间收发文件能力（需要与 Message Channel SDK V1.0.8 及以上版本配合使用）。详细信息，参考 收发文件。
  • 新增文件传输相关错误码（71001 - 71006）。详细信息，参考 错误码。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 新增支持客户端与云端游戏之间收发文件（需要与 Message Channel SDK V1.0.8 及以上版本配合使用）。详细信息，参考 文件传输。
  • 新增文件传输相关错误码（71001 - 71005）。详细信息，参考 错误码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • veGame Web SDK 开始引入插件机制，开发者可按需引入减少主包体积。详细信息，参考 插件机制。
  • 新增支持客户端与云端游戏之间收发文件（需要与 Message Channel SDK V1.0.8 及以上版本配合使用）。详细信息，参考 大文件传输。

2022年12月

云游戏客户端 SDK V1.18.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 拉流播放状态回调监听中新增 onServiceInit() 回调，用于获取并初始化各个功能服务。详细信息，参考 IGamePlayerListener。
  • 新增设置键盘启用状态接口（setKeyboardEnable）及获取键盘开关状态接口（getKeyboardEnable），支持设置是否允许用户使用键盘进行信息输入的能力。详细信息，参考 设置键盘开关。
  • 新增游戏中网络质量检测接口（onNetworkQuality），支持以回调的形式定时上报网络质量。业务方可以通过网络质量评级来了解用户的网络状况，进一步采取降级策略或提示用户更换网络，优化用户体验。详细信息，参考 IStreamListener。
  • 错误码 10010（ERROR_START_NO_STOP_BEFORE）变更为警告码 10010（WARNING_START_NO_STOP_BEFORE）；错误码 30007（ERROR_SDK_LACK_OF_LOCATION_PERMISSION）变更为警告码 30007（WARNING_SDK_LACK_OF_LOCATION_PERMISSION）。详细信息，参考 警告码。
  • 新增 “网络请求失败” 相关错误码 60002。详细信息，参考 错误码。

iOS

iOS 端 SDK 包含以下新增功能和变更：

注意

重要变更：
调整了传入火山引擎用户账号（AccountId 参数）的时机，改为在 “设置配置信息” 接口中传入，因此涉及以下接口名称变更：

  • “设置配置信息” 接口的名称，由 setupConfigInfo 变更为 setupConfigWithAccountId。
  • “创建 VeGameManager 单例对象” 接口的名称，由 sharedManagerWithAccountId: containerView: delegate: 变更为 sharedManagerWithContainerView: containerView: delegate:。
  • 新增设置键盘启用状态接口（setKeyboardEnable）及获取键盘开关状态接口（getKeyboardEnable），支持设置是否允许用户使用键盘进行信息输入的能力。详细信息，参考 设置键盘开关。
  • 新增网络质量检测回调接口（onNetworkQuality），支持以回调的形式上报网络质量。业务方可以通过网络质量评级来了解用户的网络状况，进一步采取降级策略或提示用户更换网络，优化用户体验。详细信息，参考 回调接口 和 网络质量回调。
  • 错误码 10010（ERROR_START_NO_STOP_BEFORE）变更为警告码 10010（WARNING_START_NO_STOP_BEFORE）；错误码 30007（ERROR_SDK_LACK_OF_LOCATION_PERMISSION）变更为警告码 30007（WARNING_SDK_LACK_OF_LOCATION_PERMISSION）。详细信息，参考 警告码。
  • 新增 “网络请求失败” 相关错误码 60002。详细信息，参考 错误码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 新增设置键盘启用状态接口（setKeyboardEnable）及获取键盘启用状态接口（getKeyboardEnable），支持设置是否允许用户使用键盘进行信息输入的能力。详细信息，参考 设置键盘启用状态。
  • 新增游戏中网络质量检测回调接口（on('network-quality')），支持以回调的形式上报网络质量。业务方可以通过网络质量评级来了解用户的网络状况，进一步采取降级策略或提示用户更换网络，优化用户体验。详细信息，参考 事件回调。
  • 错误码 10010（ERROR_START_NO_STOP_BEFORE）变更为警告码 10010（WARNING_START_NO_STOP_BEFORE）。详细信息，参考 警告码。
  • 新增 “网络请求失败” 相关错误码 60002。详细信息，参考 错误码。

2022年11月

云游戏客户端 SDK V1.16.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • （PC 云游戏）申请游戏服务时，新增通过 roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且新增在游戏中动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 游戏控制权转移。
  • 申请游戏服务时，新增在 extra 参数列表中通过设置 serviceReserveTime 参数，设置用户退出游戏后服务端保留游戏运行资源的时长。详细信息，参考 extra 参数列表。
  • 新增云端实例相关错误码（40047、40048、40049）。详细信息，参考 onPodExit 相关信息。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • （PC 云游戏）申请游戏服务时，新增通过 roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且新增在游戏中动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。
  • 新增文件传输通道，支持客户端与云端游戏之间进行文件传输（不超过5MB的文件）。详细信息，参考 文件传输通道。
  • 申请游戏服务时，新增在 extraDict 参数列表中通过设置 serviceReserveTime 参数，设置用户退出游戏后服务端保留游戏运行资源的时长。
  • 新增云端实例相关错误码（40047、40048、40049）。详细信息，参考 错误码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • （PC 云游戏）申请游戏服务时，新增通过 podSettings 参数指定启动游戏的场景、是否开启多人游戏及游戏控制权转移；并且新增在游戏中动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色
  • 在实例化 SDK 时，新增通过 needConnectFileChannel 参数开启文件传输通道，支持客户端与云端游戏之间进行文件传输（不超过5MB的文件）。详细信息，参考 文件传输。
  • 新增 “摇一摇” 功能、适配游戏（应用）的摇一摇场景。详细信息，参考 摇一摇协议。
  • 申请游戏服务时，新增在 extra 参数列表中通过设置 serviceReserveTime 参数，设置用户退出游戏后服务端保留游戏运行资源的时长。
  • 新增云端实例相关错误码（40047、40048、40049）。详细信息，参考 错误码。

云游戏客户端 SDK V1.15.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

注意

重要变更：

  • 更新了以下错误码的 code 及错误信息，详细信息，参考以下表格说明。

错误码

错误描述

变更前变更后
50001ERROR_MESSAGE_NOT_READYERROR_MESSAGE_NOT_CONNECTED
50002ERROR_MESSAGE_CONNECT_FAILEDERROR_MESSAGE_FAILED_TO_PARSE_MSG
50003ERROR_MESSAGE_DISCONNECTERROR_MESSAGE_CHANNEL_UID_ILLEGAL
  • 新增开始游戏时对指定的火山引擎用户账号进行校验。若校验失败，则不能开始游戏，并返回错误码 10026。详细信息，参考 错误码。
  • 修复了部分已知问题。

iOS

iOS 端 SDK 包含以下新增功能和变更：

注意

重要变更：

  • 更新了 “消息发送（支持多用户）” 接口的 “消息通道ID” 参数名称，由 channelId:(NSString *)channelId 变更为 channel:(NSString *)channel_uid。详细信息，参考 发送消息。
  • 更新了以下错误码的 code 及错误信息，详细信息，参考以下表格说明。

错误码

错误描述

变更前变更后
10019ERROR_START_INVALID_AUTO_RECYCLE_TIMEWARNING_START_INVALID_AUTO_RECYCLE_TIME
50001ERROR_MESSAGE_CHANNEL_NOT_CONNECTEDERROR_MESSAGE_NOT_CONNECTED
50002ERROR_MESSAGE_FAILED_TO_PARSE_MSG_DATAERROR_MESSAGE_FAILED_TO_PARSE_MSG
50003ERROR_MESSAGE_CHANNEL_ID_ILLEGALERROR_MESSAGE_CHANNEL_UID_ILLEGAL
  • 新增 “媒体流视频开关” 接口（muteVideo）。详细信息，参考 视频开关。
  • 新增支持调用本地键盘功能。
  • 新增开始游戏时对指定的火山引擎用户账号进行校验。若校验失败，则不能开始游戏，并返回错误码 10026。详细信息，参考 错误码。
  • 优化了部分 SDK 内部接口调用逻辑。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

注意

重要变更: 更新了以下错误码的 code 及错误信息，详细信息，参考以下表格说明。

错误码错误描述
变更前变更后
10019ERROR_START_INVALID_AUTO_RECYCLE_TIMEWARNING_START_INVALID_AUTO_RECYCLE_TIME
50002ERROR_MESSAGE_CONNECT_FAILEDERROR_MESSAGE_FAILED_TO_PARSE_MSG
50003ERROR_MESSAGE_DISCONNECTERROR_MESSAGE_CHANNEL_UID_ILLEGAL
  • 新增控制游戏内鼠标显示/隐藏的相关接口，详细说明如下：
接口/参数名称说明
start 接口的 systemCursorShowStatManual 属性是否手动控制光标显示/隐藏；详细信息，参考 启动。
setSystemCursorShowStatControlKey 方法在游戏中，当鼠标为隐藏锁定状态时，如需要显示光标，可自定义显示光标的键盘按键；详细信息，参考 设置显示光标的键盘按键。
setSystemCursorShowStat 方法当选择手动控制光标的显示/隐藏时，控制本地光标的显示或隐藏状态；详细信息，参考 显示和隐藏本地光标。
setSystemCursorSensitivity 方法设置光标在隐藏状态下的灵敏度；详细信息，参考 设置光标隐藏状态下的灵敏度。
system-cursor-stat-changed 事件回调云端游戏内光标显示/隐藏状态的变化事件；详细信息，参考 事件回调 on。
local-system-cursor-stat-changed 事件回调本地光标显示/隐藏状态的变化事件；详细信息，参考 事件回调 on。
  • 新增检测操作延迟事件，通过回调获取操作延迟数据。详细信息，参考 事件回调 on。
  • 新增开始游戏时对指定的火山引擎用户账号进行校验。若校验失败，则不能开始游戏，并返回错误码 10026。详细信息，参考 错误码。

2022年10月

云游戏客户端 SDK V1.14.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

注意

重要变更：在申请云游戏服务之前，需要在 AndroidManifest.xml 文件中填入注册的火山引擎用户账号。详细信息，参考 火山引擎账号。

  • 新增开始游戏前探测客户端网络质量接口（probeStart）。网络质量探测过程以及探测结果通过 IProbeNetworkListener 回调进行监听，提示用户当前的网络状态。详细信息，参考 网络探测。

  • 优化了本地键盘与云端游戏的交互。详细信息，参考 本地键盘。

  • 新增指定火山引擎用户账号相关错误码（30009）。详细信息，参考 错误码。

  • 新增 “云端游戏退出” 相关错误码（40008、40009）。详细信息，参考 onPodExit 相关信息。

iOS

iOS 端 SDK 包含以下新增功能和变更：

注意

重要变更：

  • 调整了 VeGameManager 初始化配置，“设置配置信息” 接口名称由 setConfigInfo 更新为 setupConfigInfo，并且在初始化云游戏实例时，必须指定注册的火山引擎用户账号（accountId 参数）。详细信息，参考 快速接入。
  • 删除了 “销毁单例”（destroy）接口。
  • 更新了以下接口的名称：
接口变更前变更后
设置配置信息setConfigInfosetupConfigInfo
输出日志consoleLogEnablelogEnable
游戏手柄setCustomOperationViewsetGamepadView

  • 新增开始游戏前探测客户端网络质量接口（probeStart），提示用户当前的网络状态。详细信息，参考 开始网络探测。

  • 新增指定火山引擎用户账号相关错误码（30009）。详细信息，参考 错误码。

  • 修复了前后摄像头切换时视频出现颠倒的问题。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

注意

重要变更: 在初始化实例时，需要指定 accountId 必选参数（注册的火山引擎用户账号）。详细信息，参考 实例化 veGameSDK。

  • 新增指定火山引擎用户账号相关错误码（30009）。详细信息，参考 错误码。

2022年9月

云游戏客户端 SDK V1.13.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 申请游戏服务时，新增在 extra 参数列表中通过设置 userFrameworkApp 参数，指定运行游戏需要的伴随程序。已上传的伴随程序列表以及伴随程序包名可通过调用服务端 伴随程序管理 接口获取。详细信息，参考 extra 参数列表。

  • 在收发消息接口 sendMessage 中，新增 channelUid 参数（云端游戏初始化 veMessageChannelClient 时填入的用户 ID），并新增 getSrcChannelUid 和 getDestChannelUid 接口，支持客户端与多个云端实例之间传输自定义消息。详细信息，参考 收发消息。

  • 新增了客户端和云端游戏之间的消息通道连接行为变更。当客户端调用 stop 接口停止拉流后，客户端和云端游戏之间已建立的消息通道长连接不会立即断开，仍保持长连接状态。详细信息，参考 Message Channel SDK。

  • 新增指定运行游戏需要的伴随程序相关告警码（10023、10024、10025）。详细信息，参考 错误码。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 对 SDK 包体积进行了优化（与上一版本相比，SDK 包体积缩小到了约 30MB；该优化为火山引擎云手机客户端 SDK 体积优化，业务集成后的体积变化需由业务方测试和评估）。

  • 在发送消息接口 sendMessage 中，新增 channelId 参数，支持客户端与多个云端实例之间传输自定义消息。详细信息，参考 发送消息（支持多用户）。

  • 新增了客户端和云端游戏之间的消息通道连接行为变更。当客户端调用 stop 接口停止拉流后，客户端和云端游戏之间已建立的消息通道长连接不会立即断开，仍保持长连接状态。详细信息，参考 Message Channel SDK。

  • 新增指定运行游戏需要的伴随程序相关告警码（10023、10024、10025）。详细信息，参考 警告码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

注意

重要变更：改变 “发送自定义消息”（sendMessage）接口的入参格式，变更如下：
变更前：
sendMessage(message, needAck, timeout)
变更后：
sendMessage({message, needAck, timeout, destUserId})

  • SDK 内部渲染 DOM 容器新增 overflow:hidden 属性，可能对业务样式产生影响，需要关注。

  • 在发送自定义消息接口 sendMessage 中，新增 destUserId 参数（云端游戏初始化 veMessageChannelClient 时填入的目标用户 ID），支持客户端与多个云端实例之间传输自定义消息。当 Message Channel 连接通道超过1条时，必须指定 destUserId 参数。详细信息，参考 发送自定义消息。

  • 新增了客户端和云端游戏之间的消息通道连接行为变更。当客户端调用 stop 接口停止拉流后，客户端和云端游戏之间已建立的消息通道长连接不会立即断开，仍保持长连接状态。详细信息，参考 Message Channel SDK。

  • 本地输入法新增支持 iOS 系统调起。

  • 新增指定运行游戏需要的伴随程序相关告警码（10023、10024、10025）。详细信息，参考参考 警告码。

2022年8月

云游戏客户端 SDK V1.12.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

注意

重要变更：如果通过 aar 包文件集成云游戏客户端 SDK，需要引用以下任意一种框架：
implementation 'com.google.code.gson:gson:2.8.5'
或
implementation 'com.alibaba:fastjson:1.1.72.android'
或
implementation 'com.fasterxml.jackson.core:jackson-databind:2.11.1'
implementation 'com.fasterxml.jackson.core:jackson-core:2.11.1'

  • 优化了动态下载机制，支持限速、文件名自动提取等功能，以及下载生命周期优化。

  • 对 SDK 包体积进行了优化（与上一版本相比，SDK 包体积缩小到了200KB以下；该优化为火山引擎云游戏客户端 SDK 体积优化，业务集成后的体积变化需由业务方测试和评估）。

  • 新增 “游戏内主动退出” 的游戏服务终止事件回调和相关警告信息。在收到回调后，客户端需提示用户进行对应操作。详细信息，参考 云游戏回调地址接入指南 和 警告码（40044）。

iOS

iOS 端 SDK 包含以下新增功能和变更：

注意

重要变更：从 V1.12 开始，调整了 veGameSDK 的接入流程。详细的接入流程，请参考 工程配置。

  • 更新了以下接口和参数名称：

    • 设置音频播放设备接口名称更新为：setAudioRoute
    • 暂停游戏开关接口名称更新为：switchPaused
    • 静音开关接口名称更新为：muteAudio
    • 各类传感器开关接口更新为通过参数进行设置。详细信息，参考 传感器开关。

  • 更新了枚举说明中以下枚举项的名称和枚举值（详细信息，参考 枚举说明）：

枚举项更新前更新后
游戏手柄按键操纵杆枚举值为：10操纵杆枚举值为：2
摄像头类型枚举项名称为：VeGameXXX枚举项名称为：VeBaseXXX
SDK 与信令服务器连接状态同上同上
网络连接类型同上同上
本地音频流状态同上同上
本地音频流相关错误码同上同上
远端音频流状态同上同上
远端音频流状态改变的原因同上同上
本地视频流状态同上同上
本地视频流相关错误码同上同上
远端视频流状态同上同上
远端视频流状态改变的原因同上同上
本地视频采集渲染模式同上同上
本地视频采集编码选项同上同上
音频播放设备类型枚举项和枚举值均有变更枚举项和枚举值均有变更
本地视频画面镜像模式枚举项和枚举值均有变更枚举项和枚举值均有变更
云端游戏切换类型枚举项名称为：VeGameRemoteGameXXX枚举项名称为：VeBaseRemoteAppXXX

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 新增键位映射配置界面，将鼠标操作和键盘操作映射为手游的 Touch 和手势滑动事件，支持用户通过 PC 端使用 Web 体验云手游的业务场景。

  • 本次发布新增了云游戏操控 SDK。在接入时，需要和服务端 “游戏详情查询” 接口（DetailGame）配合使用。详细信息，参考 云游戏操控 SDK 说明文档。

  • 申请游戏服务时，新增通过 enableFullScreen 参数指定是否开启设备全屏显示。在使用 setFullScreenState 接口设置 PC 端全屏/退出全屏状态之前，需要通过该配置参数开启设备全屏显示。详细信息，参考 启动 start。

  • 新增设置游戏重连时间接口（setReconnectTime）。在游戏过程中或者游戏切换前后台时，因为网络问题需要重连时，支持指定游戏重连时长，防止重复尝试连接。详细信息，参考 设置重连时间。

  • 新增 SDK 运行过程中的警告事件回调（on('warning')）。详细信息，参考 事件回调。

  • 更新了在自动播放失败的情况下，如何提示和引导用户与页面进行交互来恢复播放。详细信息，参考 交互播放 和 警告码（10022）。

  • 新增 “游戏内主动退出” 的游戏服务终止事件回调和相关警告信息。在收到回调后，客户端需提示用户进行对应操作。详细信息，参考 云游戏回调地址接入指南 和 警告码（40044）。

2022年7月

云游戏客户端 SDK V1.11.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

注意

重要变更：从 V1.11.0 开始，SDK 初始化变更为由 SDK 内部完成，用户无需调用初始化接口、可直接调用 start() 接口申请游戏服务。SDK 初始化成功后，由 ICloudCoreManagerStatusListener 的 onInitialed() 回调触发。

注：初始化接口已于 V1.28.0 更新为 prepare 函数，建议尽快升级 SDK 版本。详细信息，参考 SDK prepare 函数。

  • 申请游戏服务时，新增通过 autoRecycleTime 参数设置无操作自动回收服务时长；并且新增在游戏中动态设置无操作自动回收服务时长接口（setAutoRecycleTime）。详细信息，参考 设置无操作回收服务时间。

  • 申请游戏服务时，新增通过 userProfilePathList 参数设置保存游戏配置文件的路径列表；并且新增设置和获取保存游戏配置文件路径接口（ setUserProfilePath 和 getUserProfilePath）。详细信息，参考 保存/还原用户配置信息。

  • 申请游戏服务时，新增通过 enableFileChannel 参数开启大文件传输通道，支持客户端与云端实例之间收发大文件。详细信息，参考 收发数据。

  • 新增云端游戏切换前后台状态回调，并支持通过 setRemoteGameForeground 接口将云端游戏切换到前台。详细信息，参考 云端游戏切换前台。

  • 新增对采集的本地视频流进行优化处理的接口，包括设置本地视频画面布局（setLocalVideoCanvas）、使用“前置摄像头”采集时是否开启镜像翻转视频画面（setLocalVideoMirrorMode）、根据网络情况配置本地视频编码质量参数（setVideoEncoderConfig）。详细信息，参考 Camera 注入。

  • 更新了错误码及说明。详细信息，参考 错误码。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 更新申请云游戏服务的配置参数，将鉴权选项 VeGameAuthObject 合并入VeGameConfigObject 选项中，在启动游戏时只需指定 configObj 参数。详细信息，参考 创建 VeGameManager 实例。

  • 申请游戏服务时，新增通过 autoRecycleTime 参数设置无操作自动回收服务时长；并且新增在游戏中动态设置无操作自动回收服务时长接口（setAutoRecycleTime）。详细信息，参考 设置无操作回收服务时间。

  • 申请游戏服务时，新增通过 userProfilePathList 参数设置保存游戏配置文件的路径列表；并且新增设置和获取保存游戏配置文件的路径接口（ setUserProfilePath 和 getUserProfilePath）。详细信息，参考 设置保存用户配置文件的路径。

  • 新增云端游戏切换前后台状态回调，并支持通过 setRemoteGameForeground 接口将云端游戏切换到前台。详细信息，参考 云端游戏切换前台。

  • 新增对采集的本地视频流进行优化处理的接口，包括设置本地视频画面布局（setLocalVideoCanvas）、使用“前置摄像头”采集时是否开启镜像翻转视频画面（setLocalVideoMirrorMode）、根据网络情况配置本地视频编码质量参数（setVideoEncoderConfig）。详细信息，参考 设置本地视频渲染视图。

  • 更新地理位置请求开关默认值（将默认开启更新为默认关闭）。详细信息，参考 主流开关。

  • 删除了调节游戏音量接口（turnVolume），可使用调节远端音频播放音量接口（setRemoteAudioPlaybackVolume）进行游戏音量调节。

  • 更新了警告码、错误码及相关说明。详细信息，参考 警告码 和 错误码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

注意

重要变更：从 V1.11.0 开始，SDK 修改了打包方式，建议使用以下方法：
bytePlay = new veGameSDK();

  • 申请游戏服务时，新增通过 autoRecycleTime 参数设置无操作自动回收服务时长；并且新增在游戏中动态设置无操作自动回收服务时长接口（setAutoRecycleTime）。详细信息，参考 设置/获取无操作回收服务时间。

  • 申请游戏服务时，新增通过 userProfilePathList 参数设置保存游戏配置文件的路径列表；并且新增设置和获取保存游戏配置文件的路径接口（ setUserProfilePath 和 getUserProfilePath）。详细信息，参考 设置保存用户配置文件的路径。

  • 新增云端游戏切换前后台状态回调，并支持通过 setRemoteGameForeground 接口将云端游戏切换到前台。详细信息，参考 云端游戏切换前台。

  • 新增基础音频能力相关接口，包括调节客户端本地播放和采集音量、获取和设置音频设备、开启/关闭音频数据发送等功能。详细信息，参考 调节本地播放和采集音量。

  • 新增采集本地摄像头视频流并发送到云端实例的相关接口，并支持对采集的本地视频流进行优化处理的接口，包括设置本地视频画面布局（setLocalVideoCanvas）、使用“前置摄像头”采集时是否开启镜像翻转视频画面（setLocalVideoMirrorMode）、根据网络情况配置本地视频编码质量参数（setVideoEncoderConfig）。详细信息，参考 开启视频采集。

  • 新增设置 PC 端全屏状态和退出全屏接口（setFullScreenState）。详细信息，参考 设置全屏状态。

  • 新增云端游戏切换前后台、云端请求开始/停止发送音频数据、开始/停止采集音视频数据、更新音视频采集/播放设备、发送/接收音视频流状态等事件回调。详细信息，参考 事件回调。

  • 更新了错误码及说明。详细信息，参考 错误码。

2022年6月

云游戏客户端 SDK V1.10.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 新增获取用户设备唯一标识符接口（getServiceDeviceId）。在客户端 SDK 初始化后调用该接口，获取并保存设备 ID 到业务自己的服务端。在通过调用服务端 PreAllocateResource 接口锁定资源、请求游戏服务时，透传保存的设备唯一标识，用于确定是否支持游戏多开。详细信息，参考 获取设备唯一标识。

  • 新增设置客户端应用切换前后台状态接口（switchBackground）。详细信息，参考 客户端前后台切换。

  • 新增基础音频能力相关接口，包括调节客户端本地播放和采集音量、调节云端游戏播放音量、开启/关闭音频数据发送等功能。详细信息，参考 调节本地播放和采集音量。

  • 通过消息通道发送消息到云端游戏时，支持指定消息发送超时时长（timeout）参数，并增加云端实例在线、离线状态回调。详细信息，参考 收发消息。

  • 更新了错误码及说明。详细信息，参考 错误码。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 新增获取用户设备唯一标识符接口（getServiceDeviceId）。在客户端 SDK 初始化后调用该接口，获取并保存设备 ID 到业务自己的服务端。在通过调用服务端 PreAllocateResource 接口锁定资源、请求游戏服务时，透传保存的设备唯一标识，用于确定是否支持游戏多开。详细信息，参考 获取设备唯一标识。

  • 新增设置客户端应用切换前后台状态接口（switchBackground）。详细信息，参考 客户端前后台切换。

  • 新增基础音视频能力相关接口，包括调节客户端本地播放和采集音量、调节云端游戏播放音量、开启/关闭音视频数据发送等功能。详细信息，参考 开启音频采集。

  • 通过消息通道发送消息到云端游戏时，支持指定消息发送超时时长（time）参数。详细信息，参考 收发消息。

  • 新增本地音视频流数据统计参数和远端音视频流数据统计参数。详细信息，参考 数据统计。

  • 更新了错误码及说明。详细信息，参考 错误码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 新增获取用户设备唯一标识符接口（getDeviceId）。在客户端 SDK 初始化后调用该接口，获取并保存设备 ID 到业务自己的服务端。在通过调用服务端 PreAllocateResource 接口锁定资源、请求游戏服务时，透传保存的设备唯一标识，用于确定是否支持游戏多开。详细信息，参考 获取设备唯一标识。

  • 新增设置客户端应用切换前后台状态接口（switchBackground），并增加客户端应用或游戏切换前后台事件回调（background-switched）。详细信息，参考 客户端前后台切换 和 事件回调。

  • 新增基础音频能力相关接口，支持调节本地播放音量。详细信息，参考 本地播放音量调节。

  • 通过消息通道发送消息到云端游戏时，支持指定消息发送超时时长（timeout）参数，并增加云端实例在线、离线状态事件回调（message-channel-online 和 message-channel-offline）。详细信息，参考 发送自定义消息 和 事件回调。

  • 更新了错误码及说明。详细信息，参考 错误码。

2022年5月

云游戏客户端 SDK V1.9.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 新增发送客户端本地剪贴板消息到云端实例接口（sendClipBoardMessage）以及接收剪贴板消息事件回调（onClipBoardMessageReceived）。详细信息，参考 发送剪贴板消息。

  • 新增动态设置客户端切后台的保活时间接口（setIdleTime）。详细信息，参考 设置保活时间。

  • 新增刷新用户鉴权的签名密钥接口（resetToken）。详细信息，参考 重置签名密钥。

  • 更新了错误码及说明。详细信息，参考 错误码。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 新增发送客户端本地剪贴板消息到云端实例接口（sendClipBoardMessage）及回调。详细信息，参考 发送剪贴板消息。

  • 新增客户端向云端实例发送通用消息（sendGeneralMessage）及回调。详细信息，参考 发送通用消息。

  • 新增动态设置客户端切后台的保活时间接口（setIdleTime）。详细信息，参考 设置保活时间。

  • 更新屏幕旋转回调返回值类型。详细信息，参考 回调接口。

  • 拆分和更新操作延迟回调接口。详细信息，参考 回调接口。

  • 更新了错误码及说明。详细信息，参考 错误码。

  • 更新了以下接口和参数名称：

    • 启动云游戏接口名称更新为 startWithConfig: gameConfigObj auth: authObj

  • 暂停游戏开关接口名称更新为：setPaused

  • 静音开关接口名称更新为：setMute

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 新增发送客户端本地剪贴板消息到云端实例接口（sendClipBoardMessage）。详细信息，参考 发送剪贴板消息。

  • 新增动态设置客户端切后台的保活时间接口（setIdleTime）。详细信息，参考 设置保活时间。

  • 新增刷新用户鉴权的签名密钥接口（renewToken）。详细信息，参考 刷新签名密钥。

  • 新增云端实例发送到客户端的消息已接收事件回调（general-message-received）。详细信息，参考 事件回调。

  • 新增云端实例剪贴板发生变化时的回调（clipboard-message-received）。详细信息，参考 事件回调。

  • 更新了错误码及说明。详细信息，参考 错误码。

2022年4月

云游戏客户端 SDK V1.8.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 取消了通过用户传入 did 参数进行问题排查。改为通过 getDeviceId() 方法获取 SDK 生成的设备 ID，用于线上日志查询和问题排查。详细信息，参考 获取设备 ID。
  • 在初始化 SDK时，init 方法中的 cpuABIType 参数类型的包名改为了 com.volcengine.androidcloud.plugin。
  • 在 start() 接口中增加可选参数 reservedId（资源预锁定 ID），用于申请火山引擎云游戏每次服务。同时，在 onPlaySuccess 回调中返回 reservedId 字段。建议业务记录此 ID，用于每次服务会话的唯一标识，可用于调试和问题排查。详细信息，参考 开始播放。
  • 在 start() 接口中增加可选参数 customGameId（用户自定义游戏标识，在注册游戏时指定，与 game_id 必须指定其中一个）。
  • 在 start() 接口中增加可选参数 extra，可用于指定自定义扩展参数，进行设备属性修改等操作。
  • 更新了错误码及说明。详细信息，参考 错误码。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 更新了工程配置 TARGETS > Bulid Phases > Link Binary With Libraries 中需要添加的库。详细信息，参考 工程配置。
  • 在启动游戏的配置项中，增加可选参数 reservedId（资源预锁定 ID），用于申请火山引擎云游戏每次服务，并且在启动成功时返回。建议业务记录此 ID，用于每次服务会话的唯一标识，可用于调试和问题排查。详细信息，参考 初始化。
  • 在启动游戏的配置项中，增加可选参数 customGameId（用户自定义游戏标识，在注册游戏时指定，与 game_id 必须指定其中一个）。
  • 删除 SDK 内部渲染控制器的显示逻辑和旋转逻辑，交由用户自定义。详细信息，参考 初始化。
  • 更新了错误码及说明。详细信息，参考 错误码。

Web/H5

Web/H5 端 SDK 包含以下新增功能和变更：

  • 在 start() 接口中增加可选参数 reservedId（资源预锁定 ID），用于申请火山引擎云游戏每次服务，并且在启动成功时返回。建议业务记录此 ID，用于每次服务会话的唯一标识，可用于调试和问题排查。详细信息，参考 启动。
  • 在 start() 接口中增加可选参数 customGameId（用户自定义游戏标识，在注册游戏时指定，与 game_id 是映射关系）。
  • 在 start() 接口中增加可选参数 extra，可用于指定自定义扩展参数，进行设备属性修改等操作。
  • 在实例化 veGameSDK 时，删除了 appId 参数。
  • 更新了错误码及说明。详细信息，参考 错误码。

2022年3月

云游戏客户端 SDK V1.7.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能：

  • 新增了初始化 veGameEngine 时指定下载so的类型。
  • 调整了接口说明文档的结构。详细信息，参考 Android SDK 接口说明。
  • 更新了错误码及说明。

iOS

iOS 端 SDK 包含以下新增功能：

  • 调整了接口说明文档的结构。详细信息，参考 iOS SDK 接口说明。
  • 更新了错误码及说明。

Web/H5

Web/H5 端 SDK 包含以下新增功能：

  • start() 接口新增参数 isScreenLock（锁定屏幕方向），用于与 start() 接口的 rotation 参数配合使用。
  • 修复了 PWA 场景下切后台后再切回时黑屏的问题。
  • 调整了接口说明文档的结构。详细信息，参考 Web / H5 SDK 接口说明。
  • 更新了错误码及说明。

2022年1月

云游戏客户端 SDK V1.6.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能：

  • 云游戏客户端 SDK 名称更新为 veGameSDK。
  • 调整了接口说明文档的结构。详细信息，参考 Android SDK 接口说明。

iOS

iOS 端 SDK 包含以下新增功能：

  • 云游戏客户端 SDK 名称更新为 veGameSDK。
  • 调整了接口说明文档的结构。详细信息，参考 iOS SDK 接口说明。

Web/H5

Web/H5 端 SDK 包含以下新增功能：

  • 云游戏客户端 SDK 名称更新为 veGameSDK。
  • 调整了接口说明文档的结构。详细信息，参考 Web / H5 SDK 接口说明。

2021年11月

云游戏客户端 SDK V1.5.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 新增云游戏视频流清晰度切换功能。在启动云游戏时，可在配置项中通过（videoStreamProfileId）指定使用的清晰度 ID。在播放中，可调用 switchVideoStreamProfile 接口，切换清晰度档位。详细信息，参考 清晰度切换.
  • 更新错误码及说明。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 新增云游戏视频流清晰度切换功能。在启动云游戏时，可在启动配置文件中通过（videoStreamProfileId）指定使用的清晰度 ID。在播放中，调用 switchVideoStreamProfile 接口，切换清晰度。
  • 新增从客户端发送消息到云端的接口和回调。
  • 更新错误码及说明。

Web / H5

Web / H5 端 SDK 包含以下新增功能和变更：

  • 新增云游戏视频流清晰度切换功能。在启动云游戏时，通过（videoStreamProfileId）指定使用的清晰度 ID。在播放中，调用 switchVideoStreamProfile 接口，切换清晰度。
  • 新增从客户端发送消息到云端实例功能。
  • 更新错误码及说明。

2021年10月

云游戏客户端 SDK V1.4.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 在启动云游戏时，新增配置当次游戏生命周期的标识符（roundId）。
  • 更新错误码及说明。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 在启动云游戏时，新增配置当次游戏生命周期的标识符（roundId）。
  • 从云游戏启动配置文件中，删除 podId 配置项。
  • 删除 “云通知” 相关接口，以及相关错误码。
  • 更新错误码及说明。

Web/H5

Web / H5 端 SDK 包含以下新增功能和变更：

  • 新增支持本地输入法。
  • 新增重启云游戏接口 restart。
  • 在启动云游戏时，新增配置当次游戏生命周期的标识符（roundId）。
  • 更新错误码及说明。

2021年9月

云游戏客户端 SDK V1.3.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 新增 IMessageChannel 接口，支持客户端与云端游戏之间收发消息和数据流。
  • 接口名称变更，play() 变更为 start()，resumePlay 变更为 resume()。
  • 调整 init() 和 start() 接口的调用逻辑，并提供最简配置和完整配置参考。
  • 更新接入文档中的 SDK 状态转换示意图，帮助开发者了解 SDK 内部的运转逻辑。
  • 更新运行 SDK 时 .so 库加载方式，适配不同云游戏客户端场景。
  • 更新错误码及说明。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 在启动云游戏时，默认关闭部分传感器开关，优化计算资源。
  • 更新错误码及说明。

Web / H5

Web / H5 端 SDK 包含以下新增功能和变更：

  • 成功调用 start() 接口后，新增返回云端实例的宽度和高度（width 、height），用于调用发送触控事件接口时确定游戏画面的 x、y 轴相对坐标。
  • 新增发送触控事件接口（sendTouchMessage），支持自定义触控事件。
  • 新增 sendCustomMessage 接口，支持客户端与云端游戏之间收发消息和数据流。
  • 更新错误码及说明。

2021年8月

云游戏客户端 SDK V1.2.0 版的发布说明如下：

Android

Android 端 SDK 包含以下新增功能和变更：

  • 新增对接入云游戏服务的用户进行鉴权，提升客户订阅的云游戏服务的安全性。用户通过客户端 SDK 启动云游戏服务时，需要传入 Session Token。获取 Session Token 的方法，参考 签发临时 Token。
  • 启动云游戏服务时，支持通过传入游戏ID（gameId），直接启动游戏。
  • 新增发送游戏手柄消息接口。
  • 移除切换分辨率接口。

iOS

iOS 端 SDK 包含以下新增功能和变更：

  • 新增对接入云游戏服务的用户进行鉴权，提升客户订阅的云游戏服务的安全性。用户通过客户端 SDK 启动云游戏服务时，需要传入 Session Token。获取 Session Token 的方法，参考 签发临时 Token。
  • 启动云游戏服务时，支持通过传入游戏ID（gameId），直接启动游戏。

Web / H5

Web / H5 端 SDK 包含以下新增功能和变更：

  • 新增对接入云游戏服务的用户进行鉴权，提升客户订阅的云游戏服务的安全性。用户通过客户端 SDK 启动云游戏服务时，需要传入 Session Token。获取 Session Token 的方法，参考 签发临时 Token。
  • 启动云游戏服务时，支持通过传入游戏ID（gameId），直接启动游戏。
  • start 方法新增 video 自动播放失败错误码；
  • 新增 playByInteraction 方法，当发生 video 自动播放错误时，可以引导用户通过交互界面提示，继续播放，参考以下示例：
    cloudCore.start(options).then(() => {
 console.log('start successfully')
 }).catch((e) => {
 if (e.errorCode === 2000002) {
   // 弹出引导用户点击继续的 UI 界面提示
   showBtnUI();
 }
})；

btn.onclick = () => {
 cloudCore.playByInteraction();
};
  • 修复横屏游戏中画面放缩比例问题。