Cloud Phone：Windows SDK C++版

下載 SDK 和 Demo

Integration Environment要求

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 {
       //發送位元組的回調
    }
};