You need to enable JavaScript to run this app.
导航

客户端 SDK

最近更新时间2024.04.24 18:12:04

首次发布时间2023.01.13 15:08:12

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

2024年3月

云手机客户端 SDK V1.39.0 的发布说明如下:

Android

新增 sendShakeEventToRemote 透传客户端“摇一摇”指令,触发云手机模拟产生传感器重力加速数据。

iOS

新增 sendShakeEventToRemote 透传客户端“摇一摇”指令,触发云手机模拟产生传感器重力加速数据。

2024年2月

云手机客户端 SDK V1.37.0 的发布说明如下:

Android

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

  • StreamStats 类型说明中新增"获取当前编码格式"相关接口(getVideoCodecType),支持获取当前编码格式。详细信息,请参考 StreamStats 类型说明

  • Start() 接口的 config 字段中新增 accountId 用于动态修改用户的火山引擎账号。详细信息,请参考 config 字段

  • 在进程相关接口的相关功能,优化多用户加入房间控制策略。详细信息,请参考 进程相关接口

iOS

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

  • 在远端流数据统计 VeBaseRemoteStreamStats 结构下新增 videoCodecType 视频编码类型参数。详细信息,请参考 VeBaseRemoteStreamStats

  • accountId 火山账号 ID,支持动态账号切换。

  • 在进程相关接口相关功能,优化多用户加入房间控制策略。详细信息,请参考 进程相关接口

Web/H5

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

2024年1月

云手机客户端 SDK V1.34.0 的发布说明如下:

Android

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

  • 在拉流中,支持设置是否全屏的功能。详细信息,请参考设置全屏显示

  • 指令分发增加 pod 退房/进房回调接口。详细信息,请参考用户房间状态

iOS

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

Web/H5

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

2023年12月

云手机客户端 SDK V1.31.0 的发布说明如下:

Android

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

  • 新增“切换本地/云机输入法类型”相关接口(setKeyboardType)及回调说明,支持动态切换使用云机键盘或本地键盘。详细信息,参考 LocalInputManager

  • 更新了“实例退出”相关错误码 40000~40011。详细信息,参考 onPodExit 相关信息

iOS

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

  • 新增“切换本地/云机输入法类型”相关接口(setKeyboardType)及回调说明,支持动态切换使用云机键盘或本地键盘。详细信息,参考 切换本地/云机输入法类型

  • 更新了“实例退出”相关错误码 40000~40011。详细信息,参考 错误码

Web/H5

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

  • 新增“切换本地/云机输入法类型”相关接口(setKeyboardStyle),支持动态切换使用云机键盘或本地键盘。详细信息,参考 切换本地/云机输入法类型

  • 更新了“实例退出”相关错误码 40000~40011。详细信息,参考 错误码

2023年11月

云手机客户端 SDK V1.30.0 的发布说明如下:

Android

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

  • 更新 “拉取文件数据”(startPullFile)接口,支持从云机实例下载文件到客户端本地文件夹。详细信息,参考 收发文件

  • 新增 “操控权控制”(enableControl)等接口,支持设置指定用户是否具有云手机的操控权。详细信息,参考 操控权控制

  • 新增 “拦截 SDK 向云机实例发送触控事件”(setInterceptSendTouchEvent)等接口,支持回传触控事件(业务方可根据需要消费触控事件)。详细信息,参考 回传触控事件

iOS

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

  • 更新 “拉取文件数据”(startPullFile)接口,支持从云机实例下载文件到App沙盒路径下。详细信息,参考 文件传输

  • 新增 “操控权控制”(enableControl)等接口,支持设置指定用户是否具有云手机的操控权。相关信息,参考 设置用户的操控权

  • 新增 “拦截 SDK 向云机实例发送触控事件”(setInterceptSendTouchEvent)等接口,支持回传触控事件(业务方可根据需要消费触控事件)。详细信息,参考 设置是否拦截触控事件

Web/H5

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

  • 新增 “操控权控制”(enableControl)等接口,支持设置指定用户是否具有云手机的操控权。相关信息,参考 设置用户的操控权

2023年10月

云手机 Windows 客户端 SDK V1.0.0 正式发布。详细信息,参考 云手机 Windows 客户端 SDK 接入文档

2023年8月

云手机客户端 SDK V1.27.0 的发布说明如下:

Android

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

注意

重要变更
升级日志管理系统,支持日志动态开启、日志回捞、加密存储功能。删除 “设置是否生成本地日志文件”(setCreateLocalLog)接口。

2023年7月

