接口概述
本接口可以使用http
和websocket
两种方式进行访问交互
websocket
端口号为9911
http
访问端口号为9912
http请求方式
接口地址
服务器地址:9912/api
例:http://127.0.0.1:9912/api
请求方式
post
请求内容格式
json
websocket请求方式
使用websocket的方式请求接口可以获得更快的响应,但比http的请求方式复杂,所有请求结果都在回调函数内.
因为是异步的方式,如果想等待请求结果再进行下一步操作就需要进行异步转同步.
每个接口都会带msgid字段,服务端接收后会原样返回,用来异步转同步用.
接口地址
ws://服务器地址:9911/clinet
例:ws://127.0.0.1:9911/clinet
请求内容格式
json
所有接口调用后都会返回成功与否,status
为0代表成功,非0代表失败
失败的信息会在message
说明,以下是错误码列表
错误码 | 描述描述 |
---|---|
1 | 设备ID不存在 |
2 | 设备在线 |
3 | 分组不存在 |
4 | 设备不在线 |
5 | 截图失败 |
6 | 没有绑定USB设备 |
7 | 没有鼠标参数 |
8 | 参数不正确 |
9 | 通用库没有对应的型号 |
10 | 配置已存在 |
11 | 通用库没有对应的型号 |
12 | 没有找到要删除配置 |
13 | 官方库不允许删除 |
14 | USB设备没有连接 |
15 | 必须竖屏 |
16 | 发送热键失败 |
17 | 资源图不存在 |
18 | 找图失败 |
19 | OCR失败 |
20 | OCR没有识别到文字 |
21 | 没有对应的坐标参数 |
22 | 未知的错误 |
23 | 没有重启的坐标点 |
24 | 缺少关键文件 |
25 | 调用接口失败 |
26 | 插件未连接,可能没安装 |
27 | 接口调用超时 |
28 | 调用接口报错 |
29 | AirPlay服务不存在 |
30 | 未发现AirPlay投屏服务 |
31 | 已经在投屏中 |
32 | 投屏失败 |