接口列表
更新时间： 2026/05/27 21:57:27
本文介绍了 SDK 的核心接口和事件回调，详细的接口参数和返回值说明请参考具体的头文件 API 注释。
API 参考
核心接口
以下接口提供了 SDK 的基础功能，包括版本查询、引擎管理和 AI 对话 Session 操作。
| 方法 | 描述 | 头文件 |
|---|---|---|
| nertc_get_version | 获取 SDK 版本信息 | nertc_sdk.h |
| nertc_create_engine_with_config | 创建引擎实例 | nertc_sdk.h |
| nertc_destroy_engine | 销毁引擎实例并释放资源 | nertc_sdk.h |
| nertc_init_engine | 初始化引擎 | nertc_sdk.h |
| nertc_join | 加入 AI 对话 Session | nertc_sdk.h |
| nertc_leave | 离开 AI 对话 Session | nertc_sdk.h |
音频处理
SDK 支持多种音频数据输入方式，满足不同场景下的音频处理需求。
| 方法 | 描述 | 头文件 |
|---|---|---|
| nertc_push_audio_frame | 推送外部音频原始帧数据 | nertc_sdk.h |
| nertc_push_audio_encoded_frame | 推送外部音频编码帧数据 | nertc_sdk.h |
| nertc_push_audio_reference_frame | 推送外部音频参考帧数据 | nertc_sdk.h |
字幕服务
提供实时语音识别转文字功能，支持多语言识别。
| 方法 | 描述 | 头文件 |
|---|---|---|
| nertc_start_asr_caption | 开启语音识别字幕服务 | nertc_sdk.h |
| nertc_stop_asr_caption | 停止语音识别字幕服务 | nertc_sdk.h |
AI 服务
集成先进的 AI 能力，包括语音对话、图像识别、文本转语音等功能。AI 功能需要网络连接，请确保网络畅通。
| 方法 | 描述 | 头文件 |
|---|---|---|
| nertc_start_ai_with_config | 启动 AI 服务，支持 NORMAL 和 LITE 两种模式 |
nertc_sdk.h |
| nertc_stop_ai | 停止 AI 服务 | nertc_sdk.h |
| nertc_ai_manual_interrupt | 手动打断 AI 对话 | nertc_sdk.h |
| nertc_ai_manual_start_listen | 手动开启语音识别（仅按键模式） | nertc_sdk.h |
| nertc_ai_manual_stop_listen | 手动关闭语音识别（仅按键模式） | nertc_sdk.h |
| nertc_ai_llm_prompt | 发送文本消息到 AI 大模型 | nertc_sdk.h |
| nertc_ai_llm_image | 发送图片到 AI 进行识别分析 | nertc_sdk.h |
| nertc_ai_external_tts | 外部文本转语音服务 | nertc_sdk.h |
| nertc_ai_reply_mcp_tool_call | 回复 MCP 工具调用结果 | nertc_sdk.h |
重点说明：nertc_start_ai_with_config 的两种模式差异
nertc_start_ai_with_config 的实际行为会受到引擎模式（engine_config.engine_mode）影响，当前主要分为 NORMAL 模式 和 LITE 模式：
- NORMAL 模式（
NERTC_SDK_ENGINE_MODE_NORMAL）：用于完整能力场景。设备先通过nertc_join建立底层会话，再调用nertc_start_ai_with_config开启 AI 对话，支持完整的 AI 对话、打电话和实时音视频（RTC）通话能力。 - LITE 模式（
NERTC_SDK_ENGINE_MODE_LITE）：用于低时延 AI 对话场景。设备需要先通过 OTA 返回的mqtt参数完成相关初始化，再调用nertc_start_ai_with_config开启 AI 服务。该模式主要基于 MQTT 信令 + RTP 音频链路直连 AI，不支持打 SIP 电话及 RTC 通话。
此外，nertc_sdk_start_ai_config_t 当前提供 start_topic / start_topic_len 字段，可用于在启动 AI 对话时携带额外的起始主题信息。
事件回调
SDK 通过事件回调机制向应用程序报告各种状态变化和数据结果，您需要实现相应的回调函数来处理这些事件。
连接状态
监听 AI 对话 Session 连接和错误状态，确保应用程序能够及时响应网络变化。
| 回调方法 | 描述 | 头文件 |
|---|---|---|
| on_join | AI 对话 Session 加入结果回调 | nertc_sdk_event.h |
| on_channel_status_changed | 频道连接状态变更回调 | nertc_sdk_event.h |
| on_disconnect | 与服务器连接中断回调 | nertc_sdk_event.h |
| on_error | 错误事件回调 | nertc_sdk_event.h |
| on_license_expire_warning | License 过期预警回调 | nertc_sdk_event.h |
用户状态
实时监听 AI 对话 Session 内其他用户的状态变化，包括加入、离开和音频状态。
| 回调方法 | 描述 | 头文件 |
|---|---|---|
| on_user_joined | 远端用户加入 AI 对话 Session 回调 | nertc_sdk_event.h |
| on_user_left | 远端用户离开 AI 对话 Session 回调 | nertc_sdk_event.h |
| on_user_audio_start | 远端用户开启音频回调 | nertc_sdk_event.h |
| on_user_audio_mute | 远端用户静音音频回调 | nertc_sdk_event.h |
| on_user_audio_stop | 远端用户关闭音频回调 | nertc_sdk_event.h |
功能服务
获取字幕识别结果、AI 服务数据和音频流数据。
| 回调方法 | 描述 | 头文件 |
|---|---|---|
| on_asr_caption_state_changed | 字幕服务状态变更回调 | nertc_sdk_event.h |
| on_asr_caption_result | 语音识别字幕结果回调 | nertc_sdk_event.h |
| on_ai_data | AI 服务相关数据回调 | nertc_sdk_event.h |
| on_audio_encoded_data | 远端用户音频解码前数据回调 | nertc_sdk_event.h |
| on_server_time | 服务器时间同步回调 | nertc_sdk_event.h |
此文档是否对你有帮助？
