Este tema describe cómo usar la edición C++ del SDK de Windows para Cloud Phone.
1. Primeros pasos
1.1 Obtener el SDK y la demostración
Requisitos del entorno de integración
Versión release de Windows x64
Importar el SDK
Ejemplo en Visual Studio 2019:
Abra Project Properties > Configuration Properties > VC++ Directories. Agregue el directorio include de asp-client-sdk a Include Directories.
Abra Project Properties > Configuration Properties > VC++ Directories. Agregue el directorio lib de asp-client-sdk a Library Directories.
Abra Project Properties > Configuration Properties > Linker > General. Agregue el directorio lib de asp-client-sdk a Additional Library Directories.
Abra Project Properties > Configuration Properties > Linker > Input. Agregue asp-client-sdk.lib, asp-engine.lib y glog.lib a Additional Dependencies.
Ejemplo en Qt Creator:
Agregue las siguientes líneas al archivo .pro de su proyecto:
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 \
Ejecutar rápidamente la demostración
Descargue Windows_Demo_Release y descomprímalo para obtener dos directorios: server y client. Estos directorios contienen las demostraciones del servidor y del cliente, respectivamente.
Iniciar el servidor
Modifique el archivo de configuración:
{
"httpPort": "8328",
"accessKeyId": "AK",
"accessKeySecret": "SK",
"androidRegionId": "cn-hangzhou"
}
Reemplace AK y SK con su AccessKey ID y AccessKey Secret reales. Establezca androidRegionId con el identificador de región de su instancia.
Ejecute server/run_server.bat. Aparecerá el siguiente mensaje:
2024-11-01T13:48:27.002Z Server is running on http://127.0.0.1:8328/listAic
El servidor se inició correctamente.
Ejecutar el cliente
{
"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
}
Reemplace GROUPIDS con el identificador del grupo de instancias de Cloud Phone que desea controlar. El identificador debe comenzar con ag-. Es posible especificar varios identificadores de grupo. Guarde el archivo después de actualizarlo con el identificador de grupo de instancias de Cloud Phone con prefijo ag-.
Descripción de los parámetros de configuración:
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
Ejecute client/WuyingDemo.exe.
1.2 Flujo de integración
1.3 Mejores prácticas
Para obtener instrucciones detalladas sobre la integración, consulte Best practices for quickly integrating Cloud Phone. La arquitectura general de integración de Cloud Phone se muestra en el siguiente diagrama:
Existen varios métodos de inicio de sesión para obtener el ticket necesario para integrar el SDK. El siguiente diagrama de flujo muestra el proceso:
Para conocer los detalles específicos de implementación, consulte el código de ejemplo en la sección Interfaces de ciclo de vida.
2. Interfaces de ciclo de vida
2.1 Crear una conexión de miniatura
Prototipo de función: static AspClient* create(AspTicket& ticket, wuying::asp::shared_ptr<IAspClientCallback> callback);
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
ticket |
AspTicket |
AspTicket contiene información sobre si es una miniatura, detalles de la instancia y credenciales de conexión. Para más información, consulte 4.1 AspTicket. |
|
callback |
IAspClientCallback |
Callback de conexión. Para más información, consulte 2.5.1 Connection callback proxy IAspClientCallback. |
Descripción de la función: esta interfaz establece una conexión de miniatura con un Cloud Phone.
Ejemplo de código:
AspTicket ticket;
// Set ticket
ticket.ticket = "";
// Set AppInstanceId
ticket.id = "";//AppInstanceId;
// Set user
ticket.user = "";//Cloud Phone name
// uuid must match the backend uuid
ticket.uuid = "wyClient";
// Fixed for Windows
ticket.systemType = "Windows";
// Fixed to 0
ticket.partner = 0;
// Whether thumbnail mode is enabled. Fixed to true.
ticket.isThumbnailEnable = true;
// Add connection callback. See below for details.
shared_ptr<AspClientCbImpl> iClient(new AspClientCbImpl(cert.Id));
AspClient *client=AspClient::create(ticket, iClient);
// Clipboard callback. See below for details.
shared_ptr<AspClipboardlmpl> clipboardCallback(new AspClipboardlmpl());
client->setClipboardCallback(clipboardCallback);
// Shell command callback. See below for details.
shared_ptr<AspShellCmdlmpl> shellCmdCallBack(new AspShellCmdlmpl());
client->setShellCmdCallback(shellCmdCallBack);
// Set thumbnail display size: width (int), height (int), fps (int)
client->setThumbnailDisplay(with, height, 1);
// Set connection type. Fixed to socket and false.
client->setProxyConnType(ASP_CONN_SOCKET);
client->setQuicOption(false);
// Set display callback
shared_ptr<IAspDisplayCallback> iDisplay(nullptr);
auto display = client->addDisplay(iDisplay);
// Connect to the phone
client->open();
2.2 Crear una conexión de control principal
Prototipo de función: static AspClient* create(AspTicket& ticket, wuying::asp::shared_ptr<IAspClientCallback> callback);
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
ticket |
AspTicket |
AspTicket contiene información de la instancia y credenciales de conexión. Para más información, consulte 4.1 AspTicket. |
|
callback |
IAspClientCallback |
Callback de conexión. Para más información, consulte 2.5.1 Connection callback proxy IAspClientCallback. |
Descripción de la función: esta interfaz establece una conexión de control principal con un Cloud Phone.
Ejemplo de código:
AspTicket ticket;
// Set the ticket.
ticket.ticket = "";
// Set the AppInstanceId.
ticket.id = "";//AppInstanceId;
// Set the user.
ticket.user = "";// The name of the cloud phone.
// The UUID must be the same as the one on the backend.
ticket.uuid = "wyClient";
// Set to a fixed value: Windows.
ticket.systemType = "Windows";
// Set to a fixed value: 0.
ticket.partner = 0;
// Enable the thumbnail feature. Set to a fixed value: true.
ticket.isThumbnailEnable = true;
// Add a connection callback. For more information, see the subsequent sections.
shared_ptr<AspClientCbImpl> iClient(new AspClientCbImpl(cert.Id));
AspClient *client=AspClient::create(ticket, iClient);
// Clipboard callback. For more information, see the subsequent sections.
shared_ptr<AspClipboardlmpl> clipboardCallback(new AspClipboardlmpl());
client->setClipboardCallback(clipboardCallback);
// Add a Shell command callback. For more information, see the subsequent sections.
shared_ptr<AspShellCmdlmpl> shellCmdCallBack(new AspShellCmdlmpl());
client->setShellCmdCallback(shellCmdCallBack);
// Set the thumbnail window size. Parameters: width (int), height (int), and fps (int).
client->setThumbnailDisplay(with, height, 1);
// Set the connection type. The type is fixed to socket and the QUIC option is set to false.
client->setProxyConnType(ASP_CONN_SOCKET);
client->setQuicOption(false);
// Set the window callback.
shared_ptr<IAspDisplayCallback> iDisplay(nullptr);
auto display = client->addDisplay(iDisplay);
// Connect to the cloud phone.
client->open();
2.3 reopen
Prototipo de función: void reopen(std::string& ticket)
Descripción de la función: vuelve a abrir una conexión o reconecta después de una desconexión. Solo es válido después de llamar a close(false).
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
ticket |
std::string |
Ticket es la credencial de conexión. Por lo general, tiene una validez de 10 minutos. |
Ejemplo de código:
client->reopen(ticket);
2.4 close
Prototipo de función: void close(bool destroyClient = false)
Descripción de la función: cierra la conexión.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
destroyClient |
bool |
Indica si se limpian los recursos. El valor predeterminado es false. |
Ejemplo de código:
client->close(false)
2.5 Descripción de callbacks
2.5.1 Proxy de callback de conexión IAspClientCallback
Descripción de las interfaces del proxy:
|
Interfaz |
Descripción |
|
void onThumbnailUpdate(void* buffer, uint32_t width, uint32_t height, AspImageFormat format) |
Se invoca cuando se actualiza correctamente una miniatura para una conexión de Cloud Phone. Para obtener detalles del formato, consulte 5.2 AspImageFormat. |
|
void onConnectEvent(ConnectEvent& event) |
Se invoca cuando ocurre un evento de conexión. Para obtener detalles del evento, consulte 4.2 ConnectEvent. |
Ejemplo de código:
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 Proxy de callback de flujo de control principal IAspDisplayCallback
Descripción de las interfaces del proxy:
|
Interfaz |
Descripción |
|
void onImageFrameReady(AspImageFrame& frame) |
Se invoca cuando el flujo de control principal está listo tras conectarse correctamente al Cloud Phone. Para obtener detalles del fotograma, consulte 4.3 AspImageFrame. |
Ejemplo de código:
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 Proxy de callback de audio AspAudio
Descripción de las interfaces del proxy:
|
Interfaz |
Descripción |
|
void onAudioFrameRender(AspAudioFrame &frame) |
No requiere implementación. Para obtener detalles del fotograma, consulte 4.4 AspAudioFrame. El SDK gestiona internamente la renderización de audio. |
|
void onAudioVolumeUpdate(uint32_t volume) |
No requiere implementación. El SDK gestiona internamente la renderización de audio. |
|
void onAudioMuteUpdate(bool isMute) |
No requiere implementación. El SDK gestiona internamente la renderización de audio. |
|
void onAudioPlaybackUpdate(AspAudioPlayback &playback) |
No requiere implementación. Para obtener detalles de reproducción, consulte 4.5 AspAudioPlayback. El SDK gestiona internamente la renderización de audio. |
|
void onAudioPlaybackStart() |
No requiere implementación. El SDK gestiona internamente la renderización de audio. |
|
void onAudioPlaybackStop() |
No requiere implementación. El SDK gestiona internamente la renderización de audio. |
Ejemplo de código:
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. Interfaces de negocio
3.1 Interfaces de registro
3.1.1 Inicialización
Descripción de la función: esta interfaz imprime los registros internos del SDK para solucionar problemas.
Ejemplo de código:
// Initialize logging. AspLogSinkImpl is the log callback.
auto logSinkImpl = std::make_shared<AspLogSinkImpl>();
AspLogSink::setLogSink(logSinkImpl.get());
3.1.2 Proxy de callback AspLogSink
Descripción de las interfaces del proxy:
|
Interfaz |
Descripción |
|
void debug(const std::string& tag, const std::string& msg) |
Callback de registro de depuración del SDK |
|
void info(const std::string& tag, const std::string& msg) |
Callback de registro informativo del SDK |
|
void warning(const std::string& tag, const std::string& msg) |
Callback de registro de advertencia del SDK |
|
void fatal(const std::string& tag, const std::string& msg) |
Callback de registro de error fatal del SDK |
|
void error(const std::string& tag, const std::string& msg) |
Callback de registro de error del SDK |
Ejemplo de código:
#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 Interfaces de negocio de miniaturas
3.2.1 suspendThumbnailDisplay
Prototipo de función: void suspendThumbnailDisplay()
Descripción de la función: suspende la transmisión de imágenes en miniatura.
Ejemplo de código:
client->suspendThumbnailDisplay();
3.2.2 resumeThumbnailDisplay
Prototipo de función: void resumeThumbnailDisplay()
Descripción de la función: reanuda la transmisión de miniaturas y permite forzar el envío de un solo fotograma.
Ejemplo de código:
client->resumeThumbnailDisplay();
3.3 Funciones adicionales de control principal
3.3.1 setOutputImageFormat
Prototipo de función: void setOutputImageFormat(AspImageFormat format)
Descripción de la función: establece el formato del fotograma de callback de control principal.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
format |
AspImageFormat |
Formato del fotograma de callback de control principal. Para más detalles, consulte 5.2 AspImageFormat. |
Ejemplo de código:
client->setOutputImageFormat(AspImageFormat::BGRA);
3.3.2 requestGraphicsKeyFrame
Prototipo de función: void requestGraphicsKeyFrame(AspDisplay* display) = 0;
Descripción de la función: envía un fotograma clave individual para el flujo de control principal. El parámetro es AspDisplay.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
display |
AspDisplay* |
Puntero a la clase de visualización |
Ejemplo de código:
client->requestGraphicsKeyFrame(display);
3.3.3 setGraphicsQuality
Prototipo de función: void setGraphicsQuality(AspImageQuality quality) = 0;
Descripción de la función: establece la calidad de imagen. La calidad depende de la resolución. Por lo general, establezca este parámetro en AUTO. Para conocer los parámetros detallados, consulte la definición de la estructura.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
quality |
AspImageQuality |
Calidad de imagen. Para más detalles, consulte 5.4 AspImageQuality. |
client->setGraphicsQuality(ASP_IMAGE_QUALITY_AUTO)
3.3.4 setGraphicsFps
Prototipo de función: void setGraphicsFps(int fps) = 0;
Descripción de la función: establece los fotogramas por segundo (FPS).
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
fps |
int |
Tasa de fotogramas |
Ejemplo de código:
client->setGraphicsFps(30)
3.3.5 setGraphicsBitrate
Prototipo de función: void setGraphicsBitrate(int32_t bps) = 0;
Descripción de la función: establece la tasa de bits, lo cual afecta el tamaño de la imagen.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
bps |
int32_t |
Tasa de bits |
Las siguientes tasas de bits son solo de referencia:
|
Calidad de imagen |
Tasa de bits |
|
Baja calidad |
1×1024 |
|
Media |
5×1024 |
|
Alta calidad |
10×1024 |
|
Sin pérdida |
50×1024 |
Ejemplo de código:
client->setGraphicsBitrate(1*1024)
3.4 Ratón
3.4.1 sendMouseClick
Prototipo de función: void sendMouseClick(AspAction action, uint32_t button, uint32_t buttonState) = 0;
Descripción de la función: envía un evento de clic del ratón.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
action |
AspAction |
Para más detalles, consulte 5.5 AspAction. |
|
button |
uint32_t |
Para más detalles, consulte 5.6 AspMouseButtonMask. |
|
buttonState |
uint32_t |
Para más detalles, consulte 5.7 AspMouseButton. |
Ejemplo de código:
// 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
Prototipo de función: virtual void sendMouseMove(uint32_t x, uint32_t y, uint32_t buttonState) = 0;
Descripción de la función: envía un evento de movimiento del ratón.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
x |
uint32_t |
Coordenada horizontal del Cloud Phone |
|
y |
uint32_t |
Coordenada vertical del Cloud Phone |
|
buttonState |
uint32_t |
Para más detalles, consulte 5.6 AspMouseButtonMask. |
Ejemplo de código:
// x and y are the Cloud Phone coordinates
sendMouseMove(x, y, ASP_MOUSE_BUTTON_MASK_L)
3.5 Teclado
3.5.1 sendKeyEvent
Prototipo de función: virtual void sendKeyEvent(AspAction action, int scancode) = 0;
Esta función describe los eventos de teclado.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
action |
AspAction |
Tipo de acción. Para más detalles, consulte 5.5 AspAction. |
|
scancode |
int |
Código de exploración de la tecla |
Ejemplo de código:
// Key press
display->sendKeyEvent(AspAction::ACTION_DOWN,scanCode);
// Key release
display->sendKeyEvent(AspAction::ACTION_UP,scanCode);
3.6 Portapapeles
Del entorno local a la nube
De la nube al entorno local
3.6.1 setClipBoardTypes
Prototipo de función: virtual void setClipBoardTypes(std::vector<AspClipboardType> types) = 0;
Envía el formato de datos del contenido del portapapeles cuando copia al portapapeles o pega con Ctrl+V. Solo se admite texto.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
types |
std::vector<AspClipboardType> |
Matriz de tipos de portapapeles. Para más detalles, consulte 5.8 AspClipboardType. |
Ejemplo de código:
std::vector<AspClipboardType> types;
types.push_back(AspClipboardType::CLIPBOARD_UTF8_TEXT);
client->setClipBoardTypes(types);
3.6.2 notifyClipboardReadComplete
Prototipo de función: virtual void notifyClipboardReadComplete(AspClipboardType type, uint8_t* buf, size_t len) = 0;
Descripción de la función: envía contenido al Cloud Phone. Esta función se invoca cuando se activa onClipboardRead(uint8_t selection, AspClipboardType type).
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
type |
AspClipboardType |
Tipo de portapapeles. Actualmente solo admite texto. |
|
buf |
uint8_t* |
Puntero a la matriz de bytes del contenido del portapapeles |
|
len |
size_t |
Tamaño de buf |
Ejemplo de código:
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 Proxy de callback IClipboardCallback
Descripción de las interfaces del proxy:
|
Interfaz |
Descripción |
|
void onClipboardRead(uint8_t selection, AspClipboardType type) |
Se activa al copiar del entorno local al Cloud Phone mediante setClipBoardTypes(types). Llame a notifyClipboardReadComplete para enviar el contenido del portapapeles. Para obtener detalles del tipo, consulte 5.8 AspClipboardType. |
|
void onClipboardWrite(std::vector<AspClipboardData> dataV) |
Se activa al copiar del Cloud Phone al entorno local. Escriba dataV en el portapapeles local. Para obtener detalles de los datos, consulte 4.6 AspClipboardData. |
Ejemplo de código:
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 Canal de comandos de shell
3.7.1 sendStringDataToShell
Prototipo de función: virtual bool sendStringDataToShell(const std::string& val) = 0;
Descripción de la función: envía un comando de shell.
Descripción de los parámetros:
|
Nombre del parámetro |
Tipo de parámetro |
Descripción |
|
val |
std::string |
Comando de ADB Shell en formato JSON: {"id":"","cmd":""} |
Ejemplo de código:
client->sendStringDataToShell(jsonString)
Comandos comunes de ADB:
|
Función |
Comando |
|
Atrás |
input keyevent KEYCODE_BACK |
|
Inicio |
input keyevent KEYCODE_HOME |
|
Tecla de cambio |
input keyevent KEYCODE_APP_SWITCH |
|
Silenciar |
input keyevent 164 |
|
Subir volumen |
input keyevent KEYCODE_VOLUME_UP |
|
Bajar volumen |
input keyevent KEYCODE_VOLUME_DOWN |
|
Ocultar barra de navegación |
setprop persist.wy.hasnavibar false; killall com.android.systemui |
|
Mostrar barra de navegación |
setprop persist.wy.hasnavibar true; killall com.android.systemui |
|
Captura de pantalla |
screencap -p /sdcard/Download/abc.png |
3.7.2 Proxy de callback IShellCmdCallback
Descripción de las interfaces del proxy:
|
Interfaz |
Descripción |
|
void onReceiveStringData(const std::string& val) |
Recibe respuestas de comandos de shell basadas en cadenas de texto |
|
void onReceiveRawData(const std::vector<uint8_t> val) |
Recibe respuestas de comandos de shell basadas en bytes sin procesar |
Ejemplo de código:
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
}
};
4. Detalles de los parámetros
4.1 AspTicket
struct AspTicket {
std::string ticket; // Ticket string for accessing a Cloud Phone
std::string id; // Desktop ID
std::string user; // Username
std::string uuid; // Local UUID (must match the UUID used when requesting the ticket)
std::string systemType; // Operating system type
uint8_t partner; // Partner ID
bool isThumbnailEnable = false; // Whether thumbnail mode is enabled
};
4.2 ConnectEvent
struct ConnectEvent {
ConnectEventType type; // Event type such as connection success or failure
int reason; // Reason for the event trigger
};
4.3 AspImageFrame
struct AspImageFrame {
uint32_t frameId;
void* buffer;
uint32_t width;
uint32_t height;
AspImageFormat format;
ReleaseBuffer releaseBuffer;
};
4.4 AspAudioFrame
struct AspAudioFrame {
int sample; // Sample rate
int channels; // Channels
int size; // Data size
uint8_t *data; // Data address
ReleaseBuffer releaseBuffer; // Function to release data. Must be called after using data.
};
4.5 AspAudioPlayback
struct AspAudioPlayback {
AspAudioReadType readType; // Audio data retrieval method: PUSH or PULL
AspAudioMode mode; // PCM or OPUS
uint32_t channels; // Number of channels
uint32_t frequency; // Sample rate
AspAudioFormat format; // RAW or OPUS
AudioReader audioReader; // Function for data reading in PULL mode. Refer to the demo implementation.
};
4.6 AspClipboardData
struct AspClipboardData {
AspClipboardType type;
uint8_t* data;
uint32_t size;
};
5. Enumeraciones
5.1 AspConnType
enum AspConnType {
ASP_CONN_SOCKET = 0,
ASP_CONN_SOCKPAIR = 1,
ASP_CONN_PIPE = 2,
ASP_CONN_SOCKET_UNIX = 3,
ASP_CONN_END = ASP_CONN_PIPE,
};
5.2 AspImageFormat
enum class AspImageFormat {
YUV420P,
YUV422P,
YUV444P,
RGB24,
RGBA,
BGRA,
ARGB,
ABGR,
NV12
};
5.3 ConnectEventType
enum ConnectEventType {
EVENT_CONNECT_SUCCESS,
EVENT_CONNECT_FAILED,
EVENT_DISCONNECT_SUCCESS,
EVENT_RECONNECT_START,
EVENT_RECONNECT_FAILED
};
5.4 AspImageQuality
enum AspImageQuality {
ASP_IMAGE_QUALITY_LOSSLESS = 0,
ASP_IMAGE_QUALITY_HIGH = 1,
ASP_IMAGE_QUALITY_MEDIUM = 2,
ASP_IMAGE_QUALITY_LOW = 3,
ASP_IMAGE_QUALITY_AUTO = 4,
};
5.5 AspAction
enum AspAction {
ACTION_UP,
ACTION_DOWN
};
5.6 AspMouseButtonMask
enum AspMouseButtonMask {
ASP_MOUSE_BUTTON_MASK_L = (1 << 0),
ASP_MOUSE_BUTTON_MASK_M = (1 << 1),
ASP_MOUSE_BUTTON_MASK_R = (1 << 2),
ASP_MOUSE_BUTTON_MASK_F = (1 << 3),
ASP_MOUSE_BUTTON_MASK_B = (1 << 4),
ASP_MOUSE_BUTTON_MASK = 0x1f
};
5.7 AspMouseButton
enum AspMouseButton {
ASP_MOUSE_BUTTON_INVALID,
ASP_MOUSE_BUTTON_LEFT,
ASP_MOUSE_BUTTON_MIDDLE,
ASP_MOUSE_BUTTON_RIGHT,
ASP_MOUSE_BUTTON_UP,
ASP_MOUSE_BUTTON_DOWN,
ASP_MOUSE_BUTTON_SIDE_FORWARD,
ASP_MOUSE_BUTTON_SIDE_BACK,
ASP_MOUSE_BUTTON_ENUM_END
};
5.8 AspClipboardType
enum AspClipboardType {
CLIPBOARD_NONE = 0,
CLIPBOARD_UTF8_TEXT,
CLIPBOARD_IMAGE_PNG, /* All clients with image support should support this one */
CLIPBOARD_IMAGE_BMP, /* optional */
CLIPBOARD_IMAGE_TIFF, /* optional */
CLIPBOARD_IMAGE_JPG, /* optional */
CLIPBOARD_FILE, /* optional, single file */
CLIPBOARD_DIRECTORY, /* optional, support directory recursive */
CLIPBOARD_HTML,
CLIPBOARD_RTF,
CLIPBOARD_XML_SPREAD_SHEET,
};
6. Códigos de error
Código de error | Mensaje de error ( | Módulo | Causa |
Los códigos de error del 2 al 26 se relacionan principalmente con problemas de red. | |||
2 | Error al conectarse a %s. | ASP SDK | El valor MAGIC no es válido. |
3 | Error al conectarse a %s. | ASP SDK | Datos no válidos. |
4 | Las versiones del cliente y del servidor no coinciden. | ASP SDK | Las versiones no coinciden. |
5 | Se requiere una conexión TLS. | ASP SDK | El servidor requiere una conexión TLS, pero el cliente no inició ninguna. |
6 | Conexión TLS inesperada. | ASP SDK | La conexión no requiere TLS, pero se utilizó este protocolo. |
7 | Permiso denegado para conectarse a %s. | ASP SDK | Permisos insuficientes. |
8 | ID de cliente no válido durante la migración. | ASP SDK | El ID de cliente no es válido durante la migración. |
9 | Error al conectarse a %s. | ASP SDK | El canal no existe. |
20 | Error al conectarse al servidor ASP. | ASP SDK | Error de conexión del canal. |
21 | Ocurrió un error de autenticación TLS. | ASP SDK | Error de autenticación TLS. |
22 | Error al conectarse a %s. | ASP SDK | Error en el enlace del canal. |
23 | Error al conectarse a %s. | ASP SDK | Error de autenticación de la conexión. |
24 | Error al conectarse a %s. | ASP SDK | Error de E/S en la conexión. |
25 | Error al conectarse a %s. | ASP SDK | La validación del ticket falló. Este error también ocurre cuando se reutiliza un ticket de una sesión finalizada. |
26 | El handshake de xquic falló. | ASP SDK | El handshake de xquic falló. |
1206 | El ticket ya está en uso. | ASP SDK | Un ticket se puede reutilizar, pero solo para una conexión a la vez. Este error ocurre si intenta establecer una conexión nueva mientras el cloud phone ya está en uso. |
1207 | El ticket se invalidó porque se reinició la instancia. | ASP SDK | La instancia se reinició, lo que invalidó el ticket. |
Códigos de error del SDK para el modo colaborativo | |||
1000 | El token está vacío. | ASP SDK | Estos errores ocurren únicamente en el modo colaborativo cuando falla la validación secundaria entre el cliente y el servidor. |
1001 | El usuario está vacío. | ASP SDK | |
1200 | El token no es válido. | ASP SDK | |
1201 | La VM no es válida. | ASP SDK | |
1202 | Ocurrió un error interno del administrador. | ASP SDK | |
1203 | El usuario no es válido. | ASP SDK | |
1204 | El token caducó. | ASP SDK | |
1500 | Ocurrió un error interno del servidor. | ASP SDK | |
1501 | Ocurrió un error de red en el servidor. | ASP SDK | |
Interrupciones de conexión y otros errores | |||
2000 | Se desconectó del servidor porque se agotó el tiempo de espera al obtener datos de %s. | ASP SDK | Tiempo de espera agotado al obtener datos. |
2001 | %s se desconectó del servidor, posiblemente porque su proceso finalizó. | ASP SDK | Esto suele ocurrir cuando finaliza el proceso del lado del cliente. Por ejemplo, cuando el usuario cierra una aplicación de Android al presionar el botón Inicio. |
2002 | Otro usuario se conectó al %s actual desde una terminal distinta. | ASP SDK | Otro usuario tomó el control de la sesión en modo preventivo. |
2003 | %s se está apagando o reiniciando. Por lo general, esta acción la inicia un administrador. | ASP SDK | El cloud phone se apagó o se reinició, normalmente por acción de un administrador. |
2004 | La conexión del usuario actual finalizó. | ASP SDK | El cliente inició la desconexión o el servidor activó una acción de expulsión o desconexión. |
2005 | Sesión desconectada: se alcanzó el límite de tiempo de uso. | ASP SDK | La sesión finalizó porque alcanzó el límite de duración de uso establecido por el administrador. |
2006 | El administrador revocó su permiso para usar este cloud phone. Se cerrará su sesión y se le desconectará. | ASP SDK | Un administrador revocó la autorización del usuario. |
2010 | Error al conectarse a %s. | ASP SDK | Error al conectarse a Vdagent. |
2011 | Ocurrió un error al pasar los parámetros de conexión. | ASP SDK | Se pasó un parámetro no válido al conectarse al servidor. |
2027 | Se cambió el modo de extracción de flujo. | ASP SDK | El modo de extracción de flujo cambió de preventivo a colaborativo, o de colaborativo a preventivo. |
2100 | Permiso de portapapeles denegado para copiar de %s al dispositivo local. | ASP SDK | Una directiva deniega el acceso al portapapeles desde la instancia remota hacia el cliente local. |
2101 | Permiso de portapapeles denegado para copiar del dispositivo local a %s. | ASP SDK | Una directiva deniega el acceso al portapapeles desde el cliente local hacia la instancia remota. |
2200 | %s está intentando reconectarse... | ASP SDK | La conexión se perdió debido a un problema de red y el ASP SDK está intentando reconectarse. |
2201 | Su dispositivo presentó una anomalía de red que provocó la desconexión de %s. | ASP SDK | La conexión se perdió debido a un problema de red. El ASP SDK no admite la reconexión por restricciones de imagen; la aplicación debe iniciarla. |
2202 | Se agotó el tiempo de espera para reconectarse a %s. | ASP SDK | El intento de reconexión del ASP SDK superó el tiempo de espera. |
2210 | La conexión se perdió mientras el dispositivo cliente estaba en suspensión. | ASP SDK | La red local se desconectó mientras el dispositivo cliente estaba en suspensión, lo que provocó la pérdida de la conexión con el cloud phone. |
2212 | La conexión se perdió debido a una anomalía en la red local. | ASP SDK | Se detectó una anomalía en la red local que provocó la desconexión del cloud phone. |
2220 | La conexión se perdió debido a una anomalía en la red local. | ASP SDK | Se detectó una anomalía en la red local que provocó la desconexión del cloud phone. |
2240 | La reconexión falló porque el token del ticket no es válido. | ASP SDK | |
2300 | La conexión falló debido a un parámetro no válido proveniente de la aplicación. | app-side | |
2501 | El cliente no pudo conectarse al stream gateway. La red es inaccesible. | stream gateway | |
2502 | El cliente no pudo conectarse al stream gateway. La conexión TCP a la dirección IP del stream gateway superó el tiempo de espera después de tres intentos (15 segundos en total). | stream gateway | |
2503 | El cliente no pudo conectarse al stream gateway debido a un error de red desconocido. | stream gateway | |
2504 | El cliente no pudo conectarse al stream gateway. El software canceló la conexión. | stream gateway | |
2505 | El cliente no pudo conectarse al stream gateway. La conexión se rechazó. | stream gateway | |
2506 | El ticket no es válido. El gateway no pudo analizar sintácticamente el token. | stream gateway | |
2507 | El ticket no es válido porque caducó. | stream gateway | |
2508 | El ticket no es válido porque el UUID no coincide. | stream gateway | |
2509 | El stream gateway no pudo sondear el servidor ASP. | stream gateway | |
2510 | Se rechazó el sondeo al servidor. Solución: asegúrese de que el servidor esté escuchando en el puerto 5912. | stream gateway | |
2511 | El sondeo al servidor falló debido a un error distinto de un tiempo de espera agotado o un rechazo. | stream gateway | |
2512 | La validación del token del stream gateway falló. El ID de VPC del token de administración no coincide con el ID de VPC del stream gateway. | stream gateway | |
2513 | La conexión TCP se restableció durante el handshake "SayHello" entre el cliente y el stream gateway. | stream gateway | |
2520 | La conexión del cliente falló; una comprobación de autodiagnóstico indica una anomalía de red. | ASP SDK | |
2521 | El cliente se desconectó después de tres intentos de reconexión con errores durante la fase de handshake TLS con el stream gateway. | ASP SDK | |
2522 | Ocurrió un error de conexión en un entorno VPN. | ASP SDK | |
2523 | El cliente está intentando conectarse mediante el conjunto de protocolos GM/T. Compruebe la configuración del servidor o seleccione un método de conexión compatible. | ASP SDK | |
2701 | Ocurrió un problema de red del lado del cliente. | ASP SDK | |
2702 | El handshake SSL entre el cliente y el stream gateway superó el tiempo de espera. | ASP SDK | |
2703 | El handshake "SayHello" entre el cliente y el stream gateway superó el tiempo de espera. | ASP SDK | |
2704 | La respuesta del servidor ASP a la solicitud de establecimiento de conexión superó el tiempo de espera. Posibles causas: el servidor ASP no responde, anomalía de red, instancia congelada o uso elevado de memoria o CPU. | ASP SDK | |
2705 | El cliente ASP superó el tiempo de espera mientras esperaba el primer fotograma. Posibles causas: el servidor ASP no responde, no se generan fotogramas debido a un problema con la captura de pantalla o el controlador de GPU, anomalía de red o uso elevado de memoria o CPU. | ASP SDK | |
2706 | Un uso elevado de CPU o memoria en el cliente local puede provocar errores de conexión. | ASP SDK | |
2707 | El servidor ASP superó el tiempo de espera al recuperar el primer fotograma de captura de pantalla del sistema operativo invitado. | ASP SDK | |
2708 | La conexión falló porque un hilo del SDK se bloqueó. | ASP SDK | |
Errores de lógica del lado del cliente | |||
5100 | La conexión de %s al servidor ASP superó el tiempo de espera. | app-side | El lado del cliente no recibió un evento "connected" dentro del periodo de tiempo especificado. |
5102 | Se agotó el tiempo de espera al obtener datos de %s. | app-side | El lado del cliente recibió un evento "connected", pero no recibió un evento "display" dentro del periodo de tiempo especificado. |
5004 | Parámetros de inicio no válidos. | app-side | Se pasaron parámetros de inicio no válidos al lado del cliente. Esto suele ocurrir durante el desarrollo. |
5200 | La reconexión del cliente superó el tiempo de espera. | app-side | |
7. Preguntas frecuentes
¿Cómo reinicio un Cloud Phone?
Llame a la API de administración Restart instance para reiniciar el Cloud Phone. Después de llamar a esta API, la conexión del lado del cliente con el Cloud Phone se interrumpe. Vuelva a conectarse cuando el reinicio haya terminado.
Cambio entre la vista en miniatura y el control principal
Para cambiar de la vista en miniatura al control principal, cierre primero la conexión de la miniatura. Espere a que la desconexión termine antes de abrir la conexión del control principal.
Para cambiar del control principal a la vista en miniatura, cierre primero la conexión del control principal. Espere a que la desconexión termine antes de volver a abrir la conexión de la miniatura.
sequenceDiagram
participant App
participant Sdk
App->>Sdk: close(true)
Sdk-->>App: onConnectEvent EVENT_DISCONNECT_SUCCESS
App->>Sdk: reopen(Ticket)