文档中心
ar云平台 RTM 频道方法。
kit
@property (atomic, readonly, nonnull) ARtmKit *kit;
ARtmKit 实例。
channelDelegate
@property (nonatomic, weak, nullable) id<ARtmChannelDelegate> channelDelegate;
ARtmChannelDelegate 接口类向 App 发送回调通知，上报运行时的频道相关事件。
joinWithCompletion
- (void)joinWithCompletion:(ARtmJoinChannelBlock _Nullable)completionBlock;
加入频道
- ARtmJoinChannelBlock 回调返回本方法的调用结果。
- 加入频道成功后，频道内的所有远端用户收到 memberJoined 回调。
| 参数 | 描述 |
|---|---|
| completionBlock | ARtmJoinChannelBlock 回调返回本方法的调用结果。错误码详见 ARtmJoinChannelErrorCode 。 |
注意事项： 同一用户只能同时加入最多 20 个频道。加入频道超限时用户会收到错误码ARtmJoinChannelErrorExceedLimit。
leaveWithCompletion
- (void)leaveWithCompletion:(ARtmLeaveChannelBlock _Nullable)completionBlock;
离开频道
- ARtmLeaveChannelBlock 回调返回本方法的调用结果。
- 成功离开频道后，频道内的所有远端用户收到 memberLeft 回调。
| 参数 | 描述 |
|---|---|
| completionBlock | ARtmLeaveChannelBlock回调返回本方法的调用结果。错误码详见ARtmLeaveChannelErrorCode 。 |
sendMessage
- (void)sendMessage:(ARtmMessage * _Nonnull)message sendMessageOptions:(ARtmSendMessageOptions* _Nonnull)options
completion:(ARtmSendChannelMessageBlock _Nullable)completionBlock;
发送频道消息
- ARtmSendChannelMessageBlock 回调回本方法的调用结果。
- 消息发送成功后，频道内的所有远端用户收到 messageReceived 回调。
| 参数 | 描述 |
|---|---|
| message | 发送的消息内容。详见 ARtmMessage 。 |
| options | 消息发送选项。详见 ARtmSendMessageOptions 。 |
| completionBlock | ARtmSendChannelMessageBlock 回调返回方法的调用结果。错误码详见 ARtmSendChannelMessageErrorCode 。 |
注意事项： 消息（包括频道消息和点对点消息）的最高发送频率为 60 次／秒。
getMembersWithCompletion
- (void)getMembersWithCompletion:(ARtmGetMembersBlock _Nullable)completionBlock;
获取频道成员列表
| 参数 | 描述 |
|---|---|
| completionBlock | ARtmGetMembersBlock 回调返回本方法的调用结果（频道成员列表）。错误码详见 ARtmGetMembersErrorCode 。 |
注意事项： 该方法的调用频率上限为每 2 秒 5 次。