云游戏
  1. 客户端SDK
云游戏
  • OPENAPI
    • 接口签名
    • 接口状态码
    • 服务流程
    • 存档回调
    • 初始化
      • 获取token
    • 启动游戏
      • 正常开始游戏
      • 重连会话
      • 接管会话
    • 排队
      • 游戏队列
      • 取消排队
      • 排队期间切换显示等级
    • 游戏中
      • 切换显示等级
      • 客户端主动挂机
      • 手动存档
      • 游戏存档指定用户
      • 授权创建麦克风
      • 设置房间会话手柄权限
      • 设置挂机时长
    • 用户情况
      • 自己的会话列表
      • 自己的排队
      • 房主设置控制权限
    • 会话管理
      • 服务端停止游戏
      • 开始直播
      • 结束直播
    • 存档
      • 存档列表
      • 购买存档
      • 删除存档
      • 存档信息
      • 寄卖存档
    • 服务情况
      • 资源使用情况
      • 排队人数
      • 会话列表
      • 游戏列表
      • 查询会话状态
  • 客户端SDK
    • 流程和事件
    • JSSDK
      • 示例
      • SDK初始化
      • 开始游戏
      • 退出游戏
      • 设置视频等级
      • 询手柄列表
      • 添加虚拟手柄
      • 删除虚拟手柄
      • 开启/关闭手柄
      • 发送手柄状态
      • 开关/关闭键盘鼠标
      • 切换鼠标模式
      • 发送键鼠按键
      • 游戏空闲时间限制
      • 获取鼠标模式
      • 暂停鼠标键盘
      • 恢复鼠标键盘
      • 获取操控空闲时间
      • 接管游戏
      • 重连会话
      • 设置挂机时长
      • 主动挂机
      • 房主设置控制权限(停用)
      • 开始简单操控器
      • 退出简单操控器
      • 修改操控设备
      • 重启游戏
      • 开关/关闭手柄震动
      • 获取显示器数量
      • 切换显示器
      • 手动存档
      • 发起拷贝
      • 设置鼠标滚轮速度
      • 启动辅助程序
      • 鼠标拖拽模式
      • 本地音视频设备共享
      • 发送触屏状态
      • 发送透传消息
      • 设置鼠标灵敏度
      • 设置指针设备
      • 虚拟键鼠布局
      • 设置键盘大小写状态
      • 开启/关闭麦克风
    • Android SDK
      • 快速接入
      • 版本变动
      • 初始化
        • 初始化-游戏画面设置
        • 初始化-游戏画面设置(兼容模式)
        • 初始化-是否启用兼容模式显示
      • 建联
        • 建联-开始游戏
        • 建联-接管会话
        • 建联-重连会话
        • 建联-停止游戏
        • 建联-主动挂机
      • 操控
        • 操控-发送手柄指令
        • 操控-发送键盘指令
        • 操控-发送鼠标指令(逐步废弃)
        • 操控-物理按键事件处理(逐步废弃)
        • 操控-MotionEvent处理
        • 操控-发送鼠标指令(新)
        • 操控-获取手柄集
        • 操控-发送触摸指令
      • 设置
        • 设置-码流格式
        • 设置-视频等级
        • 设置-挂机时长
        • 设置-操控权限
        • 设置-软解硬解
        • 设置-房间修改用户控制权限
        • 设置-音量设置
        • 设置-鼠标模式设置
      • 文件管理
        • 文件管理-挂载本地目录
        • 文件管理-卸载挂载目录
        • 文件管理-客户端拷贝文件列表到远端服务器剪切板
        • 文件管理-客户端拷贝文本到远端服务器剪切板
        • 文件管理-客户端下载远端服务器剪切板文件列表
        • 文件管理-语音或者视频上传云端
      • 其他
        • 其它-手动存档
        • 其它-重启游戏(加载存档)
        • 其它-上号助手/启动进程
        • 其它-发送文本接口
        • 其它-端获服务器显示器数量
        • 其它-获取显示器数量
        • 其它-切换远程的显示器
        • 其它-日志开关
        • 其它-获取SDK版本
        • 存档大小通知
        • 其它-按键大小写事件同步
        • 设置-获取服务器局域网IP
        • 其它-修复鼠标
    • Windows SDK
      • 回调函数
      • 宏定义数据
      • 初始化
        • SDK操作指针创建
        • SDK操作指针释放
        • SDK初始化
        • SDK反初始化
      • 建联
        • 启动游戏
        • 接管游戏
        • 重连游戏
        • 挂起游戏
        • 重启游戏
        • 退出游戏
      • 设置
        • 设置视频等级
        • 设置视频编码格式
        • 设置房间控制权限
        • 设置静音
        • 设置鼠标工作模式
        • 设置锁定鼠标
        • 设置手柄振动
        • 设置渲染亮度
        • 设置工作模式
        • 设置键盘操控数据
        • 设置鼠标操控数据
        • 设置触屏操控数据
        • 是否启用鼠标内部操作逻辑
        • 是否启用键盘内部操控逻辑
        • 是否启用手柄内部操控逻辑
        • 设置鼠标样式
        • 是否启用鼠标样式内部操作逻辑
      • 渲染
        • 创建渲染视频窗口
        • 销毁渲染视频窗口
        • 初始化文本渲染
        • 反初始化文本渲染
        • 显示文本
        • 更新文本
        • 更新文本背景颜色
        • 给渲染窗口更新数据
      • 文件管理
        • 注册/卸载服务
        • 挂载盘符
        • 卸载盘符
      • 云桌面
        • 显示器创建/关闭
        • 设置显示某一个显示器
        • 切换显示某一个显示器
        • 同步显示器
        • 设置多显示器创建
        • 设置是否启动I444
        • 设置转发组件
        • 设置服务端编码格式
        • 设置服务端是否同步客户端的分辨力
        • 设置同步本地分辨力
        • 设置是否开启双屏标记
        • 设置主屏幕id
      • 剪切板
        • 初始化剪切板
        • 反初始化剪切板
        • 释放剪切板
        • 更新剪切板权限状态
      • 其他
        • 上号助手/启动进程
        • 手动存储
        • 获取手柄个数
        • 获取版本信息
        • 获取控制状态
    • IOS SDK
      • 快速接入
      • 版本变动
      • 初始化
        • 初始化-加载SDK
        • 初始化-设置bundle
        • 初始化-代理设置
      • 建联
        • 建联-启动游戏
        • 建联-接管游戏
        • 建联-重连游戏
        • 建联-挂起游戏
        • 建联-重启游戏
        • 建联-停止游戏
        • 建联-重启游戏(加载存档)
      • 设置
        • 设置-视频等级
        • 设置-挂机时长
        • 设置-操控权限
        • 设置-静音开关
        • 设置-房间修改用户控制权限
      • 操控
        • 操控-发送手柄指令
        • 操控-发送键盘指令
        • 操控-发送鼠标指令
        • 操控-发送触屏指令
        • 操控-发送消息指令
        • 操控-定时发送鼠标指令
        • 操控-定时发送键盘指令
        • 操控-定时发送手柄指令
      • 其它
        • 其它-发送文本
        • 其它-上号助手/启动进程
        • 其它-获取显示器数量
        • 其它-切换远程显示器
        • 其它-手动存档
      • 附录
        • 附录-事件码
        • 附录-PC键值
  • 快捷请求
  • 问题记录
    • 鼠标问题
    • 视频流问题
    • 按键问题
    • 手柄问题
    • 默认布局按键方案
    • 加速器问题
    • 房间排队问题
    • 游戏中切换存档
    • 手动存档
    • SDK无法重启游戏
    • 只一个手柄可操控
  1. 客户端SDK

