最近更新时间：2023.11.06 11:39:44
首次发布时间：2023.01.04 19:24:52
本文记录火山引擎云游戏客户端 SDK 接口功能和相关文档的动态。
云游戏客户端 SDK V1.29.0 和 V1.28.x 的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
注意
重要变更
增加了 prepare 函数，用于设置 SDK 的 Android Application 全局上下文对象 ，并开始下载对应的插件。需要在调用 start 接口之前调用。需要特别注意，调用 veGameEngine prepare 函数就是正式开始使用 SDK 了。因为 SDK 在运行过程中需要采集必要的用户信息，所以在调用 veGameEngine 的 prepare 函数前，必须提示并获得用户授权。详细信息，参考 SDK prepare 函数。
删除 “设置 Logger”（setLogger）接口。可使用“设置 Debug 模式”（setDebug）接口替代，打印日志信息。详细信息，参考 设置 Debug 模式。
iOS 端 SDK 包含以下新增功能和变更：
setDebugInfoEnable）接口。详细信息，参考 开启调试日志。Web/H5 端 SDK 包含以下新增功能和变更：
云游戏客户端 SDK V1.27.0 的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
注意
重要变更
setCreateLocalLog）接口。如需保存日志到本地文件，可以通过 “设置 Logger”（setLogger(AcLog.ILogger logger)）接口接收日志后自行实现。注：“设置 Logger”接口已于 V1.29.0 下线，可使用 设置 Debug 模式 接口替代，打印日志信息。建议按业务需要尽快升级 SDK 版本。
申请游戏服务时，新增在 extra 参数列表中通过设置 enable_archive_upload 参数，设置是否在游戏结束后上传用户存档。详细信息，参考 自定义扩展参数说明。
修复了云游戏旋转逻辑在特殊机型上显示不全的已知问题。
iOS 端 SDK 包含以下新增功能和变更：
extra 参数列表中通过设置 enable_archive_upload 参数，设置是否在游戏结束后上传用户存档。详细信息，参考 自定义扩展参数说明。Web/H5 端 SDK 包含以下新增功能和变更：
extra 参数列表中通过设置 enable_archive_upload 参数，设置是否在游戏结束后上传用户存档。详细信息，参考 自定义扩展参数说明。云游戏客户端 SDK V1.25.1 和 V1.26.0 的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
queuePriority 参数设置游戏玩家排队功能以及队列优先级。详细信息，参考 开始播放。IGamePlayerListener）中新增 “排队信息更新回调”（onQueueUpdate）和 “排队完成后申请服务回调”（onQueueSuccessAndStart）。详细信息，参考 IGamePlayerListener。enableFileChannel（开启文件传输通道）和 “收发数据” 相关接口及回调。可使用 “文件传输” 接口实现云游戏客户端 SDK 与云端游戏之间传输文件。iOS 端 SDK 包含以下新增功能和变更：
queuePriority 参数设置游戏玩家排队功能以及队列优先级。详细信息，参考 配置参数。onQueueUpdate）和 “启动游戏排队完成回调”（onQueueSuccessAndStart）。详细信息，参考 回调接口。sendData）接口及相关回调。可使用 “文件传输” 接口实现云游戏客户端 SDK 与云端游戏之间传输文件。Web/H5 端 SDK 包含以下新增功能和变更：
queuePriority 参数设置游戏玩家排队功能以及队列优先级。详细信息，参考 启动 Start。queue-update）和 “排队完成”（queue-success）回调。详细信息，参考 游戏玩家排队相关事件。needConnectFileChannel（开启文件传输通道）和 “文件传输” 相关接口及回调。可使用 “文件传输” 接口实现云游戏客户端 SDK 与云端游戏之间传输文件和数据。云游戏客户端 SDK V1.25.0 的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
switchVideoStreamProfile）说明（如果游戏使用的资源套餐为 “基础型”，切换清晰度档位时，只能切换清晰度档位对应的码率，视频流清晰度和帧率仍保持为 720P 和 30FPS）。详细信息，参考 清晰度切换。iOS 端 SDK 包含以下新增功能和变更：
switchVideoStreamProfile）说明（如果游戏使用的资源套餐为 “基础型”，切换清晰度档位时，只能切换清晰度档位对应的码率，视频流清晰度和帧率仍保持为 720P 和 30FPS）。详细信息，参考 清晰度切换。Web/H5 端 SDK 包含以下新增功能和变更：
switchVideoStreamProfile）说明（如果游戏使用的资源套餐为 “基础型”，切换清晰度档位时，只能切换清晰度档位对应的码率，视频流清晰度和帧率仍保持为 720P 和 30FPS）。详细信息，参考 清晰度切换。云游戏客户端 SDK V1.24.0 的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
setInterceptTouchSend）和 “监听 touch 事件”（setTouchListener）等接口，将触控事件转换为鼠标事件，支持在移动端操控 PC 游戏。详细信息，参考 发送鼠标事件。iOS 端 SDK 包含以下新增功能和变更：
disableTouchEvent 配置参数指定是否禁止 SDK 将触控事件发送到云端游戏（支持将触控事件转换为鼠标事件）。详细信息，参考 配置参数。Web/H5 端 SDK 包含以下新增功能和变更：
disableDefaultTouchEvent 参数指定是否禁止 SDK 将触控事件发送到云端游戏（支持将触控事件转换为鼠标事件）。详细信息，参考 实例化 veGameSDK。sendMouseMessage）的参数说明。详细信息，参考 发送鼠标事件。on-touch-event）。详细信息，参考 on-touch-event 事件。云游戏客户端 SDK V1.23.0 的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
sessionMode）参数以挂机模式启动游戏。详细信息，参考 开始播放。setSessionMode），支持在游戏过程中切换游戏为普通模式或者挂机模式。详细信息，参考 设置挂机模式。iOS 端 SDK 包含以下新增功能和变更：
sessionMode）参数以挂机模式启动游戏。详细信息，参考 配置参数。setSessionMode），支持在游戏过程中切换游戏为普通模式或者挂机模式。详细信息，参考 设置挂机模式。Web/H5 端 SDK 包含以下新增功能和变更：
videoRenderMode 参数传入 VIDEO_RENDER_MODE.FILL，指定视频流渲染模式，实现非等比拉伸视频画面并充满整个容器。详细信息，参考 启动 Start。updateVideoRenderMode），支持在运行过程中设置视频流画面渲染模式。详细信息，参考 更新画面渲染模式。sessionMode）参数以挂机模式启动游戏。详细信息，参考 启动 Start。setSessionMode），支持在游戏过程中切换游戏为普通模式或者挂机模式。详细信息，参考 设置挂机模式。云游戏客户端 SDK V1.21.0 和 V1.22.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
options 参数，支持客户端与云端游戏之间收发文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 收发文件。roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 游戏控制权转移。iOS 端 SDK 包含以下新增功能和变更：
注意
重要变更：
“设置音频播放设备” 接口的名称，由 setAudioRoute 变更为 setAudioPlaybackDevice。详细信息，参考 设置音频播放设备。
control 可选参数设置 “启用游戏控制权转移” 相关参数，然后通过 VeGameControlObject 配置参数指定用户进入游戏的默认角色和游戏房间类型。详细信息，参考 配置参数。getLocalAudioCaptureVolume）和 获取音频播放设备接口（getAudioPlaybackDevice）。详细信息，参考 获取音频采集音量 和 获取音频播放设备。options 参数，支持客户端向云端游戏发送大文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 文件传输。roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。Web/H5 端 SDK 包含以下新增功能和变更：
gamepad-connected 和 gamepad-disconnected）。详细信息，参考 实体游戏手柄连接事件。options 参数，支持客户端向云端游戏发送大文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 大文件传输。videoRenderMode 参数指定视频流渲染模式，可传入 VIDEO_RENDER_MODE.COVER，实现视频流根据视频画面分辨率长边做裁剪。详细信息，参考 启动 Start。podSettings 参数指定启动游戏的场景、是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。云游戏客户端 SDK V1.20.1 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
options 参数，支持客户端与云端游戏之间收发文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 收发文件。roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 游戏控制权转移。iOS 端 SDK 包含以下新增功能和变更：
getServiceDeviceId 改为 serviceDeviceId。options 参数，支持客户端向云端游戏发送大文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 文件传输。roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。Web/H5 端 SDK 包含以下新增功能和变更：
options 参数，支持客户端向云端游戏发送大文件时传输自定义参数，满足更多业务场景的需求。该参数需要与 Message Channel SDK V1.0.9 及以上版本配合使用。详细信息，参考 大文件传输。videoRenderMode 参数指定视频流渲染模式，可传入 VIDEO_RENDER_MODE.COVER，实现视频流根据视频画面分辨率长边做裁剪。详细信息，参考 启动 Start。podSettings 参数指定启动游戏的场景、是否开启多人游戏及游戏控制权转移；并且在游戏中可以动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。云游戏客户端 SDK V1.19.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
iOS 端 SDK 包含以下新增功能和变更：
Web/H5 端 SDK 包含以下新增功能和变更：
云游戏客户端 SDK V1.18.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
onServiceInit() 回调，用于获取并初始化各个功能服务。详细信息，参考 IGamePlayerListener。setKeyboardEnable）及获取键盘开关状态接口（getKeyboardEnable），支持设置是否允许用户使用键盘进行信息输入的能力。详细信息，参考 设置键盘开关。onNetworkQuality），支持以回调的形式定时上报网络质量。业务方可以通过网络质量评级来了解用户的网络状况，进一步采取降级策略或提示用户更换网络，优化用户体验。详细信息，参考 IStreamListener。iOS 端 SDK 包含以下新增功能和变更：
注意
重要变更：
调整了传入火山引擎用户账号（AccountId 参数）的时机，改为在 “设置配置信息” 接口中传入，因此涉及以下接口名称变更：
setupConfigInfo 变更为 setupConfigWithAccountId。sharedManagerWithAccountId: containerView: delegate: 变更为 sharedManagerWithContainerView: containerView: delegate:。setKeyboardEnable）及获取键盘开关状态接口（getKeyboardEnable），支持设置是否允许用户使用键盘进行信息输入的能力。详细信息，参考 设置键盘开关。onNetworkQuality），支持以回调的形式上报网络质量。业务方可以通过网络质量评级来了解用户的网络状况，进一步采取降级策略或提示用户更换网络，优化用户体验。详细信息，参考 回调接口 和 网络质量回调。Web/H5 端 SDK 包含以下新增功能和变更：
setKeyboardEnable）及获取键盘启用状态接口（getKeyboardEnable），支持设置是否允许用户使用键盘进行信息输入的能力。详细信息，参考 设置键盘启用状态。on('network-quality')），支持以回调的形式上报网络质量。业务方可以通过网络质量评级来了解用户的网络状况，进一步采取降级策略或提示用户更换网络，优化用户体验。详细信息，参考 事件回调。云游戏客户端 SDK V1.16.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且新增在游戏中动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 游戏控制权转移。extra 参数列表中通过设置 serviceReserveTime 参数，设置用户退出游戏后服务端保留游戏运行资源的时长。详细信息，参考 extra 参数列表。iOS 端 SDK 包含以下新增功能和变更：
roomType、role 参数指定启动游戏的场景、控制是否开启多人游戏及游戏控制权转移；并且新增在游戏中动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色。extraDict 参数列表中通过设置 serviceReserveTime 参数，设置用户退出游戏后服务端保留游戏运行资源的时长。Web/H5 端 SDK 包含以下新增功能和变更：
podSettings 参数指定启动游戏的场景、是否开启多人游戏及游戏控制权转移；并且新增在游戏中动态设置游戏玩家角色的接口（changeRole）。详细信息，参考 设置游戏玩家角色needConnectFileChannel 参数开启文件传输通道，支持客户端与云端游戏之间进行文件传输（不超过5MB的文件）。详细信息，参考 文件传输。extra 参数列表中通过设置 serviceReserveTime 参数，设置用户退出游戏后服务端保留游戏运行资源的时长。云游戏客户端 SDK V1.15.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
注意
重要变更：
错误码 | 错误描述 | |
|---|---|---|
| 变更前 | 变更后 | |
| 50001 | ERROR_MESSAGE_NOT_READY | ERROR_MESSAGE_NOT_CONNECTED |
| 50002 | ERROR_MESSAGE_CONNECT_FAILED | ERROR_MESSAGE_FAILED_TO_PARSE_MSG |
| 50003 | ERROR_MESSAGE_DISCONNECT | ERROR_MESSAGE_CHANNEL_UID_ILLEGAL |
iOS 端 SDK 包含以下新增功能和变更：
注意
重要变更：
channelId:(NSString *)channelId 变更为 channel:(NSString *)channel_uid。详细信息，参考 发送消息。错误码 | 错误描述 | |
|---|---|---|
| 变更前 | 变更后 | |
| 10019 | ERROR_START_INVALID_AUTO_RECYCLE_TIME | WARNING_START_INVALID_AUTO_RECYCLE_TIME |
| 50001 | ERROR_MESSAGE_CHANNEL_NOT_CONNECTED | ERROR_MESSAGE_NOT_CONNECTED |
| 50002 | ERROR_MESSAGE_FAILED_TO_PARSE_MSG_DATA | ERROR_MESSAGE_FAILED_TO_PARSE_MSG |
| 50003 | ERROR_MESSAGE_CHANNEL_ID_ILLEGAL | ERROR_MESSAGE_CHANNEL_UID_ILLEGAL |
muteVideo）。详细信息，参考 视频开关。Web/H5 端 SDK 包含以下新增功能和变更：
注意
重要变更: 更新了以下错误码的 code 及错误信息，详细信息，参考以下表格说明。
| 错误码 | 错误描述 | |
|---|---|---|
| 变更前 | 变更后 | |
| 10019 | ERROR_START_INVALID_AUTO_RECYCLE_TIME | WARNING_START_INVALID_AUTO_RECYCLE_TIME |
| 50002 | ERROR_MESSAGE_CONNECT_FAILED | ERROR_MESSAGE_FAILED_TO_PARSE_MSG |
| 50003 | ERROR_MESSAGE_DISCONNECT | ERROR_MESSAGE_CHANNEL_UID_ILLEGAL |
| 接口/参数名称 | 说明 |
|---|---|
| start 接口的 systemCursorShowStatManual 属性 | 是否手动控制光标显示/隐藏；详细信息，参考 启动。 |
| setSystemCursorShowStatControlKey 方法 | 在游戏中，当鼠标为隐藏锁定状态时，如需要显示光标，可自定义显示光标的键盘按键；详细信息，参考 设置显示光标的键盘按键。 |
| setSystemCursorShowStat 方法 | 当选择手动控制光标的显示/隐藏时，控制本地光标的显示或隐藏状态；详细信息，参考 显示和隐藏本地光标。 |
| setSystemCursorSensitivity 方法 | 设置光标在隐藏状态下的灵敏度；详细信息，参考 设置光标隐藏状态下的灵敏度。 |
| system-cursor-stat-changed 事件回调 | 云端游戏内光标显示/隐藏状态的变化事件；详细信息，参考 事件回调 on。 |
| local-system-cursor-stat-changed 事件回调 | 本地光标显示/隐藏状态的变化事件；详细信息，参考 事件回调 on。 |
云游戏客户端 SDK V1.14.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
注意
重要变更：在申请云游戏服务之前，需要在 AndroidManifest.xml 文件中填入注册的火山引擎用户账号。详细信息，参考 火山引擎账号。
新增开始游戏前探测客户端网络质量接口（probeStart）。网络质量探测过程以及探测结果通过 IProbeNetworkListener 回调进行监听，提示用户当前的网络状态。详细信息，参考 网络探测。
优化了本地键盘与云端游戏的交互。详细信息，参考 本地键盘。
新增指定火山引擎用户账号相关错误码（30009）。详细信息，参考 错误码。
新增 “云端游戏退出” 相关错误码（40008、40009）。详细信息，参考 onPodExit 相关信息。
iOS 端 SDK 包含以下新增功能和变更：
注意
重要变更：
setConfigInfo 更新为 setupConfigInfo，并且在初始化云游戏实例时，必须指定注册的火山引擎用户账号（accountId 参数）。详细信息，参考 快速接入。destroy）接口。| 接口 | 变更前 | 变更后 |
|---|---|---|
| 设置配置信息 | setConfigInfo | setupConfigInfo |
| 输出日志 | consoleLogEnable | logEnable |
| 游戏手柄 | setCustomOperationView | setGamepadView |
新增开始游戏前探测客户端网络质量接口（probeStart），提示用户当前的网络状态。详细信息，参考 开始网络探测。
新增指定火山引擎用户账号相关错误码（30009）。详细信息，参考 错误码。
修复了前后摄像头切换时视频出现颠倒的问题。
Web/H5 端 SDK 包含以下新增功能和变更：
注意
重要变更: 在初始化实例时，需要指定 accountId 必选参数（注册的火山引擎用户账号）。详细信息，参考 实例化 veGameSDK。
云游戏客户端 SDK V1.13.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
申请游戏服务时，新增在 extra 参数列表中通过设置 userFrameworkApp 参数，指定运行游戏需要的伴随程序。已上传的伴随程序列表以及伴随程序包名可通过调用服务端 伴随程序管理 接口获取。详细信息，参考 extra 参数列表。
在收发消息接口 sendMessage 中，新增 channelUid 参数（云端游戏初始化 veMessageChannelClient 时填入的用户 ID），并新增 getSrcChannelUid 和 getDestChannelUid 接口，支持客户端与多个云端实例之间传输自定义消息。详细信息，参考 收发消息。
新增了客户端和云端游戏之间的消息通道连接行为变更。当客户端调用 stop 接口停止拉流后，客户端和云端游戏之间已建立的消息通道长连接不会立即断开，仍保持长连接状态。详细信息，参考 Message Channel SDK。
新增指定运行游戏需要的伴随程序相关告警码（10023、10024、10025）。详细信息，参考 错误码。
iOS 端 SDK 包含以下新增功能和变更：
对 SDK 包体积进行了优化（与上一版本相比，SDK 包体积缩小到了约 30MB；该优化为火山引擎云手机客户端 SDK 体积优化，业务集成后的体积变化需由业务方测试和评估）。
在发送消息接口 sendMessage 中，新增 channelId 参数，支持客户端与多个云端实例之间传输自定义消息。详细信息，参考 发送消息（支持多用户）。
新增了客户端和云端游戏之间的消息通道连接行为变更。当客户端调用 stop 接口停止拉流后，客户端和云端游戏之间已建立的消息通道长连接不会立即断开，仍保持长连接状态。详细信息，参考 Message Channel SDK。
新增指定运行游戏需要的伴随程序相关告警码（10023、10024、10025）。详细信息，参考 警告码。
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）。详细信息，参考参考 警告码。
云游戏客户端 SDK V1.12.0 版的发布说明如下：
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 端 SDK 包含以下新增功能和变更：
注意
重要变更：从 V1.12 开始，调整了 veGameSDK 的接入流程。详细的接入流程，请参考 工程配置。
更新了以下接口和参数名称：
setAudioRouteswitchPausedmuteAudio更新了枚举说明中以下枚举项的名称和枚举值（详细信息，参考 枚举说明）：
| 枚举项 | 更新前 | 更新后 |
|---|---|---|
| 游戏手柄按键 | 操纵杆枚举值为：10 | 操纵杆枚举值为：2 |
| 摄像头类型 | 枚举项名称为：VeGameXXX | 枚举项名称为：VeBaseXXX |
| SDK 与信令服务器连接状态 | 同上 | 同上 |
| 网络连接类型 | 同上 | 同上 |
| 本地音频流状态 | 同上 | 同上 |
| 本地音频流相关错误码 | 同上 | 同上 |
| 远端音频流状态 | 同上 | 同上 |
| 远端音频流状态改变的原因 | 同上 | 同上 |
| 本地视频流状态 | 同上 | 同上 |
| 本地视频流相关错误码 | 同上 | 同上 |
| 远端视频流状态 | 同上 | 同上 |
| 远端视频流状态改变的原因 | 同上 | 同上 |
| 本地视频采集渲染模式 | 同上 | 同上 |
| 本地视频采集编码选项 | 同上 | 同上 |
| 音频播放设备类型 | 枚举项和枚举值均有变更 | 枚举项和枚举值均有变更 |
| 本地视频画面镜像模式 | 枚举项和枚举值均有变更 | 枚举项和枚举值均有变更 |
| 云端游戏切换类型 | 枚举项名称为：VeGameRemoteGameXXX | 枚举项名称为：VeBaseRemoteAppXXX |
新增 “游戏内主动退出” 的游戏服务终止事件回调和相关警告信息。在收到回调后，客户端需提示用户进行对应操作。详细信息，参考 云游戏回调地址接入指南 和 警告码（40044）。
新增 “画布设置无效” 相关的错误码说明及操作建议。详细信息，参考 错误码（30008）。
Web/H5 端 SDK 包含以下新增功能和变更：
新增键位映射配置界面，将鼠标操作和键盘操作映射为手游的 Touch 和手势滑动事件，支持用户通过 PC 端使用 Web 体验云手游的业务场景。
本次发布新增了云游戏操控 SDK。在接入时，需要和服务端 “游戏详情查询” 接口（DetailGame）配合使用。详细信息，参考 云游戏操控 SDK 说明文档。
申请游戏服务时，新增通过 enableFullScreen 参数指定是否开启设备全屏显示。在使用 setFullScreenState 接口设置 PC 端全屏/退出全屏状态之前，需要通过该配置参数开启设备全屏显示。详细信息，参考 启动 start。
新增设置游戏重连时间接口（setReconnectTime）。在游戏过程中或者游戏切换前后台时，因为网络问题需要重连时，支持指定游戏重连时长，防止重复尝试连接。详细信息，参考 设置重连时间。
新增 SDK 运行过程中的警告事件回调（on('warning')）。详细信息，参考 事件回调。
更新了在自动播放失败的情况下，如何提示和引导用户与页面进行交互来恢复播放。详细信息，参考 交互播放 和 警告码（10022）。
新增 “游戏内主动退出” 的游戏服务终止事件回调和相关警告信息。在收到回调后，客户端需提示用户进行对应操作。详细信息，参考 云游戏回调地址接入指南 和 警告码（40044）。
云游戏客户端 SDK V1.11.0 版的发布说明如下：
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 端 SDK 包含以下新增功能和变更：
更新申请云游戏服务的配置参数，将鉴权选项 VeGameAuthObject 合并入VeGameConfigObject 选项中，在启动游戏时只需指定 configObj 参数。详细信息，参考 创建 VeGameManager 实例。
申请游戏服务时，新增通过 autoRecycleTime 参数设置无操作自动回收服务时长；并且新增在游戏中动态设置无操作自动回收服务时长接口（setAutoRecycleTime）。详细信息，参考 设置无操作回收服务时间。
申请游戏服务时，新增通过 userProfilePathList 参数设置保存游戏配置文件的路径列表；并且新增设置和获取保存游戏配置文件的路径接口（ setUserProfilePath 和 getUserProfilePath）。详细信息，参考 设置保存用户配置文件的路径。
新增云端游戏切换前后台状态回调，并支持通过 setRemoteGameForeground 接口将云端游戏切换到前台。详细信息，参考 云端游戏切换前台。
新增对采集的本地视频流进行优化处理的接口，包括设置本地视频画面布局（setLocalVideoCanvas）、使用“前置摄像头”采集时是否开启镜像翻转视频画面（setLocalVideoMirrorMode）、根据网络情况配置本地视频编码质量参数（setVideoEncoderConfig）。详细信息，参考 设置本地视频渲染视图。
更新地理位置请求开关默认值（将默认开启更新为默认关闭）。详细信息，参考 主流开关。
删除了调节游戏音量接口（turnVolume），可使用调节远端音频播放音量接口（setRemoteAudioPlaybackVolume）进行游戏音量调节。
Web/H5 端 SDK 包含以下新增功能和变更：
注意
重要变更：从 V1.11.0 开始，SDK 修改了打包方式，建议使用以下方法：bytePlay = new veGameSDK();
申请游戏服务时，新增通过 autoRecycleTime 参数设置无操作自动回收服务时长；并且新增在游戏中动态设置无操作自动回收服务时长接口（setAutoRecycleTime）。详细信息，参考 设置/获取无操作回收服务时间。
申请游戏服务时，新增通过 userProfilePathList 参数设置保存游戏配置文件的路径列表；并且新增设置和获取保存游戏配置文件的路径接口（ setUserProfilePath 和 getUserProfilePath）。详细信息，参考 设置保存用户配置文件的路径。
新增云端游戏切换前后台状态回调，并支持通过 setRemoteGameForeground 接口将云端游戏切换到前台。详细信息，参考 云端游戏切换前台。
新增基础音频能力相关接口，包括调节客户端本地播放和采集音量、获取和设置音频设备、开启/关闭音频数据发送等功能。详细信息，参考 调节本地播放和采集音量。
新增采集本地摄像头视频流并发送到云端实例的相关接口，并支持对采集的本地视频流进行优化处理的接口，包括设置本地视频画面布局（setLocalVideoCanvas）、使用“前置摄像头”采集时是否开启镜像翻转视频画面（setLocalVideoMirrorMode）、根据网络情况配置本地视频编码质量参数（setVideoEncoderConfig）。详细信息，参考 开启视频采集。
新增设置 PC 端全屏状态和退出全屏接口（setFullScreenState）。详细信息，参考 设置全屏状态。
新增云端游戏切换前后台、云端请求开始/停止发送音频数据、开始/停止采集音视频数据、更新音视频采集/播放设备、发送/接收音视频流状态等事件回调。详细信息，参考 事件回调。
更新了错误码及说明。详细信息，参考 错误码。
云游戏客户端 SDK V1.10.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
新增获取用户设备唯一标识符接口（getServiceDeviceId）。在客户端 SDK 初始化后调用该接口，获取并保存设备 ID 到业务自己的服务端。在通过调用服务端 PreAllocateResource 接口锁定资源、请求游戏服务时，透传保存的设备唯一标识，用于确定是否支持游戏多开。详细信息，参考 获取设备唯一标识。
新增设置客户端应用切换前后台状态接口（switchBackground）。详细信息，参考 客户端前后台切换。
新增基础音频能力相关接口，包括调节客户端本地播放和采集音量、调节云端游戏播放音量、开启/关闭音频数据发送等功能。详细信息，参考 调节本地播放和采集音量。
通过消息通道发送消息到云端游戏时，支持指定消息发送超时时长（timeout）参数，并增加云端实例在线、离线状态回调。详细信息，参考 收发消息。
更新了错误码及说明。详细信息，参考 错误码。
iOS 端 SDK 包含以下新增功能和变更：
新增获取用户设备唯一标识符接口（getServiceDeviceId）。在客户端 SDK 初始化后调用该接口，获取并保存设备 ID 到业务自己的服务端。在通过调用服务端 PreAllocateResource 接口锁定资源、请求游戏服务时，透传保存的设备唯一标识，用于确定是否支持游戏多开。详细信息，参考 获取设备唯一标识。
新增设置客户端应用切换前后台状态接口（switchBackground）。详细信息，参考 客户端前后台切换。
新增基础音视频能力相关接口，包括调节客户端本地播放和采集音量、调节云端游戏播放音量、开启/关闭音视频数据发送等功能。详细信息，参考 开启音频采集。
通过消息通道发送消息到云端游戏时，支持指定消息发送超时时长（time）参数。详细信息，参考 收发消息。
新增本地音视频流数据统计参数和远端音视频流数据统计参数。详细信息，参考 数据统计。
更新了错误码及说明。详细信息，参考 错误码。
Web/H5 端 SDK 包含以下新增功能和变更：
新增获取用户设备唯一标识符接口（getDeviceId）。在客户端 SDK 初始化后调用该接口，获取并保存设备 ID 到业务自己的服务端。在通过调用服务端 PreAllocateResource 接口锁定资源、请求游戏服务时，透传保存的设备唯一标识，用于确定是否支持游戏多开。详细信息，参考 获取设备唯一标识。
新增设置客户端应用切换前后台状态接口（switchBackground），并增加客户端应用或游戏切换前后台事件回调（background-switched）。详细信息，参考 客户端前后台切换 和 事件回调。
新增基础音频能力相关接口，支持调节本地播放音量。详细信息，参考 本地播放音量调节。
通过消息通道发送消息到云端游戏时，支持指定消息发送超时时长（timeout）参数，并增加云端实例在线、离线状态事件回调（message-channel-online 和 message-channel-offline）。详细信息，参考 发送自定义消息 和 事件回调。
更新了错误码及说明。详细信息，参考 错误码。
云游戏客户端 SDK V1.9.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
新增发送客户端本地剪贴板消息到云端实例接口（sendClipBoardMessage）以及接收剪贴板消息事件回调（onClipBoardMessageReceived）。详细信息，参考 发送剪贴板消息。
新增动态设置客户端切后台的保活时间接口（setIdleTime）。详细信息，参考 设置保活时间。
新增刷新用户鉴权的签名密钥接口（resetToken）。详细信息，参考 重置签名密钥。
更新了错误码及说明。详细信息，参考 错误码。
iOS 端 SDK 包含以下新增功能和变更：
新增发送客户端本地剪贴板消息到云端实例接口（sendClipBoardMessage）及回调。详细信息，参考 发送剪贴板消息。
新增客户端向云端实例发送通用消息（sendGeneralMessage）及回调。详细信息，参考 发送通用消息。
新增动态设置客户端切后台的保活时间接口（setIdleTime）。详细信息，参考 设置保活时间。
更新屏幕旋转回调返回值类型。详细信息，参考 回调接口。
拆分和更新操作延迟回调接口。详细信息，参考 回调接口。
更新了错误码及说明。详细信息，参考 错误码。
更新了以下接口和参数名称：
startWithConfig: gameConfigObj auth: authObj暂停游戏开关接口名称更新为：setPaused
静音开关接口名称更新为：setMute
Web/H5 端 SDK 包含以下新增功能和变更：
新增发送客户端本地剪贴板消息到云端实例接口（sendClipBoardMessage）。详细信息，参考 发送剪贴板消息。
新增动态设置客户端切后台的保活时间接口（setIdleTime）。详细信息，参考 设置保活时间。
新增刷新用户鉴权的签名密钥接口（renewToken）。详细信息，参考 刷新签名密钥。
新增云端实例发送到客户端的消息已接收事件回调（general-message-received）。详细信息，参考 事件回调。
新增云端实例剪贴板发生变化时的回调（clipboard-message-received）。详细信息，参考 事件回调。
更新了错误码及说明。详细信息，参考 错误码。
云游戏客户端 SDK V1.8.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
did 参数进行问题排查。改为通过 getDeviceId() 方法获取 SDK 生成的设备 ID，用于线上日志查询和问题排查。详细信息，参考 获取设备 ID。init 方法中的 cpuABIType 参数类型的包名改为了 com.volcengine.androidcloud.plugin。start() 接口中增加可选参数 reservedId（资源预锁定 ID），用于申请火山引擎云游戏每次服务。同时，在 onPlaySuccess 回调中返回 reservedId 字段。建议业务记录此 ID，用于每次服务会话的唯一标识，可用于调试和问题排查。详细信息，参考 开始播放。start() 接口中增加可选参数 customGameId（用户自定义游戏标识，在注册游戏时指定，与 game_id 必须指定其中一个）。start() 接口中增加可选参数 extra，可用于指定自定义扩展参数，进行设备属性修改等操作。iOS 端 SDK 包含以下新增功能和变更：
reservedId（资源预锁定 ID），用于申请火山引擎云游戏每次服务，并且在启动成功时返回。建议业务记录此 ID，用于每次服务会话的唯一标识，可用于调试和问题排查。详细信息，参考 初始化。customGameId（用户自定义游戏标识，在注册游戏时指定，与 game_id 必须指定其中一个）。Web/H5 端 SDK 包含以下新增功能和变更：
start() 接口中增加可选参数 reservedId（资源预锁定 ID），用于申请火山引擎云游戏每次服务，并且在启动成功时返回。建议业务记录此 ID，用于每次服务会话的唯一标识，可用于调试和问题排查。详细信息，参考 启动。start() 接口中增加可选参数 customGameId（用户自定义游戏标识，在注册游戏时指定，与 game_id 是映射关系）。start() 接口中增加可选参数 extra，可用于指定自定义扩展参数，进行设备属性修改等操作。appId 参数。云游戏客户端 SDK V1.7.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能：
iOS 端 SDK 包含以下新增功能：
Web/H5 端 SDK 包含以下新增功能：
start() 接口新增参数 isScreenLock（锁定屏幕方向），用于与 start() 接口的 rotation 参数配合使用。云游戏客户端 SDK V1.6.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能：
iOS 端 SDK 包含以下新增功能：
Web/H5 端 SDK 包含以下新增功能：
云游戏客户端 SDK V1.5.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
videoStreamProfileId）指定使用的清晰度 ID。在播放中，可调用 switchVideoStreamProfile 接口，切换清晰度档位。详细信息，参考 清晰度切换.iOS 端 SDK 包含以下新增功能和变更：
videoStreamProfileId）指定使用的清晰度 ID。在播放中，调用 switchVideoStreamProfile 接口，切换清晰度。Web / H5 端 SDK 包含以下新增功能和变更：
videoStreamProfileId）指定使用的清晰度 ID。在播放中，调用 switchVideoStreamProfile 接口，切换清晰度。云游戏客户端 SDK V1.4.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
roundId）。iOS 端 SDK 包含以下新增功能和变更：
roundId）。podId 配置项。Web / H5 端 SDK 包含以下新增功能和变更：
restart。roundId）。云游戏客户端 SDK V1.3.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
play() 变更为 start()，resumePlay 变更为 resume()。init() 和 start() 接口的调用逻辑，并提供最简配置和完整配置参考。iOS 端 SDK 包含以下新增功能和变更：
Web / H5 端 SDK 包含以下新增功能和变更：
start() 接口后，新增返回云端实例的宽度和高度（width 、height），用于调用发送触控事件接口时确定游戏画面的 x、y 轴相对坐标。云游戏客户端 SDK V1.2.0 版的发布说明如下：
Android 端 SDK 包含以下新增功能和变更：
gameId），直接启动游戏。iOS 端 SDK 包含以下新增功能和变更：
gameId），直接启动游戏。Web / H5 端 SDK 包含以下新增功能和变更：
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(); };