RTSA C API 参考

方法

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

方法	描述
agora_rtc_get_version	获取 SDK 版本。
agora_rtc_err_2_str	将错误码转为静态字符串。
agora_rtc_init	初始化 SDK。
agora_rtc_set_log_level	设置 SDK 的日志等级。
agora_rtc_create_connection	创建 Connection。
agora_rtc_destroy_connection	销毁 Connection。
agora_rtc_config_log	配置 SDK 的日志文件。
agora_rtc_join_channel	加入指定 Connection 所关联的 RTC 频道。
agora_rtc_join_channel_with_user_account	使用 User Account 加入指定 Connection 所关联的 RTC 频道。
agora_rtc_get_user_info_by_user_account	通过 User Account 获取用户信息。
agora_rtc_get_user_info_by_uid	通过 UID 获取用户信息。
agora_rtc_renew_token	更新指定 Connection 所关联的 RTC 频道的 RTC Token。
agora_rtc_send_audio_data	向指定 Connection 所关联的 RTC 频道发送音频帧。
agora_rtc_send_video_data	向指定 Connection 所关联的 RTC 频道发送视频帧。
agora_rtc_mute_local_audio	暂停/恢复发送本地音频流。
agora_rtc_mute_remote_audio	暂停/恢复接收指定频道内指定远端用户的音频流。
agora_rtc_mute_local_video	暂停/恢复发送本地视频流。
agora_rtc_mute_remote_video	暂停/恢复接收指定频道内指定远端用户的视频流。
agora_rtc_create_data_stream	创建数据流。
agora_rtc_send_stream_message	发送数据流。
agora_rtc_send_media_ctrl_msg	向所有频道或指定频道发送消息。
agora_rtc_request_video_key_frame	请求指定远端用户尽快为指定远端视频流生成关键帧。
agora_rtc_set_bwe_param	设置 bandwidth estimation (BWE) 参数。
agora_rtc_send_audio_data	向指定 Connection 所关联的 RTC 频道发送音频帧。
agora_rtc_send_video_data	向指定 Connection 所关联的 RTC 频道发送视频帧。
agora_rtc_leave_channel	离开指定 Connection 所关联的 RTC 频道。
agora_rtc_fini	释放所有资源。
agora_rtm_login	登录 RTM 服务。
agora_rtm_logout	登出 RTM 服务。
agora_rtm_send_data	通过 RTM 服务发送消息。
agora_rtm_subscribe	订阅 RTM 频道。
agora_rtm_unsubscribe	取消订阅 RTM 频道。
agora_rtm_publish	向 RTM 频道发布消息。
agora_rtc_set_params	通过 JSON 配置 SDK 提供技术预览或特别定制功能。
agora_rtc_send_rdt_msg	发送 RDT 消息。
agora_rtc_get_rdt_status_info	获取 RDT 通道的信息。

回调

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

回调	描述
on_join_channel_success	加入 RTC 频道成功。
on_connection_lost	连接丢失。
on_reconnecting	正在重新连接回调。
on_rejoin_channel_success	重新加入 RTC 频道成功。
on_error	发生错误。
on_license_validation_failure	设备 License 验证失败。
on_user_joined	远端用户加入 RTC 频道。
on_user_joined_with_user_account	远端用户使用 User Account 加入 RTC 频道。
on_user_offline	远端用户离开 RTC 频道。
on_user_offline_with_user_account	使用 User Account 场景下，远端用户离开频道回调。
on_user_mute_audio	RTC 频道内远端用户暂停/恢复发送音频流。
on_user_mute_video	RTC 频道内远端用户暂停/恢复发送视频流。
on_stream_message	接收到远端用户数据流消息的回调。
on_media_ctrl_msg	接收到远端用户发送的消息回调。
on_user_info_updated	用户信息已更新回调。
on_key_frame_gen_req	RTC 频道内远端用户请求关键帧。
on_audio_data	收到 RTC 频道内远端用户的音频帧。
on_video_data	收到 RTC 频道内远端用户的视频帧。
on_mixed_audio_data	收到 RTC 频道内本地用户和远端用户的混音数据。
on_target_bitrate_changed	编码器码率更新通知。
on_token_privilege_will_expire	RTC Token 服务即将过期回调。
on_rtm_data	RTM 消息回调。
on_rtm_event	RTM 事件回调。
on_rtm_send_data_result	agora_rtm_send_data方法调用结果回调。
on_rtm_subscribe_result	订阅结果。
on_rtm_subscribe_data	收到已订阅 RTM 频道的消息回调。
on_rtm_publish_result	发布结果。
on_rdt_state	RDT 通道的连接状态已改变回调。
on_rdt_msg	收到 RDT 消息回调。