Windows SDK C++版

获取方式

• 下载 Windows_SDK

• 下载 Windows_Demo源码

• 下载 Windows_Demo_Release可执行文件

集成环境要求

Windows X64 release

引入SDK

Visual Studio 2019示例：

打开项目属性页->配置属性->VC++目录，在包含目录添加asp-client-sdk的include目录

打开项目属性页->配置属性->VC++目录，在库目录添加asp-client-sdk的lib目录

打开项目属性页->配置属性->链接器->常规，在附加库目录添加asp-client-sdk的lib目录

打开项目属性页->配置属性->链接器->输入，在附加依赖项添加asp-client-sdk.lib、asp-engine.lib、glog.lib

qt creator示例：

项目pro文件添加

INCLUDEPATH+=$$PWD/asp-client-sdk/include \
LIBS+=$$PWD/asp-client-sdk/lib/asp-client-sdk.lib \
      $$PWD/asp-client-sdk/lib/asp-engine.lib \
      $$PWD/asp-client-sdk/lib/glog.lib \

快速使用Demo

下载Windows_Demo_Release，解压缩得到 server 和 client 两个目录，分别是服务端和客户端的DEMO。

启动服务端

修改配置

{
    "httpPort": "8328",
    "accessKeyId": "AK",
    "accessKeySecret": "SK",
    "androidRegionId": "cn-hangzhou"
}

修改其中的 AK 和 SK 即可,androidRegionId填写为实例的RegionId

运行其中的 server/run_server.bat , 会提示

2024-11-01T13:48:27.002Z Server is running on http://127.0.0.1:8328/listAic

服务端启动完成

运行客户端

{
  "CLOUD_SCREENSIZE_HEIGHT": 100,
  "CLOUD_SCREENSIZE_WIDTH": 100,
  "DEBUG_MODE": 2,
  "DISPLAY_COL": 11,
  "DISPLAY_GROUP": 20,
  "GROUPIDS": [
       "ag-1jknz4zyznleim503"
  ],
  "GROUP_SCREENSIZE_HEIGHT": 100,
  "GROUP_SCREENSIZE_WIDTH": 100,
  "LOCAL_SCREENSIZE_HEIGHT": 720,
  "LOCAL_SCREENSIZE_WIDTH": 480,
  "DISPLAY_SCALE": 1,
  "GROUP_SCALE": 8,
  "MAX_PHONE_NUM": 0,
  "PROXY_CONN_TYPE": 0,
  "QUIC_OPTION": false,
  "PHONE_URL": "http://127.0.0.1",
  "PORT": 8328,
  "AUDIO_ENABLE": false,
  "USE_DUMP": false,
  "USE_OPENGL": true
}

GROUPIDS 修改为需要控制的云手机实例组 ID ag-开头, 可以支持多个 GROUPID, 修改为您创建的 ag 开头的云手机实例组 ID，保存。

配置参数说明：

CLOUD_SCREENSIZE_HEIGHT: 初始化云端分辨率高
CLOUD_SCREENSIZE_WIDTH: 初始化云端分辨率宽
DEBUG_MODE: 日志级别 0-无日志 1-debug 2-info
DISPLAY_COL: 10 展示最大列
GROUPIDS: 分组，支持列表
GROUP_SCREENSIZE_HEIGHT: 初始化本地缩略图窗口高
GROUP_SCREENSIZE_WIDTH: 初始化本地缩略图窗口宽
LOCAL_SCREENSIZE_HEIGHT: 初始化本地主控窗口高
LOCAL_SCREENSIZE_WIDTH: 初始化本地主控窗口宽
DISPLAY_SCALE: 主控缩放比例
GROUP_SCALE: 缩略图缩放比例
MAX_PHONE_NUM: 最多连接数量
PROXY_CONN_TYPE: 连接类型，固定
QUIC_OPTION: 是否使用quick 固定
PHONE_URL: 服务端地址,
PORT: 服务端端口
AUDIO_ENABLE: 是否启用音频
EndUserId: 协同流用户名
IS_COO: 是否协同流
SALE_MODE: 是否CPS
SHOW_INSTENCE_NAME: 显示名称还是ID
USE_OPENGL: 是否启用opengl渲染

运行 client/WuyingDemo.exe

2.5.1 连接回调代理IAspClientCallback

