本文档描述了云手机PC客户端SDK提供的接口。

API概览

创建云手机会话

接口名称接口描述
init初始化引擎
destory释放引擎
createPhoneClient创建云机会话，用于操控云机
reqBatchStart请求批量拉流

云手机功能接口

接口名称接口描述
start开始
stop停止
setSessionObserver设置回调
sendKeyCode发送键盘按键事件（发送一次完整的DOWN+UP事件）
sendKeyCode发送键盘按键事件（可选择发送单状态事件）
volumeUp增大云机设备音量
volumeDown减小云机设备音量
sendTouchEvent触摸点击
setVideoLevel修改画质
screenshot截图
sendInputText输入
enableAudio开启音频
enableVideo开启视频
enableBlow开启吹一吹
shake摇一摇
setVideoSink设置视频回调

接口详细说明

初始化引擎

描述：初始化ArmcloudEngine引擎

语法：

void init();

销毁引擎

描述：销毁ArmcloudEngine引擎

语法：

void destory();

建云机会话

描述：建云机会话

语法：

PhoneClient* createPhoneClient();

请求批量拉流

描述：请求批量拉流

语法：

void reqBatchStart(const BatchPhoneConfig& config);
参数描述
config设置批量请求拉流配置

启动云手机

描述：调用start()启动云手机

语法：

void start(config PhoneConfig& confg);

停止云手机

描述：调用stop()停止云手机

语法：

void stop();

设置云手机事件回调

描述：调用setSessionObserver()设置云手机事件回调

语法：

void setSessionObserver(SessionObserver* observer)
参数描述
observer云手机事件回调

发送键盘按键事件

描述：发送键盘按键事件指令到云机实例。此接口是发送一次完整的 DOWN+UP 事件，如需模拟 Home键、返回键、菜单键等系统功能键，推荐使用。

语法：

void sendKeyCode(int code)
参数描述
code键值
3：HOME键
4：BACK键
82：MENU键
187：TASK键

发送键盘按键事件

描述：发送键盘按键事件指令到云机实例。此接口可以选择发送单状态（DOWN 或 UP 事件），如需模拟一些状态要求较高的按键事件，如 DELETE 等，推荐使用。

语法：

void sendKeyCode(int action, int code)
参数描述
action按键类型
0：DOWN状态
1：UP状态
code键值
3：HOME键
4：BACK键
82：MENU键
187：TASK键

增大音量

描述：增大云机设备音量

语法：

void volumeUp()

减小音量

描述：减小云机设备音量

语法：

void volumeDown()

发送鼠标按键事件

描述：发送鼠标按键事件

语法：

void sendTouchEvent(int action, int x, int y, int width, int height)
参数描述
action按键类型
0、DOWN状态
1、UP状态
2、MOVE状态
xx轴方向点击坐标
yy轴方向点击坐标
width云手机本地画面宽度
height云手机本地画面高度

设置云手机画面清晰度

描述：设置云手机画面清晰度

语法：

void setVideoLevel(int resolution, int fps, int bitrate)
参数描述参考值
resolution分辨率07：144x256
08：216x384
08：216x384
09：288x512
10：360x640
11：480x848
12：540x960
13：600x1024
14：480x1280
15：720x1280
16：720x1920
17：1080x1920
18：1440x1920
19：1600x2560
20：2880x1080
fps帧率1：20fps
2：25fps
3：30fps
4：60fps
5：1fps
6：5fps
7：10fps
8：15fps
9：2fps
bitrate码率01：1Mbps
02：1.5Mbps
03：2Mbps
04：2.5Mbps
05：3Mbps
06：3.5Mbps
07：4Mbps
08：5Mbps
09：6Mbps
10：8Mbps
11：10Mbps
12：12Mbps
13：200kbps
14：400kbps
15：600kbps

截图

描述：对当前云手机画面进行截图

语法：

void screenshot(bool local)
参数描述
local截图保存位置
true：本地
false：云机

发送文本到输入框

描述：发送文本替换云机输入框内容（当云机输入框在焦点上才会生效）。

语法：

void sendInputText(const std::string& text)
参数描述
text发送的文本内容，必须为UTF-8编码

开启音频

描述：音频开启开关

语法：

void enableAudio(bool enable)
参数描述
enable状态 true、开启 false、停止

开启视频

描述：视频开启开关

语法：

void enableVideo(bool enable)
参数描述
enable状态 true、开启 false、停止

开启吹一吹

描述：吹一吹开启开关

语法：

void enableBlow(bool enable)
参数描述
enable状态 true、开启 false、停止

摇一摇

描述：摇一摇

语法：

void shake()

设置视频渲染器

描述：设置视频渲染器

语法：

void setVideoSink(VideoRenderSink* sink)
参数描述
sink设置视频渲染器，参考VideoRenderSink