云手机客户端 SDK V1.26.0 的发布说明如下:

Android

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

  • 申请云手机服务时,新增通过 renderView 参数指定视频流的渲染控件。详细信息,参考 开始播放

iOS

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

  • 更新了音视频流传输协议、优化画面显示效果。

Web/H5

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

  • 修复了部分已知问题以及性能优化。

2023年6月

云手机客户端 SDK V1.25.0 的发布说明如下:

Android

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

  • 更新 “云手机画面截图” 接口(screenShot)行为:截图的图片格式由 .png 格式改为 .jpg 格式;当云手机存储空间小于600MB时,不可同时指定保存截图文件在云手机实例中。详细信息,参考 云手机画面截图
  • 新增错误码11015、11016、40009。详细信息,参考 错误码

iOS

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

  • 在申请云手机服务的配置参数中,新增通过 rotaionMode 配置参数指定视频流的旋转模式,支持横屏视频流竖屏显示。详细信息,参考参考 配置参数
  • 更新 “云手机画面截图” 接口(screenShot)行为:截图的图片格式由 .png 格式改为 .jpg 格式;当云手机存储空间小于600MB时,不可同时指定保存截图文件在云手机实例中。详细信息,参考 云手机画面截图
  • 更新 “文件传输” 接口部分参数定义。详细信息,参考 文件传输
  • 新增错误码11015、11016、40009。详细信息,参考 错误码

Web/H5

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

  • 更新 “云手机画面截图” 接口(screenShot)行为:截图的图片格式由 .png 格式改为 .jpg 格式;当云手机存储空间小于600MB时,不可同时指定保存截图文件在云手机实例中。详细信息,参考 云手机画面截图
  • 新增错误码11015、11016、40009。详细信息,参考 错误码

2023年5月

云手机客户端 SDK V1.24.0 版的发布说明如下:

Android

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

注意

重要变更:
onServiceInit() 回调更新为 onServiceInit(Map<String, Object> extras),支持在调中增加服务端时间戳等信息。详细信息,参考 拉流播放状态回调监听

iOS

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

注意

重要变更:
调整 SDK 初始化接口,“初始化 SDK” 接口的名称由 setupConfigWithAccountId: AccountId 变更为 initWithAccountId: accountId。详细信息,参考 初始化 VePhoneManager 配置

  • 新增提高远端音频播放音量接口(volumeUp)和 降低远端音频播放音量接口(volumeDown)。详细信息,参考 提高远端音量降低远端音量
  • 新增 “媒体设备状态” 和 “媒体设备错误” 相关枚举项和说明,替换已有 “本地/远端音视频流状态及错误码” 相关枚举项和说明。详细信息,参考 媒体设备状态媒体设备错误 枚举说明。

Web/H5

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

  • 在实例化 vePhoneSDK 时,可通过指定可选参数 containerDomId 指定挂载 SDK 内部元素的 DOM 节点 ID。详细信息,参考 实例化 vePhoneSDK
  • 新增错误码 30014。详细信息,参考 错误码

2023年4月

云手机客户端 SDK V1.23.0 版的发布说明如下:

Android

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

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

iOS

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

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

Web/H5

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

  • 在实例化 vePhoneSDK 时,可通过指定可选参数 enableLocalKeyboard=false,支持将本地键盘输入事件同步到云机实例中,再分发到其他实例。详细信息,参考 实例化 vePhoneSDK
  • 更新实例化 vePhoneSDK 时可选参数 enableLocalKeyboard 的功能。当指定 enableLocalKeyboard=true 时,仅开启本地键盘输入功能;当指定 enableLocalKeyboard=false 时,开启云机键盘(PC Web 环境下,同时支持本地键盘)。详细信息,参考 实例化 vePhoneSDK
  • 申请云手机服务时,新增通过 videoRenderMode 参数指定视频流渲染模式,支持等比缩放居中模式、非等比拉伸模式、或等比例缩放模式。详细信息,参考 启动云手机
  • 新增更新画面渲染模式接口(updateVideoRenderMode),支持在运行过程中设置视频流画面渲染模式。详细信息,参考 更新画面渲染模式
  • 新增错误码 30012 和 30013,并更新了部分错误码及说明。详细信息,参考 错误码

2023年3月

云手机客户端 SDK V1.22.0 版的发布说明如下:

Android

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

  • 申请云手机服务时,新增通过 remoteWindowSize 参数指定云机推流的分辨率,支持获取初始化时 Container 的宽高请求服务端推流(默认)、服务端按照原始画面和分辨率推流、或按指定的宽高请求服务端推流。详细信息,参考 开始播放

  • 申请云手机服务时,新增通过 videoRenderMode 参数指定视频流渲染模式,支持等比缩放居中模式、非等比拉伸模式、或等比例缩放模式。详细信息,参考 开始播放

  • 新增更新画面渲染模式接口(updateVideoRenderMode),支持在运行过程中设置视频流画面渲染模式。详细信息,参考 更新画面渲染模式

  • 新增插件包依赖。在开发项目中引入 vePhoneSDK 时,可同时添加插件包的依赖,代替在 SDK 初始化的时候下载插件。详细信息,参考 快速接入

iOS

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

注意

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

  • 在申请云手机服务的配置参数中,新增通过 remoteWindowSize 配置参数指定云机推流的分辨率,支持获取初始化时传入的 containerView 的宽高请求服务端推流、服务端按照原始画面和分辨率推流、或按指定的宽高请求服务端推流。详细信息,参考参考 配置参数

  • 在申请云手机服务的配置参数中,新增通过 videoRenderMode 参数指定视频流渲染模式,支持等比缩放居中模式、非等比拉伸模式、或等比例缩放模式。详细信息,参考参考 配置参数

  • 新增更新画面渲染模式接口(setVideoRenderMode),支持在运行过程中设置视频流画面渲染模式。详细信息,参考 更新画面渲染模式

  • 网络质量回调中,新增 VeBaseNetworkQualityDown 评级,代表当前网络完全无法正常通信。详细信息,参考 网络质量回调

  • 新增获取本地音频采集音频接口(getLocalAudioCaptureVolume)和 获取音频播放设备接口(getAudioPlaybackDevice)。详细信息,参考 获取音频采集音量获取音频播放设备

Web/H5

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

  • 申请云手机服务时,新增通过 remoteWindowSize 参数指定云机推流的分辨率,支持获取初始化中传入 domId 容器的宽高请求服务端推流(默认)、服务端按照原始画面和分辨率推流、或按指定的宽高请求服务端推流。详细信息,参考 启动云手机

  • 网络质量回调参数中,新增 “网络完全无法正常通信” 相关评级。详细信息,参考 network-quality 事件

云手机客户端 SDK V1.21.0 版的发布说明如下:

Android

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

  • 新增查询云手机导航栏开关状态接口(getNavBarStatus)和设置云手机导航栏开关接口(setNavBarStatus)。详细信息,参考 导航栏开关
  • 申请云手机服务时,新增通过 streamType 参数指定拉取音视频流类型,支持启动云手机时默认静音的场景。详细信息,参考 开始播放
  • 更新云手机画面录屏接口(startRecording),支持指定保存录屏文件在云手机实例或上传录屏到火山引擎对象存储、并支持返回录屏文件的下载链接。详细信息,参考 云手机画面录屏

iOS

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

  • 新增查询云手机导航栏开关状态接口(getNavBarStatus)和设置云手机导航栏开关接口(setNavBarStatus)。详细信息,参考 设置导航栏开关状态
  • 在调用 startWithConfig: 启动云手机之前,新增通过 streamType 参数指定拉取音视频流类型,支持启动云手机时默认静音的场景。详细信息,参考 订阅音视频流
  • 更新云手机画面录屏接口(startRecording),支持指定保存录屏文件在云手机实例或上传录屏到火山引擎对象存储、并支持返回录屏文件的下载链。详细信息,参考 云手机画面录屏
  • 在申请云手机服务的配置参数中,新增通过 localKeyboardEnable 参数启动本地键盘输入法。详细信息,参考 配置参数
  • 删除申请云手机服务时指定 “启动的实例是否为云原生实例” 附加参数(use_cloud_native)。

Web/H5

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

  • 申请云手机服务时,新增通过 rotation 参数指定应用的横竖屏显示,即竖屏显示或默认根据应用的横竖屏进行自适应。详细信息,参考 启动云手机
  • 新增查询云手机导航栏开关状态接口(getNavBarStatus)和设置云手机导航栏开关接口(setNavBarStatus)。详细信息,参考 设置/获取导航栏开关状态
  • 更新云手机画面录屏接口(startRecording),支持指定保存录屏文件在云手机实例或上传录屏到火山引擎对象存储、并支持返回录屏文件的下载链。详细信息,参考 云手机画面录屏
  • 新增 “摇一摇” 功能、适配应用(游戏)的摇一摇场景。详细信息,参考 摇一摇
  • 删除申请云手机服务时指定 “启动的实例是否为云原生实例” 可选参数(useCloudNative)。
  • 新增屏幕旋转结果回调 on-screen-rotation,包含当前云手机中应用的显示方向、当前客户端拉取视频流的方向、以及云手机本身旋转角度。详细信息,参考 on-screen-rotation 事件
  • 修复了本地键盘和剪贴板相关的已知问题。

