云手机
云手机
文档指南
请输入
- 文档首页
云手机云手机客户端 SDK 参考Web H5 SDK数据类型
复制全文
下载 pdf数据类型
文档反馈
问问助手CloudCoreConfig
类型：interface
userId
类型：string | undefined
自定义客户端用户 ID，用于区分用户
注意
自 Web/H5 1.70.0 版本开始为非必填参数，不传时 SDK 会自动生成默认值，格式为 web_${os}_${uuid}（${os} 为操作系统类型，${uuid} 为随机生成的唯一标识符）。
domId
类型：string
运行云手机的 DOM ID ，SDK 将在该 DOM 新建画布以及渲染画面
accountId
类型：string
火山引擎用户账号，可通过火山引擎官网页面右上角 用户 > 账号管理 > 主账号信息 获取
isPC
类型：boolean | undefined
是否为 PC Web 环境下使用。默认非 PC Web 环境下将会监听 Touch 事件，而 PC Web 环境下将监听鼠标以及键盘事件
containerDomId
类型：string | undefined
挂载 SDK 内部元素的 DOM 节点 ID
isDebug
类型：boolean | undefined
是否开启调试日志
enableSyncClipboard
类型：boolean | undefined
是否开启剪切板同步
enableLocationService
类型：boolean | undefined
是否开启定位信息同步
enableLocalKeyboard
类型：boolean | undefined
开启本地键盘或云机键盘的输入功能：
- true：仅开启本地键盘
- false：开启云机键盘
说明
- PC Web 环境下，同时支持本地键盘
- 键盘事件分发：仅当指定 enableLocalKeyboard=false 时，可支持将本地键盘输入的内容同步到云机实例中，再分发到其他实例
useCustomLocalKeyboardInput
类型：boolean | undefined
enableLocalMouseScroll
类型：boolean | undefined
是否开启本地鼠标滑轮滚动映射
disableAudioInjection
类型：boolean | undefined
是否关闭音频注入功能
customLocalKeyboardInputId
类型：string | undefined
STSToken
类型：interface
AccessKeyID
类型：string
注意
通过 访问控制接口 获取到的 AccessKeyId，需要把 AccessKeyId 参数名修改为 AccessKeyID，否则在使用云手机 SDK 时将报错 ERROR_SDK_AccessKeyID_EMPTY。
SecretAccessKey
类型：string
ExpiredTime
类型：string
CurrentTime
类型：string
CoreStartConfig
类型：interface
productId
类型：string | undefined
云手机业务 ID，可通过火山引擎云手机控制台『业务管理』页面获取
mute
类型：boolean | undefined
是否静音模式，在非交互式的场景下启动云手机，需要设置为 true（部分浏览器为了防止网页在用户非自愿的情况下自动播放声音，对网页上的自动播放 Autoplay 功能做了限制：在没有用户交互操作之前不允许有声音的媒体播放，具体请参考各浏览器的自动播放策略）
token
启动云游戏的令牌，为一个 JSON 对象，包含以下属性（通过调用服务端 STSToken 接口获取）:
- AccessKeyID：用于鉴权的临时 Access Key
- SecretAccessKey：用于鉴权的临时 Secret Key
- SessionToken：用于鉴权的临时 Token
- CurrentTime：Token 创建时间
- ExpiredTime：Token 过期时间
- 有关服务端 STSToken 接口的详细信息，参考获取临时密钥。
roundId
类型：string | undefined
当次启动生命周期的标识符，可以用该参数查询使用时长，链路日志等。命名规则如下:
最大长度为128位的非空字符串，支持的字符集范围为:
- 大写字母 A ~ Z
- 小写字母 a ~ z
- 数字 0 ~ 9
- 下划线 "_", 减号 "-"
videoStreamProfileId
类型：number | undefined
planId
类型：string | undefined
实例套餐 ID
rotation
类型：string | undefined
应用的横竖屏显示，如不指定，默认会根据应用的横竖屏进行自适应，该参数仅客户端使用
- portrait：竖屏显示
- landscape: 横屏显示
isScreenLock
类型：boolean | undefined
是否锁定屏幕横竖屏显示（仅支持移动端）
- true：锁定屏幕开启
- false：锁定屏幕关闭
extra
类型：Record<string, string | boolean> | undefined
根据业务需要，自定义的扩展参数
accountId
类型：string
火山引擎用户账号，可通过火山引擎官网页面右上角 用户 > 账号管理 > 主账号信息 获取
podId
类型：string
实例 ID，可通过火山引擎云手机控制台『实例管理』页面获取
applicationId
类型：string | undefined
需要启动的应用 ID（推流时直接打开应用），可通过火山引擎云手机控制台『应用管理』页面获取
audioAutoPlay
类型：boolean | undefined
是否在用户首次点击操作时，自动播放音频（适用于自动播放音频失败的场景）
autoRecycleTime
类型：number | undefined
设置无操作自动回收服务时长，单位秒（如不设置或设置为0，则使用默认时长）
waitTime
类型：number | undefined
云手机实例进房后，等待客户端加入房间的最大允许时长。
当云手机处于房间中而没有客户端加入，或者所有客户端都已离开房间后，云手机将在到达此参数设置的时长后自动退出房间。
单位为 s，默认值为 10，传入非法参数时自动调整为默认值即 10s。
- 注意
- 请根据实际需求合理设置此参数，以确保云手机在没有客户端活动时能够及时释放资源。
remoteLocationMock
类型：{ latitude: number; longitude: number; }
设置远端经纬度信息
- latitude 纬度
- longitude 经度
- 成员
名称 | 类型 | 说明 |
latitude | number | 纬度 |
longitude | number | 经度 |
keyboardEnable
类型：boolean | undefined
设置是否允许用户使用键盘进行信息输入的能力
- true 允许
- false 禁止
videoRenderMode
类型：number | undefined
视频自适应布局
- 0 等比缩放居中模式
- 1 非等比拉伸模式
- 2 等比例缩放
remoteWindowSize
类型：{ width: number; height: number; } | undefined
设置云机实例窗口大小/比例（width 和 height）
- 注意
- 取值范围 >= 0，说明如下：
- 如果不传，默认获取初始化中传入 domId 容器的宽高作为请求参数上传；
- 当 width = 0，height = 0 时，服务端按照原始画面和分辨率推流；
- 当 width > 0， height > 0 时，将指定的宽高作为请求参数上传给服务端做分辨率适配（如果云机屏幕为竖屏，指定的 width 必须小于 height）；
- 成员
名称 | 类型 | 说明 |
width | number | 云端推流画面的宽度 |
height | number | 云端推流画面的高度 |
expireTime
类型：number | undefined
拉流过期时间，单位为秒，取值范围 [0,172800]，即 2 天。若不设置本参数，拉流不会过期断开；若设置本参数，拉流过期时间则以本参数中的设置为准。
openAutoRotate
类型：boolean | undefined
设置 SDK 是否在应用旋转时自动适配容器：
- true：是；
- false：否（默认）。
enableUserIdAuth
类型：boolean
- true：是；
- false：否（默认）。
muteAudio
类型：boolean
是否停止订阅音频流。
- true：停止接收远端音频。
- false：（默认）正常订阅音频。
ControlEventResult
类型：interface
用户操控权设置或查询结果回调。
code
类型：0 | -1
0：成功并返回操控权状态；-1：设置或查询失败
msg
类型：string | undefined
提示信息
data
用户操控权状态
ControlState
类型：interface
userId
类型：string | undefined
目标用户 ID
注意
自 Web/H5 1.70.0 版本开始为非必填参数，不传时 SDK 会自动生成默认值，格式为 web_${os}_${uuid}（${os} 为操作系统类型，${uuid} 为随机生成的唯一标识符）。
enable
类型：boolean
目标用户是否具有操控权
MODE
类型：enum
SDK 启动模式。
- 成员
- 属性值说明CLOUD_PHONE_GAME0云游戏手游CLOUD_PHONE1云手机CLOUD_PC2云游戏端游
LOCATION_SERVICE_MODE
类型：enum
云机请求获取定位信息的模式。
- 成员
- 属性值说明MODE_AUTO0自动模式MODE_MANUAL1手动模式
ACTION
类型：enum
按键动作可选枚举值。
- 成员
- 属性值说明DOWN0按键按下UP1按键放开MOVE2移动TOUCH_START0触控开始TOUCH_END1触控开TOUCH_MOVE2触控移动WHEEL8滚轮PC_TOUCH_UP0触控放开PC_TOUCH_DOWN1触控按下PC_TOUCH_MOVE2触控移动
类型：enum
鼠标可选枚举值。
- 成员
- 属性值说明LEFT0鼠标左键CENTER1鼠标滚轮RIGHT2鼠标右键
KEYCODE
类型：enum
按键键码可选枚举值
- 成员
- 属性值说明KEYCODE_HOME3Home 键KEYCODE_BACK4返回键KEYCODE_MENU82菜单键KEYCODE_APP_SWITCH187最近任务列表
VIDEO_RENDER_MODE
类型：enum
视频流渲染模式。
- 成员
- 属性值说明CONTAIN0等比缩放居中模式FILL1非等比拉伸模式COVER2等比例缩放模式
最近更新时间：2026.09.03 10:03:44
这个页面对您有帮助吗？
有用
有用
无用
无用