## MouseKeyData structure 描述：鼠标按键信息结构。语法： ```C++ typedef struct tagMouseKeyData { uint8_t key; uint8_t down; int32_t abs_x; int32_t abs_y; } MouseKeyData; ``` |**参数** |**描述** | |---|---| |key |鼠标按键值，参考 [https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes](https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes) | |down |按键状态，0 为 up，1 为 down | |abs_x |鼠标在画面的 x 轴坐标，左\-\>右映射到 [0,65535] | |abs_y |鼠标在画面的 y 轴坐标，上\-\>下映射到 [0,65535] | ## MouseMoveData structure 描述：鼠标光标移动信息结构。语法： ```C++ typedef struct tagMouseMoveData { int32_t abs_x; int32_t abs_y; int32_t delta_x; int32_t delta_y; } MouseMoveData; ``` |**参数** |**描述** | |---|---| |abs_x |鼠标在画面的 x 轴坐标，左\-\>右映射到 [0,65535] | |abs_y |鼠标在画面的 y 轴坐标，上\-\>下映射到 [0,65535] | |delta_x |相对上次鼠标位置 x 方向移动值，左负，右正 | |delta_y |相对上次鼠标位置 y 方向移动值，上负，下正 | ## MouseWheelDataArm structure 描述：鼠标滚轮（ARM）滚动信息结构。语法： ```C++ typedef struct tagMouseWheelDataArm { double x; double y; double axis_v; double axis_h; int16_t action： int16_t button; } MouseWheelDataArm; ``` |**参数** |**描述** | |---|---| |x |鼠标滚轮竖向滚动值，映射到 [0,65535] | |y |鼠标滚轮横向滚动值，映射到 [0,65535] | |axis_v |表示上下方向，\-1.0：下，1.0：上 | |axis_h |表示左右方向，\-1.0：右，1.0：左 | |action |动作类型，0：ACTION_DOWN，1：ACTION_UP，2：ACTION_MOVE，8：ACTION_SCROLL | |button |0：左键，1：右键，2：中键 | ## ImeCompositionData structure 描述：输入状态及输入字符串。语法： ```C++ typedef struct tagImeCompositionData { ImeCompositionType type; const char* str; int32_t len; int32_t start; int32_t end; } ImeCompositionData; ``` |**参数** |**描述** | |---|---| |type |输入类型：

* `0`：输入开始

* `1`：输入结束

* `2`：输入中 | |str |输入字符串，必须为 UTF\-8 编码格式 | |len |输入长度 | |start |输入起点 | |end |输入结束点 | ## MulitTouchData structure 描述：多指触控数据结构体。语法： ```C++ typedef struct _MulitTouchData { int32_t x{ 0 }; // 事件 X 坐标位置左-->右映射到 [0,65535] int32_t y{ 0 }; // 事件 Y 坐标位置上-->下映射到 [0,65535] int32_t point_id{ -1 }; // 触摸点 ID int32_t touch_action{ -1 }; // 参考具体枚举值定义 } MulitTouchData;y ``` |**参数** |**描述** | |---|---| |x |事件 X 坐标位置左\-\-\>右映射到 [0,65535] | |y |事件 Y 坐标位置上\-\-\>下映射到 [0,65535] | |point_id |触摸点 ID | |touch_action |触摸事件动作。具体枚举止请参考 [TouchType](https://docs.volcengine.com/docs/6394/2668027#RfaokZKq) 定义。 | ## FrameFormat enum 描述：外部渲染视频帧编码格式。语法： ```C++ enum FrameFormat { /** * @brief YUV I420 格式 */ YUVI420, /** * @brief ARGB 格式, 字节序为 A8 R8 G8 B8 */ ARGB, /** * @brief RGBA 格式, 字节序为 R8 G8 B8 A8 */ RGBA, /** * @brief BGRA 格式, 字节序为 B8 G8 R8 A8 */ BGRA }; ``` ## SessionStatus enum 描述：Session 状态码定义。语法： ```C++ enum class SessionStatus { /** * @brief 默认状态 */ Idle = 0x0000, /** * @brief 启动中 */ Starting = 0x0001, /** * @brief 启动完成 */ Started = 0x0002, /** * @brief 加房成功，拉流中 */ Streaming = 0x0003, /** * @brief 发生错误 */ Error = 0x0004, /** * @brief 结束状态 */ Stop = 0x005 }; ``` ## TouchType enum 描述：Touch 事件类型定义。语法： ```C++ enum class TouchType { /** * 默认值 */ None = -1, /** * 手指按下 */ Down = 0, /** * 手指抬起 */ Up = 1, /** * 手指移动 */ Move = 2, /** * 事件关闭 */ Cancel = 3, /** * @hide */ Outside = 4, /** * @hide */ PointerDown = 5, /** * @hide */ PointerUp = 6 }; ``` ## VeExternalSink |**接口** |**描述** | |---|---| |onFrame |视频帧回调，详细的回调参数请参考 [VeExtVideoFrame](https://docs.volcengine.com/docs/6394/2668027#CxDa24f2)。 | |release |通知开发者渲染器即将被废弃。如果您收到该返回通知后即可释放资源。 | ```C++ void onFrame(VeExtVideoFrame* videoFrame) { (void)videoFrame; }; ``` ```C++ void release(); ``` ## VeExtVideoFrame |**接口** |**描述** | |---|---| |timestampUs |获取视频帧时间戳，单位：微秒 | |width |获取视频帧宽度，单位：px | |height |获取视频帧高度，单位：px | |numberOfPlanes |视频帧颜色 plane 数量，根据 [FrameFormat](https://docs.volcengine.com/docs/6394/2668027#HkEyM10h) 不同视频帧编码格式，获取相关平面数量不同，区别如下：