2023年2月

云手机客户端 SDK V1.19.0 和 V1.20.0 版的发布说明如下:

Android

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

  • 更新云手机画面截图接口(screenShot),支持指定保存截图在云手机实例或上传截图到火山引擎对象存储、并支持返回截图文件的下载链。详细信息,参考 云手机画面截图
  • 新增设置音频数据的采集模式接口(setAudioSourceType),支持指定自定义采集音频流(即用户自定义音频源)或 SDK 内部采集音频流。详细信息,参考 音频自采集
  • 新增设置视频数据的采集模式接口(setVideoSourceType),支持指定自定义采集视频流(即用户自定义视频源)或 SDK 内部采集视频流。详细信息,参考 视频自采集
  • 新增支持客户端与云机实例之间收发文件能力。详细信息,参考 收发文件
  • 新增文件传输相关错误码(71001 - 71006)。详细信息,参考 错误码

iOS

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

  • 更新云手机画面截图接口(screenShot),支持指定保存截图在云手机实例或上传截图到火山引擎对象存储、并支持返回截图文件的下载链。详细信息,参考 云手机画面截图
  • 新增推送外部音频数据接口(pushExternalAudioFrame),支持采集外部音频流。详细信息,参考 推送外部音频数据
  • 新增推送外部视频数据接口(pushExternalVideoFrame),支持采集外部视频流。详细信息,参考 推送外部视频数据
  • 新增支持客户端与云机实例之间收发文件。详细信息,参考 文件传输
  • 新增文件传输相关错误码(71001 - 71005)。详细信息,参考 错误码

Web/H5

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

  • 更新云手机画面截图接口(screenShot),支持指定保存截图在云手机实例或上传截图到火山引擎对象存储、并支持返回截图文件的下载链。详细信息,参考 云手机画面截图
  • 新增支持客户端与云机实例之间收发文件。详细信息,参考 大文件传输
  • 新增文件传输相关错误码(71001 - 71006)。详细信息,参考 错误码

2022年12月

云手机客户端 SDK V1.18.0 版的发布说明如下:

Android

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

  • 拉流播放状态回调监听中新增 onServiceInit() 回调,用于获取并初始化各个功能服务。详细信息,参考 IPlayerListener
  • 新增云手机画面录屏接口(startRecordingstopRecording),支持自定义录屏时长(不超过4小时)并将录像文件保存到云手机存储中。详细信息,参考 云手机画面录屏
  • 错误码 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。详细信息,参考 错误码
  • 删除 “网络状态信号同步” 接口(enableSyncSignalStrength)及相关接口文档。

iOS

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

