接口列表
更新时间: 2026/02/12 15:27:21
本文介绍了 SDK 的核心接口和事件回调,详细的接口参数和返回值说明请参考具体的头文件 API 注释。
API 参考
核心接口
以下接口提供了 SDK 的基础功能,包括版本查询、引擎管理和房间操作。
| 方法 | 描述 | 头文件 |
|---|---|---|
| nertc_get_version | 获取 SDK 版本信息 | nertc_sdk.h |
| nertc_create_engine_with_config | 创建并初始化引擎实例 | nertc_sdk.h |
| nertcrtc_destory_engine | 销毁引擎实例并释放资源 | nertc_sdk.h |
| nertc_init_engine | 初始化引擎 | nertc_sdk.h |
| nertc_join | 加入 RTC 房间 | 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 | 启动 AI 服务 | 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_hang_up | 挂断 AI 通话 | 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 |
事件回调
SDK 通过事件回调机制向应用程序报告各种状态变化和数据结果,您需要实现相应的回调函数来处理这些事件。
连接状态
监听房间连接和错误状态,确保应用程序能够及时响应网络变化。
| 回调方法 | 描述 | 头文件 |
|---|---|---|
| on_join | RTC 房间加入结果回调 | nertc_sdk_event.h |
| on_channel_status_changed | 频道连接状态变更回调 | nertc_sdk_event.h |
| on_error | 错误事件回调 | nertc_sdk_event.h |
用户状态
实时监听房间内其他用户的状态变化,包括加入、离开和音频状态。
| 回调方法 | 描述 | 头文件 |
|---|---|---|
| on_user_joined | 远端用户加入房间回调 | nertc_sdk_event.h |
| on_user_left | 远端用户离开房间回调 | 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 |
此文档是否对你有帮助?




