接口说明

此章节主要描述指令流引擎客户端调用接口。

其中，接口返回码定义如下：

enum VmiEngineRetCode : int32_t {
    VMI_CLIENT_RECV_ORDER_FAIL = -5, // 客户端引擎接收数据函数执行顺序非法
    VMI_CLIENT_RECV_MEMCPY_FAILED = -4, // 客户端引擎接收数据函数内存拷贝失败
    VMI_CLIENT_RECV_LENGTH_NO_MATCH = -3, // 客户端引擎接收数据函数数据长度不匹配
    VMI_CLIENT_RECV_DATA_NULL = -2, // 客户端引擎接收数据函数数据为NULL
    VMI_CLIENT_RECV_INVALID_PAPAM = -1, // 客户端引擎接收数据函数传入了非法参数
    VMI_SUCCESS = 0,  // 返回成功
    VMI_CLIENT_INVALID_PARAM = 0x0A050001, // 客户端引擎传入了非法参数
    VMI_CLIENT_START_FAIL = 0x0A050002,    // 客户端引擎启动失败
    VMI_CLIENT_ALREADY_STARTED = 0x0A050003, // 客户端引擎已经启动
    VMI_CLIENT_STOP_FAIL = 0x0A050004,       // 客户端引擎停止失败
    VMI_CLIENT_SEND_HOOK_REGISTER_FAIL = 0x0A050005, // 客户端引擎注册hook函数失败
    VMI_CLIENT_SEND_FAIL = 0x0A050006, // 客户端引擎Socket函数发送失败
    VMI_CLIENT_SEND_AGAIN = 0x0A050007, // 客户端引擎Socket函数发送重试
    VMI_CLIENT_INITIALIZE_FAIL = 0x0A050008, // 客户端引擎初始化失败
    VMI_CLIENT_EXEC_ORDER_FAIL = 0x0A050009 // 客户端引擎执行顺序错误
};

指令流数据类型定义如下:

enum VMIMsgType : uint8_t {
    INVALID = 0,          // 起始数据类型
    HEARTBEAT,        // 心跳数据类型
    GL,               // OpenGL数据类型
    AUDIO,            // 音频数据类型
    TOUCH_INPUT,      // 触控数据类型
    NAVBAR_INPUT,     // 导航栏触控数据类型
    VIDEO_RR,         // 分布式渲染VmiAgent数据类型
    VIDEO_RR2 = 16,   // 分布式渲染VideoAgent数据类型
    END               // 结束数据类型
};