注意

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

  • “设置配置信息” 接口的名称,由 setupConfigInfo 变更为 setupConfigWithAccountId
  • “创建 VeGameManager 单例对象” 接口的名称,由 sharedManagerWithAccountId: containerView: delegate: 变更为 sharedManagerWithContainerView: containerView: delegate:
  • 新增云手机画面录屏接口(startRecordingstopRecording),支持自定义录屏时长(不超过4小时)并将录像文件保存到云手机存储中。详细信息,参考 云手机画面录屏
  • 新增网络质量检测回调接口(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 包含以下新增功能和变更:

  • 在初始化实例时,新增 disableAudioInjection 可选参数,支持指定是否关闭音频注入功能。详细信息,参考 实例化 vePhoneSDK
  • 新增云手机画面录屏接口(startRecordingstopRecording),支持自定义录屏时长(不超过4小时)并将录像文件保存到云手机存储中。录屏结果可通过 on-screen-record-response 回调获取。详细信息,参考 云手机画面录屏
  • 新增网络质量检测回调接口(on('network-quality')),支持以回调的形式上报网络质量。业务方可以通过网络质量评级来了解用户的网络状况,进一步采取降级策略或提示用户更换网络,优化用户体验。详细信息,参考 事件回调
  • 错误码 10010(ERROR_START_NO_STOP_BEFORE)变更为警告码 10010(WARNING_START_NO_STOP_BEFORE)。详细信息,参考 警告码
  • 新增 “网络请求失败” 相关错误码 60002。详细信息,参考 错误码

云手机客户端 SDK V1.17.0 版的发布说明如下:

Web/H5

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

  • 优化鼠标滚动映射到实例内上下滑动的操控体验。

2022年11月

云手机客户端 SDK V1.16.0 版的发布说明如下:

Android

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

iOS

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

Web/H5

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

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

云手机客户端 SDK V1.15.0 版的发布说明如下:

Android

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

注意

重要变更

  • 新增“初始化 vePhoneEngine”接口 init(Application application)。在第一次初始化时,SDK 会进行一次资源异步加载。如果在初始化时资源加载失败,不需要重新调用 init。SDK 会在调用 start 接口启动云手机时检查资源是否已成功加载,如果没有,则会重新加载。资源加载完成后会由 ICloudCoreManagerStatusListeneronInitialed() 回调。详细信息,参考 初始化
  • 更新了以下错误码的 code 及错误信息,详细信息,参考以下表格说明。

错误码

错误描述

变更前变更后
50001ERROR_MESSAGE_NOT_READYERROR_MESSAGE_NOT_CONNECTED
50002ERROR_MESSAGE_CONNECT_FAILEDERROR_MESSAGE_FAILED_TO_PARSE_MSG
50003ERROR_MESSAGE_DISCONNECTERROR_MESSAGE_CHANNEL_UID_ILLEGAL
  • 新增“焦点窗口应用变化回调”接口。详细信息,参考 查询屏幕当前焦点应用
  • 新增“动态设置客户端切后台的保活时间”接口(setIdleTime)。详细信息,参考 设置保活时间
  • 新增“在应用运行中动态设置无操作自动回收服务时间”接口(setAutoRecycleTime)。详细信息,参考 设置/获取无操作回收服务时间
  • 更新了“启动云手机”相关错误码及说明。详细信息,参考 错误码

iOS

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

注意

重要变更

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

错误码

错误描述

变更前变更后
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
  • 新增“动态设置客户端切后台的保活时间”接口(setIdleTime)。详细信息,参考 设置保活时间
  • 新增“在应用运行中动态设置无操作自动回收服务时长”接口(setAutoRecycleTime)。详细信息,参考 设置无操作回收服务时间
  • 新增“获取屏幕当前焦点窗口应用”接口(getFocusedWindowApp)。详细信息,参考 查询屏幕当前焦点应用
  • 新增“媒体流视频开关”接口(muteVideo)。详细信息,参考 视频开关
  • 新增“客户端前后台切换”接口(switchBackground)。详细信息,参考 客户端前后台切换
  • 更新了“启动云手机”相关错误码及说明。详细信息,参考 错误码

Web/H5

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

注意

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

错误码错误描述
变更前变更后
10018ERROR_START_MUILT_DEVICE_CONFLICTERROR_START_USER_CONFLICT
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
  • 新增“在应用运行中动态设置无操作自动回收服务时长”接口(setAutoRecycleTime)。详细信息,参考 设置/获取无操作回收服务时间
  • 新增“获取屏幕当前焦点窗口应用”接口(getFocusedWindowApp)。详细信息,参考 查询屏幕当前焦点应用
  • 新增“媒体流音频开关”接口(muteAudio)。详细信息,参考 静音开关
  • 新增“媒体流视频开关”接口(muteVideo)。详细信息,参考 视频开关
  • 更新了“启动云手机”相关错误码及说明。详细信息,参考 错误码

2022年10月

云手机客户端 SDK V1.14.0 版的发布说明如下:

Android

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

注意

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

  • 新增媒体流视频开关接口(muteVideo)及检查视频播放状态接口(isVideoMuted)。详细信息,参考 视频开关
  • 清晰度切换接口(switchVideoStreamProfile)增加了清晰度档位枚举值、并支持横竖屏应用清晰度切换自适应。详细信息,参考 清晰度切换
  • 新增发送键盘事件指令到云机实例接口(sendKeyEvent),支持发送 Home键、返回键、菜单键和最近任务列表键盘事件。详细信息,参考 发送键盘事件指令
  • 优化了本地键盘与云机应用的交互。详细信息,参考 本地键盘
  • 新增指定火山引擎用户账号相关错误码(30009)。详细信息,参考 错误码
  • 新增 “云机应用退出” 相关错误码(40009)。详细信息,参考 onPodExit 相关信息

iOS

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

注意

重要变更

  • 调整了 VePhoneManager 初始化配置,“设置配置信息” 接口名称由 setConfigInfo 更新为 setupConfigInfo,并且在初始化云手机实例时,必须指定注册的火山引擎用户账号(accountId 参数)。 详细信息,参考 快速接入
  • 删除了 “销毁单例”(destroy)接口。
  • 更新了以下接口的名称:
接口变更前变更后
设置配置信息setConfigInfosetupConfigInfo
输出日志consoleLogEnablelogEnable
  • 新增发送键盘事件到云机实例接口(sendKeyEvent),支持发送 Home键、返回键、菜单键和最近任务列表键盘事件。详细信息,参考 发送键盘事件
  • 新增指定火山引擎用户账号相关错误码(30009)。详细信息,参考 错误码
  • 修复了前后摄像头切换时视频出现颠倒的问题。

Web/H5

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

注意

重要变更

  • 在初始化实例时,需要指定 accountId 必选参数(注册的火山引擎用户账号)。详细信息,参考 实例化 vePhoneSDK
  • 更新了发送按键事件接口(sendKeycodeMessage)可支持的按键键码,仅支持 Home键、返回键、菜单键和最近任务列表,并且该接口的返回值变更为 Promise(返回发送成功或失败的状态)。详细信息,参考 发送按键事件
  • 新增对横屏应用默认横屏显示的支持。详细信息,参考 start 接口的 rotation 参数说明
  • 新增指定火山引擎用户账号相关错误码(30009)。详细信息,参考 错误码

2022年9月

云手机客户端 SDK V1.13.0 版的发布说明如下:

Android

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

  • 新增云手机画面截图接口 screenShot,发起对云手机画面进行截图操作。截图成功后通过 onScreenCaptured 回调,截图数据保存在云手机实例中。详细信息,参考 云手机画面截图
  • 新增网络状态信号同步接口 enableSyncSignalStrength,实时采集客户端网络信号状态(WiFi 信号或移动蜂窝网络信号)并同步到云手机实例,在云手机广播客户端上报的网络信号状态。
  • 在收发消息接口 sendMessage 中,新增 channelUid 参数(云机应用初始化 veMessageChannelClient 时填入的用户 ID);同时新增 getSrcChannelUidgetDestChannelUid 接口,替代原有 getSendUserId() 接口,支持客户端与云机多个应用之间传输自定义消息。详细信息,参考 收发消息
  • 新增了客户端和云手机应用之间的消息通道连接行为变更。当客户端调用 stop 接口停止拉流、客户端和云手机应用之间已建立的消息通道连接断开;当客户端调用 start 接口重新启动云手机后,veMessageChannelClient 会主动恢复客户端和云手机应用之间的消息通道连接(需在云机环境部署 Message Channel SDK V1.0.5 及以上版本)。详细信息,参考 Message Channel SDK 接入说明
  • 新增了云手机画面截图相关错误码及说明(40045、40046)。详细信息,参考 错误码

iOS

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

  • 对 SDK 包体积进行了优化(与上一版本相比,SDK 包体积缩小到了约 30MB;该优化为火山引擎云手机客户端 SDK 体积优化,业务集成后的体积变化需由业务方测试和评估)。
  • 新增云手机画面截图接口 screenShot,发起对云手机画面进行截图操作。截图成功后通过 onScreenShot 回调,返回保存在云手机实例中保存截图文件的路径。详细信息,参考 云手机画面截图
  • 在发送消息接口 sendMessage 中,新增 channelId 参数,支持客户端与多个云机多个应用之间传输自定义消息。详细信息,参考 使用指定消息通道向云机发送消息
  • 新增了客户端和云手机应用之间的消息通道连接行为变更。当客户端调用 stop 接口停止拉流、客户端和云手机应用之间已建立的消息通道连接断开;当客户端调用 start 接口重新启动云手机后,veMessageChannelClient 会主动恢复客户端和云手机应用之间的消息通道连接(需在云机环境部署 Message Channel SDK V1.0.5 及以上版本)。详细信息,参考 Message Channel SDK 接入说明
  • 新增了云手机画面截图相关错误码及说明(40045、40046)。详细信息,参考 错误码

Web/H5

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

注意

重要变更:改变“发送自定义消息”(sendMessage)接口的入参格式,变更如下:

变更前:
sendMessage(message, needAck, timeout)

变更后:
sendMessage({message, needAck, timeout, destUserId})

  • SDK 内部渲染 DOM 容器新增 overflow:hidden 属性,可能对业务样式产生影响,需要关注。
  • 新增 PC Web 键鼠映射功能,支持通过 PC 浏览器访问云手机时,通过 PC 端键盘和鼠标操作云手机。可在实例化 vePhoneSDK 时,通过 enableLocalKeyboardenableLocalMouseScroll 参数开启本地键盘输入功能和本地鼠标滑轮滚动映射。详细信息,参考 实例化 vePhone SDK
  • 新增云手机画面截图接口 screenShot,对当前云手机画面进行截图,并获取在云手机实例中保存截图文件的路径。详细信息,参考 云手机画面截图
  • 在发送自定义消息接口 sendMessage 中,新增 destUserId 参数(云机应用初始化 veMessageChannelClient 时填入的目标 ID),支持客户端与云机多个应用之间传输自定义消息。当 Message Channel 连接通道超过1条时,必须指定 destUserId 参数。详细信息,参考 发送自定义消息
  • 新增了客户端和云手机应用之间的消息通道连接行为变更。当客户端调用 stop 接口停止拉流、客户端和云手机应用之间已建立的消息通道连接断开;当客户端调用 start 接口重新启动云手机后,veMessageChannelClient 会主动恢复客户端和云手机应用之间的消息通道连接(需在云机环境部署 Message Channel SDK V1.0.5 及以上版本)。详细信息,参考 Message Channel SDK 接入说明
  • 新增了云手机画面截图相关错误码及说明(40045、40046)。详细信息,参考 错误码

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 体积优化,业务集成后的体积变化需由业务方测试和评估)。

