docs: 补充核心分层中文注释

This commit is contained in:
chenjintao
2026-09-29 18:18:44 +08:00
parent a77471a7b1
commit 9fd01bb61b
81 changed files with 1189 additions and 112 deletions
@@ -9,6 +9,7 @@
extern "C" {
#endif
/* 仅描述 WebSocket 传输事件,不携带 domain 层的业务会话语义。 */
typedef enum {
MULTIMODAL_WS_EVENT_CONNECTED = 0,
MULTIMODAL_WS_EVENT_DISCONNECTED,
@@ -17,6 +18,7 @@ typedef enum {
MULTIMODAL_WS_EVENT_BINARY_MESSAGE,
} multimodal_ws_event_type_t;
/* data 指针只在事件回调期间有效,需要异步处理时必须复制。 */
typedef struct {
multimodal_ws_event_type_t type;
const uint8_t *data;
@@ -26,6 +28,7 @@ typedef struct {
typedef void (*multimodal_ws_event_callback_t)(const multimodal_ws_event_t *event,
void *user_data);
/* start 复制鉴权信息和回调;stop 负责回收 client、队列及全部工作任务。 */
esp_err_t multimodal_ws_start(const char *bearer_token,
const char *workspace_id,
multimodal_ws_event_callback_t cb,
@@ -33,6 +36,7 @@ esp_err_t multimodal_ws_start(const char *bearer_token,
esp_err_t multimodal_ws_stop(int timeout_ms);
bool multimodal_ws_is_connected(void);
/* 普通文本允许内部重试;realtime 接口使用更短锁等待和发送超时以保护实时性。 */
esp_err_t multimodal_ws_send_text(const char *label, const char *text);
esp_err_t multimodal_ws_send_text_realtime(const char *label, const char *text);
esp_err_t multimodal_ws_send_binary_realtime(const uint8_t *data, size_t len);