Agora C# API Reference for Unity
概览
RtmClient
RtmChannel
LocalInvitation
RemoteInvitation
RtmCallManager
RtmClientEventHandler
RtmChannelEventHandler
RtmCallEventHandler
错误码和状态码
继承自 IRtmApiNative , 以及 IDisposable .
Public 成员函数 | |
| RtmChannel (IntPtr rtmChannelPtr, RtmChannelEventHandler rtmChannelEventHandler) | |
| int | Join () |
| int | Leave () |
| int | SendMessage (IMessage message) |
| int | SendMessage (IMessage message, SendMessageOptions options) |
| int | GetId () |
| int | GetMembers () |
| void | Dispose () |
成员函数说明
◆ Join()
| int agora_rtm.RtmChannel.Join | ( | ) |
加入频道。
- 注解
- 同一用户只能同时加入最多 20 个频道。加入频道超限时用户会收到错误码 JOIN_CHANNEL_ERR_FAILURE。
- 方法调用成功：
- 本地用户收到回调 OnJoinSuccessHandler。
- 所有远端用户收到回调 OnMemberJoinedHandler。
- 方法调用失败：本地用户收到回调 OnJoinFailureHandler。 错误代码信息详见 JOIN_CHANNEL_ERR。
- 方法调用成功：
- 返回
- 0: 方法调用成功。
- ≠0: 方法调用失败。错误码详见 JOIN_CHANNEL_ERR。
◆ Leave()
| int agora_rtm.RtmChannel.Leave | ( | ) |
离开频道。
- 方法调用成功：
- 本地用户收到回调 OnLeaveHandler 的
LEAVE_CHANNEL_ERR_OK状态。 - 所有远端用户收到回调 OnMemberLeftHandler callback。
- 本地用户收到回调 OnLeaveHandler 的
- 方法调用失败：本地用户收到回调 OnLeaveHandler 的错误代码。错误代码信息详见 LEAVE_CHANNEL_ERR。
- 返回
- 0: 方法调用成功。
- ≠0: 方法调用失败。错误码详见 LEAVE_CHANNEL_ERR。
◆ SendMessage() [1/2]
| int agora_rtm.RtmChannel.SendMessage | ( | IMessage | message | ) |
我们不推荐使用该方法发送频道消息。请改用它的重载方法 SendMessage。 方法调用成功：
- 本地用户收到回调 OnSendMessageResultHandler。
- 所有远端用户收到回调 OnMessageReceivedHandler。
- 参数
-
message 发送的消息。 详见 IMessage。
- 返回
- 0: 方法调用成功。
- ≠0: 方法调用失败。错误码详见 CHANNEL_MESSAGE_ERR_CODE。
◆ SendMessage() [2/2]
| int agora_rtm.RtmChannel.SendMessage | ( | IMessage | message, |
| SendMessageOptions | options | ||
| ) |
供频道成员向所在频道发送频道消息。 方法调用成功：
- 本地用户收到回调 OnSendMessageResultHandler。
- 所有远端用户收到回调 OnMessageReceivedHandler。
- 注解
- 发送消息（包括点对点消息和频道消息）的调用频率上限为每 3 秒 180 次。
- 参数
-
message 发送的消息。详见 IMessage。 options 消息发送选项。详见 SendMessageOptions。
- 返回
- 0: 方法调用成功。
- ≠0: 方法调用失败。错误码详见 CHANNEL_MESSAGE_ERR_CODE。
◆ GetId()
| int agora_rtm.RtmChannel.GetId | ( | ) |
获取当前频道 ID。
- 返回
- 当前频道 ID。
◆ GetMembers()
| int agora_rtm.RtmChannel.GetMembers | ( | ) |
获取频道成员列表。 SDK 通过 OnGetMembersHandler 回调返回该方法的调用结果（频道成员列表）。
- 注解
- 该方法的调用频率上限为每 2 秒 5 次。该方法最多获取 512 个频道成员。如果频道成员数量超过 512，该方法会随机返回其中的 512 个成员。
- 返回
- 0: 方法调用成功。
- ≠0: 方法调用失败。错误码详见 GET_MEMBERS_ERR 。