代理接口说明：

代码示例：

class AspClientCbImpl : public IAspClientCallback
{
public:
    AspClientCbImpl() {}
    //缩略图回调
    void onThumbnailUpdate(void* buffer, uint32_t width, uint32_t height, AspImageFormat format) override {

    }
    //连接事件
    void onConnectEvent(ConnectEvent& event) override {
       switch(event.type) {
          case ConnectEventType::EVENT_CONNECT_SUCCESS:
              
              break;
          case ConnectEventType::EVENT_CONNECT_FAILED:
              
              break;
          case ConnectEventType::EVENT_DISCONNECT_SUCCESS:
              
              break;
          case ConnectEventType::EVENT_RECONNECT_START:
              
              break;
          case ConnectEventType::EVENT_RECONNECT_FAILED:
              
              break;
          default:
              
              break;
        }
    }
};

2.5.2 主控流回调代理IAspDisplayCallback

代理接口说明：

代码示例：

class AspDisplayCbImpl : public IAspDisplayCallback
{
public:
    void onImageFrameReady(AspImageFrame& frame) override {
        //主控的图像byte数组指针，长度为长*宽*4
        uint8_t* ptr = static_cast<uint8_t*>(frame.buffer);
        //图像的宽
        int width = frame.width;
        //图像的高
        int height = frame.height;
        //必须手动释放
        frame.releaseBuffer();
    }
};

2.5.3 音频回调代理AspAudio

代理接口说明：

代码示例：

class AspAudioImpl : public AspAudio
{
public:
    void onAudioFrameRender(AspAudioFrame &frame) override{
    
    }
    void onAudioVolumeUpdate(uint32_t volume) override{
    
    }
    void onAudioMuteUpdate(bool isMute) override{
    
    }

    void onAudioPlaybackUpdate(AspAudioPlayback &playback) override{
    
    }

    void onAudioPlaybackStart() override{
    
    }
    void onAudioPlaybackStop() override{
    
    }
};

3.1.1 初始化

功能描述：该接口可以打印SDK内部日志，用于定位问题。

代码示例：

//初始化日志,AspLogSinkImpl为日志回调
auto logSinkImpl = std::make_shared<AspLogSinkImpl>();
AspLogSink::setLogSink(logSinkImpl.get());

3.1.2 回调代理AspLogSink

代理接口说明：

代码示例：

#include "AspLogSink.h"

using namespace wuying::asp;

class AspLogSinkImpl : public AspLogSink
{
public:
    AspLogSinkImpl() {

    }

    void debug(const std::string& tag, const std::string& msg) override {
        //打印debug日志
    }
    void info(const std::string& tag, const std::string& msg) override {
        //打印info日志
    }
    void warning(const std::string& tag, const std::string& msg) override {
        //打印warning日志
    }
    void fatal(const std::string& tag, const std::string& msg) override {
        //打印fatal日志
    }
    void error(const std::string& tag, const std::string& msg) override {
        //打印error日志
    }
};

3.2.1 suspendThumbnailDisplay

函数原型：void suspendThumbnailDisplay() 

功能描述：挂起缩略图的图像，不推流

代码示例：

client->suspendThumbnailDisplay();

3.2.2 resumeThumbnailDisplay

函数原型：void resumeThumbnailDisplay() 

功能描述：恢复缩略图的推流，可以强制推一帧

代码示例：

client->resumeThumbnailDisplay();

3.3.1 setOutputImageFormat

函数原型：void setOutputImageFormat(AspImageFormat format)

功能描述：设置主控回调帧格式

参数说明：

代码示例：

client->setOutputImageFormat(AspImageFormat::BGRA);

3.3.2 requestGraphicsKeyFrame

函数原型：void requestGraphicsKeyFrame(AspDisplay* display) = 0;

功能描述：推一帧主控的关键帧，参数AspDisplay

参数说明：

代码示例：

client->requestGraphicsKeyFrame(display);

3.3.3 setGraphicsQuality

函数原型：void setGraphicsQuality(AspImageQuality quality) = 0;

功能描述：设置画质，画质跟分辨率有关系，一般设置为AUTO，详细参数参见结构体

参数说明：

client->setGraphicsQuality(ASP_IMAGE_QUALITY_AUTO)