* `RGBA` / `ARGB` / `BGRA` 格式下，返回 1

* YUV 数据存储格式分为打包（packed）存储格式和平面（planar）存储格式；

* planar 格式中 Y、U、V 分平面存储

* packed 格式中 Y、U、V 交叉存储 | |getPlaneData |通过 plane 数据索引，获取 plane 数据指针。根据 [FrameFormat](https://docs.volcengine.com/docs/6394/2668027#HkEyM10h) 不同视频帧编码格式，获取 plane 数据指针不同，区别如下：

* 获取 `ARGB` / `RGBA` / `BGRA` 格式数据，getPlaneData(0)；

* 获取 `YUVI420` 格式数据：

* Y：getPlaneData(0)

* U：getPlaneData(1)

* V：getPlaneData(2) | |getPlaneStride |通过 plane 数据索引，获取 plane 中数据行的长度(步幅) 。根据 [FrameFormat](https://docs.volcengine.com/docs/6394/2668027#HkEyM10h) 不同视频帧编码格式，获取 plane 中数据行的长度(步幅) 不同，区别如下：

* 获取 `ARGB` / `RGBA` / `BGRA` 格式数据，getPlaneStride(0) ；

* 获取 `YUVI420` 格式数据 Stride

* Y：getPlaneStride(0)

* U：getPlaneStride(1)

* V：getPlaneStride(2) | ```C++ int64_t timestampUs() const = 0; int width() const = 0; int height() const = 0; int numberOfPlanes() const = 0; uint8_t* getPlaneData(int planeIndex) = 0; int getPlaneStride(int planeIndex) = 0; ``` ## KeyboardType 描述：键盘类型语法： ```C++ enum class KeyboardType { /** * @brief 使用云机键盘。 */ POD = 0, /** * @brief 使用本地键盘。 */ LOCAL = 1 }; ``` ## VideoRenderMode 描述：视频的渲染模式。语法： ```C++ enum class VideoRenderMode { COVER = 1, FIT = 2, FILL = 3, }; ``` |**类型** |**值** |**说明** | |---|---|---| |COVER |1 |覆盖模式。

适用于希望**全屏**观看视频内容，且**不介意视频内容完整性**的场景。

该模式优先考虑将视频填满整个屏幕，视频内容会等比例缩放直至屏幕边缘，确保没有黑边。这可能导致视频的某些部分被裁剪，以适应屏幕尺寸。 | |FIT |2 |适应模式，默认。

适用于需要**完整**观看视频内容，且**不介意黑边存在**的场景。

该模式确保视频内容完整显示在屏幕上，通过等比例缩放视频以适应屏幕大小，保持视频的原始宽高比。如果视频尺寸与屏幕尺寸不匹配，未填满的屏幕区域将用黑色填充，形成黑边。 | |FILL |3 |填充模式。

适用于需要**全屏且完整**观看视频内容，且**不介意画面轻微变形**的场景。

该模式旨在让视频内容完全覆盖屏幕，视频可能会进行非等比例缩放以填满整个屏幕，这意味着视频的宽高比可能会改变，导致画面变形。 | ## ChannelMessage structure 描述：消息实体。语法： ```C++ struct ChannelMessage { int type; std::string msgId; std::string ackId; std::string sourceUid; std::string destUid; std::string payload; int64_t timestamp; }; ``` |**参数** |**描述** | |---|---| |type |消息类型。 | |msgId |消息 ID。 | |ackId |ACK ID。 | |sourceUid |消息发送端用户 ID。 | |destUid |消息接收端用户 ID。 | |payload |消息内容。 | |timestamp |消息生成的时间戳。 | ## MessageChannelState enum 描述：消息通道状态。语法： ```C++ enum class MessageChannelState { Unknown = 0, Connected = 1, Disconnected = 2, }; ``` |**类型** |**值** |**说明** | |---|---|---| |Unknown |0 |未知状态。 | |Connected |1 |消息通道已建联。 | |Disconnected |2 |消息通道已断联。 |

云手机