Agora C# API Reference for Unity
概览
RtmClient
RtmChannel
LocalInvitation
RemoteInvitation
RtmCallManager
RtmClientEventHandler
RtmChannelEventHandler
RtmCallEventHandler
错误码和状态码
继承自 IRtmApiNative .
Public 成员函数 | |
| delegate void | OnJoinSuccessHandler (int id) |
| delegate void | OnJoinFailureHandler (int id, JOIN_CHANNEL_ERR errorCode) |
| delegate void | OnLeaveHandler (int id, LEAVE_CHANNEL_ERR errorCode) |
| delegate void | OnMessageReceivedHandler (int id, string userId, TextMessage message) |
| delegate void | OnSendMessageResultHandler (int id, Int64 messageId, CHANNEL_MESSAGE_ERR_CODE errorCode) |
| delegate void | OnMemberJoinedHandler (int id, RtmChannelMember member) |
| delegate void | OnMemberLeftHandler (int id, RtmChannelMember member) |
| delegate void | OnGetMembersHandler (int id, RtmChannelMember[] members, int userCount, GET_MEMBERS_ERR errorCode) |
| delegate void | OnAttributesUpdatedHandler (int id, RtmChannelAttribute[] attributesList, int numberOfAttributes) |
| delegate void | OnMemberCountUpdatedHandler (int id, int memberCount) |
| void | Release () |
Public 属性 | |
| OnJoinSuccessHandler | OnJoinSuccess |
| OnJoinFailureHandler | OnJoinFailure |
| OnLeaveHandler | OnLeave |
| OnMessageReceivedHandler | OnMessageReceived |
| OnSendMessageResultHandler | OnSendMessageResult |
| OnMemberJoinedHandler | OnMemberJoined |
| OnMemberLeftHandler | OnMemberLeft |
| OnGetMembersHandler | OnGetMembers |
| OnAttributesUpdatedHandler | OnAttributesUpdated |
| OnMemberCountUpdatedHandler | OnMemberCountUpdated |
成员函数说明
◆ OnJoinSuccessHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnJoinSuccessHandler | ( | int | id | ) |
加入频道成功回调。 本地用户调用 Join 方法成功加入频道后：
- SDK 触发此回调；
- 频道内所有远端用户收到 OnMemberJoinedHandler 回调。
- 参数
-
id RtmChannelEventHandler ID
◆ OnJoinFailureHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnJoinFailureHandler | ( | int | id, |
| JOIN_CHANNEL_ERR | errorCode | ||
| ) |
加入频道失败回调。 SDK 会在用户 Join 方法失败后触发此回调。
- 参数
-
id RtmChannelEventHandler ID errorCode 错误码。详见 JOIN_CHANNEL_ERR。
◆ OnLeaveHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnLeaveHandler | ( | int | id, |
| LEAVE_CHANNEL_ERR | errorCode | ||
| ) |
离开频道回调。
- 参数
-
id RtmChannelEventHandler ID errorCode 错误码。详见 LEAVE_CHANNEL_ERR。
◆ OnMessageReceivedHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnMessageReceivedHandler | ( | int | id, |
| string | userId, | ||
| TextMessage | message | ||
| ) |
收到频道消息回调。 当远端用户调用 SendMessage 方法成功发送频道消息后，在相同频道的本地用户会收到此回调。
- 参数
-
id RtmChannelEventHandler ID userId 消息发送者的用户 ID。 message 接收到的频道消息内容。详见 IMessage。
◆ OnSendMessageResultHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnSendMessageResultHandler | ( | int | id, |
| Int64 | messageId, | ||
| CHANNEL_MESSAGE_ERR_CODE | errorCode | ||
| ) |
报告 SendMessage 方法的调用结果。 本地用户调用 SendMessage 方法成功发送频道消息后：
- SDK 触发此回调；
- 频道内所有远端用户收到 OnMessageReceived 回调。
- 参数
-
id RtmChannelEventHandler ID messageId 频道消息的 ID。 errorCode 错误码。详见 CHANNEL_MESSAGE_ERR_CODE。
◆ OnMemberJoinedHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnMemberJoinedHandler | ( | int | id, |
| RtmChannelMember | member | ||
| ) |
远端用户加入频道回调。 当有远端用户调用 Join 方法加入频道并收到 OnJoinSuccessHandler 回调时，在相同频道的本地用户会收到此回调。 note 频道人数超过 512 人时后台会关闭上下线通知。
- 参数
-
id RtmChannelEventHandler ID member 加入频道的远端用户。详见 ChannelMember。
◆ OnMemberLeftHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnMemberLeftHandler | ( | int | id, |
| RtmChannelMember | member | ||
| ) |
频道成员离开频道回调。 当有频道成员调用 Leave 方法离开频道并收到 OnLeaveHandler (LEAVE_CHANNEL_ERR_OK) 回调时，在相同频道的本地用户会收到此回调。
- 注解
- 频道人数超过 512 人时后台会关闭上下线通知。
- 参数
-
id RtmChannelEventHandler ID member 离开频道的频道成员。详见 ChannelMember。
◆ OnGetMembersHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnGetMembersHandler | ( | int | id, |
| RtmChannelMember[] | members, | ||
| int | userCount, | ||
| GET_MEMBERS_ERR | errorCode | ||
| ) |
报告 GetMembers 方法的调用结果。 当方法调用成功时，SDK 会返回 RtmChannel 频道成员列表。
- 注解
- 该方法的调用频率上限为每 2 秒 5 次。
- 参数
-
id RtmChannelEventHandler ID members 频道成员列表。详见 RtmChannel。 userCount 频道成员数量。 errorCode 错误代码。详见 GET_MEMBERS_ERR。
◆ OnAttributesUpdatedHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnAttributesUpdatedHandler | ( | int | id, |
| RtmChannelAttribute[] | attributesList, | ||
| int | numberOfAttributes | ||
| ) |
频道属性更新回调。报告所在频道的所有属性。
- 注解
- 只有当频道属性更新者将 enableNotificationToChannelMembers 设为
true后，该回调才会被触发。请注意：该标志位为一次性标志位，仅对当前频道属性操作有效。
- 参数
-
id RtmChannelEventHandler ID attributesList 当前频道的所有属性。 numberOfAttributes 频道属性的条数。
◆ OnMemberCountUpdatedHandler()
| delegate void agora_rtm.RtmChannelEventHandler.OnMemberCountUpdatedHandler | ( | int | id, |
| int | memberCount | ||
| ) |
频道成员人数更新回调。报告最新频道成员人数。
- 注解
- SDK 会在频道成员人数更新时返回该回调：
- 频道成员人数 ≤ 512 时，回调触发频率为每秒 1 次。
- 频道成员人数超过 512 时，回调触发频率为每 3 秒 1 次。
- 用户在成功加入频道时会收到该回调。你可以通过监听该回调获取加入频道时的频道成员人数和后继人数更新。
- 参数
-
id RtmChannelEventHandler ID memberCount 最新频道成员人数。