3.3.4 setGraphicsFps

函数原型：void setGraphicsFps(int fps) = 0；

功能描述：设置fps

参数说明：

代码示例：

client->setGraphicsFps(30)

3.3.5 setGraphicsBitrate

函数原型：void setGraphicsBitrate(int32_t bps) = 0;

功能描述：设置码率，码率影响图片的大小

参数说明：

以下码率仅供参考：

代码示例：

client->setGraphicsBitrate(1*1024)

3.4.1 sendMouseClick

函数原型：void sendMouseClick(AspAction action, uint32_t button, uint32_t buttonState) = 0;

功能描述：鼠标点击

参数说明：

代码示例：

//鼠标左键按下
display->sendMouseClick(AspAction::ACTION_DOWN, ASP_MOUSE_BUTTON_MASK_L, ASP_MOUSE_BUTTON_LEFT);
//鼠标左键弹起
display->sendMouseClick(AspAction::ACTION_UP, ASP_MOUSE_BUTTON_MASK_L, ASP_MOUSE_BUTTON_LEFT);

3.4.2 sendMouseMove

函数原型：virtual void sendMouseMove(uint32_t x, uint32_t y, uint32_t buttonState) = 0;

功能描述：鼠标移动

参数说明：

代码示例：

//x y 为云机的x y坐标
sendMouseMove(x, y, ASP_MOUSE_BUTTON_MASK_L)

3.5.1 sendKeyEvent

函数原型：virtual void sendKeyEvent(AspAction action, int scancode) = 0;

功能描述：键盘事件

参数说明：

代码示例：

//键盘按下
display->sendKeyEvent(AspAction::ACTION_DOWN,scanCode);
//键盘弹起
display->sendKeyEvent(AspAction::ACTION_UP,scanCode);

3.6.1 setClipBoardTypes

函数原型：virtual void setClipBoardTypes(std::vector<AspClipboardType> types) = 0;

功能描述：发送剪贴板类型，一般在Ctrl+V调用或写入剪贴板时调用，目前仅支持文本。

参数说明：

代码示例：

std::vector<AspClipboardType> types;
types.push_back(AspClipboardType::CLIPBOARD_UTF8_TEXT);
client->setClipBoardTypes(types);

3.6.2 notifyClipboardReadComplete

函数原型：virtual void notifyClipboardReadComplete(AspClipboardType type, uint8_t* buf, size_t len) = 0;

功能描述：将内容传到云机在onClipboardRead(uint8_t selection, AspClipboardType type)触发时调用

参数说明：

代码示例：

void onClipboardRead(uint8_t selection, AspClipboardType type) override {
        //本地到云机，通过client->setClipBoardTypes(types)触发
        //触发onClipboardRead，将剪贴板内容写入notifyClipboardReadComplete
        client->notifyClipboardReadComplete(type, reinterpret_cast<uint8_t *>(utf8Data.data()), utf8Data.size());
}

3.6.3 回调代理IClipboardCallback

代理接口说明：

代码示例：

class AspClipboardlmpl :public IClipboardCallback
{
public:
    AspClipboardlmpl() {};

    void onClipboardRead(uint8_t selection, AspClipboardType type) override {
        //本地到云机，通过client->setClipBoardTypes(types)触发
        //触发onClipboardRead，将剪贴板内容写入notifyClipboardReadComplete
        //client->notifyClipboardReadComplete(type, reinterpret_cast<uint8_t *>(utf8Data.data()), utf8Data.size());
    }
    void onClipboardWrite(std::vector<AspClipboardData> dataV) override {
        //云机到本地剪贴板，将dataV数据写入剪贴板
    }
};

3.7.1 sendStringDataToShell

函数原型：virtual bool sendStringDataToShell(const std::string& val) = 0;

功能描述：发送Shell命令

参数说明：

代码示例：

client->sendStringDataToShell(jsonString)

常用ADB命令：

3.7.2 回调代理IShellCmdCallback

代理接口说明：

代码示例：

class AspShellCmdlmpl :public IShellCmdCallback
{
public:
    AspShellCmdlmpl() {};

    void onReceiveStringData(const std::string& val) override {
        //发送字符的回调
    }
    void onReceiveRawData(const std::vector<uint8_t> val) override {
       //发送字节的回调
    }
};