# RTSA C API 参考 (/zh-CN/api-reference/rtsa/c/overview)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="md_mainpage"></a>

<a id="方法"></a>

# 方法 [#方法]

以下为应用程序调用的主要方法。

| 方法 | 描述 |
| --- | --- |
| [agora_rtc_get_version](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#ad01077e5b926ab8a6a1743a74ff3cdd7) | 获取 SDK 版本。 |
| [agora_rtc_err_2_str](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a4d71911dc6236c8317bed8e2e7be6a6f) | 将错误码转为静态字符串。 |
| [agora_rtc_init](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a6187076d897f0b56cb20942368c15aaa) | 初始化 SDK。 |
| [agora_rtc_set_log_level](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a665de5b57dcb7b3c62d7a35b9a5992f7) | 设置 SDK 的日志等级。 |
| [agora_rtc_create_connection](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#adef869ae47e2f1c194af611b57d06394) | 创建 Connection。 |
| [agora_rtc_destroy_connection](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#ac58d42a331c45233d81085fc13defcaf) | 销毁 Connection。 |
| [agora_rtc_config_log](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a390557a8930a59dfffbfd1d4b52e9c94) | 配置 SDK 的日志文件。 |
| [agora_rtc_join_channel](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a6c29ff27f04623526a164cf6e5dcd738) | 加入指定 Connection 所关联的 RTC 频道。 |
| [agora_rtc_join_channel_with_user_account](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a64a24029bfaa5408e987122261385013) | 使用 User Account 加入指定 Connection 所关联的 RTC 频道。 |
| [agora_rtc_get_user_info_by_user_account](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a68efcfa431803942c8fdc733b00c30c1) | 通过 User Account 获取用户信息。 |
| [agora_rtc_get_user_info_by_uid](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#ad6b1be785d6c2b4fa8fb0eac90290194) | 通过 UID 获取用户信息。 |
| [agora_rtc_renew_token](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a87c94a2d518278926807e24592b41336) | 更新指定 Connection 所关联的 RTC 频道的 RTC Token。 |
| [agora_rtc_send_audio_data](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a0a00045d34a87e7a3798c6c906f9e197) | 向指定 Connection 所关联的 RTC 频道发送音频帧。 |
| [agora_rtc_send_video_data](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a05973c4f32a5eb480e52b4f566601bf5) | 向指定 Connection 所关联的 RTC 频道发送视频帧。 |
| [agora_rtc_mute_local_audio](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a28c1dae086be4014ad732a07db248b16) | 暂停/恢复发送本地音频流。 |
| [agora_rtc_mute_remote_audio](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a8ad8bfa0e0a46a0c5e7fae11449ab575) | 暂停/恢复接收指定频道内指定远端用户的音频流。 |
| [agora_rtc_mute_local_video](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a47f116e271b78c0659fcd68a96d34224) | 暂停/恢复发送本地视频流。 |
| [agora_rtc_mute_remote_video](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a894f5a102c66b20c408bb495ac424efa) | 暂停/恢复接收指定频道内指定远端用户的视频流。 |
| [agora_rtc_create_data_stream](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#aa6b288b479c7048b4cceb85d995771ed) | 创建数据流。 |
| [agora_rtc_send_stream_message](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#aee89fa14447b4529d45275afe5b5a86f) | 发送数据流。 |
| [agora_rtc_send_media_ctrl_msg](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a83dd3f91afbae5d54548c4d8e546aafc) | 向所有频道或指定频道发送消息。 |
| [agora_rtc_request_video_key_frame](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a74fbf2ac33a8cefce0f02de3eacc2577) | 请求指定远端用户尽快为指定远端视频流生成关键帧。 |
| [agora_rtc_set_bwe_param](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#ae274291aadd1afb9974a4672ed6c2bb8) | 设置 bandwidth estimation (BWE) 参数。 |
| [agora_rtc_send_audio_data](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a0a00045d34a87e7a3798c6c906f9e197) | 向指定 Connection 所关联的 RTC 频道发送音频帧。 |
| [agora_rtc_send_video_data](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a05973c4f32a5eb480e52b4f566601bf5) | 向指定 Connection 所关联的 RTC 频道发送视频帧。 |
| [agora_rtc_leave_channel](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a939878648ce563ef4041da892d478f8b) | 离开指定 Connection 所关联的 RTC 频道。 |
| [agora_rtc_fini](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a09875c7766bbb543425da877a3ef6e1d) | 释放所有资源。 |
| [agora_rtm_login](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#abd4be43c4d5850c8753ef27c18417c20) | 登录 RTM 服务。 |
| [agora_rtm_logout](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a6775e5f6356091e50328cc5dd7c3f9a1) | 登出 RTM 服务。 |
| [agora_rtm_send_data](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#ab001eda008555d96e4e64dc9e66687bf) | 通过 RTM 服务发送消息。 |
| [agora_rtm_subscribe](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a30c2d99a514ebd98a4d335685668f595) | 订阅 RTM 频道。 |
| [agora_rtm_unsubscribe](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a80ccd21954a2f23c1fc7d0b540709fe6) | 取消订阅 RTM 频道。 |
| [agora_rtm_publish](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#ab3dfb2693ca2cc21a56862065a16d718) | 向 RTM 频道发布消息。 |
| [agora_rtc_set_params](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a3d0aac6ce04ce9f2420c459fa9990d41) | 通过 JSON 配置 SDK 提供技术预览或特别定制功能。 |
| [agora_rtc_send_rdt_msg](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a056de38235f67ad1ea91cfd695ffaf61) | 发送 RDT 消息。 |
| [agora_rtc_get_rdt_status_info](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#a80f16bf3cf9bcdf8a6cecc51f8e584aa) | 获取 RDT 通道的信息。 |

<a id="回调"></a>

# 回调 [#回调]

用于向应用程序发送回调通知。

| 回调 | 描述 |
| --- | --- |
| [on_join_channel_success](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#af1fb7d73977c5d23301bed8066b92024) | 加入 RTC 频道成功。 |
| [on_connection_lost](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a93ef61674bc7c4d5f53fe2b59aa38e88) | 连接丢失。 |
| [on_reconnecting](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a63382fa7b0cba7589f1577630657a323) | 正在重新连接回调。 |
| [on_rejoin_channel_success](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a289e8f276aaecbf44f80f8c66efeac0b) | 重新加入 RTC 频道成功。 |
| [on_error](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a7a67b6ffff8d0758afe5b38a91e3a6e3) | 发生错误。 |
| [on_license_validation_failure](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#af300f9a2a90391ce3ef8bbca2217bd91) | 设备 License 验证失败。 |
| [on_user_joined](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a74df0f085839d12a7d85236a70f2ff1d) | 远端用户加入 RTC 频道。 |
| [on_user_joined_with_user_account](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#aa7f9418b6d5502ee641b8231c6f3292f) | 远端用户使用 User Account 加入 RTC 频道。 |
| [on_user_offline](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#ac3f1bcc48ccb52dbe58e2698a24d1faa) | 远端用户离开 RTC 频道。 |
| [on_user_offline_with_user_account](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#ab81aeacbe7daef9eff3f14362267ded7) | 使用 User Account 场景下，远端用户离开频道回调。 |
| [on_user_mute_audio](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a5c823e048831fcefa7fca0a2c01ad864) | RTC 频道内远端用户暂停/恢复发送音频流。 |
| [on_user_mute_video](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#ae07cf9b3a19154ad8d889a4bd3f51b59) | RTC 频道内远端用户暂停/恢复发送视频流。 |
| [on_stream_message](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a60c9fde781cd1429ed824efeb1cdd7e5) | 接收到远端用户数据流消息的回调。 |
| [on_media_ctrl_msg](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a2e1c250bc84081128d1c2f4fed26bf92) | 接收到远端用户发送的消息回调。 |
| [on_user_info_updated](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a4235da22aa144746564deaa878dcda40) | 用户信息已更新回调。 |
| [on_key_frame_gen_req](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a67e5f4137e45db389ca5f69866135715) | RTC 频道内远端用户请求关键帧。 |
| [on_audio_data](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#af50f0b13389c28ffab6f185d6dc7e18c) | 收到 RTC 频道内远端用户的音频帧。 |
| [on_video_data](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#ad22676cef8f3d947b68c84b95ea5cde9) | 收到 RTC 频道内远端用户的视频帧。 |
| [on_mixed_audio_data](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#aa10d23bce1cd68dbe42e16945e45b174) | 收到 RTC 频道内本地用户和远端用户的混音数据。 |
| [on_target_bitrate_changed](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a2cd16998c0834bac5c47c0e2b9f47fcc) | 编码器码率更新通知。 |
| [on_token_privilege_will_expire](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a73ce0c60c3e00ac601342ddf70408a58) | RTC Token 服务即将过期回调。 |
| [on_rtm_data](/zh-CN/api-reference/rtsa/c/structagora-rtm-handler-t#a8c5e9092fcc6702053f25a4e9a437d7e) | RTM 消息回调。 |
| [on_rtm_event](/zh-CN/api-reference/rtsa/c/structagora-rtm-handler-t#ab2549296a558191c8108cc5ca80de6ca) | RTM 事件回调。 |
| [on_rtm_send_data_result](/zh-CN/api-reference/rtsa/c/structagora-rtm-handler-t#a8b8816e97d0ec1563280cc39fe4d28ca) | [agora_rtm_send_data](/zh-CN/api-reference/rtsa/c/agora-rtc-api-8h#ab001eda008555d96e4e64dc9e66687bf) 方法调用结果回调。 |
| [on_rtm_subscribe_result](/zh-CN/api-reference/rtsa/c/structagora-rtm-handler-t#a4af3bd1e0ff1e84245e81e7f2cb1fc79) | 订阅结果。 |
| [on_rtm_subscribe_data](/zh-CN/api-reference/rtsa/c/structagora-rtm-handler-t#a40440ce1910c685ba80d7116bc289062) | 收到已订阅 RTM 频道的消息回调。 |
| [on_rtm_publish_result](/zh-CN/api-reference/rtsa/c/structagora-rtm-handler-t#ab4a465f3612760c6b7b74f6b79a5e6f6) | 发布结果。 |
| [on_rdt_state](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#afe6c35e916473a1424f28d3fefbdda69) | RDT 通道的连接状态已改变回调。 |
| [on_rdt_msg](/zh-CN/api-reference/rtsa/c/structagora-rtc-event-handler-t#a7b5b9ba5f3acaf9b336040e4edd282a5) | 收到 RDT 消息回调。 |