Cloud Phone:Windows SDK C++ edition

Download the SDK and demo

Integration environment requirements

Windows x64 release

Import the SDK

Visual Studio 2019 example:

Open Project Properties > Configuration Properties > VC++ Directories. Add the asp-client-sdk include directory to Include Directories.

Open Project Properties > Configuration Properties > VC++ Directories. Add the asp-client-sdk lib directory to Library Directories.

Open Project Properties > Configuration Properties > Linker > General. Add the asp-client-sdk lib directory to Additional Library Directories.

Open Project Properties > Configuration Properties > Linker > Input. Add asp-client-sdk.lib, asp-engine.lib, and glog.lib to Additional Dependencies.

Qt Creator example:

Add the following lines to your project .pro file:

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 \

Quickly run the demo

Download Windows_Demo_Release and decompress it to obtain two directories: server and client. These directories contain the server-side and client-side demos, respectively.

Start the server

Modify the configuration file:

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

Replace AK and SK with your actual AccessKey ID and AccessKey Secret. Set androidRegionId to the region ID of your instance.

Run server/run_server.bat. The following message appears:

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

The server has started successfully.

Run the client

{
  "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
}

Replace GROUPIDS with the ID of the Cloud Phone instance group you want to control. The ID must start with ag-. You can specify multiple group IDs. Save the file after updating it with your ag- prefixed Cloud Phone instance group ID.

Configuration parameter descriptions:

CLOUD_SCREENSIZE_HEIGHT: Initial cloud screen height
CLOUD_SCREENSIZE_WIDTH: Initial cloud screen width
DEBUG_MODE: Log level (0 = no logs, 1 = debug, 2 = info)
DISPLAY_COL: Maximum number of columns displayed (10)
GROUPIDS: Instance groups (supports a list)
GROUP_SCREENSIZE_HEIGHT: Initial local thumbnail window height
GROUP_SCREENSIZE_WIDTH: Initial local thumbnail window width
LOCAL_SCREENSIZE_HEIGHT: Initial local main control window height
LOCAL_SCREENSIZE_WIDTH: Initial local main control window width
DISPLAY_SCALE: Main control scaling ratio
GROUP_SCALE: Thumbnail scaling ratio
MAX_PHONE_NUM: Maximum number of connections
PROXY_CONN_TYPE: Connection type (fixed value)
QUIC_OPTION: Whether to use QUIC (fixed value)
PHONE_URL: Server address
PORT: Server port
AUDIO_ENABLE: Whether to enable audio
EndUserId: Collaborative streaming username
IS_COO: Whether collaborative streaming is enabled
SALE_MODE: Whether CPS is enabled
SHOW_INSTENCE_NAME: Whether to display the instance name or ID
USE_OPENGL: Whether to enable OpenGL rendering

Run client/WuyingDemo.exe.

2.5.1 Connection callback proxy IAspClientCallback

Proxy interface descriptions:

Code example:

class AspClientCbImpl : public IAspClientCallback
{
public:
    AspClientCbImpl() {}
    // Thumbnail update callback
    void onThumbnailUpdate(void* buffer, uint32_t width, uint32_t height, AspImageFormat format) override {

    }
    // Connection event callback
    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 Main control stream callback proxy IAspDisplayCallback

Proxy interface descriptions:

Code example:

class AspDisplayCbImpl : public IAspDisplayCallback
{
public:
    void onImageFrameReady(AspImageFrame& frame) override {
        // Pointer to the main control image byte array (length = width × height × 4)
        uint8_t* ptr = static_cast<uint8_t*>(frame.buffer);
        // Image width
        int width = frame.width;
        // Image height
        int height = frame.height;
        // Must manually release
        frame.releaseBuffer();
    }
};

2.5.3 Audio callback proxy AspAudio

Proxy interface descriptions:

Code example:

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 Initialization

Function description: This interface prints internal SDK logs for troubleshooting.

Code example:

// Initialize logging. AspLogSinkImpl is the log callback.
auto logSinkImpl = std::make_shared<AspLogSinkImpl>();
AspLogSink::setLogSink(logSinkImpl.get());

3.1.2 Callback proxy AspLogSink

Proxy interface descriptions:

Code example:

#include "AspLogSink.h"

using namespace wuying::asp;

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

    }

    void debug(const std::string& tag, const std::string& msg) override {
        // Print debug log
    }
    void info(const std::string& tag, const std::string& msg) override {
        // Print info log
    }
    void warning(const std::string& tag, const std::string& msg) override {
        // Print warning log
    }
    void fatal(const std::string& tag, const std::string& msg) override {
        // Print fatal log
    }
    void error(const std::string& tag, const std::string& msg) override {
        // Print error log
    }
};

3.2.1 suspendThumbnailDisplay

Function prototype: void suspendThumbnailDisplay() 

Function description: Suspends thumbnail image streaming.

Code example:

client->suspendThumbnailDisplay();

3.2.2 resumeThumbnailDisplay

Function prototype: void resumeThumbnailDisplay() 

Function description: Resumes thumbnail streaming and can force-push a single frame.