iOS

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

  • 新增 “画布设置无效” 相关的错误码说明及操作建议。详细信息,参考 错误码(30008)

Web/H5

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

  • 对以下问题进行了修复:
    • 修复了首次 start 即进入重新连接的问题;
    • 修复了音频自动播放失败的问题,在自动播放失败时抛出 warning 事件,提示和引导用户与页面进行交互来恢复播放;
    • 增加屏幕方向变化的日志。

2022年7月

云手机客户端 SDK V1.11.0 版的发布说明如下:

Android

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

注意

重要变更:从 V1.11.0 开始,SDK 初始化变更为由 SDK 内部完成,用户无需调用初始化接口、可直接调用 start() 接口申请云手机服务。SDK 初始化成功后,由 ICloudCoreManagerStatusListeneronInitialed() 回调触发。

  • SDK 初始化变更为由 SDK 内部完成,用户无需调用初始化接口、可直接调用 start() 接口申请云手机服务。SDK 初始化成功后,由 ICloudCoreManagerStatusListeneronInitialed() 回调触发。

  • 申请云手机服务时,新增通过 enableFileChannel 参数开启大文件传输通道,支持客户端与云机实例之间收发大文件。

  • 新增动态设置云手机经纬度信息接口(setRemoteLocationMock),模拟云手机的 GPS 定位,满足模拟挂机场景。详细信息,参考 设置远端请求位置信息的模式

  • 新增云机应用切换前后台状态回调,并支持通过 setRemoteAppForeground 接口将云机应用切换到前台。详细信息,参考 云机应用切换前台

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

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

