agora_rtm_handler_t Struct Reference

#include <agora_rtc_api.h>

Data Fields
void(*	on_rtm_data )(const char *rtm_uid, const void *msg, size_t msg_len)
void(*	on_rtm_event )(const char *rtm_uid, rtm_event_type_e event_type, rtm_err_code_e err_code)
void(*	on_send_rtm_data_result )(uint32_t msg_id, rtm_err_code_e error_code)

Detailed Description

RTM event handler.

Field Documentation

on_rtm_data

void(* on_rtm_data) (const char *rtm_uid, const void *msg, size_t msg_len)

Occurs when the local user receives an RTM message.

Parameters

[in]	rtm_uid	The remote RTM user ID who sends the RTM message.
[in]	msg	The RTM message that the local user receives.
[in]	msg_len	Length of the RTM message.

on_rtm_event

void(* on_rtm_event) (const char *rtm_uid, rtm_event_type_e event_type, rtm_err_code_e err_code)

Occurs when an RTM event occurs.

Parameters

[in]	rtm_uid	RTM user ID.
[in]	event_type	Event type.
[in]	event_info	Event information.

on_send_rtm_data_result

void(* on_send_rtm_data_result) (uint32_t msg_id, rtm_err_code_e error_code)

Reports the result of the agora_rtc_send_rtm_data method call.

Parameters

[in]	msg_id	RTM message ID.
[in]	error_code	Error code number. 0 : Success. 1 : Failure.

---

The documentation for this struct was generated from the following file:

• agora_rtc_api.h