Methods

Methods of the SDK.

Method	Description
agora_rtc_get_version	Gets the SDK version.
agora_rtc_err_2_str	Converts an error code to a string.
agora_rtc_init	Initializes the SDK.
agora_rtc_set_log_level	Sets the log level.
agora_rtc_create_connection	Creates a connection.
agora_rtc_destroy_connection	Destroys a connection.
agora_rtc_config_log	Configures the log file.
agora_rtc_join_channel	Joins an RTC channel corresponding to a specified connection.
agora_rtc_join_channel_with_user_account	Joins an RTC channel corresponding to a specified connection with a user account.
agora_rtc_get_user_info_by_user_account	Gets user information by user account.
agora_rtc_get_user_info_by_uid	Gets user information by UID.
agora_rtc_renew_token	Renews an RTC token for one or multiple channels corresponding to a connection.
agora_rtc_send_audio_data	Sends an audio frame to one or multiple channels corresponding to a connection.
agora_rtc_send_video_data	Sends a video frame to one or multiple channels corresponding to a connection.
agora_rtc_mute_local_audio	Enables/disables sending local audio data to one or multiple channels corresponding to a connection.
agora_rtc_mute_remote_audio	Enables/disables receiving local audio data from one or multiple channels corresponding to a connection.
agora_rtc_mute_local_video	Enables/disables sending local video data to one or multiple channels corresponding to a connection.
agora_rtc_mute_remote_video	Enables/disables receiving local video data from one or multiple channels corresponding to a connection.
agora_rtc_create_data_stream	Creates a data stream.
agora_rtc_send_stream_message	Sends a data stream message.
agora_rtc_send_media_ctrl_msg	Sends a message to all channels or a specified channel.
agora_rtc_request_video_key_frame	Requests a keyframe from a remote user in one or multiple channels corresponding to a connection.
agora_rtc_set_bwe_param	Sets network bandwidth estimation (BWE) parameters.
agora_rtc_send_audio_data	Sends an audio frame to one or multiple channels corresponding to a connection.
agora_rtc_send_video_data	Sends a video frame to one or multiple channels corresponding to a connection.
agora_rtc_leave_channel	Leaves an RTC channel corresponding to a specified connection.
agora_rtc_fini	Releases all resources allocated by the SDK.
agora_rtc_login_rtm	Logs into RTM.
agora_rtc_logout_rtm	Logs out of RTM.
agora_rtc_send_rtm_data	Sends an RTM message.
agora_rtc_set_params	Provides technical preview functionalities or special customizations by configuring the SDK with JSON options.
agora_rtc_send_rdt_msg	Sends an RDT message.
agora_rtc_get_rdt_status_info	Gets information about an RDT channel.

Callbacks

Callbacks of the SDK.

Callback	Description
on_join_channel_success	Occurs when the local user joins an RTC channel successfully.
on_connection_lost	Occurs when the local user disconnects from an RTC channel.
on_reconnecting	Occurs when the SDK is reconnecting to an RTC channel.
on_rejoin_channel_success	Occurs when the local user rejoins an RTC channel successfully.
on_error	Occurs when the SDK reports an error.
on_license_validation_failure	Occurs when device license validation fails.
on_user_joined	Occurs when a remote user joins an RTC channel successfully.
on_user_joined_with_user_account	Occurs when a remote user joins an RTC channel with a user account.
on_user_offline	Occurs when a remote user leaves an RTC channel.
on_user_offline_with_user_account	Occurs when a remote user leaves an RTC channel in a user account scenario.
on_user_mute_audio	Occurs when a remote user enables/disables sending audio.
on_user_mute_video	Occurs when a remote user enables/disables sending video.
on_stream_message	Occurs when the local user receives a data stream message from a remote user.
on_media_ctrl_msg	Occurs when the local user receives a message from a remote user.
on_user_info_updated	Occurs when user information is updated.
on_key_frame_gen_req	Occurs when a remote user requests a keyframe.
on_audio_data	Occurs when receiving the audio frame of a remote user in the channel.
on_video_data	Occurs when receiving the video frame of a remote user in the channel.
on_mixed_audio_data	Occurs when receiving the mixed audio frame of local and remote users. This callback occurs every 20 ms.
on_target_bitrate_changed	Occurs when network bandwidth change is detected. Use this callback to adjust your bitrate.
on_token_privilege_will_expire	Occurs when the RTC token expires in 30 seconds.
on_rtm_data	Occurs when the local user receives an RTM message.
on_rtm_event	Occurs when an RTM event occurs.
on_rtm_send_data_result	Reports the result of the agora_rtc_send_rtm_data method call.
on_rdt_state	Occurs when the connection state of an RDT channel changes.
on_rdt_msg	Occurs when the local user receives an RDT message.