Code example:

client->resumeThumbnailDisplay();

3.3.1 setOutputImageFormat

Function prototype: void setOutputImageFormat(AspImageFormat format)

Function description: Sets the main control callback frame format.

Parameter descriptions:

Code example:

client->setOutputImageFormat(AspImageFormat::BGRA);

3.3.2 requestGraphicsKeyFrame

Function prototype: void requestGraphicsKeyFrame(AspDisplay* display) = 0;

Function description: Pushes a single keyframe for the main control stream. The parameter is AspDisplay.

Parameter descriptions:

Code example:

client->requestGraphicsKeyFrame(display);

3.3.3 setGraphicsQuality

Function prototype: void setGraphicsQuality(AspImageQuality quality) = 0;

Function description: Sets image quality. Quality depends on the resolution. Generally, set this parameter to AUTO. For detailed parameters, see the struct definition.

Parameter descriptions:

client->setGraphicsQuality(ASP_IMAGE_QUALITY_AUTO)

3.3.4 setGraphicsFps

Function prototype: void setGraphicsFps(int fps) = 0;

Function description: Sets frames per second (FPS).

Parameter descriptions:

Code example:

client->setGraphicsFps(30)

3.3.5 setGraphicsBitrate

Function prototype: void setGraphicsBitrate(int32_t bps) = 0;

Function description: Sets the bitrate, which affects image size.

Parameter descriptions:

The following bitrates are for reference only:

Code example:

client->setGraphicsBitrate(1*1024)

3.4.1 sendMouseClick

Function prototype: void sendMouseClick(AspAction action, uint32_t button, uint32_t buttonState) = 0;

Function description: Sends a mouse click event.

Parameter descriptions:

Code example:

// Mouse left button press
display->sendMouseClick(AspAction::ACTION_DOWN, ASP_MOUSE_BUTTON_MASK_L, ASP_MOUSE_BUTTON_LEFT);
// Mouse left button release
display->sendMouseClick(AspAction::ACTION_UP, ASP_MOUSE_BUTTON_MASK_L, ASP_MOUSE_BUTTON_LEFT);

3.4.2 sendMouseMove

Function prototype: virtual void sendMouseMove(uint32_t x, uint32_t y, uint32_t buttonState) = 0;

Function description: Sends a mouse move event.

Parameter descriptions:

Code example:

// x and y are the Cloud Phone coordinates
sendMouseMove(x, y, ASP_MOUSE_BUTTON_MASK_L)

3.5.1 sendKeyEvent

Function prototype: virtual void sendKeyEvent(AspAction action, int scancode) = 0;

This feature describes keyboard events.

Parameter descriptions:

Code example:

// Key press
display->sendKeyEvent(AspAction::ACTION_DOWN,scanCode);
// Key release
display->sendKeyEvent(AspAction::ACTION_UP,scanCode);

3.6.1 setClipBoardTypes

Function prototype: virtual void setClipBoardTypes(std::vector<AspClipboardType> types) = 0;

Sends the data format of clipboard content when you copy to the clipboard or paste by pressing Ctrl+V. Only text is supported.

Parameter descriptions:

Code example:

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

3.6.2 notifyClipboardReadComplete

Function prototype: virtual void notifyClipboardReadComplete(AspClipboardType type, uint8_t* buf, size_t len) = 0;

Function description: Sends content to the Cloud Phone. This function is called when onClipboardRead(uint8_t selection, AspClipboardType type) is triggered.

Parameter descriptions:

Code example:

void onClipboardRead(uint8_t selection, AspClipboardType type) override {
        // Triggered when copying from local to Cloud Phone via client->setClipBoardTypes(types)
        // Call notifyClipboardReadComplete to send clipboard content
        client->notifyClipboardReadComplete(type, reinterpret_cast<uint8_t *>(utf8Data.data()), utf8Data.size());
}

3.6.3 Callback proxy IClipboardCallback

Proxy interface descriptions:

Code example:

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

    void onClipboardRead(uint8_t selection, AspClipboardType type) override {
        // Triggered when copying from local to Cloud Phone via client->setClipBoardTypes(types)
        // Call notifyClipboardReadComplete to send clipboard content
        //client->notifyClipboardReadComplete(type, reinterpret_cast<uint8_t *>(utf8Data.data()), utf8Data.size());
    }
    void onClipboardWrite(std::vector<AspClipboardData> dataV) override {
        // Write dataV to the local clipboard when copying from Cloud Phone
    }
};

3.7.1 sendStringDataToShell

Function prototype: virtual bool sendStringDataToShell(const std::string& val) = 0;

Function description: Sends a Shell command.

Parameter descriptions:

Code example:

client->sendStringDataToShell(jsonString)

Common ADB commands:

3.7.2 Callback proxy IShellCmdCallback

Proxy interface descriptions:

Code example:

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

    void onReceiveStringData(const std::string& val) override {
        // Callback for string responses
    }
    void onReceiveRawData(const std::vector<uint8_t> val) override {
       // Callback for raw byte responses
    }
};