iOS

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

  • 更新申请云手机服务的配置参数,将鉴权选项 VePhoneAuthObject 合并入VePhoneConfigObject 选项中,在启动云手机时只需指定 configObj 参数。详细信息,参考 创建 VePhoneManager 实例

  • 新增设置配置信息接口(setConfigInfo),在程序启动的时候调用,初始化 VePhoneManager 配置。

  • 新增动态设置云手机经纬度信息接口(setRemoteLocationMock),模拟云手机的 GPS 定位,满足模拟挂机场景。详细信息,参考 设置远端定位信息

  • 新增云机应用切换前后台状态回调,并支持通过 setRemoteAppForeground 接口将云机应用切换到前台。详细信息,参考 云机应用切换前台

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

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

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

Web/H5

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

注意

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

  • 新增动态设置云手机经纬度信息接口(setRemoteLocationMock),模拟云手机的 GPS 定位,满足模拟挂机场景。详细信息,参考 设置远端位置信息

  • 新增云机应用切换前后台状态回调,并支持通过 setRemoteAppForeground 接口将云机应用切换到前台。详细信息,参考 云机应用切换前台

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

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

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

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

2022年6月

云手机客户端 SDK V1.10.0 版的发布说明如下:

Android

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

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

  • 通过消息通道发送消息到云机应用时,支持指定消息发送超时时长(timeout)参数,并增加云机实例在线、离线状态回调。详细信息,参考 收发消息

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

