## volc_get_version 获取当前 SDK 版本信息。 ```C const char* volc_get_version(void); ``` **传入参数** 无 **返回值** 当前 SDK 版本信息。 ## volc_err_2_str 获取 SDK 内各种错误码、告警码的描述文字。 ```C const char* volc_err_2_str(int err_code); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |err_code |int |需要获取描述的错误码。 | **返回值** 错误码的文本描述。 ## volc_create 创建 SDK 实例。 ```C int volc_create(volc_engine_t* handle, const char* config_json, volc_event_handler_t event_handler, void* user_data); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t\* |创建的引擎实例。 | |config_json |const char\* |一个 JSON 格式的字符串，包含所有初始化所需配置。具体配置项，请参见下方的 config_json 配置示例。 | |event_handler |volc_event_handler_t |SDK 回调给应用层的 Callback 对象，参见 [volc_event_handler_t](/docs/6348/1806635#volc-event-handler-t)。 | |user_data |void\* |用户设置的自定义数据。 | config_json 配置示例 * 低负载方案： ```JSON { "ver": 1, "iot": { "instance_id": "******", // 实例 ID，通过控制台获取 "product_key": "******", // 产品 KEY，通过控制台获取 "product_secret": "******", // 产品密钥，通过控制台获取 "device_name": "device_name" // 设备名，可自行指定 }, "ws": { "audio" : { "codec": 4 // 音频数据类型，可通过“数据类型”了解枚举值 } } } ``` * 高质量方案： ```JSON { "ver": 1, "iot": { "instance_id": "******", // 实例ID，通过控制台获取 "product_key": "******", // 产品KEY，通过控制台获取 "product_secret": "******", // 产品密钥，通过控制台获取 "device_name": "device_name" // 设备名，可自行指定 }, "rtc": { // rtc方案配置 "log_level": 3, // rtc 日志等级，1：info，2：warn，3：error "audio" : { "publish": true, "subscribe": true, "codec": 3 }, "video" : { "publish": false, "subscribe": false, "codec": 1 // 音频数据类型，可通过“数据类型”了解枚举值 }, "params": [ "{\"debug\":{\"log_to_console\":1}}", "{\"rtc\":{\"access\":{\"concurrent_requests\":1}}}", "{\"rtc\":{\"ice\":{\"concurrent_agents\":1}}}", ] // 透传给 RTC 的私有参数 } } ``` **返回值** * 0：创建成功。 * <0：创建失败。 ## volc_destroy 销毁 [volc_create](/docs/6348/1806633#volc-create) 所创建的引擎实例，并释放所有相关资源。 ```C void volc_destroy(volc_engine_t handle); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t |待销毁的引擎实例。 | **返回值** 无 ## volc_start 启动智能体。 ```C int volc_start(volc_engine_t handle, volc_opt_t* opt); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t |引擎实例，参见 [volc_engine_t](/docs/6348/1806635#volc-engine-t) 。 | |opt |volc_opt_t\* |会话参数，参见 [volc_opt_t](/docs/6348/1806635#volc-opt-t)。 | **返回值** * 0：成功。 * <0：失败。参见 [volc_error_code_e](/docs/6348/1806635#volc-error-code-e)。 ## volc_stop 停止与智能体对话。 ```C int volc_stop(volc_engine_t handle); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t |引擎实例，参见 [volc_engine_t](/docs/6348/1806635#volc-engine-t)。 | **返回值** * 0：成功。 * <0：失败。参见 [volc_error_code_e](/docs/6348/1806635#volc-error-code-e)。 ## volc_update 更新智能体。 ```C int volc_update(volc_engine_t handle, const void* config_json, size_t config_json); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t |引擎实例，参见 [volc_engine_t](/docs/6348/1806635#volc-engine-t)。 | |config_json |const void\* |智能体配置或数据。 | |data_len |size_t |数据长度。 | **返回值** * 0：成功。 * <0：失败。参见 [volc_error_code_e](/docs/6348/1806635#volc-error-code-e)。 ## volc_send_audio_data 推送本地采集的音频数据。 ```C int volc_send_audio_data(volc_engine_t handle, const void* data_ptr, size_t data_len, volc_audio_frame_info_t* info_ptr); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t |引擎实例，参见 [volc_engine_t](/docs/6348/1806635#volc-engine-t)。 | |data_ptr |const void\* |音频数据包。 | |data_len |size_t |音频数据长度，单位：字节。 | |info_ptr |volc_audio_frame_info_t\* |音频数据描述信息，参见 [volc_audio_frame_info_t](/docs/6348/1806635#volc-audio-frame-info-t)。 | **返回值** * 0：成功。 * <0：失败。参见 [volc_error_code_e](/docs/6348/1806635#volc-error-code-e)。 ## volc_send_video_data 推送视频帧数据。 :::warning 该接口仅适用于高质量集成方案。 ::: ```C int volc_send_video_data(volc_engine_t handle, const void* data_ptr, size_t data_len, volc_video_frame_info_t* info_ptr); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t |引擎实例，参见 [volc_engine_t](/docs/6348/1806635#volc-engine-t)。 | |data_ptr |const void\* |视频数据。 | |data_len |size_t |视频数据长度，单位：字节。 | |info_ptr |volc_video_frame_info_t\* |视频数据描述信息，参见 [volc_video_frame_info_t](/docs/6348/1806635#volc-video-frame-info-t)。 | **返回值** * 0：成功。 * <0：失败。参见 [volc_error_code_e](/docs/6348/1806635#volc-error-code-e)。 ## volc_send_message 推送自定义消息。 ```C int volc_send_message(volc_engine_t handle, const void* data_ptr, size_t data_len, volc_message_info_t* info_ptr); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t |引擎实例，参见 [volc_engine_t](/docs/6348/1806635#volc-engine-t)。 | |data_ptr |const void\* |消息数据。 | |data_len |size_t |消息长度，单位：字节。 | |info_ptr |volc_message_info_t\* |消息数据描述信息，参见 [volc_message_info_t](/docs/6348/1806635#volc-message-info-t)。 | **返回值** * 0：成功。 * <0：失败。参见 [volc_error_code_e](/docs/6348/1806635#volc-error-code-e)。 ## volc_send_text_to_agent 向智能体发送要播报的文本。 :::warning 该接口仅适用于高质量集成方案。 ::: ```C int volc_send_text_to_agent(volc_engine_t handle, const char* text, volc_agent_type_e type, int interrupt_mode); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t |引擎实例，参见 [volc_engine_t](/docs/6348/1806635#volc-engine-t)。 | |text |const char\* |要播报的文本内容。 | |type |volc_agent_type_e |智能体类型，参见[volc_agent_type_e](/docs/6348/1806635#ad6422b7)。 | |interrupt_mode |int |文本播报内容的优先级。取值：|\ | | ||\ | | |* `1`：高优先级。智能体会终止当前交互，直接播放传入的文本内容。|\ | | |* `2`：中优先级。智能体会在当前交互结束后，播放传入的文本内容。|\ | | |* `3`：低优先级。如果此时智能体正在交互，智能体会直直接丢弃传入的文本内容。如果未在交互，智能体会播放传入的文本内容。 | **返回值** * 0：成功。 * <0：失败。参见 [volc_error_code_e](/docs/6348/1806635#volc-error-code-e)。 ## volc_interrupt 打断智能体。 ```C int volc_interrupt(volc_engine_t handle); ``` **传入参数** |参数名 |类型 |说明 | |---|---|---| |handle |volc_engine_t |引擎实例，参见 [volc_engine_t](/docs/6348/1806635#volc-engine-t)。 | **返回值** * 0：成功。 * <0：失败。参见 [volc_error_code_e](/docs/6348/1806635#volc-error-code-e)。

实时音视频