最近更新时间:2024.04.24 19:40:19
首次发布时间:2021.10.18 18:26:38
火山引擎-云手机为您提供对接云手机-云原生PaaS服务的客户端 SDK,支持 Android、iOS、Web/H5 和 Windows 终端接入。vePhoneSDK 提供了丰富的接口,帮助开发者快速搭建实例开始自己的业务。
客户端 | SDK 包文件 | 开发者文档 |
---|---|---|
Android | ||
iOS | ||
Web/H5 | ||
Windows |
云手机客户端 SDK V1.39.0 的发布说明如下:
新增 sendShakeEventToRemote
接口透传客户端“摇一摇”指令,触发云手机模拟产生传感器重力加速数据。
新增 sendShakeEventToRemote
接口透传客户端“摇一摇”指令,触发云手机模拟产生传感器重力加速数据。
云手机客户端 SDK V1.37.0 的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
getVideoCodecType()
获取当前视频编码格式”相关接口,视频编码格式参数回调,详细信息,请参考 StreamStats。start()
接口中详细配置新增参数 accountId
” 账号 ID,支持动态切换,详细信息,请参考config。iOS 端 SDK 包含以下新增功能和变更:
videoCodecType
视频编码类型参数”,视频编码格式参数回调,详细信息,请参考 VeBaseRemoteStreamStats。VePhoneConfigObject
中详细配置新增参数 accountId
” 账号 ID,支持动态切换,详细信息,请参考 VePhoneConfigObject。Web/H5 端 SDK 包含以下新增功能和变更:
切换视频清晰度,switchVideoStreamProfile
变更为 setVideoStreamProfileId
错误码优化:
StartErrorCode
中删除 10009 错误码
ErrorCode
中删除 40002
、40003
、40005
、40011
错误码
云手机客户端 SDK V1.34.0 的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
onFullScreenStateChanged
)及回调说明,在拉流过程中,支持设置是否全屏的功能。详细信息,请参考 onFullScreenStateChanged。iOS 端 SDK 包含以下新增功能和变更:
enableFullScreen
),在拉流过程中,支持设置是否全屏的功能。详细信息,请参考 enableFullScreen。Web/H5 端 SDK 包含以下新增功能和变更:
新增“在拉流过程中,设置云端实例是否全屏显示”相关接口(enableFullScreen
),在拉流过程中,支持设置是否全屏的功能。详细信息,请参考
新增“进程相关接口“及回调说明,从控 pod 加房、离房回调。详细信息,请参考[进程相关接口]
云手机客户端 SDK V1.31.0 的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
新增“切换本地/云机输入法类型”相关接口(setKeyboardType
)及回调说明,支持动态切换使用云机键盘或本地键盘。详细信息,参考 LocalInputManager。
更新了“实例退出”相关错误码 40000~40011。详细信息,参考 onPodExit 相关信息。
iOS 端 SDK 包含以下新增功能和变更:
新增“切换本地/云机输入法类型”相关接口(setKeyboardType
)及回调说明,支持动态切换使用云机键盘或本地键盘。详细信息,参考 切换本地/云机输入法类型。
更新了“实例退出”相关错误码 40000~40011。详细信息,参考 错误码。
Web/H5 端 SDK 包含以下新增功能和变更:
新增“切换本地/云机输入法类型”相关接口(setKeyboardStyle
),支持动态切换使用云机键盘或本地键盘。详细信息,参考 切换本地/云机输入法类型。
更新了“实例退出”相关错误码 40000~40011。详细信息,参考 参考 错误码。
云手机客户端 SDK V1.30.0 的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
更新 “拉取文件数据”(startPullFile
)接口,支持从云机实例下载文件到客户端本地文件夹。详细信息,参考 收发文件。
新增 “操控权控制”(enableControl
)等接口,支持设置指定用户是否具有云手机的操控权。详细信息,参考 操控权控制。
新增 “拦截 SDK 向云机实例发送触控事件”(setInterceptSendTouchEvent
)等接口,支持回传触控事件(业务方可根据需要消费触控事件)。详细信息,参考 回传触控事件。
iOS 端 SDK 包含以下新增功能和变更:
更新 “拉取文件数据”(startPullFile
)接口,支持从云机实例下载文件到App沙盒路径下。详细信息,参考 文件传输。
新增 “操控权控制”(enableControl
)等接口,支持设置指定用户是否具有云手机的操控权。相关信息,参考 设置用户的操控权。
新增 “拦截 SDK 向云机实例发送触控事件”(setInterceptSendTouchEvent
)等接口,支持回传触控事件(业务方可根据需要消费触控事件)。详细信息,参考 设置是否拦截触控事件。
Web/H5 端 SDK 包含以下新增功能和变更:
enableControl
)等接口,支持设置指定用户是否具有云手机的操控权。相关信息,参考 设置用户的操控权。云手机客户端 SDK V1.29.0 的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
删除 “设置 Logger”(setLogger
)接口。使用 “设置 Debug 模式”(setDebug
)接口打印日志信息。详细信息,参考 设置 Debug 模式。
修复了部分已知问题。
iOS 端 SDK 包含以下新增功能和变更:
Web/H5 端 SDK 包含以下新增功能和变更:
Android 端 SDK V1.28.2 包含以下新增功能和变更:
注意
重要变更
新增了 prepare
函数,用于设置 SDK 的 Android Application 全局上下文对象 ,并开始下载对应的插件。需要在调用 start
接口之前调用。需要特别注意,调用 vePhoneEngine prepare
函数就是正式开始使用 SDK 了。因为 SDK 在运行过程中需要采集必要的用户信息,所以在调用 vePhoneEngine 的 prepare
函数前,必须提示并获得用户授权。详细信息,参考 SDK prepare 函数。
申请云手机服务时,新增通过 videoRotationMode
参数指定视频旋转模式,支持 SDK 内部对视频画面进行方向处理。详细信息,参考 开始播放。
新增 “设置/获取视频旋转模式”(setVideoRotationMode
和 getVideoRotationMode
)接口,支持 SDK 内部对视频画面进行方向处理。详细信息,参考 SDK 内部渲染旋转画面。
新增警告码 30012。详细信息,参考 警告码。
Web/H5 端 SDK V1.28.2 包含以下新增功能和变更:
Windows 客户端 SDK V1.0.0 正式发布。详细信息,参考 云手机 Windows 客户端 SDK 接入文档。
云手机客户端 SDK V1.27.x 的发布说明如下:
Android 端 SDK V1.27.3 包含以下新增功能和变更:
sendInputText
),支持直接发送文字到云手机实例输入框内。详细信息,参考 本地键盘。iOS 端 SDK V1.27.0 包含以下新增功能和变更:
setDebugInfoEnable
)接口。详细信息,参考 开启调试日志。Web/H5 端 SDK V1.27.1 包含以下新增功能和变更:
云手机客户端 SDK V1.27.0 的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
注意
重要变更
升级日志管理系统,支持日志动态开启、日志回捞、加密存储功能。删除 “设置是否生成本地日志文件”(setCreateLocalLog
)接口。如需保存日志到本地文件,可以通过 “设置 Logger”(setLogger(AcLog.ILogger logger)
)接口接收日志后自行实现。
云手机客户端 SDK V1.26.0 的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
renderView
参数指定视频流的渲染控件。详细信息,参考 开始播放。iOS 端 SDK 包含以下新增功能和变更:
Web/H5 端 SDK 包含以下新增功能和变更:
云手机客户端 SDK V1.25.0 的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
screenShot
)行为:截图的图片格式由 .png 格式改为 .jpg 格式;当云手机存储空间小于600MB时,不可同时指定保存截图文件在云手机实例中。详细信息,参考 云手机画面截图。iOS 端 SDK 包含以下新增功能和变更:
rotaionMode
配置参数指定视频流的旋转模式,支持横屏视频流竖屏显示。详细信息,参考参考 配置参数。screenShot
)行为:截图的图片格式由 .png 格式改为 .jpg 格式;当云手机存储空间小于600MB时,不可同时指定保存截图文件在云手机实例中。详细信息,参考 云手机画面截图。Web/H5 端 SDK 包含以下新增功能和变更:
screenShot
)行为:截图的图片格式由 .png 格式改为 .jpg 格式;当云手机存储空间小于600MB时,不可同时指定保存截图文件在云手机实例中。详细信息,参考 云手机画面截图。云手机客户端 SDK V1.24.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
注意
重要变更:onServiceInit()
回调更新为 onServiceInit(Map<String, Object> extras)
,支持在调中增加服务端时间戳等信息。详细信息,参考 拉流播放状态回调监听。
iOS 端 SDK 包含以下新增功能和变更:
注意
重要变更:
调整 SDK 初始化接口,“初始化 SDK” 接口的名称由 setupConfigWithAccountId: AccountId
变更为 initWithAccountId: accountId
。详细信息,参考 初始化 VePhoneManager 配置。
volumeUp
)和 降低远端音频播放音量接口(volumeDown
)。详细信息,参考 提高远端音量 和 降低远端音量。Web/H5 端 SDK 包含以下新增功能和变更:
containerDomId
指定挂载 SDK 内部元素的 DOM 节点 ID。详细信息,参考 实例化 vePhoneSDK。云手机客户端 SDK V1.23.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
iOS 端 SDK 包含以下新增功能和变更:
Web/H5 端 SDK 包含以下新增功能和变更:
enableLocalKeyboard=false
,支持将本地键盘输入事件同步到云机实例中,再分发到其他实例。详细信息,参考 实例化 vePhoneSDK。enableLocalKeyboard
的功能。当指定 enableLocalKeyboard=true
时,仅开启本地键盘输入功能;当指定 enableLocalKeyboard=false
时,开启云机键盘(PC Web 环境下,同时支持本地键盘)。详细信息,参考 实例化 vePhoneSDK。videoRenderMode
参数指定视频流渲染模式,支持等比缩放居中模式、非等比拉伸模式、或等比例缩放模式。详细信息,参考 启动云手机。updateVideoRenderMode
),支持在运行过程中设置视频流画面渲染模式。详细信息,参考 更新画面渲染模式。云手机客户端 SDK V1.22.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
申请云手机服务时,新增通过 remoteWindowSize
参数指定云机推流的分辨率,支持获取初始化时 Container 的宽高请求服务端推流(默认)、服务端按照原始画面和分辨率推流、或按指定的宽高请求服务端推流。详细信息,参考 开始播放。
申请云手机服务时,新增通过 videoRenderMode
参数指定视频流渲染模式,支持等比缩放居中模式、非等比拉伸模式、或等比例缩放模式。详细信息,参考 开始播放。
新增更新画面渲染模式接口(updateVideoRenderMode
),支持在运行过程中设置视频流画面渲染模式。详细信息,参考 更新画面渲染模式。
新增插件包依赖。在开发项目中引入 vePhoneSDK 时,可同时添加插件包的依赖,代替在 SDK 初始化的时候下载插件。详细信息,参考 快速接入。
iOS 端 SDK 包含以下新增功能和变更:
注意
重要变更:
“设置音频播放设备” 接口的名称,由 setAudioRoute
变更为 setAudioPlaybackDevice
。详细信息,参考 设置音频播放设备。
在申请云手机服务的配置参数中,新增通过 remoteWindowSize
配置参数指定云机推流的分辨率,支持获取初始化时传入的 containerView 的宽高请求服务端推流、服务端按照原始画面和分辨率推流、或按指定的宽高请求服务端推流。详细信息,参考参考 配置参数。
在申请云手机服务的配置参数中,新增通过 videoRenderMode
参数指定视频流渲染模式,支持等比缩放居中模式、非等比拉伸模式、或等比例缩放模式。详细信息,参考参考 配置参数。
新增更新画面渲染模式接口(setVideoRenderMode
),支持在运行过程中设置视频流画面渲染模式。详细信息,参考 更新画面渲染模式。
网络质量回调中,新增 VeBaseNetworkQualityDown
评级,代表当前网络完全无法正常通信。详细信息,参考 网络质量回调。
新增获取本地音频采集音频接口(getLocalAudioCaptureVolume
)和 获取音频播放设备接口(getAudioPlaybackDevice
)。详细信息,参考 获取音频采集音量 和 获取音频播放设备。
Web/H5 端 SDK 包含以下新增功能和变更:
申请云手机服务时,新增通过 remoteWindowSize
参数指定云机推流的分辨率,支持获取初始化中传入 domId 容器的宽高请求服务端推流(默认)、服务端按照原始画面和分辨率推流、或按指定的宽高请求服务端推流。详细信息,参考 启动云手机。
网络质量回调参数中,新增 “网络完全无法正常通信” 相关评级。详细信息,参考 network-quality 事件。
云手机客户端 SDK V1.21.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
getNavBarStatus
)和设置云手机导航栏开关接口(setNavBarStatus
)。详细信息,参考 导航栏开关。streamType
参数指定拉取音视频流类型,支持启动云手机时默认静音的场景。详细信息,参考 开始播放。startRecording
),支持指定保存录屏文件在云手机实例或上传录屏到火山引擎对象存储、并支持返回录屏文件的下载链接。详细信息,参考 云手机画面录屏。iOS 端 SDK 包含以下新增功能和变更:
getNavBarStatus
)和设置云手机导航栏开关接口(setNavBarStatus
)。详细信息,参考 设置导航栏开关状态。startWithConfig:
启动云手机之前,新增通过 streamType
参数指定拉取音视频流类型,支持启动云手机时默认静音的场景。详细信息,参考 订阅音视频流。startRecording
),支持指定保存录屏文件在云手机实例或上传录屏到火山引擎对象存储、并支持返回录屏文件的下载链。详细信息,参考 云手机画面录屏。localKeyboardEnable
参数启动本地键盘输入法。详细信息,参考 配置参数。use_cloud_native
)。Web/H5 端 SDK 包含以下新增功能和变更:
rotation
参数指定应用的横竖屏显示,即竖屏显示或默认根据应用的横竖屏进行自适应。详细信息,参考 启动云手机。getNavBarStatus
)和设置云手机导航栏开关接口(setNavBarStatus
)。详细信息,参考 设置/获取导航栏开关状态。startRecording
),支持指定保存录屏文件在云手机实例或上传录屏到火山引擎对象存储、并支持返回录屏文件的下载链。详细信息,参考 云手机画面录屏。useCloudNative
)。on-screen-rotation
,包含当前云手机中应用的显示方向、当前客户端拉取视频流的方向、以及云手机本身旋转角度。详细信息,参考 on-screen-rotation 事件。云手机客户端 SDK V1.20.1 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
screenShot
),支持指定保存截图在云手机实例或上传截图到火山引擎对象存储、并支持返回截图文件的下载链。详细信息,参考 云手机画面截图。setAudioSourceType
),支持指定自定义采集音频流(即用户自定义音频源)或 SDK 内部采集音频流。详细信息,参考 音频自采集。setVideoSourceType
),支持指定自定义采集视频流(即用户自定义视频源)或 SDK 内部采集视频流。详细信息,参考 视频自采集。iOS 端 SDK 包含以下新增功能和变更:
screenShot
),支持指定保存截图在云手机实例或上传截图到火山引擎对象存储、并支持返回截图文件的下载链。详细信息,参考 云手机画面截图。pushExternalAudioFrame
),支持采集外部音频流。详细信息,参考 推送外部音频数据。pushExternalVideoFrame
),支持采集外部视频流。详细信息,参考 推送外部视频数据。Web/H5 端 SDK 包含以下新增功能和变更:
screenShot
),支持指定保存截图在云手机实例或上传截图到火山引擎对象存储、并支持返回截图文件的下载链。详细信息,参考 云手机画面截图。云手机客户端 SDK V1.18.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
onServiceInit()
回调,用于获取并初始化各个功能服务。详细信息,参考 IPlayerListener。startRecording
和 stopRecording
),支持自定义录屏时长(不超过4小时)并将录像文件保存到云手机存储中。详细信息,参考 云手机画面录屏。enableSyncSignalStrength
)及相关接口文档。iOS 端 SDK 包含以下新增功能和变更:
注意
重要变更:
调整了传入火山引擎用户账号(AccountId
参数)的时机,改为在 “设置配置信息” 接口中传入,因此涉及以下接口名称变更:
setupConfigInfo
变更为 setupConfigWithAccountId
。sharedManagerWithAccountId: containerView: delegate:
变更为 sharedManagerWithContainerView: containerView: delegate:
。startRecording
和 stopRecording
),支持自定义录屏时长(不超过4小时)并将录像文件保存到云手机存储中。详细信息,参考 云手机画面录屏。onNetworkQuality
),支持以回调的形式上报网络质量。业务方可以通过网络质量评级来了解用户的网络状况,进一步采取降级策略或提示用户更换网络,优化用户体验。详细信息,参考 回调接口 和 网络质量回调。Web/H5 端 SDK 包含以下新增功能和变更:
disableAudioInjection
可选参数,支持指定是否关闭音频注入功能。详细信息,参考 实例化 vePhoneSDK。startRecording
和 stopRecording
),支持自定义录屏时长(不超过4小时)并将录像文件保存到云手机存储中。录屏结果可通过 on-screen-record-response
回调获取。详细信息,参考 云手机画面录屏。on('network-quality')
),支持以回调的形式上报网络质量。业务方可以通过网络质量评级来了解用户的网络状况,进一步采取降级策略或提示用户更换网络,优化用户体验。详细信息,参考 事件回调。云手机客户端 SDK V1.17.0 版的发布说明如下:
Web/H5 端 SDK 包含以下新增功能和变更:
云手机客户端 SDK V1.16.1 版的发布说明如下:
Web/H5 端 SDK 包含以下新增功能和变更:
setAudioSourceType/setVideoSourceType
)接口,支持指定自定义采集音视频流(即用户自定义音视频源)或 SDK 内部采集音视频流。详细信息,参考 设置音频/视频采集模式。startExternalVideoTrack/stopExternalVideoTrack
)接口。详细信息,参考 开启/关闭视频外部采集。startExternalAudioTrack/stopExternalAudioTrack
)接口。详细信息,参考 开启/关闭音频外部采集。云手机客户端 SDK V1.16.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
iOS 端 SDK 包含以下新增功能和变更:
Web/H5 端 SDK 包含以下新增功能和变更:
云手机客户端 SDK V1.15.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
注意
重要变更:
更新了以下错误码的 code 及错误信息,详细信息,参考以下表格说明。
错误码 | 错误描述 | |
---|---|---|
变更前 | 变更后 | |
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 |
setIdleTime
)。详细信息,参考 设置保活时间。setAutoRecycleTime
)。详细信息,参考 设置/获取无操作回收服务时间。iOS 端 SDK 包含以下新增功能和变更:
注意
重要变更:
channelId:(NSString *)channelId
变更为 channel:(NSString *)channel_uid
。详细信息,参考 发送消息。错误码 | 错误描述 | |
---|---|---|
变更前 | 变更后 | |
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 |
setIdleTime
)。详细信息,参考 设置保活时间。setAutoRecycleTime
)。详细信息,参考 设置无操作回收服务时间。getFocusedWindowApp
)。详细信息,参考 查询屏幕当前焦点应用。muteVideo
)。详细信息,参考 视频开关。switchBackground
)。详细信息,参考 客户端前后台切换。Web/H5 端 SDK 包含以下新增功能和变更:
注意
重要变更:更新了以下错误码的 code 及错误信息,详细信息,参考以下表格说明。
错误码 | 错误描述 | |
---|---|---|
变更前 | 变更后 | |
10018 | ERROR_START_MUILT_DEVICE_CONFLICT | ERROR_START_USER_CONFLICT |
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 |
setAutoRecycleTime
)。详细信息,参考 设置/获取无操作回收服务时间。getFocusedWindowApp
)。详细信息,参考 查询屏幕当前焦点应用。muteAudio
)。详细信息,参考 静音开关。muteVideo
)。详细信息,参考 视频开关。云手机客户端 SDK V1.14.1 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
onStreamStats
)中增加 “获取卡顿时长”(getStallDuration
) 和 “获取卡顿率”(getFrozenRate
)回调接口。详细信息,参考 StreamStats 类型说明。getFocusedWindowApp
)。详细信息,参考 查询屏幕当前焦点应用。iOS 端 SDK 包含以下新增功能和变更:
云手机客户端 SDK V1.14.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
注意
重要变更:在申请云手机服务之前,需要在 AndroidManifest.xml
文件中填入注册的火山引擎用户账号。详细信息,参考 火山引擎账号。
muteVideo
)及检查视频播放状态接口(isVideoMuted
)。详细信息,参考 视频开关。switchVideoStreamProfile
)增加了清晰度档位枚举值、并支持横竖屏应用清晰度切换自适应。详细信息,参考 清晰度切换。sendKeyEvent
),支持发送 Home键、返回键、菜单键和最近任务列表键盘事件。详细信息,参考 发送键盘事件指令。iOS 端 SDK 包含以下新增功能和变更:
注意
重要变更:
setConfigInfo
更新为 setupConfigInfo
,并且在初始化云手机实例时,必须指定注册的火山引擎用户账号(accountId
参数)。 详细信息,参考 快速接入。destroy
)接口。接口 | 变更前 | 变更后 |
---|---|---|
设置配置信息 | setConfigInfo | setupConfigInfo |
输出日志 | consoleLogEnable | logEnable |
sendKeyEvent
),支持发送 Home键、返回键、菜单键和最近任务列表键盘事件。详细信息,参考 发送键盘事件。Web/H5 端 SDK 包含以下新增功能和变更:
注意
重要变更:
accountId
必选参数(注册的火山引擎用户账号)。详细信息,参考 实例化 vePhoneSDK。sendKeycodeMessage
)可支持的按键键码,仅支持 Home键、返回键、菜单键和最近任务列表,并且该接口的返回值变更为 Promise(返回发送成功或失败的状态)。详细信息,参考 发送按键事件。start
接口的 rotation
参数说明。云手机客户端 SDK V1.13.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
screenShot
,发起对云手机画面进行截图操作。截图成功后通过 onScreenCaptured
回调,截图数据保存在云手机实例中。详细信息,参考 云手机画面截图。enableSyncSignalStrength
,实时采集客户端网络信号状态(WiFi 信号或移动蜂窝网络信号)并同步到云手机实例,在云手机广播客户端上报的网络信号状态。sendMessage
中,新增 channelUid
参数(云机应用初始化 veMessageChannelClient 时填入的用户 ID);同时新增 getSrcChannelUid
和 getDestChannelUid
接口,替代原有 getSendUserId()
接口,支持客户端与云机多个应用之间传输自定义消息。详细信息,参考 收发消息。stop
接口停止拉流、客户端和云手机应用之间已建立的消息通道连接断开;当客户端调用 start
接口重新启动云手机后,veMessageChannelClient 会主动恢复客户端和云手机应用之间的消息通道连接(需在云机环境部署 Message Channel SDK V1.0.5 及以上版本)。详细信息,参考 Message Channel SDK 接入说明。iOS 端 SDK 包含以下新增功能和变更:
screenShot
,发起对云手机画面进行截图操作。截图成功后通过 onScreenShot
回调,返回保存在云手机实例中保存截图文件的路径。详细信息,参考 云手机画面截图。sendMessage
中,新增 channelId
参数,支持客户端与多个云机多个应用之间传输自定义消息。详细信息,参考 发送消息(支持多用户)。stop
接口停止拉流、客户端和云手机应用之间已建立的消息通道连接断开;当客户端调用 start
接口重新启动云手机后,veMessageChannelClient 会主动恢复客户端和云手机应用之间的消息通道连接(需在云机环境部署 Message Channel SDK V1.0.5 及以上版本)。详细信息,参考 Message Channel SDK 接入说明。Web/H5 端 SDK 包含以下新增功能和变更:
注意
重要变更:改变“发送自定义消息”(sendMessage
)接口的入参格式,变更如下:
变更前:sendMessage(message, needAck, timeout)
变更后:sendMessage({message, needAck, timeout, destUserId})
overflow:hidden
属性,可能对业务样式产生影响,需要关注。enableLocalKeyboard
和 enableLocalMouseScroll
参数开启本地键盘输入功能和本地鼠标滑轮滚动映射。详细信息,参考 实例化 vePhone SDK。screenShot
,对当前云手机画面进行截图,并获取在云手机实例中保存截图文件的路径。详细信息,参考 云手机画面截图。sendMessage
中,新增 destUserId
参数(云机应用初始化 veMessageChannelClient 时填入的目标 ID),支持客户端与云机多个应用之间传输自定义消息。当 Message Channel 连接通道超过1条时,必须指定 destUserId
参数。详细信息,参考 发送自定义消息。stop
接口停止拉流、客户端和云手机应用之间已建立的消息通道连接断开;当客户端调用 start
接口重新启动云手机后,veMessageChannelClient 会主动恢复客户端和云手机应用之间的消息通道连接(需在云机环境部署 Message Channel SDK V1.0.5 及以上版本)。详细信息,参考 Message Channel SDK 接入说明。云手机客户端 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 体积优化,业务集成后的体积变化需由业务方测试和评估)。
iOS 端 SDK 包含以下新增功能和变更:
Web/H5 端 SDK 包含以下新增功能和变更:
云手机客户端 SDK V1.11.02 版的发布说明如下:
Android 端 SDK 包含以下新增功能和变更:
云手机客户端 SDK V1.11.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能:
注意
重要变更:从 V1.11.0 开始,SDK 初始化变更为由 SDK 内部完成,用户无需调用初始化接口、可直接调用 start()
接口申请云手机服务。SDK 初始化成功后,由 ICloudCoreManagerStatusListener
的 onInitialed()
回调触发。
SDK 初始化变更为由 SDK 内部完成,用户无需调用初始化接口、可直接调用 start()
接口申请云手机服务。SDK 初始化成功后,由 ICloudCoreManagerStatusListener
的 onInitialed()
回调触发。
申请云手机服务时,新增通过 enableFileChannel
参数开启大文件传输通道,支持客户端与云机实例之间收发大文件。
新增动态设置云手机经纬度信息接口(setRemoteLocationMock
),模拟云手机的 GPS 定位,满足模拟挂机场景。详细信息,参考 设置远端位置信息。
新增云机应用切换前后台状态回调,并支持通过 setRemoteAppForeground
接口将云机应用切换到前台。详细信息,参考 云机应用切换前台。
新增对采集的本地视频流进行优化处理的接口,包括设置本地视频画面布局(setLocalVideoCanvas
)、使用“前置摄像头”采集时是否开启镜像翻转视频画面(setLocalVideoMirrorMode
)、根据网络情况配置本地视频编码质量参数(setVideoEncoderConfig
)。详细信息,参考 Camera 注入。
更新了错误码及说明。详细信息,参考 错误码及说明。
iOS 端 SDK 包含以下新增功能:
更新申请云手机服务的配置参数,将鉴权选项 VePhoneAuthObject
合并入VePhoneConfigObject
选项中,在启动云手机时只需指定 configObj
参数。详细信息,参考 创建 VePhoneManager 实例。
新增设置配置信息接口(setConfigInfo
),在程序启动的时候调用,初始化 VePhoneManager 配置。
新增动态设置云手机经纬度信息接口(setRemoteLocationMock
),模拟云手机的 GPS 定位,满足模拟挂机场景。详细信息,参考 设置远端定位信息。
新增云机应用切换前后台状态回调,并支持通过 setRemoteAppForeground
接口将云机应用切换到前台。详细信息,参考 云机应用切换前台。
新增对采集的本地视频流进行优化处理的接口,包括设置本地视频画面布局(setLocalVideoCanvas
)、使用“前置摄像头”采集时是否开启镜像翻转视频画面(setLocalVideoMirrorMode
)、根据网络情况配置本地视频编码质量参数(setVideoEncoderConfig
)。详细信息,参考 设置本地视频渲染视图。
更新地理位置请求开关默认值(将默认开启更新为默认关闭)。详细信息,参考 主流开关。
Web/H5 端 SDK 包含以下新增功能:
注意
重要变更:从 V1.11.0 开始,SDK 修改了打包方式,建议使用以下方法:bytePlay = new vePhoneSDK();
新增动态设置云手机经纬度信息接口(setRemoteLocationMock
),模拟云手机的 GPS 定位,满足模拟挂机场景。详细信息,参考 设置远端位置信息。
新增云机应用切换前后台状态回调,并支持通过 setRemoteAppForeground
接口将云机应用切换到前台。详细信息,参考 云机应用切换前台。
新增基础音频能力相关接口,包括调节客户端本地播放音量、获取和设置音频设备、开启/关闭音频数据发送等功能。详细信息,参考 调节本地播放音量。
新增采集本地摄像头视频流并发送到云机实例的相关接口,并支持对采集的本地视频流进行优化处理的接口,包括设置本地视频画面布局(setLocalVideoCanvas
)、使用“前置摄像头”采集时是否开启镜像翻转视频画面(setLocalVideoMirrorMode
)、根据网络情况配置本地视频编码质量参数(setVideoEncoderConfig
)。详细信息,参考 开启视频采集。
新增云机应用切换前后台、云机请求开始/停止发送音频数据、开始/停止采集音视频数据、更新音视频采集/播放设备、发送/接收音视频流状态等事件回调。详细信息,参考 事件回调。
更新了错误码及说明。详细信息,参考 错误码。
云手机客户端 SDK V1.10.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能:
新增基础音频能力相关接口,包括调节客户端本地播放和采集音量、调节云机应用播放音量、开启/关闭音频数据发送等功能。详细信息,参考 调节本地播放和采集音量。
通过消息通道发送消息到云机应用时,支持指定消息发送超时时长(timeout
)参数,并增加云机实例在线、离线状态回调。详细信息,参考 收发消息。
更新了错误码及说明。详细信息,参考 错误码及说明。
iOS 端 SDK 包含以下新增功能:
新增基础音视频能力相关接口,包括调节客户端本地播放和采集音量、调节云机应用播放音量、开启/关闭音视频数据发送等功能。详细信息,参考 开启音频采集。
通过消息通道发送消息到云机应用时,支持指定消息发送超时时长(time
)参数。详细信息,参考 收发消息。
新增本地音视频流数据统计参数和远端音视频流数据统计参数。详细信息,参考 数据统计。
删除了音量接调节接口(turnVolume
),可使用新增的音视频能力相关接口代替。
更新了错误码及说明。详细信息,参考 错误码。
Web/H5 端 SDK 包含以下新增功能:
启动云手机时,可使用新增的 rotation
和 isScreenLock
参数设置旋转终端时应用(游戏)的横竖屏显示方式。详细信息,参考 启动 start。
新增基础音频能力相关接口,支持调节本地播放音量。详细信息,参考 本地播放音量调节。
通过消息通道发送消息到云机应用时,支持指定消息发送超时时长(timeout
)参数,并增加云机实例在线、离线状态事件回调(message-channel-online
和 message-channel-offline
)。详细信息,参考 发送自定义消息 和 事件回调。
更新了错误码及说明。详细信息,参考 错误码。
云手机客户端 SDK V1.9.1 版的发布说明如下:
Web/H5 端 SDK 包含以下新增功能和变更:
stream-reconnecting
和 stream-reconnected
)。详细信息,参考 事件回调。云手机客户端 SDK V1.9.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能:
新增发送客户端本地剪贴板消息到云机实例接口(sendClipBoardMessage
)以及接收剪贴板消息事件回调(onClipBoardMessageReceived
)。详细信息,参考 发送剪贴板消息。
删除了麦克风开关相关接口(enableMic
和 isEnableMic
)。
更新了错误码及说明。详细信息,参考 错误码及说明。
iOS 端 SDK 包含以下新增功能:
新增获取 SDK 生成的设备 ID 接口(currentDeviceId
),用于线上日志查询和问题排查。详细信息,参考 获取设备 ID。
新增发送客户端本地剪贴板消息到云机实例接口(sendClipBoardMessage
)及回调。详细信息,参考 发送剪贴板消息。
更新了错误码及说明。详细信息,参考 错误码及说明。
Web/H5 端 SDK 包含以下新增功能:
新增发送客户端本地剪贴板消息到云机实例接口(sendClipBoardMessage
)。详细信息,参考 发送剪贴板消息。
新增云机实例发送到客户端的消息已接收事件回调(general-message-received
)。详细信息,参考 事件回调。
新增云机实例剪贴板发生变化时的回调(clipboard-message-received
)。详细信息,参考 事件回调。
更新错误码及说明。详细信息,参考 错误码及说明。
云手机客户端 SDK V1.8.0 版的发布说明如下:
Web/H5 端 SDK 包含以下新增功能:
启动云手机 start
接口中,新增指定需要启动的应用 ID 参数 applicationId
。详细信息,参考 启动。
更新错误码及说明。
云手机客户端 SDK V1.7.0 版的发布说明如下:
start()
接口中,新增 reset
参数,支持退出后,重置设备环境。详细信息,参考 开始播放。videoStreamProfileId
参数指定使用的清晰度档位。在播放中,可调用 switchVideoStreamProfile()
接口,切换清晰度档位。详细信息,参考 清晰度切换。云手机客户端 SDK V1.6.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能:
iOS 端 SDK 包含以下新增功能:
Web/H5 端 SDK 包含以下新增功能:
云手机客户端 SDK V1.5.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和行为变更:
iOS 端 SDK 包含以下新增功能和行为变更:
Web / H5 端 SDK 包含以下新增功能和行为变更:
云手机客户端 SDK V1.4.0 版的发布说明如下:
Android 端 SDK 包含以下新增功能和行为变更:
iOS 端 SDK 包含以下新增功能和行为变更:
Web / H5 端 SDK 包含以下新增功能和行为变更:
云手机客户端 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 包含以下新增功能和行为变更:
iOS 端 SDK 包含以下新增功能和行为变更:
Web / H5 端 SDK 包含以下新增功能和行为变更:
start
方法新增 video 自动播放失败错误码;playByInteraction
方法,当发生 video 自动播放错误时,可以引导用户通过交互界面提示,继续播放,参考以下示例:cloudCore.start(options).then(() => { console.log('start successfully') }).catch((e) => { if (e.errorCode === 2000002) { // 弹出引导用户点击继续的 UI 界面提示 showBtnUI(); } }); btn.onclick = () => { cloudCore.playByInteraction(); };