iOS

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

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

  • 通过消息通道发送消息到云机应用时,支持指定消息发送超时时长(time)参数。详细信息,参考 收发消息

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

  • 删除了音量接调节接口(turnVolume),可使用新增的音视频能力相关接口代替。

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

Web/H5

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

  • 启动云手机时,可使用新增的 rotationisScreenLock 参数设置旋转终端时应用(游戏)的横竖屏显示方式。详细信息,参考 启动 start

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

  • 通过消息通道发送消息到云机应用时,支持指定消息发送超时时长(timeout)参数,并增加云机实例在线、离线状态事件回调(message-channel-onlinemessage-channel-offline)。详细信息,参考 发送自定义消息事件回调

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

2022年5月

云手机客户端 SDK V1.9.0 版的发布说明如下:

Android

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

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

  • 删除了麦克风开关相关接口(enableMicisEnableMic)。

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

iOS

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

  • 新增获取 SDK 生成的设备 ID 接口(currentDeviceId),用于线上日志查询和问题排查。详细信息,参考 获取设备 ID

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

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

Web/H5

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

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

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

  • 新增云机实例剪贴板发生变化时的回调(clipboard-message-received)。详细信息,参考 事件回调

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

2022年4月

云手机客户端 SDK V1.8.0 版的发布说明如下:

Web/H5

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

  • 启动云手机 start 接口中,新增指定需要启动的应用 ID 参数 applicationId。详细信息,参考 启动

  • 更新错误码及说明。

2022年3月

云手机客户端 SDK V1.7.0 版的发布说明如下:

Android

  • 在初始化时,支持下载指定 so 的类型。详细信息,参考 初始化
  • start() 接口中,新增 reset 参数,支持退出后,重置设备环境。详细信息,参考 开始播放
  • 新增视频流多清晰度档位设置功能。在启动云手机时,可在配置项中通过 videoStreamProfileId 参数指定使用的清晰度档位。在播放中,可调用 switchVideoStreamProfile() 接口,切换清晰度档位。详细信息,参考 清晰度切换
  • 更新错误码及说明。

2022年1月

云手机客户端 SDK V1.6.0 版的发布说明如下:

Android

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

  • 云手机客户端 SDK 名称更新为 vePhoneSDK。
  • 调整了接口说明文档的结构。详细信息,参考 Android SDK 接口说明

iOS

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

  • 云手机客户端 SDK 名称更新为 vePhoneSDK。
  • 调整了接口说明文档的结构。详细信息,参考 iOS SDK 接口说明

Web/H5

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

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

2021年11月

云手机客户端 SDK V1.5.0 版的发布说明如下:

Android

Android 端 SDK 包含以下新增功能和行为变更:

  • 更新错误码及说明。

iOS

iOS 端 SDK 包含以下新增功能和行为变更:

  • 新增从客户端发送消息到云机的接口和回调。
  • 更新错误码及说明。

Web / H5

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

  • 新增从客户端发送消息到云机实例功能。
  • 更新错误码及说明。

2021年10月

云手机客户端 SDK V1.4.0 版的发布说明如下:

Android

Android 端 SDK 包含以下新增功能和行为变更:

  • 更新错误码及说明。

iOS

iOS 端 SDK 包含以下新增功能和行为变更:

  • 删除 “云通知” 相关接口,以及相关错误码。
  • 更新错误码及说明。

Web / H5

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

  • 新增支持本地输入法。
  • 更新错误码及说明。

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() 接口后,新增返回云机实例的宽度和高度(widthheight),用于调用发送触控事件接口时确定手机画面的 x、y 轴相对坐标。
  • 新增发送触控事件接口(sendTouchMessage),支持自定义触控事件。
  • 新增 sendCustomMessage 接口,支持客户端与云机应用之间收发消息和数据流。
  • 更新错误码及说明。

2021年8月

云手机 SDK V1.2.0 版的发布说明如下:

Android

Android 端 SDK 包含以下新增功能和行为变更:

  • 新增对接入云手机服务的用户进行鉴权,提升客户订阅的云手机服务的安全性。用户通过客户端 SDK 启动云手机服务时,需要传入 Session Token。获取 Session Token 的方法,参考 签发临时 Token
  • 移除切换分辨率接口。

iOS

iOS 端 SDK 包含以下新增功能和行为变更:

  • 新增对接入云手机服务的用户进行鉴权,提升客户订阅的云手机服务的安全性。用户通过客户端 SDK 启动云手机服务时,需要传入 Session Token。获取 Session Token 的方法,参考 签发临时 Token

Web / H5

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

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