表情 Helper

[English]

公共头文件： #include "brookesia/service_helper/expression/emote.hpp"

概述

本页用于查看 Expression/Emote helper 的原始 Doxygen API，包括公共类型、枚举、方法与相关宏定义。

API 参考

Header File

service/brookesia_service_helper/include/brookesia/service_helper/expression/emote.hpp

Classes

class ExpressionEmote : public esp_brookesia::service::helper::Base<ExpressionEmote>

Helper schema definitions for the emote-expression service.

Public Types

enum class EventMessageType

Supported message categories rendered by the expression service.

Values:

enumerator Idle

enumerator Speak

enumerator Listen

enumerator System

enumerator User

enumerator Battery

enumerator Max

enum class AssetSourceType

Supported asset-source backends used when loading expression assets.

Values:

enumerator Path

enumerator PartitionLabel

enumerator Max

struct AssetSource

Description of one asset source used by the expression service.

Public Members

std::string source: Source identifier such as a path or partition label.

AssetSourceType type: How source should be interpreted.

bool flag_enable_mmap = false: Whether mmap-backed loading should be enabled.

struct Config

Runtime display and task configuration for the expression service.

Public Members

uint32_t h_res = 0: Horizontal resolution in pixels.

uint32_t v_res = 0: Vertical resolution in pixels.

size_t buf_pixels = 0: Display buffer size in pixels.

uint32_t fps = 0: Target render frame rate.

int task_priority = 0: Render task priority.

int task_stack = 0: Render task stack size in bytes.

int task_affinity = 0: Core affinity for the render task.

bool task_stack_in_ext = false: Whether the task stack should live in external memory.

bool flag_swap_color_bytes = false: Whether output color bytes must be swapped.

bool flag_double_buffer = false: Whether double buffering is enabled.

bool flag_buff_dma = false: Whether display buffers must be DMA-capable.

bool flag_buff_spiram = false: Whether display buffers may be allocated in SPIRAM.

struct FlushReadyEventParam

Parameters delivered with the flush-ready event.

Public Members

int x_start = 0: Left edge of the dirty region.

int y_start = 0: Top edge of the dirty region.

int x_end = 0: Right edge of the dirty region.

int y_end = 0: Bottom edge of the dirty region.

const void *data = nullptr: Pixel buffer for the dirty region.