agora_rtm_handler_t Struct Reference

#include <agora_rtc_api.h>

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

Detailed Description

Agora RTC SDK 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 data comes from RTM

Parameters

[in]	rtm_uid	The remote rtm uid which the data come from.
[in]	msg	The Data received.
[in]	msg_len	Length of the data received.

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. See rtm_event_type_e.
[in]	err_code	Error code. See rtm_err_code_e.

on_rtm_send_data_result

void(*) on_rtm_send_data_result(const char *rtm_uid, uint32_t msg_id, rtm_msg_state_e state)

Reports the result of agora_rtc_send_rtm_data.

Parameters

[in]	rtm_uid	RTM user ID.
[in]	msg_id	Message ID.
[in]	state	RTM message state. See rtm_msg_state_e.

---

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

• agora_rtc_api.h