流程和事件

对接概要:#

image.png

关键回调:#

image.png

正常会话状态变化:#

image.png

事件状态#

事件类型事件名称状态码描述
SDK初始化初始化成功50000
SDK初始化SDK连接失败40000无法连接BS服务器
SDK初始化SDK认证失败40001提供的认证信息校验失败
连接建立消息交换成功52000
连接建立消息交换失败42000无法建立连接
连接建立签名失败42001token信息校验错误
连接建立服务连接成功53000连接成功
连接建立视频流接收成功53100接收流成功
连接建立服务连接失败43000无法建立连接
连接建立服务连接丢失43001游戏过程中连接断开
连接建立视频流接收失败43100接收流失败或者超时
游戏运行游戏启动54000
游戏运行游戏退出54001
游戏运行服务等级切换成功54101
游戏运行游戏启动失败44000
游戏运行游戏运行失败44001
游戏运行游戏配置修改44002比如修改分辨率等
游戏运行服务等级切换失败44101比如等级不存在等
手柄操控手柄获取错误45000
手柄操控长时间未操控45001
运行异常其他异常41002
质量回调定时回调服务信息50001
操控事件用户有操控55000
会话过程会话被接管54002另外一个客户端接管了会话
会话过程操控权限被更改54003操控权限被房主修改
会话过程会话不存在44003针对操作的会话ID不存在
游戏挂机设置挂机时间成功54102更改了挂机时间,但不影响当前会话
游戏挂机挂机成功54103更改挂机时间,并断开连接
游戏挂机设置挂机时间失败44102更改挂机时间失败
游戏挂机挂机失败44103挂机失败
操控权限设置权限成功54104更改某个会话的操控权限
操控权限设置权限失败44104更改某个会话的操控权限失败
游戏重启游戏重启成功54005主动重启游戏成功
游戏重启游戏重启失败44005主动重启游戏失败
游戏交互游戏打开URL54105游戏主动打开URL
显示设备显示器数量54106服务端显示器变化的时候返回数量number
显示设备显示器切换成功54107画满切换到对应的显示器
显示设备显示器切换成功44106画满切换到对应的显示器失败
手动存档手动存档成功54110手动上传存档成功
手动存档手动存档失败44110手动上传失败
辅助程序辅助程序成功54108辅助程序成功
辅助程序辅助程序失败44108辅助程序失败
虚拟手柄虚拟手柄位置回调54109虚拟手柄位置回调
虚拟手柄虚拟手柄游戏客户端登录用户54110虚拟手柄游戏客户端登录用户
鼠标事件鼠标位置54111x和y为以游戏区域左上角为起点的像素偏移值
鼠标事件鼠标样式54112图标的url,x和y为鼠标焦点位置偏移量
透传消息GS的消息54113由GS通知给客户端消息,一般对应登录和支付
游戏运行游戏窗口54114游戏窗口已经打开
键盘事件等待输入54115等待键盘输入
修改于 2024-11-27 02:47:00
上一页
查询会话状态
下一页
示例
Built with